Get client detail

GET

/api/v1/clients/{bucket_id}

• Production
• Development

Returns detailed usage data for a specific client.

Authorizations

• cookieAuth

Parameters

Path Parameters

bucket_id

required

string

/^[a-zA-Z0-9_-]{1,64}$/

Example

acme-corp

Client bucket identifier (alphanumeric, hyphens, underscores)

Responses

200

Client details

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

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"
}

404

Resource not found

object

error

Error message

string

request_id

Request ID for debugging

string

nullable

Example

{
  "error": "Not found"
}