Available slots

Overview

The "Available slots" API allows users to retrieve a list of available times of the user (or users in the case of multi-host or round-robin meetings) for a specific meeting for a given month. These slots can later be used to book a meeting.

Usage

Base URL

https://<organization>.neetocal.com/api/external/v1

Replace the <organization> with the desired organization's subdomain.

Endpoint

GET /<meeting_slug>/slots

Replace the <meeting_slug> with the desired meeting's slug.

Request header

This endpoint requires authentication. You must include a valid API key in the request header.

Header	Type	Required	Description
X-Api-Key	String	Yes	Bearer token for API access.

Query parameters

Parameter	Type	Required	Description
time_zone	String	Yes	The time zone in which to check available slots
year	String	Yes	The year for which to check available slots
month	String	Yes	The month for which to check available slots

Note: All the above query parameters can also be passed as a JSON body.

Example

For getting the slots of a meeting, "Meeting with Oliver Smith", with the slug meeting-with-oliver-smith of organization "Spinkart" with subdomain spinkart using curl:

curl -X GET "https://spinkart.neetocal.com/api/external/v1/slots/meeting-with-oliver-smith" \
  --header "X-Api-Key: YOUR_API_KEY" \
  --data '{
    "time_zone": "America/New_York",
    "year": 2024,
    "month": 7
  }'

Response Codes

Code	Description
200	OK - Request succeeded
400	Bad Request - Missing/Invalid parameters
401	Unauthorized - Invalid API key
500	Internal server error