GET
/
availabilities
List all availabilities of the team members
curl --request GET \
  --url https://{workspace}.neetocal.com/api/external/v1/availabilities \
  --header 'X-Api-Key: <x-api-key>'
{
  "availabilities": [
    {
      "id": "01ea5ddf-ed00-4bed-bfa3-ba8ea80a856a",
      "sid": "2nq7q5c",
      "name": "Availability for custom user",
      "default": false,
      "after_buffer_time": 0,
      "before_buffer_time": 0,
      "periods": [
        {
          "id": "21c812a7-3859-4f01-b214-850e6f11caad",
          "wday": "monday",
          "start_time": "09:00 AM",
          "end_time": "05:00 PM"
        }
      ],
      "overrides": [
        {
          "date": "2025-03-07",
          "periods": [
            {
              "wday": "friday",
              "start_time": "10:00 AM",
              "end_time": "03:00 PM"
            }
          ]
        }
      ],
      "user": {
        "id": "b6d02dfa-8ef6-453d-b9f7-67a6f20bcaa6",
        "name": "Oliver Smith",
        "email": "oliver@example.com"
      }
    }
  ],
  "pagination": {
    "total_records": 123,
    "total_pages": 123,
    "current_page_number": 123,
    "page_size": 123
  }
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.
Pro tip: In the API playground above, you can easily add multiple email addresses by clicking the ”+” button next to the emails[] parameter. The playground will automatically generate the correct query string format for you.

​
Example Usage

curl -X GET "https://yourworkspace.neetocal.com/api/external/v1/availabilities?emails[]=oliver@example.com&emails[]=cypress@example.com&emails[]=john@example.com" \
  -H "X-Api-Key: YOUR_API_KEY"

Headers

​
X-Api-Key
string
required

You can generate an API key from the NeetoCal API Keys dashboard.

Query Parameters

​
emails[]
string<email>[]
required

Email addresses of team members whose availabilities should be listed. You can add multiple email addresses to get availabilities for multiple team members. The API playground allows you to easily add multiple emails by clicking the "+" button.

Example:
[
  "oliver@example.com",
  "cypress@example.com",
  "john@example.com"
]
​
page
string

Page number.

​
page_size
string

Number of availabilities to receive. The default value is 30.

Response

200
application/json

OK - Request succeeded

The response is of type object.