Sign in
Accounts

Retrieve an account by external_id.

get/v2/accounts/external-id/{external_id}

Path parameters

external_idstring required

Caller-supplied external identifier. Maximum 256 Unicode scalar values.

Example:crm_acme_001

External identifier.

Response

Resource found.

idstring required

LedgerUp account identifier.

external_idstring nullable required

Optional caller-supplied external identifier. Maximum 256 Unicode scalar values.

ledgerup_customer_idstring uuid nullable required

Optional LedgerUp billing customer UUID.

namestring required

Human-readable name. Maximum 256 Unicode scalar values.

descriptionstring nullable required

Optional description. Maximum 2048 Unicode scalar values.

created_atinteger required

Unix timestamp in seconds.

updated_atinteger required

Unix timestamp in seconds.

archived_atinteger required

Unix timestamp in seconds.

Example response

{
  "id": "account_0194f4e3a2b77c6aa91c4f6b4db2a980",
  "external_id": "crm_acme_001",
  "ledgerup_customer_id": "0194f4e3-a2b7-7c6a-a91c-4f6b4db2a980",
  "name": "Acme",
  "description": "Usage tracked for Acme.",
  "created_at": 1767225600,
  "updated_at": 1767225600,
  "archived_at": 1767225600
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.