Custom Object Fields
List Custom Object Fields
Lists all undeleted custom fields for the specified object.
Allowed For
- Agents
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
get/api/v2/custom_objects/{custom_object_key}/fields
Path parameters
custom_object_keystring required
The key of a custom object
Query parameters
page[before]string
A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.
page[after]string
A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.
page[size]integer
Specifies how many records should be returned in the response. You can specify up to 100 records per page.
include_standard_fieldsboolean
Include standard fields if true. Exclude them if false
Response
Success response