Get details about an availability

Get availability details

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

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

GET

availabilities

{availability_id}

Get availability details

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

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

Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key

string

required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Path Parameters

availability_id

string

required

Id of the availability can be retrieved by going to the particular availability page, and copying it from the URL.

Response

200 - application/json

OK - Request succeeded

availability

object

Hide child attributes

availability.id

string

Unique identifier for the availability configuration.

Example:

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

availability.sid

string

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

Example:

"2nq7q5c"

availability.name

string

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

Example:

"Availability for custom user"

availability.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

availability.after_buffer_time

integer

Buffer time in minutes after each meeting to allow for wrap-up, notes, or preparation for the next meeting.

Example:

0

availability.before_buffer_time

integer

Buffer time in minutes before each meeting to allow for setup, preparation, or travel time.

Example:

0

availability.periods

object[]

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

Hide child attributes

string

Unique identifier for this specific availability period.

Example:

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

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"

start_time

string

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

Example:

"09:00 AM"

end_time

string

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

Example:

"05:00 PM"

availability.overrides

object[]

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

Hide child attributes

date

string<date>

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

Example:

"2025-03-07"

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

wday

enum<string>

Day of the week corresponding to the override date. Valid values are "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".

Available options:

monday,

tuesday,

wednesday,

thursday,

friday,

saturday,

sunday

Example:

"friday"

start_time

string

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

Example:

"10:00 AM"

end_time

string

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

Example:

"03:00 PM"

availability.user

object

Information about the team member this availability configuration belongs to.

Hide child attributes

availability.user.id

string

Unique identifier for the user/team member.

Example:

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

availability.user.name

string

Full name of the team member.

Example:

"Oliver Smith"

availability.user.email

string<email>

Email address of the team member.

Example:

"oliver@example.com"

List all availabilities of a team member Update an availability

Getting Started

Scheduling links API

Meeting spots API

Meeting durations API

Bookings API

Availabilities API

Slots API

Packages API

Team Members API

Discount Codes API

Get details about an availability

Headers

Path Parameters

Response