List bookings

Lists bookings one page at a time.

GET /booking

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/booking?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "data": [
    {
      "account": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "allow_contract": true,
      "billing_address": {
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "address_line_4": "<string>",
        "address_line_5": "<string>",
        "city": "<string>",
        "country": "<string>",
        "name": "<string>",
        "postal_code": "<string>",
        "state": "<string>"
      },
      "billing_preferences": {
        "billing_period": "<string>",
        "communication_profile": "<string>",
        "consolidate_invoice": true,
        "consolidate_key": "<string>",
        "fulfillment_mode": "<string>",
        "fulfillment_term": "<string>",
        "invoice_mode": "<string>",
        "invoice_term": "<string>",
        "payment_mode": "<string>",
        "payment_processor": "<string>",
        "payment_term": "<string>",
        "payment_term_alignment": "<string>",
        "proforma_properties": {
          "acceptance_date": null,
          "acceptance_required": true,
          "acceptance_term": null,
          "payment_required": true,
          "terms_and_conditions": null
        }
      },
      "billing_start_date": "<string>",
      "billing_start_day_of_month": "<string>",
      "communication_preferences": [
        {
          "channel": "<string>",
          "enabled": true
        }
      ],
      "contract_properties": {
        "allow_downgrade": true,
        "allow_downgrade_charge": true,
        "allow_early_termination": true,
        "allow_postponement": true,
        "allow_trial": true,
        "allow_upgrade": true,
        "auto_renewal_ends_on": "<string>",
        "auto_renewal_require_customer_acceptance": true,
        "auto_renewal_term": "<string>",
        "downgrade_charge_fixed": "<string>",
        "downgrade_charge_type": "<string>",
        "initial_contract_term": "<string>",
        "period_before_downgrade": "<string>",
        "renew_automatically": "<string>",
        "require_customer_acceptance": true,
        "requires_payment_method": true,
        "termination_accounting_code": "<string>",
        "termination_notice_period": "<string>"
      },
      "created_by": null,
      "created_on": "<string>",
      "currency": {
        "code": "<string>",
        "href": "<string>",
        "id": "<string>",
        "name": "<string>",
        "object": "<string>"
      },
      "custom_form": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "customer_purchase_order_id": "<string>",
      "description": "<string>",
      "discount_profile": {
        "amount": "<string>",
        "href": "<string>",
        "id": "<string>",
        "name": "<string>",
        "object": "<string>",
        "redemption_code": "<string>",
        "type": "<string>"
      },
      "display_name": "<string>",
      "id": "<string>",
      "invoice_note": "<string>",
      "last_updated_by": null,
      "last_updated_on": "<string>",
      "manager": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "name": "<string>",
      "next_billing_from_date": "<string>",
      "next_billing_from_date_utc": "<string>",
      "object": "<string>",
      "order_start_date": "<string>",
      "order_type": "<string>",
      "origin": "<string>",
      "original_total": "<string>",
      "pre_order": true,
      "price_tax_inclusive": true,
      "quote_converted": true,
      "quote_order": true,
      "referral_account": {
        "href": "<string>",
        "id": "<string>",
        "object": "<string>"
      },
      "sales_rep": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "shipping_address": {
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "address_line_4": "<string>",
        "address_line_5": "<string>",
        "city": "<string>",
        "country": "<string>",
        "name": "<string>",
        "postal_code": "<string>",
        "state": "<string>"
      },
      "shipping_cost": 123,
      "shipping_profile": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "status": "<string>",
      "time_zone": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "version": 123
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

Returns one page of bookings under data, with a pagination block. Pass limit to set the page size and cursor to move to the next page. Other fields filter as filter_<field> for equality and filter_<field>_<operator> otherwise.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit · integer

How many records to return on one page.

Example:

20

cursor · string

The next_cursor of the previous page, to read the page after it.

sort · string

The field to sort by. Prefix it with - for descending order, as in -created_on.

Example:

"-created_on"

Response

200 - application/json

A page of bookings under data.

data · object[]

Show child attributes

object · string

pagination · object

Show child attributes

url · string