List contact custom field values

Lists stored custom field values across contacts, one entry per contact-and-field pair, 20 per page by default. Each entry's contact property is the contact id, field is the custom field definition id, and value holds the stored text. Use filters[fieldid] to scope to one field, contacts[] to scope to contacts, or GET /contacts/{id}/fieldValues for a single contact's values. Values belonging to deleted contacts are excluded. 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. Date and datetime values are returned in ISO 8601 in the API user's timezone. meta.total is the number of matching values, returned as a string.

{
    "fieldValues": [
        {
            "contact": "5",
            "field": "1",
            "value": "Burger",
            "cdate": "2018-09-29T12:03:11-06:00",
            "udate": "2018-09-29T12:03:11-06:00",
            "links": {
                "owner": "https://:account.api-us1.com/api/3/fieldValues/1/owner",
                "field": "https://:account.api-us1.com/api/3/fieldValues/1/field"
            },
            "id": "1",
            "owner": "5"
        },
        {
            "contact": "7",
            "field": "2",
            "value": "2018-05-10",
            "cdate": "2018-04-24T12:04:46-06:00",
            "udate": "2018-04-24T12:04:46-06:00",
            "links": {
                "owner": "https://:account.api-us1.com/api/3/fieldValues/2/owner",
                "field": "https://:account.api-us1.com/api/3/fieldValues/2/field"
            },
            "id": "2",
            "owner": "7"
        }
    ],
    "meta": {
        "total": "2"
    }
}
Query Params
string

Return only values of this custom field definition id. Exact match.

string

Return only values exactly equal to this text. No partial matching.

string

Return only values of the given custom field definition ids, passed in array form: fields[]=1&fields[]=2. The non-array form fields=1,2 currently fails with a 500 error.

string

Return only values belonging to the given contact ids, passed in array form: contacts[]=1&contacts[]=2. The non-array form contacts=1,2 currently fails with a 500 error.

string

Order values by custom field definition id. ASC or DESC.

string

Order values by the stored text. ASC or DESC.

string

Comma-separated list of fieldValue ids to fetch. Overrides limit.

integer

Number of values per page. Default 20, maximum 100.

integer

Number of values to skip, for pagination.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json