objects

Detail /objects/{uuid}

Get one object by UUID (/objects/{uuid}). Returns record with core fields, status, types, contact, relations, dates, custom fields, and organization when applicable. Reference entities use UUIDs only.

GET

/objects/{uuid}

curl --request GET \
  --url 'https://default.hannacrm.app/api/v4/objects/{uuid}?fields=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "record": {
    "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"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "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"
  }
}

Autorizacijos

Authorizationstringheaderprivaloma

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

Kelio parametrai

uuidstringprivaloma

Record identifier (uuid)

Užklausos parametrai

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.

Atsakymas

Single record

recordobject

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Rodyti: child attributes

Vis dar reikia pagalbos? Klausti komandos