Skip to content
LeadMCPDocs

List column values

GET/contacts/schema/{column}/values

Returns the allowed slugs of one closed-list column, or the observed values of an open list column (city, region, skills). A column that identifies a person has no values route and is answered as not found. Free.

FreeFree.

Returns the allowed slugs of one closed-list column, or the observed values of an open list column (city, region, skills). A column that identifies a person has no values route and is answered as not found. Free.

Parameters

columnstringin pathrequired

The column name, as GET /contacts/schema prints it, for example seniority.

qstringin queryoptional

An optional search string that filters the values by slug or by label.

limitintegerin queryoptional

The maximum number of values to return. The default is 100. Default 100.

Response

The fields inside data. The values of the column. An open list comes most common first. A closed list comes in its published order, with count null.

valuestringrequired

The canonical slug. Slugs never change.

labelstringrequired

The display label. A label may change, so never store it.

countinteger or nulloptional

How many rows carry the value, or null when it was not computed.

Failures

StatusMeaning
400The request shape, a filter key, a value, a cursor or the enrichment mode was rejected.
401The credential is missing, unknown or revoked.
404The id or the column does not exist, or the row was opted out.
429The key passed 300 requests a minute or 2 concurrent requests.
503The data is unavailable for a short time.