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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Reclaim.ai

Reclaim.ai users API

The users API from Reclaim.ai — 45 operation(s) for users.

Documentation Provider Profile APIs.io OpenAPI GitHub

Reclaim.ai users 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 users. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 49 operations across 45 paths, and defines 120 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.

49 operations 45 paths 120 schemas 2 DELETE10 GET5 PATCH25 POST7 PUT

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
Contact
Reclaim.ai Inc.
License
Reclaim 9.9
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 49

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

users 49
GET
/api/users/current
User details for the currently authenticated user
current → 200
DELETE
/api/users/current
delete_6 → 200
PATCH
/api/users/current
patch_2 body → 200
GET
/api/users/current/access
access → 200
GET
/api/users/current/access/{entityType}
accessByEntityType 1 param → 200
GET
/api/users/current/adventures
getAdventures → 200
GET
/api/users/current/adventures/{adventure}
getAdventure 1 param → 200
POST
/api/users/current/adventures/{adventure}
updateAdventure 1 param body → 200
PATCH
/api/users/current/date-field-order-settings
What should the order of day (D), month (M) and year (Y) be when displaying dates.
updateDateFieldOrderSettings 1 param → 200
GET
/api/users/current/downgrade-snapshot
getHardDowngradeSnapshot → 200
PUT
/api/users/current/features/app-notifications
updateAppNotifications body → 200
POST
/api/users/current/features/assist-settings/damp-smart-meetings
updateDampSmartMeetings 1 param → 200
POST
/api/users/current/features/assist-settings/enable-external-llm
updateEnableExternalLlm 1 param → 200
PUT
/api/users/current/features/assist-settings/notification-settings
updateAssistNotificationSettings body → 200
POST
/api/users/current/features/assist-settings/reschedule-unstarted
updateRescheduleUnstarted 1 param → 200
POST
/api/users/current/features/assist-settings/schedule-smart-meetings-at-most-daily
updateScheduleSmartMeetingsAtMostDaily 1 param → 200
POST
/api/users/current/features/assist-settings/schedule-smart-meetings-once
updateScheduleSmartMeetingsOnce 1 param → 200
PUT
/api/users/current/features/assist-settings/scheduling-behavior
updateSchedulingBehavior body → 200
POST
/api/users/current/features/assist-settings/smart-habit-recurrence-type
updateSmartHabitRecurrenceType 1 param → 200
POST
/api/users/current/features/assist-settings/smart-habits-to-reclaim-recurrence-auto-migrate
updateSmartHabitsToGen3AutoMigrate 1 param → 200
POST
/api/users/current/features/assist-settings/smart-meeting-recurrence-type
updateSmartMeetingRecurrenceType 1 param → 200
POST
/api/users/current/features/assist-settings/smart-meetings-to-reclaim-recurrence-auto-migrate
updateSmartMeetingsToGen3AutoMigrate 1 param → 200
POST
/api/users/current/features/assist-settings/v1-habits-and-meetings-to-reclaim-recurrence-auto-migrate
updateGen1HabitsAndMeetingsToGen3AutoMigrate 1 param → 200
PUT
/api/users/current/features/calendar-permission-settings
updateCalendarPermissionSettings body → 200
PUT
/api/users/current/features/event-display-preferences
updateEventDisplayPreferences body → 200
POST
/api/users/current/features/experimental-settings/look-ahead-for-smart-meeting-ideal-day-on-weekly-meetings
updateLookAheadForSmartMeetingIdealDayOnWeeklyMeetings 1 param → 200
POST
/api/users/current/features/experimental-settings/treat-optional-smart-meeting-attendees-as-free
updateTreatOptionalSmartMeetingAttendeesAsFree 1 param → 200
POST
/api/users/current/features/focus/debug
updateFocusDebug 1 param → 200
POST
/api/users/current/features/mask-suppress-until
updateMaskSuppressUntil 1 param → 200
DELETE
/api/users/current/features/mask-suppress-until
clearMaskSuppressUntil → 200
PATCH
/api/users/current/features/post-onboard
patchPostOnboard body → 200
PATCH
/api/users/current/format24hour-settings
Whether to show the time in 24h format.
updateFormat24HourTimeSettings 1 param → 200
POST
/api/users/current/onboarded
onboarded 1 param body → 200
POST
/api/users/current/pipeline-migration
migrationToPipeline → 200
POST
/api/users/current/pipeline-migration-async
migrationToPipelineAsync → 200
GET
/api/users/current/product-usage
productUsage → 200
POST
/api/users/current/product-usage/hard-downgrade
hardDowngrade → 200
GET
/api/users/current/referrals
referrals → 200
POST
/api/users/current/reset
reset → 200
GET
/api/users/current/restorable-features
getRestorableFeatures → 200
POST
/api/users/current/restore-features
restoreFeatures body → 200
POST
/api/users/current/rewards
claimRewards 1 param → 200
PUT
/api/users/current/rsvp-settings
updateRSVPSettings body → 200
POST
/api/users/current/run-manual-assist
runManualAssist body → 200
PUT
/api/users/current/timezone-settings
updateTimezoneSettings body → 200
PATCH
/api/users/current/week-start-settings
Whether the week should start on Sunday (0), Monday (1) or Saturday (6).
updateWeekStartSettings 1 param → 200
POST
/api/users/interestdeprecated
interest_2 1 param → 200
POST
/api/users/trait/{trait}
addTrait 2 params → 200
GET
/api/users/tzs
getAvailableTimeZones → 200

Schemas 120

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

