GET
/
bookings
List all bookings
curl --request GET \
  --url https://{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": "<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": "<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>"
        }
      ]
    }
  ],
  "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

You can generate an API key from the NeetoCal API Keys dashboard.

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
number

Page number. The default value is 1.

page_size
number

Number of bookings to receive. The default value is 30.

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

The response is of type object.