Basker Docs

List Custom Object Definitions

Retrieve a paginated list of Custom Object Definitions. Rate limit: 100 requests per minute per API key.

A custom object definition describes the shape of a custom object — its label, handle, icon, and the fields its entries can hold. This resource is accessed at /custom-object-definitions. The entries themselves are returned by the custom object instances endpoints.

GET
/{version}/{tenant}/custom-object-definitions
Authorization<token>

Use format: users API-Key YOUR_API_KEY

In: header

Path Parameters

version*string

API version

Default"2026-02"
Value in"2026-02"
tenant*string

Tenant slug

Query Parameters

limit?integer

Number of items to return

Default10
page?integer

Page number

Default1
sort?string

Sort field (prefix with - for descending)

where?object

Query filters

select?

Field selection object. Example query: select[slug]=true&select[updatedAt]=true

populate?

Relationship population object. Example query: populate[media][url]=true

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",
      "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."
}