Skip to main content
GET
/
bookings
List bookings
curl --request GET \
  --url https://{your-subdomain}.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_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": {
        "id": "59413def-60eb-47c6-b390-098fcf583b66",
        "name": "Pricing Discussion",
        "color": "yellow",
        "kind": "custom",
        "color_hex": "#EAB308",
        "is_system": false,
        "is_organization_owned": true
      },
      "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
  }
}

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

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.

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.

pagination
object