GET
/
v1
/
accounts
curl "https://api.zquenceeee.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",
      "buyer": {
        "id": "6a25cdac36bc6230704b5b59",
        "name": "James Carter",
        "email": "james.carter@example.com",
        "phone": "+447911123456",
        "accepted": true
      },
      "seller": {
        "id": "6a25cdac36bc6230704b5b60",
        "name": "Emily Thompson",
        "email": "emily.thompson@example.com",
        "phone": "+14155550193",
        "accepted": true
      },
      "timeline": [
        {
          "event": "Buyer invitation sent",
          "eventType": "sent",
          "timestamp": "2026-06-07T20:00:12.400Z"
        },
        {
          "event": "Buyer accepted invitation",
          "eventType": "accepted",
          "timestamp": "2026-06-07T20:15:00.000Z"
        }
      ],
      "archivedAt": null,
      "archivedBy": null,
      "createdAt": "2026-06-07T20:00:12.414Z",
      "updatedAt": "2026-06-07T20:15:00.000Z"
    },
    {
      "id": "6a25cdcc36bc6230704b5bcf",
      "title": "Acme Corporation Escrow",
      "accountType": "permanent",
      "status": "pending",
      "buyer": {
        "id": "6a25cdac36bc6230704b5b59",
        "name": "Acme Inc",
        "email": "contact@acme.example.com",
        "phone": "+14155550100",
        "accepted": false
      },
      "timeline": [
        {
          "event": "Customer invitation sent",
          "eventType": "sent",
          "timestamp": "2026-06-08T10:30:00.000Z"
        }
      ],
      "archivedAt": null,
      "archivedBy": null,
      "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. 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
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.
buyer
object | null
For real_estate accounts: the buyer party. For permanent and construction: the single customer party. Fields: id, name, email, phone, accepted.
seller
object | null
Only present for real_estate accounts. For other types this field is omitted. Fields: id, name, email, phone, accepted.
timeline
array
Ordered list of timeline events. Each entry has event, eventType, timestamp, and optional details.
archivedAt
string | null
ISO 8601 timestamp if the account has been archived. null otherwise.
archivedBy
string | null
User ID of the admin who archived it. null otherwise.
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://api.zquenceeee.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",
      "buyer": {
        "id": "6a25cdac36bc6230704b5b59",
        "name": "James Carter",
        "email": "james.carter@example.com",
        "phone": "+447911123456",
        "accepted": true
      },
      "seller": {
        "id": "6a25cdac36bc6230704b5b60",
        "name": "Emily Thompson",
        "email": "emily.thompson@example.com",
        "phone": "+14155550193",
        "accepted": true
      },
      "timeline": [
        {
          "event": "Buyer invitation sent",
          "eventType": "sent",
          "timestamp": "2026-06-07T20:00:12.400Z"
        },
        {
          "event": "Buyer accepted invitation",
          "eventType": "accepted",
          "timestamp": "2026-06-07T20:15:00.000Z"
        }
      ],
      "archivedAt": null,
      "archivedBy": null,
      "createdAt": "2026-06-07T20:00:12.414Z",
      "updatedAt": "2026-06-07T20:15:00.000Z"
    },
    {
      "id": "6a25cdcc36bc6230704b5bcf",
      "title": "Acme Corporation Escrow",
      "accountType": "permanent",
      "status": "pending",
      "buyer": {
        "id": "6a25cdac36bc6230704b5b59",
        "name": "Acme Inc",
        "email": "contact@acme.example.com",
        "phone": "+14155550100",
        "accepted": false
      },
      "timeline": [
        {
          "event": "Customer invitation sent",
          "eventType": "sent",
          "timestamp": "2026-06-08T10:30:00.000Z"
        }
      ],
      "archivedAt": null,
      "archivedBy": null,
      "createdAt": "2026-06-08T10:30:00.000Z",
      "updatedAt": "2026-06-08T10:30:00.000Z"
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}