Retrieve a custom object with its instances

cURL

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

from exsited import build_client

client = build_client()

response = client.accounts.get_account_custom_object(
    "ACC0001", "co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b", {"limit": 20}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.accounts.getAccountCustomObject('ACC0001', 'co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b', {
    limit: 20,
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->accounts->getAccountCustomObject(
    'ACC0001',
    'co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b',
    ['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.accounts.accounts_dto.AccountsDto.AccountCustomObject;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<AccountCustomObject> response = client.accounts().getAccountCustomObject(
        "ACC0001",
        "co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Accounts.GetAccountCustomObjectAsync(
    "ACC0001",
    "co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.accounts.getAccountCustomObject(
  'ACC0001',
  'co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b',
  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.Accounts().GetAccountCustomObject(context.Background(), "ACC0001", "co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

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

GET

accounts

{account_id}

custom_objects

{custom_object_id}

cURL

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

from exsited import build_client

client = build_client()

response = client.accounts.get_account_custom_object(
    "ACC0001", "co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b", {"limit": 20}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.accounts.getAccountCustomObject('ACC0001', 'co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b', {
    limit: 20,
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->accounts->getAccountCustomObject(
    'ACC0001',
    'co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b',
    ['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.accounts.accounts_dto.AccountsDto.AccountCustomObject;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<AccountCustomObject> response = client.accounts().getAccountCustomObject(
        "ACC0001",
        "co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Accounts.GetAccountCustomObjectAsync(
    "ACC0001",
    "co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.accounts.getAccountCustomObject(
  'ACC0001',
  'co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b',
  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.Accounts().GetAccountCustomObject(context.Background(), "ACC0001", "co_5d2a8f1c3b7e4a9d8c6b1e2f3a4d5c6b", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

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

Name the custom object by its co_ id. The account’s instances come in instances, paged by the pagination inside custom_object.

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

account_id

string

required

The account's id, such as ACC0001. Not its uuid.

custom_object_id

string

required

The custom object's co_ id.

Query Parameters

limit

integer

The most instances to return on one page.

Example:

20

cursor

string

The pagination.next_cursor from the previous page, to fetch the next page.

Response

200 - application/json

The custom object, under custom_object.

custom_object

object

A custom object with this account's instances of it, which are paged inside it.

Show child attributes

Guides

API reference

Retrieve a custom object with its instances

Authorizations

Path Parameters

Query Parameters

Response