Skip to main content
GET
/
api
/
buckets
List all buckets
curl --request GET \
  --url https://api.example.com/api/buckets \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {}
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Query Parameters

​
active_indicator
boolean
​
client_transaction_id
string
​
limit
integer

Number of results to return per page.

​
name
string
​
offset
integer

The initial index from which to return the results.

Response

200 - application/json

List of buckets retrieved successfully.

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"