Custom Objects

List custom objects with filtering and sorting

POST https://{tenant}.atomicwork.com/api/v1/custom-objects/{objectTypeId}/list

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Path Parameters

objectTypeIdpathintegerrequired

The object type ID to scope results to

Body

filtersbodyarray of object

Optional filter conditions

properties

sortbodyenum (string)

Sort order for custom object list view results

Allowed valuesCREATED_AT_ASCCREATED_AT_DESCUPDATED_AT_ASCUPDATED_AT_DESCDISPLAY_ID_ASCDISPLAY_ID_DESC

scopebodyenum (string)

Scope of the object type (GLOBAL or WORKSPACE)

Allowed valuesGLOBALWORKSPACE

workspace_idbodyinteger

Workspace ID for cross-type queries. Required when scope=WORKSPACE in cross-type list calls (when objectTypeId is absent).

pagebodyinteger

Page number (1-based)

page_sizebodyinteger

Number of records per page

Response

200

Successful response

cURL

curl -X POST 'https://{tenant}.atomicwork.com/api/v1/custom-objects/{objectTypeId}/list' \
  -H 'X-Api-Key: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"filters": [{"attribute": "string", "operator": "EQUALS", "values": ["\u2026"]}], "sort": "CREATED_AT_ASC", "scope": "GLOBAL", "workspace_id": 0, "page": 0, "page_size": 0}'