List a booking's custom objects (alternate path)

cURL

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

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.bookings.getBookingCustomObjectsInstances('BOOKING_ID', {limit: 20});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->bookings->getBookingCustomObjectsInstances('BOOKING_ID', ['limit' => 20]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.bookings.bookings_dto.BookingsDto.BookingCustomObjectList;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<BookingCustomObjectList> response = client.bookings().getBookingCustomObjectsInstances(
        "BOOKING_ID",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Bookings.GetBookingCustomObjectsInstancesAsync(
    "BOOKING_ID",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.bookings.getBookingCustomObjectsInstances(
  'BOOKING_ID',
  queryParams: {'limit': 20},
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Bookings().GetBookingCustomObjectsInstances(context.Background(), "BOOKING_ID", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

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

GET

booking

{booking_id}

custom_objects_instances

cURL

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

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.bookings.getBookingCustomObjectsInstances('BOOKING_ID', {limit: 20});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->bookings->getBookingCustomObjectsInstances('BOOKING_ID', ['limit' => 20]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.bookings.bookings_dto.BookingsDto.BookingCustomObjectList;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<BookingCustomObjectList> response = client.bookings().getBookingCustomObjectsInstances(
        "BOOKING_ID",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Bookings.GetBookingCustomObjectsInstancesAsync(
    "BOOKING_ID",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.bookings.getBookingCustomObjectsInstances(
  'BOOKING_ID',
  queryParams: {'limit': 20},
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Bookings().GetBookingCustomObjectsInstances(context.Background(), "BOOKING_ID", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

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

Another path to List a booking’s custom objects: it returns the same body, one page under data. 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.

Path Parameters

booking_id

string

required

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

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 custom objects under data.

data

object[]

Show child attributes

object

string

pagination

object

Show child attributes

url

string

Guides

API reference

List a booking's custom objects (alternate path)

Authorizations

Path Parameters

Query Parameters

Response