clients

Detail /clients/{uuid}

Get one client by UUID (/clients/{uuid}). Returns a record object with the detail projection: company data, addresses, types, categories, balances, primary contact, assigned users, and fields enabled for your plan. All related entities use UUIDs (or code_name for types).

GET

/clients/{uuid}

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

{
  "record": {
    "address": {
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zip": "<string>"
    },
    "assigned_users": [
      {}
    ],
    "avg_salary": "<string>",
    "bank_account": "<string>",
    "billing_address": {
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zip": "<string>"
    },
    "city": "<string>",
    "client_activities": [
      {}
    ],
    "client_categories": [
      {}
    ],
    "client_types": [
      {}
    ],
    "company": "<string>",
    "company_code": "<string>",
    "country": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "customer_levels": [
      {}
    ],
    "datecreated": "2023-11-07T05:31:56Z",
    "debt_balance": "<string>",
    "debt_overdue_balance": "<string>",
    "default_language": "<string>",
    "description": "<string>",
    "email": "<string>",
    "employees_count": "<string>",
    "is_send_invoice_due_reminders": "<string>",
    "last_contact": "2023-11-07T05:31:56Z",
    "legal_type": "<string>",
    "money_balance": "<string>",
    "organization": [
      {}
    ],
    "organization_default": "<string>",
    "phone": "<string>",
    "primary_contact": {
      "email": "<string>",
      "full_name": "<string>",
      "phone": "<string>",
      "uuid": "<string>"
    },
    "sale_potential": "<string>",
    "send_invoice_due_reminders_after_days": "<string>",
    "shipping_address": {
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zip": "<string>"
    },
    "source_name": "<string>",

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

uuidstringrequired

Record identifier (uuid)

Query Parameters

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

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.

Show child attributes

Still need help? Ask the team