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.
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.
Optional external reference provided at creation. Omitted if not set.
All parties attached to this account. Each entry contains:
role—"buyer","seller", or"customer"(single-party accounts use"customer")userId— the Zquence user ID for this participantaccepted—trueonce the participant has accepted their invitation
Whether an invitation email was requested at creation. Omitted if not set.
ISO 8601 timestamp of when the invitation was dispatched. Omitted if not yet sent.
Present if the invitation delivery failed. Contains
failedAt (ISO 8601) and message.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. |