List accounts
Return a paginated list of escrow accounts for the authenticated tenant and environment.
GET
Results are scoped to the environment resolved from the authenticated API key. Live keys return live accounts; sandbox keys return sandbox accounts. Pass
Each
environmentId explicitly to query a specific environment.
Party field naming: real_estate accounts return both buyer and seller fields. permanent and construction accounts return only a buyer field (representing the single customer).
Requires the
transaction.view.all permission on the authenticated API key or role.Query parameters
Page number (1-indexed).
Results per page. Maximum
100. Alias: page_size.Filter by account type. Supported values:
real_estate, permanent, construction.Filter by account status. Supported values:
invited, pending, accepted, completed.Filter results to accounts in this specific environment. When provided, overrides the environment resolved from the API key.
Use the List environments endpoint to get valid environment IDs.
Use the List environments endpoint to get valid environment IDs.
Free-text search on account title or account ID. Case-insensitive.
ISO 8601 date — return accounts created on or after this date (e.g.
2026-01-01).ISO 8601 date — return accounts created on or before this date (e.g.
2026-12-31).Controls archived visibility.
false = active only, true = archived only, all = both.Returns
A paginated response object.Array of account summary objects for the current page.
Total accounts matching the query.
Current page number.
Page size in effect.
Total number of pages.
data entry includes:
Account ID (MongoDB ObjectId).
Account title as provided at creation.
"real_estate", "permanent", or "construction".Current account status — see status values below.
For
real_estate accounts: the buyer party. For permanent and construction: the single customer party. Fields: id, name, email, phone, accepted.Only present for
real_estate accounts. For other types this field is omitted. Fields: id, name, email, phone, accepted.Ordered list of timeline events. Each entry has
event, eventType, timestamp, and optional details.ISO 8601 timestamp if the account has been archived.
null otherwise.User ID of the admin who archived it.
null otherwise.ISO 8601 UTC creation timestamp.
ISO 8601 UTC last-updated timestamp.
Account status values
| Value | Description |
|---|---|
invited | Account created, invitations sent — no party has accepted yet. |
pending | At least one party has accepted; waiting on the remaining party. |
accepted | All required parties accepted — document submission is open. |
completed | Admin closed the account after all compliance requirements were verified. |
Error codes
| Status | Meaning |
|---|---|
401 | Missing or invalid API key pair. |
403 | Caller does not have transaction.view.all permission. |