Skip to main content

Get All Account Collections

GET /v1/account/collection

Retrieves a paginated list of account collections for the authenticated tenant. Use this to view, search, and filter collections by attributes like name or associated account IDs. Results include essential details for each collection and pagination metadata for efficient listing in admin tools and dashboards.

Query Parameters​

  • perPage - Parameter for perPage
  • page - Page number for pagination

Request Example​

GET /v1/account/collection?perPage=25&page=0

Response Example​

{
  "data": [
    {
      "id": "collection-id-1",
      "name": "Example Collection A",
      "tenant": "tenant-id-1",
      "accountIds": ["account-id-1", "account-id-2"],
      "created": "2025-01-15T10:30:00.000Z",
      "updated": "2025-01-15T10:30:00.000Z"
    },
    {
      "id": "collection-id-2",
      "name": "Example Collection B",
      "tenant": "tenant-id-1",
      "accountIds": [],
      "created": "2025-01-16T09:00:00.000Z",
      "updated": "2025-01-16T09:00:00.000Z"
    }
  ],
  "metadata": {
    "total": 25,
    "page": 0,
    "perPage": 25
  }
}