List contact custom fields

get

https://{youraccountname}.api-us1.com/api/3/fields

Lists custom field definitions for contacts, 20 per page by default, ordered by ordernum then id unless an orders parameter is given. The response side-loads a fieldOptions array with the options of every returned field; ids inside it are field option ids, not field ids, and are only valid on the fieldOptions endpoints, never on /fields/{id}. A fieldRels array side-loads the fields' list relationships. Each field's own options property lists the ids of its options in the side-loaded array. Use only the query parameters documented here: unsupported filter and order fields are silently ignored, so the response looks filtered but is not. filters match exactly; use search for a partial title match. Passing any orders parameter, including an unsupported one, replaces the default ordernum ordering: when no supported orders field is given, the results come back in no guaranteed order. meta.total is the number of matching fields, returned as a string. This endpoint covers contact fields only; deal fields live under dealCustomFieldMeta and account fields under accountCustomFieldMeta.

{
    "fieldOptions": [],
    "fieldRels": [],
    "fields": [
        {
            "title": "Another Test Title",
            "descript": null,
            "type": "",
            "isrequired": "0",
            "perstag": "ANOTHER_TEST_TITLE",
            "defval": null,
            "show_in_list": "0",
            "rows": "0",
            "cols": "0",
            "visible": "1",
            "service": "",
            "ordernum": "2",
            "cdate": "2018-11-15T21:43:38-06:00",
            "udate": "2018-11-15T21:43:38-06:00",
            "options": [],
            "relations": [],
            "links": {
                "options": "https://:account.api-us1.com/api/:version/fields/2/options",
                "relations": "https://:account.api-us1.com/api/:version/fields/2/relations"
            },
            "id": "2"
        },
        {
            "title": "Title",
            "descript": "Field  description",
            "type": "textarea",
            "isrequired": "1",
            "perstag": "PERSONALIZEDTAG",
            "defval": "Defaut Value",
            "show_in_list": "1",
            "rows": "2",
            "cols": "2",
            "visible": "1",
            "service": "google",
            "ordernum": "3",
            "cdate": "2018-11-15T21:42:40-06:00",
            "udate": "2018-11-15T21:49:52-06:00",
            "options": [],
            "relations": [],
            "links": {
                "options": "https://:account.api-us1.com/api/:version/fields/1/options",
                "relations": "https://:account.api-us1.com/api/:version/fields/1/relations"
            },
            "id": "1"
        }
    ],
    "meta": {
        "total": "2"
    }
}

Query Params

limit

int32

Defaults to 20

Number of fields per page. Default 20, maximum 500.

offset

integer

Number of fields to skip, for pagination.

all

string

Pass all=1 to return every field in one response, ignoring limit and offset.

string

Return only fields whose title contains this text (substring match).

filter

string

Comma-separated list of field types; returns only fields of those types. Example: filter=dropdown,listbox.

listfilter

string

Comma-separated list of list ids; returns only fields related to those lists or to all lists.

excludeHidden

string

Pass excludeHidden=1 to omit fields that are hidden in the Form Builder (visible flag 0).

title_or_perstag

string

Return only fields whose title or personalization tag contains this text (substring match).

perstags[]

string

Return only fields whose personalization tag is exactly one of the given values. Repeat the parameter for several tags: perstags[]=FIRSTNAME&perstags[]=LASTNAME.

filters[id]

string

Return only the field with this id. Exact match.

filters[title]

string

Return only fields with exactly this title. For a partial match use search instead.

filters[perstag]

string

Return only fields with exactly this personalization tag. Example: CUSTOMER_GROUP.

filters[type]

string

Return only fields of exactly this type. For several types at once use filter instead.

filters[isrequired]

string

Return only fields whose isrequired flag equals this value (0 or 1).

filters[ordernum]

string

Return only fields with exactly this ordernum. Exact match.

orders[id]

string

Order fields by id. ASC or DESC.

orders[title]

string

Order fields by title. ASC or DESC.

orders[perstag]

string

Order fields by personalization tag. ASC or DESC.

orders[type]

string

Order fields by type. ASC or DESC.

orders[isrequired]

string

Order fields by the isrequired flag. ASC or DESC.

orders[ordernum]

string

Order fields by ordernum. ASC or DESC.

ids[]

string

Field ids to fetch, passed in array form: ids[]=1&ids[]=2. Overrides limit. The comma-separated ids=1,2 form accepted by other endpoints currently fails with a 500 error on this endpoint.

exclude_field_options

string

Pass exclude_field_options=1 to omit the side-loaded fieldOptions array and each field's options ids.

exclude_field_rel

string

Pass exclude_field_rel=1 to omit the side-loaded fieldRels array and each field's relations ids.

formid

string

Return only the custom fields that appear on this form id.

isAi

string

Pass isAi=1 to add an is_ai flag to each field showing whether an AI dynamic-content block uses it.

selected

string

A field id; echoes that field's id, title, and type under meta.selected.

Response

Language

Credentials

Header

URL

Loading…

Response

Choose an example:

application/json

200200