custom_fields

List /custom_fields

List the custom fields defined on this account, so that custom_fields write payloads can use real slugs. Filter by module with filter[module]=leads (API module slug, e.g. leads, clients, tasks).

GET

/custom_fields

List /custom_fields

curl --request GET \
  --url 'https://default.hannacrm.app/api/v4/custom_fields?query=%3Cstring%3E&page=123&per_page=123&filter%5Bmodule%5D=%3Cstring%3E&filter%5Btype%5D=%3Cstring%3E&sort=%3Cstring%3E&fields=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "module": "<string>",
      "name": "<string>",
      "options": [
        "<string>"
      ],
      "required": "<string>",
      "slug": "<string>",
      "type": "<string>",
      "uuid": "<string>"
    }
  ],
  "pagination": {
    "from": 123,
    "last_page": 123,
    "page": 123,
    "per_page": 123,
    "to": 123,
    "total": 123
  },
  "query": "<string>"
}

Each item includes slug (the stable key used when writing custom_fields: [{"slug": "...", "value": ...}]), name (human-readable, translated), type, module, required, and options (allowed values for select / multiselect, empty otherwise). Only active fields are returned. Response: items and pagination.

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Query Parameters

querystringquery

Optional search phrase (matches slug and name).

Minimum string length: 1

pageintegerquery

Page number (1-based).

Required range: 1 <= x

per_pageintegerquery

Number of results per page. limit is accepted as an alias.

Required range: 1 <= x <= 500

API module slug: clients, contacts, contracts, credit_notes, documents, expenses, invoices, items, leads, objects, opportunities, pre_invoices, projects, supplier_orders, tasks, tickets. The internal fieldto name is accepted as well. An unknown value is rejected with 422.

filter[type]stringquery

Field type (e.g. input, textarea, select, multiselect, date_picker, checkbox).

sortstringquery

Optional sort order, comma-separated; prefix a field with - for descending (e.g. sort=-updated_at); empty values sort last. Sortable fields: name, options, required, slug, type, uuid. Default when omitted: fieldto,field_order.

fieldsstring[]query

Optional response field paths (dot notation for nested groups, e.g. billing_address.street; array fields are returned whole). Comma-separated string is also accepted. Identifier field is always included.

Response

Search results

itemsobject[]

Show child attributes

paginationobject

Show child attributes

querystring

Still need help? Ask the team