Available Calendars
Testing
POST
/calendars/availability
available-calendar endpoint to filter and display calendars that can accommodate the event without overlaps by passing dates and frequency on the bodyRequest Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.aladia.io/v2/calendars/availability?limit=50' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data-raw '{
"dates": {
"startDate": "2024-09-01T08:45:00.000",
"endDate": "2024-09-01T09:00:00.000"
},
"frequency": {
"type": "daily",
"endDate": "2024-09-05T10:00:00.000"
}
}'Response Response Example
201 - Success
{
"data": [
{
"id": "66fba5afd195e04a6f6137ec",
"owner": {
"id": "66fba5a3d195e04a6f6137e3",
"type": "profile"
},
"entityId": null,
"entityType": null,
"name": "user001last",
"type": null,
"color": "#7F7309",
"eventDuration": null,
"schedule": null,
"createdAt": "Tue Oct 01 2024 10:33:03 GMT+0300 (East Africa Time)",
"updatedAt": "Tue Oct 01 2024 10:33:03 GMT+0300 (East Africa Time)",
"defaultCalendar": true,
"updatedBy": "66fba5a3d195e04a6f6137e3",
"createdBy": "66fba5a3d195e04a6f6137e3",
"timezone": "UTC",
"baseDuration": null,
"available": true
},
{
"id": "66fba5d3d195e04a6f613818",
"owner": {
"id": "66fba5d0d195e04a6f61380f",
"type": "profile"
},
"entityId": null,
"entityType": null,
"name": "user002last",
"type": null,
"color": "#51126B",
"eventDuration": null,
"schedule": null,
"createdAt": "Tue Oct 01 2024 10:33:39 GMT+0300 (East Africa Time)",
"updatedAt": "Tue Oct 01 2024 10:33:39 GMT+0300 (East Africa Time)",
"defaultCalendar": true,
"updatedBy": "66fba5d0d195e04a6f61380f",
"createdBy": "66fba5d0d195e04a6f61380f",
"timezone": "UTC",
"baseDuration": null,
"available": null
},
{
"id": "66fba64ed195e04a6f61384c",
"owner": {
"id": "66fba64ad195e04a6f613846",
"type": "organization"
},
"entityId": null,
"entityType": null,
"name": null,
"type": null,
"color": "#006451",
"eventDuration": null,
"schedule": null,
"createdAt": "Tue Oct 01 2024 10:35:42 GMT+0300 (East Africa Time)",
"updatedAt": "Tue Oct 01 2024 10:35:42 GMT+0300 (East Africa Time)",
"defaultCalendar": false,
"updatedBy": "66fba64ad195e04a6f613846",
"createdBy": "66fba64ad195e04a6f613846",
"timezone": "UTC",
"baseDuration": null,
"available": false
}
],
"cursor": {
"next": "eyJpZCI6IjY2ZmJhNjRlZDE5NWUwNGE2ZjYxMzg0YyIsImRpcmVjdGlvbiI6ImFzYyJ9",
"prev": null,
"totalItems": 52
}
}Request
Query Params
limit
integerÂ
optional
Default:
50
Header Params
apikey
stringÂ
optional
Example:
{{apikey}}
Body Params application/json
Responses
Modified at 2025-04-09 12:55:54