List availabilities of team members

List availabilities of the team members

curl --request GET \
  --url https://{your-subdomain}.neetocal.com/api/external/v1/availabilities \
  --header 'X-Api-Key: <x-api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};

fetch('https://{your-subdomain}.neetocal.com/api/external/v1/availabilities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetocal.com/api/external/v1/availabilities"

headers = {"X-Api-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "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
  }
}

GET

availabilities

List availabilities of the team members

curl --request GET \
  --url https://{your-subdomain}.neetocal.com/api/external/v1/availabilities \
  --header 'X-Api-Key: <x-api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};

fetch('https://{your-subdomain}.neetocal.com/api/external/v1/availabilities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetocal.com/api/external/v1/availabilities"

headers = {"X-Api-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "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
  }
}

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.

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/v1/availabilities?emails[]=oliver@example.com&emails[]=cypress@example.com&emails[]=john@example.com" \
  -H 'X-Api-Key: YOUR_API_KEY'

const emails = [
  "oliver@example.com",
  "cypress@example.com",
  "john@example.com",
];
const params = new URLSearchParams();
emails.forEach((email) => params.append("emails[]", email));

const response = await fetch(
  `https://your-subdomain.neetocal.com/api/external/v1/availabilities?${params}`,
  {
    headers: {
      "X-Api-Key": "YOUR_API_KEY",
    },
  }
);

import requests

emails = ['oliver@example.com', 'cypress@example.com', 'john@example.com']
params = [('emails[]', email) for email in emails]

response = requests.get(
    'https://your-subdomain.neetocal.com/api/external/v1/availabilities',
    params=params,
    headers={'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

Page of results to retrieve, starting from 1. Defaults to 1 when omitted.

page_size

integer

Number of results per page. Defaults 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.

Hide child attributes

availabilities.id

string

Unique identifier for the availability configuration.

Example:

"01ea5ddf-ed00-4bed-bfa3-ba8ea80a856a"

availabilities.sid

string

Short identifier (SID) for the availability, used in URLs and API calls for easy reference.

Example:

"2nq7q5c"

availabilities.name

string

Human-readable name for the availability configuration (e.g., "Working hours", "Custom schedule").

Example:

"Availability for custom user"

availabilities.default

boolean

Indicates whether this is the default availability configuration for the team member. Only one availability can be set as default per user.

Example:

false

availabilities.periods

object[]

List of time periods defining when the team member is available for meetings throughout the week.

Hide child attributes

availabilities.periods.id

string

Unique identifier for this specific availability period.

Example:

"21c812a7-3859-4f01-b214-850e6f11caad"

availabilities.periods.wday

enum<string>

Day of the week for this availability period. Valid values are "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".

Available options:

monday,

tuesday,

wednesday,

thursday,

friday,

saturday,

sunday

Example:

"monday"

availabilities.periods.start_time

string

Start time of the availability period in 12-hour format with AM/PM designation.

Example:

"09:00 AM"

availabilities.periods.end_time

string

End time of the availability period in 12-hour format with AM/PM designation.

Example:

"05:00 PM"

availabilities.overrides

object[]

List of date-specific availability overrides (e.g., holidays, vacation days, or special working hours for specific dates).

Hide child attributes

availabilities.overrides.date

string<date>

The specific date for this availability override in YYYY-MM-DD format.

Example:

"2025-03-07"

availabilities.overrides.periods

object[]

Time periods for this specific date. Set as empty array ([]) to mark the date as unavailable. If periods are provided, they override the regular weekly schedule for this date.

Hide child attributes

availabilities.overrides.periods.start_time

string

Start time for the override period in 12-hour format with AM/PM designation.

Example:

"10:00 AM"

availabilities.overrides.periods.end_time

string

End time for the override period in 12-hour format with AM/PM designation.

Example:

"03:00 PM"

availabilities.user

object

Information about the team member this availability configuration belongs to.

Hide child attributes

availabilities.user.id

string

Unique identifier for the user/team member.

Example:

"b6d02dfa-8ef6-453d-b9f7-67a6f20bcaa6"

availabilities.user.name

string

Full name of the team member.

Example:

"Oliver Smith"

availabilities.user.email

string<email>

Email address of the team member.

Example:

"oliver@example.com"

pagination

object

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

Hide child attributes

pagination.total_records

integer

Total number of records.

pagination.total_pages

integer

Total number of pages available.

pagination.current_page_number

integer

Current page number.

pagination.page_size

integer

Number of records per page.

Getting started

Scheduling links

Meeting places

Meeting durations

Bookings

Availabilities

Slots

Packages

Team members

Meeting outcomes

Discount codes

Automation rules

Prefill tokens

API v1 (deprecated)

List availabilities of team members

Example Usage

Headers

Query Parameters

Response

​Example Usage

Headers

Query Parameters

Response

Example Usage