List Custom Object Definitions
Retrieve the labels, handles, icons, and field definitions for custom-object types. Use custom object instances to read the records created from those definitions. Rate limit: 100 requests per minute per API key.
Authorization
apiKey Use format: users API-Key YOUR_API_KEY
In: header
Path Parameters
API version
"2026-02""2026-02"Tenant slug
Query Parameters
Number of items to return
10Page number
1Sort field (prefix with - for descending)
Query filters
Field selection object. Example query: select[slug]=true&select[updatedAt]=true
Relationship population object. Example query: populate[media][url]=true
Relationship population depth.
0 <= valueContent locale, or all to return every locale.
Locale to use when the requested locale has no value.
When true, read or write the draft version.
falseControls pagination, sorting, filtering, and counts for joined fields.
Set false to return every matching record without page-based pagination.
trueFilters configured custom attributes by public key and operator.
Advanced where-operator options.
Response Body
application/json
application/json
curl -X GET "https://api.basker.app/partners/2026-02/string/custom-object-definitions?select%5Bslug%5D=true&select%5BupdatedAt%5D=true&populate%5Bmedia%5D=%5Bobject+Object%5D"{
"docs": [
{
"description": "string",
"fieldDefinitions": [
{}
],
"handle": "string",
"icon": "string",
"label": "string"
}
],
"totalDocs": 0,
"limit": 0,
"totalPages": 0,
"page": 0,
"pagingCounter": 0,
"hasPrevPage": true,
"hasNextPage": true,
"prevPage": 0,
"nextPage": 0
}{
"error": "Too Many Requests",
"message": "Rate limit exceeded. Please retry later."
}