List all bookings

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

{
  "bookings": [
    {
      "id": "<string>",
      "sid": "<string>",
      "parent_booking_id": "<string>",
      "email": "<string>",
      "name": "<string>",
      "host_name": "<string>",
      "host_email": "<string>",
      "is_multihost": true,
      "multihosts": [
        {
          "name": "<string>",
          "email": "<string>"
        }
      ],
      "starts_at": "2023-11-07T05:31:56Z",
      "ends_at": "2023-11-07T05:31:56Z",
      "time_zone": "<string>",
      "starts_at_for_client": "<string>",
      "ends_at_for_client": "<string>",
      "status": "<string>",
      "cancel_reason": "<string>",
      "cancelled_by": "<string>",
      "reschedule_requested": true,
      "preferred_meeting_spot": "<string>",
      "room_type": "daily",
      "room_url": "<string>",
      "room_id": "<string>",
      "spot_details": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "meeting_id": "<string>",
      "meeting": {
        "name": "<string>"
      },
      "no_show": true,
      "meeting_outcome": "<string>",
      "notes_url": "<string>",
      "internal_notes": "<string>",
      "metadata": {},
      "admin_booking_url": "<string>",
      "client_booking_url": "<string>",
      "form_responses": [
        {
          "field": "<string>",
          "value": "<string>",
          "type": "<string>",
          "field_code": "<string>"
        }
      ],
      "form_responses_as_hash": {}
    }
  ],
  "pagination": {
    "total_records": 123,
    "total_pages": 123,
    "current_page_number": 123,
    "page_size": 123
  }
}

GET

bookings

List all bookings

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

{
  "bookings": [
    {
      "id": "<string>",
      "sid": "<string>",
      "parent_booking_id": "<string>",
      "email": "<string>",
      "name": "<string>",
      "host_name": "<string>",
      "host_email": "<string>",
      "is_multihost": true,
      "multihosts": [
        {
          "name": "<string>",
          "email": "<string>"
        }
      ],
      "starts_at": "2023-11-07T05:31:56Z",
      "ends_at": "2023-11-07T05:31:56Z",
      "time_zone": "<string>",
      "starts_at_for_client": "<string>",
      "ends_at_for_client": "<string>",
      "status": "<string>",
      "cancel_reason": "<string>",
      "cancelled_by": "<string>",
      "reschedule_requested": true,
      "preferred_meeting_spot": "<string>",
      "room_type": "daily",
      "room_url": "<string>",
      "room_id": "<string>",
      "spot_details": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "meeting_id": "<string>",
      "meeting": {
        "name": "<string>"
      },
      "no_show": true,
      "meeting_outcome": "<string>",
      "notes_url": "<string>",
      "internal_notes": "<string>",
      "metadata": {},
      "admin_booking_url": "<string>",
      "client_booking_url": "<string>",
      "form_responses": [
        {
          "field": "<string>",
          "value": "<string>",
          "type": "<string>",
          "field_code": "<string>"
        }
      ],
      "form_responses_as_hash": {}
    }
  ],
  "pagination": {
    "total_records": 123,
    "total_pages": 123,
    "current_page_number": 123,
    "page_size": 123
  }
}

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.

Query Parameters

type

string

To get the bookings of a particular type only. The available types are upcoming, past, cancelled, and incomplete. If no value is passed it will default to all bookings.

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.

host_email

string

To get the bookings of a particular host only.

client_email

string

To get the bookings of a particular client only.

filters

object

Apply filters on your bookings.

Hide child attributes

filters.starts_at

object

To filter bookings by meeting start time, use deep object style in the query string, e.g.: ?filters[starts_at][rule]=after&filters[starts_at][value]=2027-12-19T06:00:00.000Z

Supported rules: at, after, before, between
Value: a single UTC datetime string for at/after/before, or two comma-separated UTC datetime strings for between.

Hide child attributes

filters.starts_at.rule

enum<string>

The rule to be used for comparing with the starts_at value

Available options:

at,

after,

before,

between

filters.starts_at.value

string

filters.ends_at

object

To filter bookings by meeting end time, use deep object style in the query string, e.g.: ?filters[ends_at][rule]=before&filters[ends_at][value]=2027-12-19T10:00:00.000Z

Supported rules: at, after, before, between
Value: a single UTC datetime string for at/after/before, or two comma-separated UTC datetime strings for between.

Hide child attributes

filters.ends_at.rule

enum<string>

The rule to be used for comparing with the ends_at value

Available options:

at,

after,

before,

between

filters.ends_at.value

string

sorting_order

enum<string>

Sort bookings by booking creation date. The default value is desc.

Available options:

asc,

desc

Response

200 - application/json

OK - Request succeeded

bookings

object[]

List of bookings.

Hide child attributes

string

Unique identifier for the booking.

sid

string

Short identifier (SID) for the booking, used in URLs and API calls.

parent_booking_id

string | null

Reference to the parent booking if this is a group booking.

string

Email address of the person who made the booking.

name

string

Name of the person who made the booking.

host_name

string

Name of the primary host for the meeting.

host_email

string

Email address of the primary host for the meeting.

is_multihost

boolean

Whether the meeting has multiple hosts.

multihosts

object[]

List of all hosts for the meeting when is_multihost is true.

Hide child attributes

name

string

Name of the host.

string

Email address of the host.

starts_at

string<date-time>

Start time of the booking in UTC.

ends_at

string<date-time>

End time of the booking in UTC.

time_zone

string

Time zone of the booking location.

starts_at_for_client

string

Start time of the booking in the client's local time zone.

ends_at_for_client

string

End time of the booking in the client's local time zone.

status

string

Current status of the booking (e.g., confirmed, cancelled, awaiting_approval, rejected).

cancel_reason

string | null

Reason provided when the booking was cancelled.

cancelled_by

string | null

Name of the person who cancelled the booking.

reschedule_requested

boolean

Whether a reschedule has been requested for this booking.

preferred_meeting_spot

string

Preferred meeting platform or location type selected by the client.

room_type

enum<string> | null

Type of meeting room or platform being used.

Available options:

daily,

zoom,

jitsi,

google_meet,

teams,

whereby,

in_person,

custom,

phone_call

room_url

string | null

URL for the meeting room or platform.

room_id

string | null

Unique identifier for the meeting room or platform.

spot_details

string | null

Additional details about the meeting location or platform.

created_at

string<date-time>

Timestamp when the booking was created.

updated_at

string<date-time>

Timestamp when the booking was last updated.

meeting_id

string

Unique identifier of the scheduling link this booking belongs to.

meeting

object

Basic information about the associated meeting.

Hide child attributes

meeting.name

string

Name of the meeting/scheduling link.

no_show

boolean

Whether the booking is marked as no-show by the host.

meeting_outcome

string | null

Outcome status of the meeting.

notes_url

string | null

URL to access notes or additional information about the booking.

internal_notes

string | null

Internal notes about the booking visible only to hosts and admins.

metadata

object | null

Additional custom data associated with the booking.

admin_booking_url

string

URL for hosts and admins to view and manage the booking.

client_booking_url

string

URL for clients to view their booking details.

form_responses

object[]

Responses submitted through the booking form.

Hide child attributes

field

string

Display name of the form field.

value

string

Value submitted for the form field.

type

string

Type of the form field (e.g., name, email, additional_guests).

field_code

string

Internal code identifier for the form field.

form_responses_as_hash

object

Form responses organized as key-value pairs for easier access.

Hide child attributes

form_responses_as_hash.{key}

string

pagination

object

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.

Delete a duration for a meeting Get booking details

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

List all bookings

Headers

Query Parameters

Response