Skip to main content
GET
/
availabilities
List availabilities of the team members
curl --request GET \
  --url https://{your-subdomain}.neetocal.com/api/external/v2/availabilities \
  --header 'X-Api-Key: <x-api-key>'
{
  "availabilities": [
    {
      "id": "01ea5ddf-ed00-4bed-bfa3-ba8ea80a856a",
      "sid": "2nq7q5c",
      "name": "Availability for custom user",
      "default": false,
      "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": [
            {
              "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-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace 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://your-subdomain.neetocal.com/api/external/v2/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

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

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_number
integer

Retrieve paginated results by specifying the desired page number. If this parameter is absent, all results will be returned.

​
page_size
integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

Response

200 - application/json

OK - Request succeeded

​
availabilities
object[]

Array of availability configurations for the requested team members. Each availability contains the schedule and associated user information.

​
pagination
object

Pagination information including total records, pages, and current page details.