picklists

List /picklists

List picklists (optional query matches name, codename, and module; optional filter[module]). Each item includes uuid, module, name, and codename. Response: items and pagination.

GET

/picklists

List /picklists

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

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

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

querystringquery

Optional search phrase (matches name, codename, and module).

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

CRM module slug (e.g. tasks, contacts).

sortstringquery

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

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