List custom fields

GET/custom-fields

The workspace's custom fields, in the order Salesteam shows them. Leads carry their values in customFields, by key.

Try itSend a real request with your API key

Answer

200 OK Every custom field.

dataarray of CustomFieldInfoRequired
Each item
- keystringRequired
  What the field is called in customFields and in messages: {{custom.<key>}}. It never changes, even when the field is renamed.
- namestringRequired
- typestringRequired
  One of text, select, multi_select, number, date, url.
- typeLabelstringRequired
  The type as Salesteam shows it, such as Single select.
- optionsarray of stringRequired
  The choices of a Single select or Multi-select field; empty for other types.
nextCursorstring or nullRequired
Pass as cursor for the next page; null on the last page.

Errors

401 Unauthorizedunauthorized
429 Too many requestsrate_limited
500 Server errorserver_error

Every error has the same shape. See Errors.

GET /custom-fields

curl "https://app.salesteam.dev/api/v1/custom-fields" \
  -H "Authorization: Bearer $SALESTEAM_API_KEY"

const response = await fetch("https://app.salesteam.dev/api/v1/custom-fields", {
  headers: {
    Authorization: `Bearer ${process.env.SALESTEAM_API_KEY}`,
  },
});
console.log(response.status, await response.json());

import os
import requests

response = requests.get(
    "https://app.salesteam.dev/api/v1/custom-fields",
    headers={"Authorization": f"Bearer {os.environ['SALESTEAM_API_KEY']}"},
)
print(response.status_code, response.json())

200 answer

{
  "data": [
    {
      "key": "service_word",
      "name": "Service word",
      "type": "select",
      "typeLabel": "Single select",
      "options": [
        "ads",
        "marketing",
        "PR"
      ]
    }
  ],
  "nextCursor": null
}