Skip to main content

List custom fields

GET 
/api/custom-fields
warning

Requires "Custom Fields" feature to be enabled.

Request​

Query Parameters

    domain string

    Possible values: [project_plan]

    Filter items by the domain field.

    include string

    Possible values: [options]

    Include one or more relations in the response, separated by commas.

    When available, use dot-notation to retrieve nested relations.

    You can request any level of a nested relation, (e.g. relation or relation.nested or relation.nested.deeplyNested).

    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}

    archived string

    Possible values: [exclude, include, only]

    Default value: include

    Filter items by archival status.

    archived_at date-time

    Filter items by the archived_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 fields.

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 name

    description string

    The custom field description

    type stringrequired

    The custom field type

    domain stringrequired

    The domain the custom field is bound to

    required booleanrequired

    Whether a value is required for this custom field

    sort integerrequired

    The sort position of the custom field

    options

    object[]

    The list of options of this custom field. Only available when type is single_option, status or multi_select.

  • 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

  • ]

    • archived_at date-time

    The date and time when the resource was archived

    deleted_at date-time

    The date and time when the resource was deleted

  • ]

Loading...