LogoRecal
Rest apiEndpoints

Get Organization Availability

GET
/v1/organizations/{orgSlug}/calendar/busy

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

Authorization

token
AuthorizationBearer <token>

Recal API token

In: header

Path Parameters

orgSlug*string
Match^[a-z0-9][a-z0-9_-]{2,127}$

Query Parameters

end*string
Match^([+-]?\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*string
Match^([+-]?\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)?)?)?)?$
primaryOnly?|

Boolean query parameter (accepts "true" or "false")

provider?array<>|unknown|unknown

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/organizations/recal/calendar/busy?end=string&start=string"
{  "data": [    {      "end": "2019-08-24T14:15:22Z",      "start": "2019-08-24T14:15:22Z"    }  ],  "failedUsers": [    {      "customId": "user_123",      "failedCalendars": [        {          "calendarId": "string",          "message": "string",          "provider": "google",          "reason": "accessDenied"        }      ],      "message": "string",      "reason": "accessDenied"    }  ]}