Reclaim.ai schedule-policy API
The schedule-policy API from Reclaim.ai — 12 operation(s) for schedule-policy.
Reclaim.ai schedule-policy 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 schedule-policy. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 12 operations across 12 paths, and defines 321 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.
12 operations
12 paths
321 schemas
9 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Reclaim.ai schedule-policy API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Authorization).
Paths & Operations 12
Across 12 paths, the API surfaces 12 operations — 9 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
schedule-policy 12
GET
/api/schedule-policy
GET
/api/schedule-policy/available-types
GET
/api/schedule-policy/create-default-policies
GET
/api/schedule-policy/event-matcher-tags
POST
/api/schedule-policy/matching-events
POST
/api/schedule-policy/recommended
GET
/api/schedule-policy/smart-meeting/candidates
GET
/api/schedule-policy/templates
POST
/api/schedule-policy/templates/instantiate-meeting-quality
GET
/api/schedule-policy/templates/instantiated/{templateId}
GET
/api/schedule-policy/{policyId}
GET
/api/schedule-policy/{policyId}/events
Schemas 321
The contract defines 321 schemas that model the data the API accepts and returns. The most detailed are CalendarEventV2 (33 properties), UpdateEventAction (26 properties), AddEventAction (23 properties), GtdLinearTask (21 properties). Each schema is shown below with its type and property counts.
GtdGoogleTasksTaskForCreate
object
10 properties
2 required
EventLockAction
object
5 properties
3 required
AnyAttendeeEventMatcher
object
Matches if any attendee satisfies the given attendee predicate
2 properties
1 required
AndEventMatcher
object
Matches if both the left and right matchers match
3 properties
2 required
AddEventAction
object
23 properties
6 required
Transparency
string
GtdTaskForCreate
object
GtdTaskId.TaskSourceType
string
Colorized
object
1 property
EventDateRange
object
FindTemplatesResponse
object
1 property
1 required
SelfRSVPMatcher
object
Matches by the user's own RSVP status
4 properties
1 required
SmartSeriesId
object
3 properties
2 required
UncompleteGtdTaskAction
object
3 properties
1 required
UpcomingPolicyEventsResponse
object
HasVideoConferenceEventMatcher
object
Matches events with or without a video conference link
2 properties
1 required
TimeWindowEventMatcher.TimeWindowMatchMode
string
RecurrenceFrequency
string
CancelEventAction
object
11 properties
2 required
RescheduleEventAction
object
11 properties
4 required
LacksRsvpCreateRequestFields
object
4 properties
1 required
AttendeeCountEventMatcher
object
Matches by attendee count using a comparison operator
5 properties
4 required
LacksRsvpPolicyTemplate
object
8 properties
7 required
EventConflictPatchRequestFields
object
3 properties
ZoomConferenceRequest
object
2 properties
1 required
EventEditType
string
Reminders
object
2 properties
2 required
ManualEventEdit
object
9 properties
6 required
CreateGtdTaskAction
object
6 properties
3 required
RecurrenceEditType
string
PlatformEventData
object
ConferenceRequest
object
PolicyScope
string
LacksVideoConferencePatchRequestFields
object
4 properties
DayOfWeek
string
ShieldsUpProblem
object
6 properties
4 required
HabitPatchRequestFields
object
12 properties
RecentPaperDocMatcher
object
Matches events with a recently modified paper document
3 properties
2 required
TeamsConferenceData
object
3 properties
1 required
Reminder
object
2 properties
2 required
EventLockAction.LockMode
string
SchedulePolicy
object
SlotAvailability
object
2 properties
2 required
AssistType
string
GtdTask
object
NotEventMatcher
object
Negates another matcher
2 properties
1 required
FindANewTimeAction
object
4 properties
2 required
BufferEventData
object
4 properties
3 required
TimeOfDayEventMatcher
object
Matches events based on their start or end time of day
4 properties
3 required
AttendeeDeclined
object
8 properties
4 required
AddFocusEventAction
object
15 properties
5 required
EventConflictType
string
BufferEventSettingsView
object
2 properties
2 required
AddVideoConferenceAction
object
6 properties
3 required
UpcomingBufferEventsResponse
object
2 properties
1 required
ReclaimResourceId
object
NotAttendeeMatcher
object
Negates an attendee matcher
2 properties
1 required
ShieldsUpPolicyTemplate
object
12 properties
10 required
FocusTimeCreateRequestFields
object
19 properties
5 required
EventCategory
FocusTimePolicyTemplate
object
12 properties
7 required
ManagedEventData_1
object
2 properties
GtdNotionTask
object
15 properties
4 required
ReclaimEventType
string
AttendeeAvailabilityWarningPolicyTemplate
object
6 properties
5 required
BasicEventWarningCreateRequestFields
object
7 properties
3 required
NotionTaskGroup
string
RequiresTravelEventMatcher
object
Matches events that require travel
2 properties
1 required
AnyEventMatcher
object
Matches if ANY matcher in the list matches
2 properties
1 required
BasicEventWarningPolicyTemplate
object
8 properties
7 required
LacksRsvp
object
8 properties
3 required
UpdatePolicyIndexPatchRequestFields
object
3 properties
2 required
ReclaimTask
object
12 properties
4 required
EventReadOnlyReason
string
LacksRsvpPatchRequestFields
object
4 properties
AwayFromIdealSlot
object
10 properties
8 required
AutomationType
string
FocusTimeEventData
object
1 property
1 required
FocusTimeProblem
object
6 properties
4 required
ScheduleProblemWithActions
object
2 properties
1 required
TitleEventMatcher
object
Matches by event title text
3 properties
2 required
ClickUpTaskState
object
5 properties
5 required
LogContext
object
UpdatePolicyPriorityAndIndexPatchRequestFields
object
4 properties
HabitPolicy
object
12 properties
5 required
AttendeeMatcher
object
RecurrenceContinuityData
object
2 properties
JiraTaskState
object
4 properties
4 required
HasAgendaEventMatcher
object
Matches events that have an agenda
3 properties
2 required
AnyTextEventMatcher
object
Matches if text appears in title, description, or location
2 properties
1 required
ResourceRSVPEventMatcher
object
Matches by resource attendee RSVP status
2 properties
1 required
SchedulingLinkId
object
2 properties
1 required
ReclaimRecurrence
object
Recurrence pattern for a recurring event. - frequency is always required - For WEEKLY: days is required (which days of the week) - For MONTHLY: monthlyDay is r…
8 properties
1 required
TaggedEventMatcher
object
Wraps a matcher with a named tag
3 properties
2 required
AllowedEditTypesView
object
2 properties
2 required
FocusTimePatchRequestFields
object
19 properties
EventKeyEventMatcher
object
Matches a specific event by its key
3 properties
2 required
DescriptionEventMatcher
object
Matches by event description text
3 properties
2 required
LacksVideoConferenceCreateRequestFields
object
4 properties
1 required
Month
string
AllAttendeesEventMatcher
object
Matches if all attendees satisfy the given attendee predicate
2 properties
1 required
ReclaimSchedulerData
object
3 properties
3 required
LacksVideoConferencePolicy
object
4 properties
3 required
InstantiatedTemplate
object
2 properties
2 required
BufferProblemType
string
EntryStatus
string
GtdJiraTask
object
15 properties
6 required
EventAttendee
object
9 properties
1 required
BufferEventPatchRequestFields
object
20 properties
GtdTodoistTask
object
14 properties
4 required
GtdTodoistTaskForCreate
object
10 properties
2 required
BasicEventWarning
object
7 properties
5 required
EventSubType
string
GtdLinearTaskForCreate
object
13 properties
2 required
IgnoreEventKeyAction
object
5 properties
2 required
RescheduleHourSource
string
OneOff
object
2 properties
1 required
PolicyStatus
string
LocationEventMatcher
object
Matches by event location text
3 properties
2 required
BufferEventCreateRequestFields
object
15 properties
3 required
LacksRsvpPolicy
object
4 properties
3 required
AllDayDateRange
object
3 properties
2 required
SchedulePolicyId
object
1 property
1 required
PolicyAssociation
object
3 properties
3 required
CalendarEventV2
object
33 properties
21 required
AllowedEditTypeReason
string
PolicyAdherenceMetricDescriptor
object
2 properties
2 required
FocusTimeProblemType
string
LocalTimeInterval
object
3 properties
2 required
TaskEventData_1
object
1 property
1 required
AndAttendeeMatcher
object
Matches if both attendee matchers match
3 properties
2 required
ReclaimEventData
object
9 properties
2 required
PolicyTemplate
object
RecommendedPoliciesRequest
object
1 property
1 required
OrEventMatcher
object
Matches if either the left or right matcher matches
3 properties
2 required
FalseEventMatcher
object
Never matches any event
SchedulingLinkMeetingId
object
2 properties
1 required
EventConflictPolicy
object
3 properties
2 required
UpcomingManagedEventsResponse
object
3 properties
1 required
EventConflictPolicyTemplate
object
6 properties
5 required
ResponseStatus
string
FocusId
object
2 properties
1 required
AttendeeBooleanMatcher
object
Matches an attendee's boolean field
3 properties
2 required
Visibility
string
EntryColor
string
EventCategoryEventMatcher
object
Matches by event category
3 properties
2 required
AttendeeAvailabilityWarningPatchRequestFields
object
3 properties
AttendeeStringMatcher.StringField
string
FindSchedulePoliciesResponse
object
1 property
1 required
ManagedEventNoAvailabilityAction
string
LinearWorkflowStateType
string
OrAttendeeMatcher
object
Matches if either attendee matcher matches
3 properties
2 required
PolicyIndexMove
string
EventMatcher
object
CalendarEventField
string
AttendeeEmailEventMatcher
object
Matches events where any attendee's email satisfies the operator/predicate
3 properties
2 required
GtdClickUpTaskForCreate
object
10 properties
2 required
MoreEntryPoint
object
4 properties
1 required
GtdAsanaTaskForCreate
object
11 properties
2 required
AvailablePolicyTypesResponse
object
1 property
1 required
FixedDateTimeRange_2
object
2 properties
2 required
VideoEntryPoint
object
5 properties
1 required
ManualEditEventAction
object
4 properties
2 required
OutlookEventData
object
IsRecurringInstanceEventMatcher
object
Matches events that are an instance of a recurring series
EventKey
object
2 properties
2 required
SchedulePolicyType
string
TaskId
object
2 properties
1 required
MergeableEventView.MergeType
string
SipEntryPoint
object
4 properties
1 required
HabitPolicyTemplate
object
9 properties
8 required
IsOrganizerEventMatcher
object
Matches based on whether the user is the event organizer
2 properties
1 required
RecurrenceEnding
object
5 properties
2 required
ManagedEventData
object
2 properties
AttendeeAvailabilityView
object
14 properties
6 required
BufferEventType
string
ConferenceRequestType
string
FocusTimeProperties
object
3 properties
FocusTimeEventData_1
object
1 property
1 required
EventResourceParticipant
object
9 properties
1 required
BufferEventPairView
object
2 properties
1 required
NotionTaskStatus
object
4 properties
3 required
AttendeeIntMatcher
object
Matches an attendee's integer field using an operator
4 properties
3 required
RecurrenceContinuityData_1
object
2 properties
PhoneEntryPoint
object
6 properties
1 required
ShieldsUpPolicy
object
18 properties
7 required
TaskEventData
object
1 property
1 required
UnknownPolicy
object
2 properties
1 required
FocusTimeChatStatus
string
RsvpEventAction
object
7 properties
3 required
CompleteGtdTaskAction
object
3 properties
1 required
LogTaskAction
object
8 properties
5 required
AttendeeStringMatcher.StringOperator
string
CalendarEventMatcher
object
Matches events on a specific calendar
2 properties
1 required
EventPolicyAssociation
string
JiraStatusCategory
string
EntryNotificationRequest
string
EventTagEventMatcher
object
Matches events with a specific tag
2 properties
1 required
SmartMeetingPatchRequestFields
object
8 properties
NoneEventMatcher
object
Matches if NONE of the matchers in the list match
2 properties
1 required
YearlyDay
object
Day of the year for YEARLY recurrences.
2 properties
EventAssociationDetailsView
object
5 properties
4 required
FalseAttendeeMatcher
object
Never matches any attendee
TravelBufferId
object
2 properties
1 required
GtdTaskLink
object
1 property
1 required
MutatePolicyRequestFields
object
EventMatcherTags
object
1 property
1 required
AttendeeResponseStatusMatcher.SetOperator
string
EventConflict
object
9 properties
4 required
ShieldsUpThresholdType
string
AttendeeAvailabilityWarningPolicy
object
3 properties
2 required
EventParticipant
object
ShieldsUpEventData
object
1 property
1 required
BufferEventData_1
object
4 properties
3 required
DateMode
string
EventMatcherOperator
string
AutoDeclineMode
string
TimeWindowEventMatcher
object
Matches events within a time window
4 properties
3 required
AssistantData_1
object
6 properties
SmartMeetingCandidatesResponse
object
1 property
1 required
PendingConferenceData
object
2 properties
1 required
TrueAttendeeMatcher
object
Always matches any attendee
GtdNotionTaskForCreate
object
9 properties
2 required
BasicEventWarningPatchRequestFields
object
7 properties
AttendeeStringMatcher
object
Matches an attendee's string field using an operator
4 properties
3 required
TrueEventMatcher
object
Always matches any event
ScoringReason
string
PolicyDeleteRequestFields
object
2 properties
1 required
SmartMeetingPolicyTemplate
object
9 properties
8 required
GtdAsanaTask
object
13 properties
4 required
AttendeeAvailabilityWarningCreateRequestFields
object
3 properties
2 required
EventAttendeeParticipant
object
9 properties
1 required
AllEventMatcher
object
Matches if ALL matchers in the list match
2 properties
1 required
RecurringSeriesEventMatcher
object
Matches the root series event itself by its eventKey ID. Rarely needed — prefer RecurringInstanceEventMatcher to target all occurrences.
4 properties
2 required
AllDayDateRange_2
object
2 properties
2 required
RescheduleEventAndCancelOthersAction
object
5 properties
3 required
AttendeeBooleanMatcher.BooleanField
string
EventMatcherTag
string
SummarizedEventMatcher
object
Wraps a matcher with a human-readable summary
3 properties
2 required
RecurringInstanceEventMatcher
object
Matches all occurrences of a recurring event by recurringEventId. This is the preferred matcher for targeting a recurring event in policies.
5 properties
2 required
ConferenceEntryPoint
object
BufferPolicyTemplate
object
13 properties
10 required
MeetConferenceRequest
object
2 properties
1 required
BasicEventWarningPolicy
object
7 properties
4 required
FixedDateTimeRange
object
3 properties
2 required
AssistantData
object
6 properties
BufferEventPolicy
object
19 properties
6 required
EventDateRange_1
object
1 property
ReclaimTaskForCreate
object
8 properties
2 required
PolicySeriesView
object
2 properties
2 required
VersionData
object
2 properties
MeetConferenceData
object
3 properties
2 required
ConferenceData
object
SchedulePolicyTimePolicy
object
LinearState
object
15 properties
GoogleEventData
object
3 properties
1 required
GtdClickUpTask
object
15 properties
6 required
ShieldsUpPatchRequestFields
object
18 properties
PolicyTemplateCategory
string
BufferEventProblem
object
12 properties
4 required
MutatePolicyAction
object
4 properties
2 required
PolicyToTry
object
2 properties
2 required
ScheduleProblem
object
EventConflictCreateRequestFields
object
3 properties
2 required
PriorityLevel
string
ReclaimEventTypeEventMatcher
object
Matches by Reclaim event type
3 properties
2 required
TimeOfDayEventMatcher.TimeField
string
ExistingTimeScheme
object
2 properties
1 required
DurationEventMatcher
object
Matches by event duration in minutes
3 properties
2 required
GtdGoogleTasksTask
object
14 properties
6 required
IgnoreScheduleProblemAction
object
5 properties
2 required
DailyHabitId
object
2 properties
1 required
InstantiateTemplatesResponse
object
1 property
1 required
HasAgenda.AgendaType
string
SmartMeetingCandidateView
object
3 properties
2 required
TeamsConferenceRequest
object
2 properties
1 required
ConferenceBufferId
object
2 properties
1 required
DayHours
object
3 properties
1 required
MatchingEventsResponse
object
1 property
1 required
AttendeeResponseStatusMatcher
object
Matches an attendee's RSVP response status
3 properties
2 required
LacksVideoConferencePolicyTemplate
object
8 properties
7 required
MatchingEventsRequest
object
4 properties
3 required
RecommendedPoliciesResponse
object
1 property
1 required
MonthlyDay
object
Day of the month. Use EITHER dayOfMonth for a fixed day, OR dayOfWeek + week for a relative day. Examples: dayOfMonth=15 for "the 15th", or dayOfWeek=TUESDAY +…
3 properties
ScheduleActionWithEvents
object
3 properties
1 required
GtdJiraTaskForCreate
object
13 properties
2 required
SchedulePolicyCommonDataCreateRequestFields
object
5 properties
4 required
SmartMeetingCreateRequestFields
object
8 properties
4 required
GtdLinearTask
object
21 properties
4 required
AddBufferEventAction
object
16 properties
7 required
SchedulePolicyCommonDataPatchRequestFields
object
4 properties
AutoDeclineModeView
string
MergeableEvent
object
4 properties
4 required
LacksVideoConference
object
7 properties
3 required
ShieldsUpCreateRequestFields
object
18 properties
7 required
AttendeeCalendarVisibility
string
AttendeeCountEventMatcher.AttendeeType
string
FreeBusy
string
UpdateGtdTaskStatusAction
object
4 properties
2 required
ManagedEventFieldProblem
object
6 properties
4 required
SmartMeetingPolicy
object
8 properties
5 required
ReminderType
string
UpdateEventAction
object
26 properties
3 required
SchedulePolicyCommonData
object
10 properties
8 required
TimePolicy
object
3 properties
1 required
ShieldsUpProblemType
string
UpcomingEventsResponse
object
2 properties
1 required
PolicyTemplateId
string
CalendarSyncSourceData
object
3 properties
3 required
FocusTimePolicy
object
19 properties
5 required
MatchingAttendeeCountEventMatcher
object
Matches by count of attendees satisfying a predicate, compared with an operator
4 properties
3 required
AttendeeIntMatcher.IntField
string
SyncStatus
string
ScheduleAction
object
HabitCreateRequestFields
object
12 properties
6 required
EventColor
string
ZoomConferenceData
object
3 properties
1 required
GuestPermissions
object
3 properties
3 required
AttendeeConflict
object
8 properties
4 required
ShieldsUpEventData_1
object
1 property
1 required
ScheduleWindow
object
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Reclaim.ai 12
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 Admin 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
#schedule-policy