Bulk Read Custom Fields

get

https://{protocol}://{base-url}/integration/v2/custom_field/

This endpoint can be used to list all Custom Fields. Deleted Custom Fields are ignored.

Query Params

allow_multiple

boolean

Filter by allow_multiple. Used only for OBJECT_SET fields (Object Sets, People Sets, and References). Set to true to get Object Set and People Set fields or false to get Reference fields.

field_type

string

enum

Filter by field_type.

Allowed:

integer

≥ 1

Filter by Custom Field ID. Multiple IDs can be specified using the format ?id=3&id=4.

limit

integer

≥ 1

Defaults to 100

The number of items to return.

name_plural

string

length ≤ 255

Filter by an exact match on name_plural.

name_plural__contains

string

length ≤ 255

Filter by a case-sensitive substring on name_plural.

name_plural__icontains

string

length ≤ 255

Filter by a case-insensitive substring on name_plural.

name_singular

string

length ≤ 255

Filter by an exact match on name_singular.

name_singular__contains

string

length ≤ 255

Filter by a case-sensitive substring on name_singular.

name_singular__icontains

string

length ≤ 255

Filter by a case-insensitive substring on name_singular.

skip

integer

Defaults to 0

The number of items to skip.

order_by

string

enum

Sort by a specified property:

field_type - Ordering: TEXT, DATE, PICKER, OBJECT_SET, RICH_TEXT, MULTI_PICKER
-field_type - Ordering: MULTI_PICKER, RICH_TEXT, OBJECT_SET, PICKER, DATE, TEXT
id - Ascending by id
-id - Descending by id
name_plural - A to Z, by name_plural
-name_plural - Z to A, by name_plural
name_singular - A to Z, by name_singular
-name_singular - Z to A, by name_singular

tooltip_text

string

length ≤ 255

tooltip_text__contains

string

length ≤ 255

tooltip_text__icontains

string

length ≤ 255

values

string

A comma-separated sub-set of properties to select for each item.

Responses

Language

Credentials

Header

URL

Loading…

Response

Choose an example:

application/json

200Requested Custom Fields

400Malformed Request

401Unauthorized bad/missing token

403Forbidden User cannot edit this resource

404The specified resource was not found

500Internal Server Error