List Accounts - SnackBase

GET

api

accounts

List Accounts

curl --request GET \
  --url https://api.example.com/api/v1/accounts

{
  "items": [
    {
      "id": "<string>",
      "account_code": "<string>",
      "slug": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "user_count": 123,
      "status": "active"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}

Query Parameters

page

integer

default:1

Page number (1-indexed)

Required range: x >= 1

page_size

integer

default:25

Items per page

Required range: 1 <= x <= 100

sort_by

string

default:created_at

Column to sort by

sort_order

string

default:desc

Sort order

Pattern: ^(asc|desc)$

string | null

Search query

Response

Successful Response

Paginated response for account list.

items

AccountListItem · object[]

required

List of accounts

Show child attributes

total

integer

required

Total number of accounts

page

integer

required

Current page number (1-indexed)

page_size

integer

required

Number of items per page

total_pages

integer

required

Total number of pages

Create AccountCreate a new account. Creates a new account with auto-generated ID and optional slug. Only superadmins can access this endpoint.

List Accounts

curl --request GET \
  --url https://api.example.com/api/v1/accounts

{
  "items": [
    {
      "id": "<string>",
      "account_code": "<string>",
      "slug": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "user_count": 123,
      "status": "active"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}