Skip to main content
GET
List Custom Field Keys
customFields is free-form, so nothing tells you which keys a workspace already uses. This returns the ones in use with a count, so you can write the right key in PATCH /api/leads/{id} instead of guessing and creating a near-duplicate.

Authentication

Pass your workspace API key as a Bearer token, or use a Clerk session token.

Example

Success (200 OK)

This is a sample, not an exhaustive index. The scan is bounded to keep it cheap on large workspaces: at most 2,000 lead documents are inspected and at most 200 keys returned. A rarely-used key may be missing from the list — and it still works. customFields accepts any key, and {cf:Anything} resolves at send time whether or not it appears here.

Response

object[]
Custom-field keys found in the sample.
On an internal error this endpoint returns 200 with { "keys": [] } rather than failing — it is a discovery aid, and an empty list must not break a page that calls it.

Errors