Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Reclaim.ai Admin API

The Admin API from Reclaim.ai — 7 operation(s) for admin.

Reclaim.ai Admin API is one of 83 APIs that Reclaim.ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Admin. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 7 paths, and defines 111 schemas. It is described by OpenAPI 3.0.1, at version 0.1.

Requests are made against the base URL https://api.app.reclaim.ai.

10 operations 7 paths 111 schemas 2 DELETE2 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
0.1
Base URL
https://api.app.reclaim.ai
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Reclaim.ai Admin API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Authorization).

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 2 DELETE, 2 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Admin 10
POST
/api/admin/users
admin_createUser body → 200
DELETE
/api/admin/users/{username}
admin_deleteUser 1 param → 200
GET
/api/admin/users/{username}/accounts
admin_listAccounts 1 param → 200
POST
/api/admin/users/{username}/accounts
admin_createAccount 1 param body → 200
POST
/api/admin/users/{username}/accounts/{accountId}/main
admin_switchMainAccount 2 params → 200
GET
/api/admin/users/{username}/calendar-syncs
admin_getCalendarSyncs 1 param → 200
POST
/api/admin/users/{username}/calendar-syncs
admin_createCalendarSync 1 param body → 200
DELETE
/api/admin/users/{username}/calendar-syncs/{sourceId}/to/{targetId}
admin_deleteSync 3 params → 200
PATCH
/api/admin/users/{username}/calendar-syncs/{sourceId}/to/{targetId}
admin_patchSync 3 params body → 200
PATCH
/api/admin/users/{username}/orgMetadata
admin_patchOrgMetadata 1 param body → 200

Schemas 111

The contract defines 111 schemas that model the data the API accepts and returns. The most detailed are ConnectedAccount (63 properties), User (46 properties), AssistSettings (46 properties), UserSettings (44 properties). Each schema is shown below with its type and property counts.

DefaultRsvpAvailability
object
1 property
SchedulingWindowWeeks
string
UserView
object
3 properties 3 required
WebhookSettings
object
2 properties
UserInterests
object
12 properties
AvailabilitySettings
object
1 property
UserProfileDepartment
string
CapabilityStatus
string
Colorized
object
1 property
UserPayload
object
6 properties 2 required
CapabilityInfo
object
2 properties 1 required
TaskAutoWorkflowSettings
object
2 properties
EventType
string
AsanaSettings
object
1 property
TimezonePreference
string
ConnectedAccountType
string
UserProvisioningDetails
object
1 property 1 required
ImmutableCollection_CalendarView_
object
UserMetadataUsecase
string
ExperimentalSettings
object
2 properties
PrioritiesSettings
object
1 property
EventDisplayPreferences
object
9 properties 9 required
SchedulingWindowWeeksOverride
string
UserAccountLock.AccountLockType
string
SignupMethod
string
UserMetadata
object
9 properties
UserMetadataCompanySize
string
CalendarEntrySettings
object
11 properties
DetailedEntitlements
object
14 properties
SyncCalendarType
string
AssistSettings
object
46 properties
DayOfWeek
string
ConnectedAccountPayload
object
1 property 1 required
AdventureSetting
object
1 property 1 required
AssistNotificationSettings
object
4 properties 4 required
User
object
46 properties 4 required
TaskAutoWorkflowType
string
MicrosoftSettings
object
3 properties
GoogleAddOnSettings
object
1 property
UserProfileGoal
string
TimezoneSettings
object
3 properties 1 required
Reminder
object
2 properties 2 required
EntitlementDetails
object
3 properties 2 required
ConferenceBufferType
string
UserDateTimeFormatter
object
1 property
AvailabilityType
string
SyncFeatureSettings
object
3 properties
SlackStatusSetting
object
4 properties
UserPostOnboard
object
15 properties
SyncAllDayEvents
string
SyncTransparency
string
AnalyticsSettings
object
2 properties
AutoLock
string
QuestSettings
object
1 property
SchedulingLinkSettings
object
5 properties
DateFieldOrder
string
CalendarAccess
string
TaskDefaults
object
13 properties
UserOnboard
object
25 properties
Entitlements
object
18 properties
DirectoryAccess
object
2 properties 2 required
ColorsSettings
object
5 properties
CalendarSync
object
9 properties 9 required
IneligibilityReason
string
OrgMetadata.OrgManager
object
3 properties 3 required
UserAccountLock
object
2 properties 2 required
SmartSeriesRecurrenceType
string
CalendarPermissionSettings
object
1 property
TaskSettings
object
6 properties 1 required
CalendarUseType
string
TaskCooldown
string
EventCategory
ThinCalendar
object
6 properties 6 required
SharedCalendarsAccess
object
2 properties 2 required
CalendarView
object
16 properties 12 required
SlotScorerVersion
string
UserProfileRole
string
ReminderType
string
ReclaimEventType
string
AppNotificationsSettings
object
4 properties
UserSettings
object
44 properties 35 required
FocusSettings
object
2 properties
ContactsAccess
object
2 properties 2 required
EntitlementValue_Object_
object
3 properties 3 required
RSVPSetting
object
1 property
Settings
object
8 properties
TodoistSettings
object
1 property
OrgMetadata
object
7 properties
ConnectedAccount
object
63 properties
UserPostOnboardState
string
DropboxSettings
object
1 property
SlackOutsideHoursSetting
object
3 properties 2 required
BillingSettings
object
1 property
UserAdventures
object
1 property
ImmutableSet_CalendarView_
object
SchedulingLinkNameVisibility
string
SlackSettings.StatusSync
string
ProjectsSettings
object
1 property
SmartOneOnOneSettings
object
1 property
EventColor
string
AbstractCollection_CalendarView_
object
1 property
CreateCalendarSyncRequest
object
9 properties 9 required
ScheduleAssistantScoringSettings
object
1 property
ReclaimEdition
string
SlackSettings
object
19 properties
ObservedUser
object
TemporalSettings
object
1 property
CalendarSettings
object
2 properties
LogContext
object
ScheduleAssistantSettings
object
10 properties
WeeklyReport
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reclaim-ai-admin-api-openapi.yml Raw ↑

Other APIs Reclaim.ai publishes across the network.

Reclaim.ai account-time-schemes API
Reclaim.ai accounts API
Reclaim.ai action-items API
Reclaim.ai actions API
Reclaim.ai analytics API
Reclaim.ai Anonymous API
Reclaim.ai api-management API
Reclaim.ai asana API
Reclaim.ai assist API
Reclaim.ai Assistant API
Reclaim.ai Avatar API
Reclaim.ai aws-ses API