Sign in
Docs

List the public-API scope catalog

Changed on

GET /public-api-docs/scopes/ — one entry per PublicAPIResources member.

These are the values a SystemUser token may be granted through available_resources on /public-api-tokens/, and the values the public GraphQL API checks a token against when it resolves a field. The catalog is what a client builds its scope picker from, so it never has to carry its own copy of the enum — a copy that silently goes stale every time a resource is added here.

Returned in enum declaration order, which groups related resources together (all the calendar ones, all the availability-window ones, ...) the way alphabetical order would not.

Must stay detail=False so the router registers it before the {slug} detail route. scopes is therefore a reserved slug that a concept doc may never use.

get/public-api-docs/scopes{format}

Request

  • The document declares no server URL.
  • Auth: none required

Path parameters

format'.json' required

Response

value'calendar_event' | 'calendar' | 'recurrence_rule' | 'external_attendee' | 'external_attendance' | 'attendance' | 'user' | 'resource_allocation' | 'event_recurring_exception' | 'blocked_time' | 'blocked_time_recurring_exception' | 'available_time' | 'available_time_recurring_exception' | 'availability_windows' | 'unavailable_windows' | 'organization' | 'appointment_type' | 'calendar_pool' | 'system_user' | 'membership' | 'invitation' | 'branding' | 'child_org_analytics' | 'calendar_booking_code' | 'create_resource_calendar' | 'disable_resource_calendar' | 'update_resource_calendar' | 'import_resource_calendars' | 'create_availability_window' | 'update_availability_window' | 'delete_availability_window' | 'batch_update_availability_windows' | 'create_blocked_time' | 'update_blocked_time' | 'delete_blocked_time' | 'calendar_bundle' | 'create_calendar' | 'update_calendar' | 'create_calendar_bundle' | 'update_calendar_bundle' | 'disable_calendar_bundle' | 'webhook_configuration' | 'external_event_change_request' | 'booking_policy' | 'bookable_slots' | 'appointment_type_scoped_availability_windows' | 'batch_upsert_appointment_type_scoped_availability_windows' | 'appointment_type_scoped_blocked_times' | 'batch_upsert_appointment_type_scoped_blocked_times' | 'appointment_type_scoped_quota_rules' | 'batch_upsert_appointment_type_scoped_quota_rules' required
  • calendar_event - Calendar Event
  • calendar - Calendar
  • recurrence_rule - Recurrence Rule
  • external_attendee - External Attendee
  • external_attendance - External Attendance
  • attendance - Attendance
  • user - User
  • resource_allocation - Resource Allocation
  • event_recurring_exception - Event Recurring Exception
  • blocked_time - Blocked Time
  • blocked_time_recurring_exception - Blocked Time Recurring Exception
  • available_time - Available Time
  • available_time_recurring_exception - Available Time Recurring Exception
  • availability_windows - Availability Windows
  • unavailable_windows - Unavailable Windows
  • organization - Organization
  • appointment_type - Appointment Type
  • calendar_pool - Calendar Pool
  • system_user - System User
  • membership - Membership
  • invitation - Invitation
  • branding - Branding
  • child_org_analytics - Child Organization Analytics
  • calendar_booking_code - Calendar Booking Code
  • create_resource_calendar - Create Resource Calendar
  • disable_resource_calendar - Disable Resource Calendar
  • update_resource_calendar - Update Resource Calendar
  • import_resource_calendars - Import Resource Calendars
  • create_availability_window - Create Availability Window
  • update_availability_window - Update Availability Window
  • delete_availability_window - Delete Availability Window
  • batch_update_availability_windows - Batch Update Availability Windows
  • create_blocked_time - Create Blocked Time
  • update_blocked_time - Update Blocked Time
  • delete_blocked_time - Delete Blocked Time
  • calendar_bundle - Calendar Bundle
  • create_calendar - Create Calendar
  • update_calendar - Update Calendar
  • create_calendar_bundle - Create Calendar Bundle
  • update_calendar_bundle - Update Calendar Bundle
  • disable_calendar_bundle - Disable Calendar Bundle
  • webhook_configuration - Webhook Configuration
  • external_event_change_request - External Event Change Request
  • booking_policy - Booking Policy
  • bookable_slots - Bookable Slots
  • appointment_type_scoped_availability_windows - Appointment-Type-Scoped Availability Windows
  • batch_upsert_appointment_type_scoped_availability_windows - Batch Upsert Appointment-Type-Scoped Availability Windows
  • appointment_type_scoped_blocked_times - Appointment-Type-Scoped Blocked Times
  • batch_upsert_appointment_type_scoped_blocked_times - Batch Upsert Appointment-Type-Scoped Blocked Times
  • appointment_type_scoped_quota_rules - Appointment-Type-Scoped Quota Rules
  • batch_upsert_appointment_type_scoped_quota_rules - Batch Upsert Appointment-Type-Scoped Quota Rules
labelstring required
provider_scopedboolean required

Changes

  • e92afcb6b029Revision changes
    • ●

      added the new appointment_type enum value to the ///// response property for the response status

    • ●

      added the new appointment_type_scoped_availability_windows enum value to the ///// response property for the response status

    • ●

      added the new appointment_type_scoped_blocked_times enum value to the ///// response property for the response status

    • ●

      added the new appointment_type_scoped_quota_rules enum value to the ///// response property for the response status

    • ●

      added the new batch_upsert_appointment_type_scoped_availability_windows enum value to the ///// response property for the response status

    • ●

      added the new batch_upsert_appointment_type_scoped_blocked_times enum value to the ///// response property for the response status

    • ●

      added the new batch_upsert_appointment_type_scoped_quota_rules enum value to the ///// response property for the response status

    • ○

      removed the batch_upsert_group_scoped_availability_windows enum value from the ///// response property for the response status

    • ○

      removed the batch_upsert_group_scoped_blocked_times enum value from the ///// response property for the response status

    • ○

      removed the batch_upsert_group_scoped_quota_rules enum value from the ///// response property for the response status

    • ○

      removed the calendar_group enum value from the ///// response property for the response status

    • ○

      removed the group_scoped_availability_windows enum value from the ///// response property for the response status

    • ○

      removed the group_scoped_blocked_times enum value from the ///// response property for the response status

    • ○

      removed the group_scoped_quota_rules enum value from the ///// response property for the response status

  • 722e2911db6eRevision changes
    • ●

      added the new calendar_pool enum value to the ///// response property for the response status