FOformbricks
V3 Contacts

List distinct values of a contact attribute

Changed on

Returns the distinct, non-empty values one contact attribute takes in a workspace, in ascending order and bounded by limit — for quick-filter value pickers. Not paginated: meta.truncated says whether more values match than were returned, so a picker can ask the user to narrow the search. Number and date attributes return their stored text value. Requires the Contacts entitlement (403 without it). An unknown key → 400. Session cookie, x-api-key, or a Bearer token.

get/api/v3/contacts/attribute-values

Request

  • Base URL
    https://app.formbricks.com
  • URL
    https://app.formbricks.com/api/v3/contacts/attribute-values
  • Auth
    • API key in cookie next-auth.session-token
    • or API key in header x-api-key
    • or HTTP bearer

Query parameters

workspaceIdstring cuid2 required

Workspace identifier.

keystring required

The attribute key (ContactAttributeKeyResource.key).

filter[value][contains]string

Case-insensitive substring match on the value.

limitinteger

Maximum number of values returned (max 100). Not paginated.

Response

Values retrieved successfully

Changes