Skip to main content
GET
/
api
/
buckets
List all buckets
curl --request GET \
  --url http://localhost/api/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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt

Use this file to discover all available pages before exploring further.

Select existing buckets for users to load transactions and conduct transaction monitoring. If there are more than 10 buckets available, the records provided in the response will be paginated by 10 buckets per page.

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"