/api/v1/object/field/managerList every field in the workspace, one page at a time.
List every field in the workspace, one page at a time.
Returns one row per field definition across all objects, ordered by
object name, then field order. object_slug is the object that owns the
field. shared_with lists the other objects it is shared into, and
usage_count is 1 plus that number. Rows carry flags such as
has_default_value instead of the field's settings; read one field for
its full settings.
Query parameters:
page— page number, from 1. Default1.limit— page size, 1 to 200. Default50.search— keep fields whose name or label contains this text, ignoring letter case.types— keep these field types:types=select,statusor repeatedtypes=select&types=status.object_slug— keep the fields of one object, including fields shared into it.shared_only—truekeeps only fields shared into other objects.system—falseleaves out system fields. Defaulttrue.
Scope: object.read.
Errors:
400—object_slugnames no active object.422— a query parameter is invalid, for example an unknown type.
Response 200:
{
"status": 200,
"message": "Workspace fields retrieved successfully",
"data": [
{
"slug": "phone-q8w2e4r6",
"name": "phone",
"label": "Phone",
"icon": null,
"type": "phone",
"required": false,
"is_active": true,
"is_system": false,
"sort_order": 3,
"api_only": false,
"object_slug": "contacts",
"object_name": "Contacts",
"has_default_value": false,
"has_conditional_requirement": false,
"is_shared": false,
"shared_with": [
{ "slug": "deals", "name": "Deals" }
],
"usage_count": 2,
"created_at": "2026-08-02T08:30:00.000Z",
"updated_at": "2026-09-01T11:15:00.000Z"
}
],
"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
{
"slug": "string",
"name": "string",
"label": "string",
"icon": "string",
"type": "string",
"required": true,
"is_active": true,
"is_system": true,
"sort_order": 1.5,
"api_only": true,
"object_slug": "string",
"object_name": "string",
"has_default_value": true,
"has_conditional_requirement": true,
"is_shared": true,
"shared_with": [
"string"
],
"usage_count": 1.5,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}Value-write lock — renders the "API only" chip beside the "System" one.
Owning Unit (the object the field definition belongs to).
Presence flag only — the value itself is not a governance concern.
1 (owning Unit) + number of placements — "used in N locations".
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