Getting Custom Object List
Fucntion: account_custom_objects_list()
Purpose
This SDK function retrieves a list of all custom objects associated with a specific account. It sends a request to the backend using a valid authentication token and fetches the metadata for each custom object defined at the account level.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string | Unique identifier of the account being queried. |
Use Case
This function is useful when developers or administrators need to view all custom objects configured for a specific account. For example, in configuration dashboards or dynamic form builders, this data can be used to render and link custom schemas. The response includes metadata such as UUID, name, entity type, and values link.
def account_custom_objects_list():
SDKConfig.PRINT_REQUEST_DATA = True
SDKConfig.PRINT_RAW_RESPONSE = False
token_file_path = "shared_token.json"
file_token_mgr = FileTokenManager(token_file_path)
exsited_sdk: ExsitedSDK = ExsitedSDK().init_sdk(
request_token_dto=CommonData.get_request_token_dto(),
file_token_mgr=file_token_mgr
)
try:
response = exsited_sdk.custom_objects_in_account.account_list(id='7O8DW7')
print(response)
return response
# ResponseToObj().process(response=response["accounts"][0])
except ABException as ab:
print(ab)
print(ab.get_errors())
print(ab.raw_response)public function account_custom_objects_list()
{
$id ="7O8DW7";
try {
$response = $this->accountService->readCustomObject($id,'v3');
echo '<pre>' . json_encode($response, JSON_PRETTY_PRINT) . '</pre>';
} catch (Exception $e) {
echo 'Error: ' . $e->getMessage();
}
}Response
Returns a list of custom objects belonging to the account, each with UUID, name, entity type, and a values link to fetch detailed data. On failure (invalid token, permission error, etc.), an ABException is raised, returning detailed error information and raw response.
CustomObjectsListDTO(
customObjects=[
CustomObjectDataDTO(
uuid='76f070f4-8cca-4f8e-8e81-f6da735cb66d',
name='custom_object_1',
entity='account',
type='one_to_one',
values='https://dev-api.exsited.com/api/v2/accounts/7O8DW7/custom_objects/76f070f4-8cca-4f8e-8e81-f6da735cb66d',
createdBy=None,
createdOn=None,
lastUpdatedBy=None,
lastUpdatedOn=None,
link=None,
version=None,
attributes=None
)
]
){
"custom_objects": [
{
"uuid": "76f070f4-8cca-4f8e-8e81-f6da735cb66d",
"name": "custom_object_1",
"entity": "account",
"type": "one_to_one",
"values": "https:\/\/dev-api.exsited.com\/api\/v2\/accounts\/7O8DW7\/custom_objects\/76f070f4-8cca-4f8e-8e81-f6da735cb66d"
}
],
"autobillCredential": {
"apiUrl": "https:\/\/dev-api.exsited.com\/api\/v3\/accounts\/7O8DW7\/custom_objects",
"appUrl": null,
"ClientId": "DTgOBjoFCTsCCDU3DAY5OWUCBwsKNgIJOgs6Ag0KDgcCCjg3CTkLBwYKBzo3Ag4FBwwCBQwKBjg=",
"ClientSecret": "NmE3L2MuMmQrL2YyYWJgMjErNDViYysyMjU3K2BiNTcrMWI3YDEvZF81NzEzKzcuMDUrYTY3M2E=",
"file_path": "C:\\Users\\saeedullah\\Desktop\\PROJECTS\\exsited\\php-sdk\\exsited-app-sdk-php\/token.json"
}
}Getting Custom Object Instance
Function: account_custom_objects_uuid_details()
Purpose
This SDK function retrieves a single custom object instance for a given account and object UUID. It helps fetch both the metadata and current values (attributes) of the object instance.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
String | The unique ID of the account. |
co_uuid |
String | The UUID of the custom object instance. |
Use Case
Use this function to fetch the stored data for a specific custom object instance useful for pre-filling forms, displaying saved configurations or integrating custom data in workflow automation.
def account_custom_objects_uuid_details():
SDKConfig.PRINT_REQUEST_DATA = True
SDKConfig.PRINT_RAW_RESPONSE = False
token_file_path = "shared_token.json"
file_token_mgr = FileTokenManager(token_file_path)
exsited_sdk: ExsitedSDK = ExsitedSDK().init_sdk(
request_token_dto=CommonData.get_request_token_dto(),
file_token_mgr=file_token_mgr
)
try:
response = exsited_sdk.custom_objects_in_account.account_co_details_uuid(id='7O8DW7', uuid='76f070f4-8cca-4f8e-8e81-f6da735cb66d')
print(response)
return response
# ResponseToObj().process(response=response["accounts"][0])
except ABException as ab:
print(ab)
print(ab.get_errors())
print(ab.raw_response)public functionaccount_custom_objects_uuid_details()
{
$id = "7O8DW7";
$customObjectUUID = "76f070f4-8cca-4f8e-8e81-f6da735cb66d";
try {
$response = $this->accountService->readCustomObjectDetails($id,$customObjectUUID,'v3');
echo '<pre>' . json_encode($response, JSON_PRETTY_PRINT) . '</pre>';
} catch (Exception $e) {
echo 'Error: ' . $e->getMessage();
}
}Response
Returns a single custom_object with metadata like UUID, creator info, timestamps, and an attributes array with name–value pairs. On failure, an ABException is thrown, exposing error details and the raw backend response.
CustomObjectsDetailsDTO(
customObject=CustomObjectDataDTO(
uuid='f23b13b8-e5bd-4132-b7e6-bfda41c4b5e2',
name=None,
entity=None,
type=None,
values=None,
createdBy='Implementer',
createdOn='2025-08-06T02:40:18Z',
lastUpdatedBy='',
lastUpdatedOn='',
link='https://dev-api.exsited.com/api/v2/accounts/7O8DW7/custom_objects_instances/f23b13b8-e5bd-4132-b7e6-bfda41c4b5e2',
version='',
attributes=[
CustomAttributesDTO(
name='my_name',
value='saeed'
)
]
)
){
"custom_object": {
"uuid": "f23b13b8-e5bd-4132-b7e6-bfda41c4b5e2",
"created_by": "Implementer",
"created_on": "2025-08-06T02:40:18Z",
"last_updated_by": "",
"last_updated_on": "",
"link": "https:\/\/dev-api.exsited.com\/api\/v2\/accounts\/7O8DW7\/custom_objects_instances\/f23b13b8-e5bd-4132-b7e6-bfda41c4b5e2",
"version": "",
"attributes": [
{
"name": "my_name",
"value": "saeed"
}
]
},
"autobillCredential": {
"apiUrl": "https:\/\/dev-api.exsited.com\/api\/v3\/accounts\/7O8DW7\/custom_objects\/76f070f4-8cca-4f8e-8e81-f6da735cb66d",
"appUrl": null,
"ClientId": "DTgOBjoFCTsCCDU3DAY5OWUCBwsKNgIJOgs6Ag0KDgcCCjg3CTkLBwYKBzo3Ag4FBwwCBQwKBjg=",
"ClientSecret": "NmE3L2MuMmQrL2YyYWJgMjErNDViYysyMjU3K2BiNTcrMWI3YDEvZF81NzEzKzcuMDUrYTY3M2E=",
"file_path": "C:\\Users\\saeedullah\\Desktop\\PROJECTS\\exsited\\php-sdk\\exsited-app-sdk-php\/token.json"
}
}