objects

List /objects

Search objects. Matches name, serial number, address, city, or description (optional query). Supports pagination and filters: status, type, project, contact, active, responsible person, and organization. Each item includes uuid, status, type, contact, and related references as UUID JSON objects. Response: items and pagination.

GET

/objects

List /objects

curl --request GET \
  --url 'https://default.hannacrm.app/api/v4/objects?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%5Bstatus%5D=%3Cstring%3E&filter%5Btype%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bproject%5D=%3Cstring%3E&filter%5Bcontact%5D=%3Cstring%3E&filter%5Bactive%5D=123&filter%5Bresponsible_person%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Borganization%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&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": [
    {
      "active": "<string>",
      "address": "<string>",
      "city": "<string>",
      "contact": [
        {}
      ],
      "contact_person": [
        {}
      ],
      "contract": [
        {}
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "description": "<string>",
      "installation_date": "2023-11-07T05:31:56Z",
      "latitude": "<string>",
      "lead": [
        {}
      ],
      "longitude": "<string>",
      "name": "<string>",
      "note": "<string>",
      "organization": [
        {}
      ],
      "organization_name": "<string>",
      "project": [
        {}
      ],
      "responsible_person": [
        {}
      ],
      "serial_no": "<string>",
      "status": [
        {}
      ],
      "subdivision": [
        {}
      ],
      "type": [
        {}
      ],
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "uuid": "<string>",
      "warranty_until_date": "2023-11-07T05:31:56Z"
    }
  ],
  "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 object name, serial number, address, city, or description.

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[status]stringquery

Object status UUIDs or code_name values.

filter[type]string[]query

Object type UUIDs or code_name values.

filter[project]stringquery

Project UUIDs.

filter[contact]stringquery

Client (contact) UUIDs.

filter[active]integerquery

Filter by active flag.

Required range: 0 <= x <= 1

filter[responsible_person]string[]query

Responsible person staff UUIDs.

filter[organization]string[]query

Organization UUIDs.

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: active, address, city, created_at, description, installation_date, latitude, longitude, name, note, serial_no, updated_at, uuid, warranty_until_date. Default when omitted: -created_at.

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