Skip to main content
GET
List contact attribute keys

Authorizations

next-auth.session-token
string
cookie
required

NextAuth session JWT cookie. Development: often next-auth.session-token. Production (HTTPS): often __Secure-next-auth.session-token. Send the cookie your browser receives after sign-in.

Query Parameters

workspaceId
string<cuid2>
required

Workspace identifier. This is the canonical container ID for v3 APIs.

limit
integer
default:50

Page size (max 250).

Required range: 1 <= x <= 250
cursor
string

Opaque cursor returned as meta.nextCursor from the previous page. Omit on the first request.

includeTotalCount
boolean
default:false

When true, meta.totalCount is the number of keys matching the search and filters across all pages; otherwise it is null.

Case-insensitive substring match over key, name and description.

Maximum string length: 512
filter[dataType][in]
enum<string>[]

Keep only keys with one of these data types. Repeat the parameter or send comma-separated values. Unknown values → 400.

Available options:
string,
number,
date
filter[type][in]
enum<string>[]

Keep only built-in (default) or workspace-defined (custom) keys. Repeat or comma-separate.

Available options:
default,
custom
sortBy
enum<string>

Sort order. name sorts by the display name (falling back to key), case-insensitively. A leading - sorts newest first. Omit for the original order (by id).

Available options:
createdAt,
-createdAt,
name,
updatedAt,
-updatedAt

Response

Contact attribute keys retrieved successfully

data
object[]
required
meta
object
required

A list meta carrying pagination and the filtered total. totalCount is required but nullable, gated on the operation's includeTotalCount parameter.