Retrieve a booking custom object

Returns one custom object with this booking’s instances of it.

GET /booking/{booking_id}/custom_objects/{custom_object_id}

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/booking/BOOKING_ID/custom_objects/CUSTOM_OBJECT_ID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "custom_object": {
    "created_by": null,
    "created_on": "<string>",
    "custom_component": null,
    "description": null,
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "instances": "<array>",
    "last_updated_by": null,
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "pagination": {
      "limit": 123,
      "has_more": true,
      "next_cursor": "<string>",
      "prev_cursor": "<string>",
      "links": {
        "next": "<string>",
        "prev": "<string>"
      }
    },
    "relation": "<string>",
    "use_in": "<string>"
  }
}

Returns the custom object under custom_object, with the booking’s instances in instances and a pagination block.

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.

Path Parameters

booking_id · string · required

The booking's id. Any order's id works here, whatever the order's type.

custom_object_id · string · required

The custom object's id, for a custom object used in orders (use_in is SALE_ORDER).

Response

200 - application/json

The custom object, under custom_object.

custom_object · object · required

Show child attributes