Skip to main content

List custom field options

GET 
/api/custom-field-options
warning

Requires "Custom Fields" feature to be enabled.

Request​

Query Parameters

    custom_field_id integer

    Possible values: >= 1

    Filter items by the custom_field_id field.

    order string

    Possible values: [name, sort]

    Order the results by one or more attributes, separated by commas.

    Prefix an attribute with - for descending order or + for ascending order.

    If no prefix is provided, the default order is ascending.

    search string

    Search for entities by a specific string.

    limit integer

    Possible values: >= 1 and <= 100

    Default value: 100

    The number of items to include in the response.

    offset integer

    Default value: 0

    The offset of the first returned item.

    updated_at date-time

    Filter items by the updated_at field.

    Operators:

    Usage: eq:{value}

    deleted string

    Possible values: [exclude, include, only]

    Default value: exclude

    Filter items by deletion status.

    deleted_at date-time

    Filter items by the deleted_at field.

    Operators:

    Usage: eq:{value}

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Returns the list of custom field options.

Schema

  • Array [

    • id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    name stringrequired

    Possible values: <= 255 characters

    The custom field option name

    color string

    The hex color code of the option

    sort integerrequired

    The sort position of the option

    custom_field_id integerrequired

    The id of the custom field this option belongs to

    deleted_at date-time

    The date and time when the resource was deleted

  • ]

Loading...