Skip to main content
GET
/
availabilities
/
team_member
List availabilities of a team member
curl --request GET \
  --url https://{your-subdomain}.neetocal.com/api/external/v1/availabilities/team_member \
  --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
  }
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.neetocal.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint is part of API v1, which is deprecated. Please use the v2 API instead.
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

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

email
string
required

Email of the team member whose availabilities should be listed.

Example:

"oliver@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.