Skip to main content
GET
Describe the lead-generation filter surface and list valid enum values

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Query Parameters

companyId
string

Company ID (optional — this endpoint is free)

describe
boolean

true = filter schema map (all fields + types). Compact unless field/group is set. Recommended first call.

group
string

With describe: scope to one group (location/person/business/financial/housing/contact/intent) and inline its enum options.

field
string

One field. With describe: inline that field's options. Without describe: that enumerated field's values (omit for all).

Response

Filter schema map (with describe) or enum option values

Field name -> schema entry (with describe) or field name -> option values (without)

fields
object

Field name -> schema entry (with describe) or field name -> option values (without).