v2

latestOpenAPI 3.0.02026-08-08112115411.4 KB

Leads

Get the fields for a lead

Get the list of fields that can possibly be associated with leads, along with whether they are valid for filtering sorting.

get/leads/list/fields

Response

Lead fields

Example response

{
  "properties": {
    "exampleProperty": {
      "type": "string",
      "title": "Example Property",
      "description": "This is an example property",
      "isFilterable": true,
      "isDisplayable": true,
      "isSortable": true,
      "isAddable": true,
      "isBoardable": true,
      "isNullable": true,
      "relationships": [
        "users",
        "teams"
      ],
      "enum": [
        "Option1",
        "Option2"
      ],
      "format": "uri"
    }
  }
}