Getting Started
Scheduling links
Meeting places
Meeting durations
Bookings
Availabilities
Team Members
Discount Codes
API v1 (Deprecated)
- GETList scheduling links
- GETList scheduling link templates
- GETGet scheduling link
- POSTCreate scheduling link
- PATCHUpdate scheduling link
- POSTCreate one-time scheduling link
- GETList meeting places
- GETGet meeting place
- POSTCreate meeting place
- PUTUpdate meeting place
- DELDelete meeting place
- GETList meeting durations
- GETGet meeting duration
- POSTCreate meeting duration
- PUTUpdate meeting duration
- DELDelete meeting duration
- GETList bookings
- GETGet booking
- POSTCreate booking
- POSTCreate payment
- PUTConfirm payment
- PATCHReschedule booking
- POSTCancel booking
- POSTApprove booking
- POSTReject booking
- GETGet associated bookings
- GETList availabilities of team members
- GETList availabilities of a team member
- GETGet availability
- POSTCreate availability
- PATCHUpdate availability
- POSTCreate custom availability for scheduling-link
- POSTUpdate scheduling-link availability
- GETList available slots
- GETList packages
- GETGet package
- GETList package purchases
- GETGet package purchase
- GETList team members
- POSTAdd team members
- PATCHUpdate team member
- DELRemove team member
- POSTCreate discount code
- POSTCreate automation rule
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,
"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": [
{
"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
}
}List availabilities of a team member
List availabilities for 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,
"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": [
{
"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
}
}{your-subdomain} with your workspace’s subdomain. Learn how to find your subdomain in Identifying subdomain.
Headers
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.
Query Parameters
Email of the team member whose availabilities should be listed.
"oliver@example.com"
Retrieve paginated results by specifying the desired page number. If this parameter is absent, all results will be returned.
Set the number of results returned in the response. Defaulting to 30 when omitted.
Response
OK - Request succeeded
Array of availability configurations for the requested team members. Each availability contains the schedule, buffer times, and associated user information.
Hide child attributes
Hide child attributes
Unique identifier for the availability configuration.
"01ea5ddf-ed00-4bed-bfa3-ba8ea80a856a"
Short identifier (SID) for the availability, used in URLs and API calls for easy reference.
"2nq7q5c"
Human-readable name for the availability configuration (e.g., "Working hours", "Custom schedule").
"Availability for custom user"
Indicates whether this is the default availability configuration for the team member. Only one availability can be set as default per user.
false
Buffer time in minutes after each meeting to allow for wrap-up, notes, or preparation for the next meeting.
0
Buffer time in minutes before each meeting to allow for setup, preparation, or travel time.
0
List of time periods defining when the team member is available for meetings throughout the week.
Hide child attributes
Hide child attributes
Unique identifier for this specific availability period.
"21c812a7-3859-4f01-b214-850e6f11caad"
Day of the week for this availability period. Valid values are "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".
monday, tuesday, wednesday, thursday, friday, saturday, sunday "monday"
Start time of the availability period in 12-hour format with AM/PM designation.
"09:00 AM"
End time of the availability period in 12-hour format with AM/PM designation.
"05:00 PM"
List of date-specific availability overrides (e.g., holidays, vacation days, or special working hours for specific dates).
Hide child attributes
Hide child attributes
The specific date for this availability override in YYYY-MM-DD format.
"2025-03-07"
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
Hide child attributes
Information about the team member this availability configuration belongs to.
Hide child attributes
Hide child attributes
Unique identifier for the user/team member.
"b6d02dfa-8ef6-453d-b9f7-67a6f20bcaa6"
Full name of the team member.
"Oliver Smith"
Email address of the team member.
"oliver@example.com"
Pagination information including total records, pages, and current page details.