Skip to Content
CallMitraDocs
API referenceLeads

List custom lead fields

Every custom field defined in the workspace. Send values for these keys in a lead's `attributes` object on createLead and updateLead; pushLead takes them as top-level fields. `valueType` says how they are stored and compared in audience rules.

GET
/api/v1/lead-fields/catalog

Every custom field defined in the workspace. Send values for these keys in a lead's attributes object on createLead and updateLead; pushLead takes them as top-level fields. valueType says how they are stored and compared in audience rules.

Authorization

headerX-API-Key<token>

Create in the console: Settings → API & webhooks.

Response Body

OK

application/json
  1. response

Every custom lead field of the workspace, by label.

fields*array<>

Field definitions, sorted by label.

[key: string]?any
Example Request
curl -X GET 'https://api.callmitra.ai/api/v1/lead-fields/catalog'
Example Response
{  "fields": [    {      "id": "6f1c2a9e-3b7d-4e21-9c55-0d8a7b3e4f10",      "key": "city",      "label": "City",      "valueType": "text"    }  ]}