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 smart-habits API

The smart-habits API from Reclaim.ai — 29 operation(s) for smart-habits.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 32 operations across 29 paths, and defines 79 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.

32 operations 29 paths 79 schemas 2 DELETE8 GET3 PATCH19 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
Contact
Reclaim.ai Inc.
License
Reclaim 9.9
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 32

Across 29 paths, the API surfaces 32 operations — 2 DELETE, 8 GET, 3 PATCH, 19 POST. Each is listed below with its method, path, parameters, and response codes.

smart-habits 32
GET
/api/smart-habits
findAllSmartHabits → 200
POST
/api/smart-habits
createSmartHabit 2 params body → 200
POST
/api/smart-habits/convert/{calendarId}/{eventId}
convertToSmartHabits 3 params body → 200
GET
/api/smart-habits/detect
detectSmartHabits 1 param → 200
POST
/api/smart-habits/planner/{eventId}/done
markAsDone 2 params → 200
POST
/api/smart-habits/planner/{eventId}/lock
lockHabitInstance 2 params → 200
POST
/api/smart-habits/planner/{eventId}/move
moveMeetingInstance 4 params → 200
POST
/api/smart-habits/planner/{eventId}/reschedule
rescheduleMeetingInstance 3 params → 200
POST
/api/smart-habits/planner/{eventId}/skip
skipHabitInstance 2 params → 200
POST
/api/smart-habits/planner/{eventId}/unlock
unlockHabitInstance 2 params → 200
POST
/api/smart-habits/planner/{lineageId}/clear-exceptions
resetSchedule 2 params → 200
POST
/api/smart-habits/planner/{lineageId}/record
record 4 params → 200
GET
/api/smart-habits/planner/{lineageId}/recordable-periods
recordablePeriods 2 params → 200
POST
/api/smart-habits/planner/{lineageId}/start
startNow 2 params → 200
POST
/api/smart-habits/planner/{lineageId}/stop
stop 2 params → 200
POST
/api/smart-habits/planner/{seriesId}/clear-force-skipped
clearForceSkipped 3 params → 200
POST
/api/smart-habits/planner/{seriesId}/clear-time-policy-exceptions
clearTimePolicyExceptions 3 params → 200
POST
/api/smart-habits/shared
createSharedHabit body → 200
GET
/api/smart-habits/shared/v2/{sharedHabitShortCode}
getSharedHabit 1 param → 200
GET
/api/smart-habits/shared/{sharedHabitShortCode}deprecated
getSharedHabit_deprecated 1 param → 200
GET
/api/smart-habits/template
getSmartHabitTemplate 1 param → 200
GET
/api/smart-habits/templates
getSmartHabitTemplates 2 params → 200
POST
/api/smart-habits/templates/create
createHabitTemplates_1 body → 200
POST
/api/smart-habits/to-single-instances
convertToSingleInstances → 200
GET
/api/smart-habits/{lineageId}
findForSmartHabitLineage 1 param → 200
DELETE
/api/smart-habits/{lineageId}
deleteForSmartHabitLineage 4 params → 200
PATCH
/api/smart-habits/{lineageId}
patchSmartHabit 4 params body → 200
PATCH
/api/smart-habits/{lineageId}/as-attendee
patchSmartHabitForAttendee 2 params body → 200
DELETE
/api/smart-habits/{lineageId}/disable
disable 2 params → 200
POST
/api/smart-habits/{lineageId}/enable
enable_1 2 params → 200
PATCH
/api/smart-habits/{lineageId}/force-successor
forceSuccessor 1 param body → 200
POST
/api/smart-habits/{lineageId}/to-single-instances
convertToSingleInstances_1 1 param → 200

Schemas 79

The contract defines 79 schemas that model the data the API accepts and returns. The most detailed are Event (58 properties), CreateSmartHabitRequest (37 properties), SmartSeriesView (36 properties), PatchSmartHabitRequest (32 properties). Each schema is shown below with its type and property counts.

EventSourceDetails
object
9 properties 9 required
SmartSeriesLineageView
object
10 properties
EventKey
object
2 properties 2 required
SmartHabitTemplateKey
string
Frequency
string
ConferenceSource
string
MergeDetails
object
4 properties 4 required
UserProfileDepartment
string
SnoozeOption
string
Colorized
object
1 property
SmartSeriesAttendeeView
object
10 properties 7 required
EventType
string
RecurringAssignmentType
string
ConferenceType
string
SmartSeriesPeriodEventStatus
string
PriorityLevel
string
SmartHabitTemplate
object
14 properties 10 required
CreateSmartHabitRequest
object
37 properties 8 required
ConferenceDetails
object
4 properties 4 required
EventAttendee
object
9 properties 1 required
SmartSeriesResourceView
object
8 properties 8 required
EventSubType
string
ChangeLogReason
string
PatchSmartHabitRequest
object
32 properties
SmartSeriesOrganizerRequest
object
8 properties
SmartSeriesRole
string
ConferenceStatus
string
EventResponseStatus
string
ChangeLogEntryView
object
13 properties 3 required
DayOfWeek
string
IdealMonthlyDay
object
3 properties
DayHours
object
3 properties 1 required
SmartSeriesView
object
36 properties
DefenseAggression
string
SmartHabitLineageView
EventStatus
string
AssistType
string
GoogleCalendarEventMetadata
object
3 properties 3 required
RecurrenceDefinition
object
5 properties 1 required
SmartSeriesResourceRequest
object
2 properties 2 required
LocalTimeInterval
object
3 properties 2 required
SmartSeriesActionPlannedResult
object
The expected result of a planner action. Note: this isn't the reality at the point it's returned, but what we expect to make reality as we execute the planner…
4 properties 4 required
SmartSeriesEventType
string
ConferenceSolution
string
Event
object
58 properties 27 required
SmartSeriesStatus
string
SmartSeriesRecurrenceType
string
CreateSharedSmartHabitRequest
object
5 properties 1 required
AttendeeCalendarVisibility
string
SmartMeetingLineageView
SmartSeriesPeriodSchedulerStatus
string
AssistDetails
object
This entity maps to the assistevents table.
28 properties
EventCategory
ResponseStatus
string
UserProfileRole
string
ThinPerson
object
7 properties 1 required
SmartSeriesVisibility
string
ReclaimEventType
string
CreateHabitTemplateRequest
object
1 property 1 required
SmartSeriesAttendeeRequest
object
9 properties
TimePolicyType
string
MeetingType
string
AssistStatus
string
TimePolicy
object
3 properties 1 required
SmartSeriesType
string
SharedSmartHabitView
object
3 properties 2 required
EventColor
string
SmartSeriesDependencyType
string
PrioritySource
string
SharedSmartHabit
object
8 properties 6 required
SmartSeriesAttendeeResponseStatus
string
SmartSeriesPeriodView
object
15 properties 13 required
LockState
string
SmartSeriesBookingFailurePolicy
string
ChangeLogEntryMetadataView
object
AssistPolicyOverride
object
6 properties 6 required
SharedSmartHabitMeta
object
3 properties 3 required
MergeDetails.EventType
string
PlatformEventType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reclaim-ai-smart-habits-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
#smart-habits
← Back to R APIs
API Details
ID
reclaim-ai:reclaim-ai-smart-habits-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