DefaultRsvpAvailability
object
1 property
SchedulingWindowWeeks
string
WebhookSettings
object
2 properties
PipelineMigrationStatus
string
SmartHabitTemplateKey
string
ProductUsageReport
object
7 properties 7 required
UserInterests
object
12 properties
AvailabilitySettings
object
1 property
UserProfileDepartment
string
Adventure
string
Colorized
object
1 property
FocusTimeSchedulingTypeV2
string
UserEntityTypeAccessView
object
1 property 1 required
EntityTypePermissionsView
object
2 properties 2 required
TaskAutoWorkflowSettings
object
2 properties
AsanaSettings
object
1 property
TimezoneSettingsPatch
object
1 property
TimezonePreference
string
UserProvisioningDetails
object
1 property 1 required
RestorableSnapshot
object
3 properties 3 required
UserMetadataUsecase
string
ExperimentalSettings
object
2 properties
PrioritiesSettings
object
1 property
EventDisplayPreferences
object
9 properties 9 required
SchedulingWindowWeeksOverride
string
UserAccountLock.AccountLockType
string
SignupMethod
string
NotificationKeyRequest
object
1 property
UserMetadata
object
9 properties
UserMetadataCompanySize
string
CalendarEntrySettings
object
11 properties
EntityTypePermissions
object
2 properties 2 required
EntityTypeAccessView
object
1 property 1 required
DetailedEntitlements
object
14 properties
AssistSettings
object
46 properties
DayOfWeek
string
FocusTimeBalloonFillType
string
AdventureSetting
object
1 property 1 required
AssistNotificationSettings
object
4 properties 4 required
UserPermissionsView
object
1 property 1 required
User
object
46 properties 4 required
UserWithIntercomHash
object
2 required
UserTrait
string
TaskAutoWorkflowType
string
MicrosoftSettings
object
3 properties
OnboardFocusTimeRequest
object
5 properties 1 required
UserPostOnboardPatchRequest
object
15 properties
GoogleAddOnSettings
object
1 property
UserProfileGoal
string
TimezoneSettings
object
3 properties 1 required
EntitlementDetails
object
3 properties 2 required
ConferenceBufferType
string
CircuitBreakerRequest
object
4 properties 3 required
UserDateTimeFormatter
object
1 property
AvailabilityType
string
SyncFeatureSettings
object
3 properties
SchedulingBehaviorSettings
object
2 properties 2 required
SlackStatusSetting
object
4 properties
UserPostOnboard
object
15 properties
AnalyticsSettings
object
2 properties
AutoLock
string
QuestSettings
object
1 property
SchedulingLinkSettings
object
5 properties
DateFieldOrder
string
EntitlementOverageSnapshot
object
4 properties 1 required
OnboardedState
object
11 properties 2 required
TaskDefaults
object
13 properties
UserOnboard
object
25 properties
Entitlements
object
18 properties
ColorsSettings
object
5 properties
OrgMetadata.OrgManager
object
3 properties 3 required
HabitTemplateKey
string
RestorableItem
object
3 properties 3 required
UserAccountLock
object
2 properties 2 required
BalloonFillRequest
object
6 properties 2 required
SmartSeriesRecurrenceType
string
CalendarPermissionSettings
object
1 property
TaskSettings
object
6 properties 1 required
TaskCooldown
string
EventCategory
ThinCalendar
object
6 properties 6 required
TimeZoneView
object
10 properties 8 required
SlotScorerVersion
string
UserProfileRole
string
AppNotificationsSettings
object
4 properties
UserSettings
object
44 properties 35 required
FocusSettings
object
2 properties
RsvpSettingsView
object
1 property 1 required
EntitlementValue_Object_
object
3 properties 3 required
RSVPSetting
object
1 property
Settings
object
8 properties
TodoistSettings
object
1 property
OrgMetadata
object
7 properties
EntityTypeView
object
1 property 1 required
FocusTimeCircuitBreakerType
string
UserPostOnboardState
string
DropboxSettings
object
1 property
SlackOutsideHoursSetting
object
3 properties 2 required
BillingSettings
object
1 property
UserAdventures
object
1 property
SchedulingLinkNameVisibility
string
SlackSettings.StatusSync
string
ProjectsSettings
object
1 property
SmartOneOnOneSettings
object
1 property
EventColor
string
FocusTimeSchedulingType
string
EntitlementActual_Object_
object
5 properties 5 required
ScheduleAssistantScoringSettings
object
1 property
ReclaimEdition
string
SlackSettings
object
19 properties
ObservedUser
object
TemporalSettings
object
1 property
CalendarSettings
object
2 properties
Entitlement
string
EntityType
string
FocusTimeCountingStyle
string
LogContext
object
ReferralStats
object
5 properties 3 required
ScheduleAssistantSettings
object
10 properties
WeeklyReport
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Reclaim.ai publishes across the network.

Reclaim.ai account-time-schemes API
AE Profile APIs.io
Reclaim.ai accounts API
AE Profile APIs.io
Reclaim.ai action-items API
AE Profile APIs.io
Reclaim.ai actions API
AE Profile APIs.io
Reclaim.ai Admin API
AE Profile APIs.io
Reclaim.ai analytics API
AE Profile APIs.io
Reclaim.ai Anonymous API
AE Profile APIs.io
Reclaim.ai api-management API
AE Profile APIs.io
Reclaim.ai asana API
AE Profile APIs.io
Reclaim.ai assist API
AE Profile APIs.io
Reclaim.ai Assistant API
AE Profile APIs.io
Reclaim.ai Avatar API
AE Profile APIs.io
#users
← Back to R APIs
API Details
ID
reclaim-ai:reclaim-ai-users-api
Base URL
https://api.app.reclaim.ai
Docs
https://help.reclaim.ai/en/collections/3455874-developer-api
Provider
Reclaim.ai
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network