Skip to contentSkip to navigation

List Lead Fields

List the workspace's lead custom fields.

GET /api/v1/lead-fields

Defined fields come first, in their order, then keys that leads carry without a definition (from imports or the API), sorted by name, with defined: false.

Response

data object[]

Field objects, see Create Lead Field for the shape.

Rate Limit

  • 300 requests per minute, shared by every read call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (read).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Was this page helpful?