List custom fields
GET/v2/custom_fields
Fetches multiple custom field records. The records can be filtered, paged, and sorted according to the respective parameters.
Request
Query Parameters
IDs of custom fields to fetch.
Type of field to fetch. Value must be one of: person, company, opportunity
Value type of fields to fetch. Value must be one of: text, date, datetime, picklist, user_reference
Key to sort on, must be one of: created_at, updated_at, name. Defaults to updated_at
Direction to sort in, must be one of: ASC, DESC. Defaults to DESC
How many records to show per page in the range [1, 100]. Defaults to 25
The current page to fetch results from. Defaults to 1
Whether to include total_pages and total_count in the metadata. Defaults to false
Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
Responses
- 200
Success
- application/json
- Schema
- Example (from schema)
Schema
ID of Custom Field
Name of the Custom Field
Type of the Custom Field. Value must be one of: person, company, opportunity.
Value Type of the Custom Field. Value must be one of: text, date.
Datetime of when the Custom Field was created
Datetime of when the Custom Field was last updated
{
"id": 1,
"name": "My Custom Field",
"field_type": "person",
"value_type": "text",
"created_at": "2024-01-01T00:00:00.000000+00:00",
"updated_at": "2024-01-01T00:00:00.000000+00:00"
}