List all clients

GET

/api/v1/clients

• Production
• Development

Returns a paginated list of all clients with current usage summaries. Supports filtering by status and pagination.

Authorizations

• cookieAuth

Parameters

Query Parameters

status

string

Allowed values: active inactive suspended trial

Filter by client status

limit

integer

default: 50 >= 1 <= 1000

Maximum number of clients to return

cursor

string

Pagination cursor from previous response

Responses

200

List of clients

object

clients

Array<object>

object

bucket_id

Unique client identifier

string

Example

acme-corp

display_name

Human-readable client name

string

Example

Acme Corporation

status

Client status

string

Allowed values: active inactive suspended trial

total_records

Total record count across all collections

integer

Example

125000

total_storage_bytes

Total S3 storage in bytes

integer

Example

5368709120

trial_end_date

Trial expiration date if applicable

string format: date

nullable

client_since

Date client was created

string format: date

nullable

created_at

Record creation timestamp

string format: date-time

updated_at

Last update timestamp

string format: date-time

count

Number of clients in this response

integer

cursor

Cursor for next page, null if no more results

string

nullable

400

Invalid request parameters

object

error

Error message

string

request_id

Request ID for debugging

string

nullable

Example

{
  "error": "Invalid bucket_id"
}

401

Authentication required

object

error

Error message

string

request_id

Request ID for debugging

string

nullable

Example

{
  "error": "Unauthorized"
}