Skip to main content
GET
List Custom Objects

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId
string<uuid>
required

Company identifier

objectType
string
required

Custom object type in snake_case format (e.g., vehicle, building_info)

Query Parameters

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
updatedAt,
displayName
sortDirection
enum<string>
default:desc

Sort direction (default desc)

Available options:
asc,
desc
page
integer
default:1

Page number (1-based, default 1, page size 50)

Required range: x >= 1

Response

Paginated list of custom objects

items
object[]
totalCount
integer

Total number of matching custom objects across all pages