Skip to main content

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 integer[]

    IDs of custom fields to fetch.

    Example: [1, 2]
    field_type string

    Type of field to fetch. Value must be one of: person, company, opportunity

    Example: company
    value_type string

    Value type of fields to fetch. Value must be one of: text, date, datetime, picklist, user_reference

    Example: text
    sort_by string

    Key to sort on, must be one of: created_at, updated_at, name. Defaults to updated_at

    sort_direction string

    Direction to sort in, must be one of: ASC, DESC. Defaults to DESC

    per_page integer

    How many records to show per page in the range [1, 100]. Defaults to 25

    page integer

    The current page to fetch results from. Defaults to 1

    include_paging_counts boolean

    Whether to include total_pages and total_count in the metadata. Defaults to false

    limit_paging_counts boolean

    Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data

Responses​

Success

Schema
    id integer

    ID of Custom Field

    name string

    Name of the Custom Field

    field_type string

    Type of the Custom Field. Value must be one of: person, company, opportunity.

    value_type string

    Value Type of the Custom Field. Value must be one of: text, date.

    created_at date-time

    Datetime of when the Custom Field was created

    updated_at date-time

    Datetime of when the Custom Field was last updated

Loading...