Records
List CRM Records
List paginated records of any custom CRM object in Zeeg by object slug, with sorting and pagination controls for browsing, export, and sync jobs
GET
List CRM records
Returns a paginated list of records for a custom CRM object. Use this endpoint to browse all records for any object you’ve created — products, deals, subscriptions, or any other custom object in your workspace.
The
Keep requesting until
Path parameter
| Parameter | Type | Description |
|---|---|---|
objectSlug | string | The slug of the custom CRM object. Must already exist. Discover available slugs via List CRM Objects. |
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
page | integer | 1 | Page number. Starts at 1. |
perPage | integer | 10 | Number of records returned per page. Maximum is 100. |
sortBy | string | created_at | Attribute slug to sort by. Pass the exact attribute key (e.g. price, sku). Use created_at or updated_at for system timestamps. |
sortOrder | string | asc | Sort direction. Either asc (oldest/lowest first) or desc (newest/highest first). |
Response shape
Each record in therecords array contains:
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Unique identifier for the record. Store this on your side to avoid re-fetching. |
objectSlug | string | The object this record belongs to. |
attributes | object | All attribute values keyed by their attribute slug. Unset attributes are null. |
createdAt | string (ISO 8601) | When the record was created. |
updatedAt | string (ISO 8601) | When the record was last modified. |
pagination wrapper contains:
| Field | Type | Description |
|---|---|---|
totalItems | integer | Total number of records across all pages. |
perPage | integer | Records per page as requested. |
currentPage | integer | The page returned in this response. |
lastPage | integer | Total number of pages. |
hasPreviousPage | boolean | true when a previous page exists. |
hasNextPage | boolean | true when a next page exists. |
Discovering attribute keys
Attribute keys (the keys insideattributes) are defined on the object schema. To see all available attribute slugs and their types, call GET /v2/crm/objects/{slug} before building a UI or processing the response.
Pagination example
To iterate through all records in pages of 50, ordered newest first:hasNextPage is false.
When to use this endpoint
- Browsing — display a table of records in your UI.
- Export — page through all records to write them to another system.
- Sync jobs — poll for recently updated records with
sortBy=updated_at&sortOrder=desc.
Authorizations
Path Parameters
Slug of the custom CRM object.
Query Parameters
Page number.
Required range:
x >= 1Number of records per page.
Required range:
1 <= x <= 100Attribute slug to sort by.
Sort direction.
Available options:
asc, desc Last modified on June 11, 2026