/api/v1/objectList objects, one page at a time.
List objects, one page at a time.
Returns the objects whose records the credential can read
(read.<object slug>). A credential with object.read gets every object.
Results are ordered active first, then by sort_order, then newest first.
Items carry the listed fields only; is_system, is_public, options
and updated_at are not included here. It needs no scope.
Query parameters:
page— page number, from 1. Default1.limit— page size, 1 to 200. Default50.search— keep objects whose name, slug or description contains this text, ignoring letter case. At most 100 characters.is_active—trueorfalseto keep only active or inactive objects.
Errors:
422— a query parameter is invalid, for examplelimitabove 200.
Response 200:
{
"status": 200,
"message": "Objects retrieved successfully",
"data": [
{
"id": 37,
"name": "Contacts",
"slug": "contacts",
"icon": "tabler-users",
"description": "People we sell to",
"permission_name": "contacts",
"is_active": true,
"sort_order": 2,
"created_at": "2026-07-20T09:12:44.000Z",
"folder_slug": null,
"default_view_slug": null,
"default_view_type": null
}
],
"pagination": {
"total": 1,
"page": 1,
"limit": 50,
"totalPages": 1,
"nextPage": null,
"prevPage": null
}
}
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
Successful response
{
"id": 1.5,
"name": "string",
"slug": "string",
"icon": "string",
"description": "string",
"permission_name": "string",
"is_active": true,
"sort_order": 1.5,
"is_system": true,
"is_public": true,
"options": "string",
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z",
"folder_slug": "string",
"default_view_slug": "string",
"default_view_type": "string"
}Bad request
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Unauthorized
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Internal server error
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Powered by heyo-docs