Get one Customer

​

Fetch one Customer by external id. Amounts and currencyCode are the record's own transaction currency. Records created in act may take up to one export cycle to become readable.

Path Parameters
  • external_id
    Type: string · External Id
    required

    The record's external id.

Query Parameters
  • expand
    Type: array string[] | null · Expandenumnullable

    Linked records to include under expanded (repeat the key).

    values
    • invoices
    • payments
  • include_deleted
    Type: boolean · Include Deleted

    Return the record even if act has deleted it; it then carries customFields.t0_deleted_at.

Headers
  • X-Api-Key
    Type: string · X-Api-Keynullable
Responses
  • application/json
  • 401

    Missing or invalid X-Api-Key (CAPI11).

  • 403

    The key lacks the customer_api:read permission (CAPI71).

  • 404

    No record of this type with that id in the key's entity (CAPI61).

  • 409

    The id resolves to more than one record of this type (CAPI63), or the entity has no applied books start date (CAPI67).

  • application/json
Request Example for get/v1/customers/{external_id}
curl '/v1/customers/{external_id}' \
  --header 'X-Api-Key: YOUR_SECRET_TOKEN'

{
  "id": {
    "dataType": "Adjustment",
    "externalId": "string",
    "platformDataType": "string",
    "platformId": "string",
    "platformType": "string"
  },
  "data": {
    "customFields": {
      "additionalProperty": "anything"
    },
    "date": "2026-09-10",
    "email": "string",
    "name": "string"
  },
  "links": [
    {
      "dataType": "Adjustment",
      "externalId": "string",
      "platformDataType": "string",
      "platformId": "string",
      "platformType": "string"
    }
  ],
  "expanded": {
    "additionalProperty": [
      {
        "data": {
          "amount": 1,
          "currencyCode": "string",
          "customFields": {
            "additionalProperty": "anything"
          },
          "date": "2026-09-10",
          "description": "string",
          "endDate": "2026-09-10",
          "exchangeRates": [],
          "startDate": "2026-09-10"
        },
        "id": {
          "dataType": "Adjustment",
          "externalId": "string",
          "platformDataType": "string",
          "platformId": "string",
          "platformType": "string"
        },
        "links": []
      }
    ]
  },
  "expanded_truncated": [
    "string"
  ]
}

Successful Response