Get booking

Get booking details

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

const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};

fetch('https://{your-subdomain}.neetocal.com/api/external/v2/bookings/{booking_sid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetocal.com/api/external/v2/bookings/{booking_sid}"

headers = {"X-Api-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "id": "efb296a3-8205-419f-8ac4-1abfc46bc3c7",
  "sid": "8sqtzrs",
  "parent_booking_id": null,
  "name": "John Doe",
  "email": "john.doe@example.com",
  "host_name": "Jane Smith",
  "host_email": "jane@bigbinary.com",
  "is_multihost": false,
  "multihosts": [
    {
      "name": "Jane Smith",
      "email": "jane@bigbinary.com"
    }
  ],
  "starts_at": "2025-07-23T05:00:00.000Z",
  "ends_at": "2025-07-23T05:15:00.000Z",
  "time_zone": "Asia/Kolkata",
  "starts_at_for_client": "2025-07-23T10:30:00.000+05:30",
  "ends_at_for_client": "2025-07-23T10:45:00.000+05:30",
  "status": "confirmed",
  "cancel_reason": null,
  "cancelled_by": null,
  "reschedule_requested": false,
  "preferred_meeting_spot": "jitsi",
  "room_type": "jitsi",
  "room_url": "https://jitsi.neetocal.com/meeting-with-jane-of-jane-d12ec",
  "room_id": null,
  "spot_details": "https://jitsi.neetocal.com/meeting-with-jane-of-jane-d12ec",
  "created_at": "2025-07-22T06:29:35.963Z",
  "updated_at": "2025-07-22T06:31:33.090Z",
  "meeting_id": "8a7794e3-3142-4569-9dd7-6411369b5d3f",
  "meeting": {
    "name": "Product Demo Meeting"
  },
  "no_show": false,
  "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
  },
  "internal_notes": null,
  "metadata": {},
  "admin_booking_url": "https://jane-bigbinary.neetocal.com/admin/bookings/8sqtzrs",
  "client_booking_url": "https://jane-bigbinary.neetocal.com/booking/8sqtzrs",
  "form_responses": [
    {
      "field": "Name",
      "value": "John Doe",
      "type": "name",
      "field_code": "name",
      "Name": "John Doe"
    },
    {
      "field": "Email",
      "value": "john.doe@example.com",
      "type": "email",
      "field_code": "email",
      "Email": "john.doe@example.com"
    },
    {
      "field": "Guest email(s)",
      "value": [],
      "type": "additional_guests",
      "field_code": "guest_email_s",
      "Guest email(s)": []
    }
  ],
  "form_responses_as_hash": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "guest_email_s": []
  }
}

GET

bookings

{booking_sid}

Get booking details

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

const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};

