Recal Organizations Calendar API

openapi: 3.2.0
info:
  title: Recal Organizations Calendar API
  description: 'The official Recal.dev API.


    **Tip:** Use `x-timezone` header to set timezone for all returned datetimes.'
  version: 0.2.0
servers:
- url: https://api.recal.dev
  description: Recal API
security:
- token: []
tags:
- name: Organizations Calendar
paths:
  /v1/organizations/{orgSlug}/calendar/busy:
    get:
      operationId: getV1OrganizationsByOrgSlugCalendarBusy
      description: Get the consolidated busy times of all users of an organization. Users whose calendars could not be read are listed in `failedUsers` and contribute no busy time, so a non-empty `failedUsers` means `data` is a partial answer rather than a complete one. Members with no connected calendar are not listed — https://docs.recal.dev/core/troubleshooting
      tags:
      - Organizations Calendar
      responses:
        '200':
          description: Busy times of all users of an organization, plus the users that could not be read
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TimeRange'
                  failedUsers:
                    type: array
                    items:
                      $ref: '#/components/schemas/FailedFreeBusyUser'
                required:
                - data
                - failedUsers
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  data:
                    type: 'null'
                required:
                - error
                - data
        '404':
          description: Organization not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  error:
                    type: string
                    examples:
                    - Organization with slug {orgSlug} not found
                required:
                - data
                - error
      parameters:
      - in: path
        name: orgSlug
        schema:
          type: string
          examples:
          - recal
          pattern: ^[a-z0-9][a-z0-9_-]{2,127}$
        required: true
      - in: query
        name: end
        schema:
          type: string
          pattern: ^([+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-3])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))(T((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([,.]\d+(?!:))?)?(\17[0-5]\d([,.]\d+)?)?([Zz]|([+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$
        required: true
      - in: query
        name: start
        schema:
          type: string
          pattern: ^([+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-3])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))(T((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([,.]\d+(?!:))?)?(\17[0-5]\d([,.]\d+)?)?([Zz]|([+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$
        required: true
      - in: query
        name: primaryOnly
        schema:
          enum:
          - 'false'
          - 'true'
          examples:
          - 'true'
          - 'false'
        description: Boolean query parameter (accepts "true" or "false")
      - in: query
        name: provider
        schema:
          anyOf:
          - type: array
            items:
              enum:
              - google
              - microsoft
          - const: google
          - const: microsoft
      summary: Get V1Organizations by org slug calendar busy
      x-summary-source: derived
components:
  schemas:
    FreeBusyFailureReason:
      enum:
      - accessDenied
      - authorizationInvalid
      - insufficientScopes
      - invalidCalendarId
      - mailboxUnavailable
      - notFound
      - providerError
      - providerNotConfigured
      - rateLimited
      - tooManyCalendars
      description: 'Why a calendar or a user could not be read. What each value means and how to resolve it: https://docs.recal.dev/core/troubleshooting'
    FailedCalendar:
      type: object
      description: A calendar that could not be read
      properties:
        calendarId:
          type: string
        message:
          type: string
        provider:
          enum:
          - google
          - microsoft
        reason:
          $ref: '#/components/schemas/FreeBusyFailureReason'
      required:
      - calendarId
      - message
      - provider
      - reason
    FailedFreeBusyUser:
      type: object
      description: A user whose busy times are missing (failedCalendars empty) or incomplete (failedCalendars names the gaps)
      properties:
        customId:
          type: string
          examples:
          - user_123
        failedCalendars:
          type: array
          items:
            $ref: '#/components/schemas/FailedCalendar'
        message:
          type: string
        reason:
          $ref: '#/components/schemas/FreeBusyFailureReason'
      required:
      - customId
      - failedCalendars
      - message
      - reason
    TimeRange:
      type: object
      description: Recal Normalized Time Range
      properties:
        end:
          type: string
          description: End time of the time range in ISO format
          format: date-time
          pattern: ^([+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-3])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))(T((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([,.]\d+(?!:))?)?(\17[0-5]\d([,.]\d+)?)?([Zz]|([+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$
        start:
          type: string
          description: Start time of the time range in ISO format
          format: date-time
          pattern: ^([+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-3])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))(T((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([,.]\d+(?!:))?)?(\17[0-5]\d([,.]\d+)?)?([Zz]|([+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$
      required:
      - end
      - start
  securitySchemes:
    token:
      type: http
      scheme: bearer
      bearerFormat: recal-token
      description: Recal API token