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 whose contact row no longer exists 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; id_greater and id_less do not change it. For a user outside the Admin group calling the API directly, only values of fields available on one of the user's lists (or on all lists) are returned. Without orders, id_greater or id_less, the order is not defined. Values that are equal under orders[fieldid] or orders[val] also come back in no defined order; send orders[id] last to make it stable. To read a large set, page by id instead of by offset: a large offset gets slower with every page, while each id_greater page costs the same however far in.

{
    "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 created after this date or time. The bound is exclusive. Any date or datetime that PHP's strtotime reads works, such as 2026-04-01, 04/01/2026 or 2026-04-01T13:45:10-05:00; a blank or unreadable value returns a 400. Same name and parsing as GET /contacts. It narrows meta.total as well as the page.

string

Return only values created before this date or time. The bound is exclusive. Any date or datetime that PHP's strtotime reads works, such as 2026-04-01, 04/01/2026 or 2026-04-01T13:45:10-05:00; a blank or unreadable value returns a 400. Same name and parsing as GET /contacts. It narrows meta.total as well as the page.

string

Return only values last updated after this date or time. The bound is exclusive. Any date or datetime that PHP's strtotime reads works, such as 2026-04-01, 04/01/2026 or 2026-04-01T13:45:10-05:00; a blank or unreadable value returns a 400. Same name and parsing as GET /contacts. It narrows meta.total as well as the page.

string

Return only values last updated before this date or time. The bound is exclusive. Any date or datetime that PHP's strtotime reads works, such as 2026-04-01, 04/01/2026 or 2026-04-01T13:45:10-05:00; a blank or unreadable value returns a 400. Same name and parsing as GET /contacts. It narrows meta.total as well as the page.

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

Order values by id. ASC or DESC. It is applied after any other orders, because ids are unique. Use it with id_greater or id_less to page by id; sending either of those without orders[id] orders by id ascending.

string

Comma-separated list of fieldValue ids to fetch. Overrides limit; offset still applies.

string

Return only values with an id greater than this number, to page by id instead of by offset: send orders[id]=ASC (or id_greater alone), then send the largest id on the page as id_greater for the next page. Each page costs the same however far in, where a large offset gets slower with every page. A blank or 0 value is ignored; a value that is not a whole number returns a 400. Same name as GET /contacts. It does not change meta.total, which stays the size of the whole filtered collection.

string

Return only values with an id less than this number. To page backwards, send orders[id]=DESC and the smallest id on the page as id_less for the next page. A blank or 0 value is ignored; a value that is not a whole number returns a 400. Same name as GET /contacts. It does not change meta.total.

integer

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

integer

Number of values to skip, for pagination. The deeper the offset, the slower each page is, so page large sets with id_greater instead.

Responses

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