Get All Accounts

GET /v1/account

Retrieves a list of all customer accounts associated with the authenticated tenant. Each account includes address details (postal, delivery, official, invoice, visit), account metadata, account manager, primary user, integration links, and timestamps. Pagination info (total, skip, limit) is returned for client-side paging.

Query Parameters

• ~filter[tenant] - Parameter for ~filter[tenant]
• ~pagination - Parameter for ~pagination
• ~filter[number] - Parameter for ~filter[number]
• ~limit - Parameter for ~limit
• ~offset - Parameter for ~offset

Request Example

GET /v1/account

Response Example

{
  "data": [
    {
      "status": {
        "active": true
      },
      "address": {
        "postal": {
          "line2": "",
          "street": "Example Street 1",
          "zip": "1111",
          "city": "Example City",
          "country": "EX",
          "state": "",
          "editable": true,
          "_id": "address-id-postal-1"
        },
        "delivery": {
          "line2": "",
          "street": "Example Street 1",
          "zip": "1111",
          "city": "Example City",
          "country": "EX",
          "state": "",
          "editable": true,
          "_id": "address-id-delivery-1"
        },
        "official": {
          "line2": "",
          "street": "Example Street 1",
          "zip": "1111",
          "city": "Example City",
          "country": "EX",
          "state": "",
          "editable": true,
          "_id": "address-id-official-1"
        },
        "invoice": {
          "line2": "",
          "street": "",
          "zip": "",
          "city": "",
          "country": "",
          "state": "",
          "editable": true,
          "_id": "address-id-invoice-1"
        },
        "visit": {
          "line2": "",
          "street": "",
          "zip": "",
          "city": "",
          "country": "",
          "state": "",
          "editable": true,
          "_id": "address-id-visit-1"
        }
      },
      "email": {
        "default": "user@example.com"
      },
      "metadata": {
        "last_login": "2025-09-03T12:56:09.095Z"
      },
      "_id": "account-db-id-1",
      "id": "account-id-1",
      "name": "Example Account",
      "number": "123456789",
      "type": "customer",
      "country": "EX",
      "comment": "Optional comment text",
      "bankaccount": [],
      "contacts": [],
      "integrations": [
        {
          "_id": "integration-rel-id-1",
          "integrationId": "integration-id-1",
          "objectId": "OBJ123456"
        }
      ],
      "accountmanager": "manager-id-1",
      "primaryuser": "user-id-1",
      "tenant": "tenant-id-1",
      "created": "2020-01-01T00:00:00.000Z",
      "updated": "2025-09-03T12:56:09.106Z",
      "__v": 0
    },
    {
      "status": {
        "active": true
      },
      "address": {
        "postal": {
          "line2": "",
          "street": "Example Road 22",
          "zip": "2222",
          "city": "Sampletown",
          "country": "EX",
          "state": "",
          "editable": true,
          "_id": "address-id-postal-2"
        },
        "delivery": {
          "line2": "",
          "street": "Example Road 22",
          "zip": "2222",
          "city": "Sampletown",
          "country": "EX",
          "state": "",
          "editable": true,
          "_id": "address-id-delivery-2"
        },
        "official": {
          "line2": "",
          "street": "Example Road 22",
          "zip": "2222",
          "city": "Sampletown",
          "country": "EX",
          "state": "",
          "editable": true,
          "_id": "address-id-official-2"
        },
        "invoice": {
          "line2": "",
          "street": "",
          "zip": "",
          "city": "",
          "country": "",
          "state": "",
          "editable": true,
          "_id": "address-id-invoice-2"
        },
        "visit": {
          "line2": "",
          "street": "",
          "zip": "",
          "city": "",
          "country": "",
          "state": "",
          "editable": true,
          "_id": "address-id-visit-2"
        }
      },
      "email": {
        "default": "customer@example.org"
      },
      "metadata": {
        "last_login": "2025-10-15T09:00:00.000Z"
      },
      "_id": "account-db-id-2",
      "id": "account-id-2",
      "name": "Sample Industries",
      "number": "987654321",
      "type": "customer",
      "country": "EX",
      "comment": "",
      "bankaccount": [],
      "contacts": [],
      "integrations": [],
      "accountmanager": "manager-id-2",
      "primaryuser": "user-id-2",
      "tenant": "tenant-id-2",
      "created": "2021-03-05T11:20:00.000Z",
      "updated": "2025-10-15T09:00:00.000Z",
      "__v": 0
    }
  ],
  "total": {
    "total": 47,
    "skip": 0,
    "limit": 200
  }
}