leads

List /leads

Search leads. Matches company, company code, contact name, email, or phone (optional query). Supports pagination and filters: lead types/groups (UUID or code_name), status, source, assignees, country, city, date range, and custom views (lost, junk, etc.). Items use uuid only. Response: items and pagination.

GET

/leads

List /leads

curl --request GET \
  --url 'https://default.hannacrm.app/api/v4/leads?query=%3Cstring%3E&page=123&per_page=123&filter%5Bupdated_since%5D=2023-11-07T05%3A31%3A56Z&filter%5Bcreated_since%5D=2023-11-07T05%3A31%3A56Z&filter%5Blead_types%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Blead_groups%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bstatus%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bsource%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bresponsible%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bcountries%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bcity%5D=%3Cstring%3E&filter%5Bcustom_view%5D=%3Cstring%3E&filter%5Bperiod%5D=%3Cstring%3E&filter%5Buuid%5D=%3Cstring%3E&filter%5Bcreated_by%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bupdated_by%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bcreated_at%5D=%3Cstring%3E&filter%5Bupdated_at%5D=%3Cstring%3E&sort=%3Cstring%3E&fields=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "city": "<string>",
      "company": "<string>",
      "company_code": "<string>",
      "country": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "dateadded": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "lead_categories": [
        {}
      ],
      "lead_types": [
        {}
      ],
      "name": "<string>",
      "organization": [
        {}
      ],
      "phone": "<string>",
      "source": {
        "code_name": "<string>",
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "source_name": "<string>",
      "status": {
        "color": "<string>",
        "name": "<string>",
        "uuid": "<string>"
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "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 for company, company code, name, email, or phone.

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 <= 50

filter[updated_since]stringquery

Return only records whose updated_at is at or after this ISO 8601 timestamp (e.g. 2026-08-11T00:00:00Z). Intended for incremental polling.

filter[created_since]stringquery

Return only records whose created_at is at or after this ISO 8601 timestamp (e.g. 2026-08-11T00:00:00Z). Intended for polling new records.

filter[lead_types]string[]query

Lead type UUIDs or code_name values (customer types).

filter[lead_groups]string[]query

Lead group / category UUIDs or code_name values.

filter[status]string[]query

Lead status UUIDs or code_name values.

filter[source]string[]query

Lead source UUIDs or code_name values.

filter[responsible]string[]query

Assignee staff UUIDs.

filter[countries]string[]query

Country UUIDs.

filter[city]stringquery

City names (exact match).

filter[custom_view]stringquery

Additional views: lost, junk, not_assigned, public, contacted_today, created_today.

filter[period]stringquery

Created date range (Y-m-d).

filter[uuid]stringquery

Record UUIDs. Use it to fetch several known records in one call.

filter[created_by]string[]query

Staff UUID who created the record.

filter[updated_by]string[]query

Staff UUID who last changed the record. Empty until the record is saved once after 2026-09.

filter[created_at]stringquery

Created date range (YYYY-MM-DD - YYYY-MM-DD). Use created_since for one-sided incremental polling.

filter[updated_at]stringquery

Last change date range (YYYY-MM-DD - YYYY-MM-DD). Use updated_since for one-sided incremental polling.

sortstringquery

Optional sort order, comma-separated; prefix a field with - for descending (e.g. sort=-updated_at); empty values sort last. Sortable fields: city, company, company_code, created_at, dateadded, email, name, phone, updated_at, uuid. Default when omitted: -dateadded.

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