List company custom field definitions

Returns the workspace custom field definitions available for companies.

GET /companies/custom-fields

List company custom field definitions

cURL

curl --request GET \
  --url https://app.leonar.app/api/v1/companies/custom-fields \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "cf2b8df3-1c85-4e5d-8f50-0c10b3994e90",
      "key": "crm_tier",
      "label": "CRM Tier",
      "type": "select",
      "options": [
        {
          "value": "enterprise",
          "label": "Enterprise"
        },
        {
          "value": "mid_market",
          "label": "Mid-market"
        }
      ],
      "is_required": false,
      "position": 0
    }
  ],
  "meta": {
    "total": 142,
    "limit": 50,
    "offset": 0,
    "has_more": true
  }
}

Authorizations

Authorization · string · header · required

API key starting with leo_

Response

200

application/json

List of company custom field definitions

data · object[]

Show child attributes

meta · object

Show child attributes

Example:

{
  "total": 142,
  "limit": 50,
  "offset": 0,
  "has_more": true
}