GET
/
v1
/
accounts
curl "https://app-dev.zquence.com/v1/accounts?page=1&limit=20" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"
{
  "data": [
    {
      "id": "6a25cdcc36bc6230704b5bce",
      "title": "123 Elm Street Escrow",
      "accountType": "real_estate",
      "status": "accepted",
      "participants": [
        {
          "role": "buyer",
          "userId": "6a25cdac36bc6230704b5b59",
          "accepted": true
        },
        {
          "role": "seller",
          "userId": "6a25cdac36bc6230704b5b60",
          "accepted": true
        }
      ],
      "sendInvitation": true,
      "invitationSentAt": "2026-06-07T20:00:12.400Z",
      "createdAt": "2026-06-07T20:00:12.414Z",
      "updatedAt": "2026-06-07T20:15:00.000Z"
    },
    {
      "id": "6a25cdcc36bc6230704b5bcf",
      "title": "Acme Corporation Escrow",
      "accountType": "permanent",
      "status": "pending",
      "participants": [
        {
          "role": "customer",
          "userId": "6a25cdac36bc6230704b5b59",
          "accepted": false
        }
      ],
      "sendInvitation": true,
      "invitationSentAt": "2026-06-08T10:30:00.000Z",
      "createdAt": "2026-06-08T10:30:00.000Z",
      "updatedAt": "2026-06-08T10:30:00.000Z"
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}
Results are scoped to the environment resolved from the authenticated API key. Live keys return live accounts; sandbox keys return sandbox accounts. Pass environmentId explicitly to query a specific environment.
Requires the transaction.view.all permission on the authenticated API key or role.

Query parameters

page
integer
default:"1"
Page number (1-indexed).
limit
integer
default:"10"
Results per page. Maximum 100. Alias: page_size.
accountType
string
Filter by account type. Supported values: real_estate, permanent, construction.
status
string
Filter by account status. Supported values: invited, pending, accepted, completed.
environmentId
string
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.
Free-text search on account title or account ID. Case-insensitive.
dateFrom
string
ISO 8601 date — return accounts created on or after this date (e.g. 2026-01-01).
dateTo
string
ISO 8601 date — return accounts created on or before this date (e.g. 2026-12-31).
archived
string
default:"false"
Controls archived visibility. false = active only, true = archived only, all = both.

Returns

A paginated response object.
data
array
Array of account summary objects for the current page.
total
number
Total accounts matching the query.
page
number
Current page number.
limit
number
Page size in effect.
totalPages
number
Total number of pages.
Each data entry includes:
id
string
Account ID (MongoDB ObjectId).
title
string
Account title as provided at creation.
accountType
string
"real_estate", "permanent", or "construction".
status
string
Current account status — see status values below.
externalReference
string | undefined
Optional external reference provided at creation. Omitted if not set.
participants
array
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 participant
  • accepted — true once the participant has accepted their invitation
sendInvitation
boolean | undefined
Whether an invitation email was requested at creation. Omitted if not set.
invitationSentAt
string | undefined
ISO 8601 timestamp of when the invitation was dispatched. Omitted if not yet sent.
invitationFailure
object | undefined
Present if the invitation delivery failed. Contains failedAt (ISO 8601) and message.
createdAt
string
ISO 8601 UTC creation timestamp.
updatedAt
string
ISO 8601 UTC last-updated timestamp.

Account status values

ValueDescription
invitedAccount created, invitations sent — no party has accepted yet.
pendingAt least one party has accepted; waiting on the remaining party.
acceptedAll required parties accepted — document submission is open.
completedAdmin closed the account after all compliance requirements were verified.

Error codes

StatusMeaning
401Missing or invalid API key pair.
403Caller does not have transaction.view.all permission.
curl "https://app-dev.zquence.com/v1/accounts?page=1&limit=20" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"
{
  "data": [
    {
      "id": "6a25cdcc36bc6230704b5bce",
      "title": "123 Elm Street Escrow",
      "accountType": "real_estate",
      "status": "accepted",
      "participants": [
        {
          "role": "buyer",
          "userId": "6a25cdac36bc6230704b5b59",
          "accepted": true
        },
        {
          "role": "seller",
          "userId": "6a25cdac36bc6230704b5b60",
          "accepted": true
        }
      ],
      "sendInvitation": true,
      "invitationSentAt": "2026-06-07T20:00:12.400Z",
      "createdAt": "2026-06-07T20:00:12.414Z",
      "updatedAt": "2026-06-07T20:15:00.000Z"
    },
    {
      "id": "6a25cdcc36bc6230704b5bcf",
      "title": "Acme Corporation Escrow",
      "accountType": "permanent",
      "status": "pending",
      "participants": [
        {
          "role": "customer",
          "userId": "6a25cdac36bc6230704b5b59",
          "accepted": false
        }
      ],
      "sendInvitation": true,
      "invitationSentAt": "2026-06-08T10:30:00.000Z",
      "createdAt": "2026-06-08T10:30:00.000Z",
      "updatedAt": "2026-06-08T10:30:00.000Z"
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}