Retrieve an account
Fetch a single account by its ID.
GET
Returns one account from the environment your API key is bound to. The response has the same
shape as Create an account, so you can use one parser for both.
It works for every account in the environment, including accounts created in the Zquence console.
Requires an API key with the
accounts.read scope that is bound to an environment.Path parameters
The account ID, as returned by Create an account (also in
its
Location header) or List accounts.Returns
Account ID.
Your reference from Create an account. Omitted for accounts
created without one, including accounts created in the console.
Account-type code, for example
permanent or real_estate.Account title.
invited, pending, accepted, completed, or cancelled.One
customer, or a buyer and a seller.ISO 8601 UTC creation timestamp.
ISO 8601 UTC last-updated timestamp.
Error codes
| Status | code | Meaning |
|---|---|---|
400 | invalid_account_id | id isn’t a valid account ID. |
400 | invalid_external_read_context | The API key isn’t bound to an environment. Use a sandbox or live key. |
401 | key_missing / key_invalid / key_revoked | Missing, wrong, or revoked API key pair. |
403 | key_forbidden | The key lacks the accounts.read scope. |
404 | account_not_found | No account with this ID in the key’s tenant and environment. A sandbox key can’t read live accounts, and a live key can’t read sandbox accounts. |