fetch('https://{your-subdomain}.neetocal.com/api/external/v2/bookings/{booking_sid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetocal.com/api/external/v2/bookings/{booking_sid}"

headers = {"X-Api-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "id": "efb296a3-8205-419f-8ac4-1abfc46bc3c7",
  "sid": "8sqtzrs",
  "parent_booking_id": null,
  "name": "John Doe",
  "email": "john.doe@example.com",
  "host_name": "Jane Smith",
  "host_email": "jane@bigbinary.com",
  "is_multihost": false,
  "multihosts": [
    {
      "name": "Jane Smith",
      "email": "jane@bigbinary.com"
    }
  ],
  "starts_at": "2025-07-23T05:00:00.000Z",
  "ends_at": "2025-07-23T05:15:00.000Z",
  "time_zone": "Asia/Kolkata",
  "starts_at_for_client": "2025-07-23T10:30:00.000+05:30",
  "ends_at_for_client": "2025-07-23T10:45:00.000+05:30",
  "status": "confirmed",
  "cancel_reason": null,
  "cancelled_by": null,
  "reschedule_requested": false,
  "preferred_meeting_spot": "jitsi",
  "room_type": "jitsi",
  "room_url": "https://jitsi.neetocal.com/meeting-with-jane-of-jane-d12ec",
  "room_id": null,
  "spot_details": "https://jitsi.neetocal.com/meeting-with-jane-of-jane-d12ec",
  "created_at": "2025-07-22T06:29:35.963Z",
  "updated_at": "2025-07-22T06:31:33.090Z",
  "meeting_id": "8a7794e3-3142-4569-9dd7-6411369b5d3f",
  "meeting": {
    "name": "Product Demo Meeting"
  },
  "no_show": false,
  "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
  },
  "internal_notes": null,
  "metadata": {},
  "admin_booking_url": "https://jane-bigbinary.neetocal.com/admin/bookings/8sqtzrs",
  "client_booking_url": "https://jane-bigbinary.neetocal.com/booking/8sqtzrs",
  "form_responses": [
    {
      "field": "Name",
      "value": "John Doe",
      "type": "name",
      "field_code": "name",
      "Name": "John Doe"
    },
    {
      "field": "Email",
      "value": "john.doe@example.com",
      "type": "email",
      "field_code": "email",
      "Email": "john.doe@example.com"
    },
    {
      "field": "Guest email(s)",
      "value": [],
      "type": "additional_guests",
      "field_code": "guest_email_s",
      "Guest email(s)": []
    }
  ],
  "form_responses_as_hash": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "guest_email_s": []
  }
}

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.

Path Parameters

booking_sid

string

required

SID of the booking you want to retrieve.

Example:

"8sqtzrs"

Response

200 - application/json

OK - Request succeeded

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

multihosts.name

string

Name of the host.

multihosts.email

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

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 scheduling link.

no_show

boolean

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

meeting_outcome

object | null

Meeting outcome assigned to the booking.

Hide child attributes

meeting_outcome.id

string

Unique identifier for the meeting outcome.

Example:

"59413def-60eb-47c6-b390-098fcf583b66"

meeting_outcome.name

string

Name of the meeting outcome.

Example:

"Pricing Discussion"

meeting_outcome.color

enum<string>

Color assigned to the meeting outcome.

Available options:

blue,

orange,

gray,

red,

yellow,

violet,

pink,

teal,

cyan,

green

Example:

"yellow"

meeting_outcome.kind

string

Kind of the meeting outcome.

Example:

"custom"

meeting_outcome.color_hex

string

Hex color code for the meeting outcome.

Example:

"#EAB308"

meeting_outcome.is_system

boolean

Whether this is a system-defined meeting outcome. System outcomes cannot be modified or deleted.

Example:

false

meeting_outcome.is_organization_owned

boolean

Whether this outcome belongs to the organization.

Example:

true

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

form_responses.field

string

Display name of the form field.

form_responses.value

string

Value submitted for the form field.

form_responses.type

string

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

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

payment

object | null

Payment details for the booking. Included only when a payment exists for the booking.

Hide child attributes

payment.id

string<uuid>

Unique identifier of the payment record.

Example:

"f46c9ddf-221d-4238-afb2-280c1c6b3185"

payment.external_id

string | null

Payment reference ID from the payment provider.

Example:

"pi_3ThCkv2c3CtEndqE1BwejQno"

payment.provider

string

Payment provider that processed the payment.

Example:

"stripe"

payment.amount

string

Payment amount.

Example:

"100.0"

payment.currency

string

Currency code. Follows the ISO 4217 standard.

Example:

"USD"

payment.status

string

Current status of the payment.

Example:

"successful"

payment.successful

boolean

Whether the payment was completed successfully.

Example:

true

payment.payment_at

string<date-time> | null

Timestamp when the payment was made.

Example:

"2026-06-11T17:51:09.321Z"

List bookings Create booking

Getting Started

Scheduling links

Meeting places

Meeting durations

Bookings

Availabilities

Slots

Packages

Team Members

Meeting Outcomes

Discount Codes

Automation Rules

API v1 (Deprecated)

Headers

Path Parameters

Response