Retrieve Bucket

Retrieve the definition of a bucket, and retrieve helper metadata which can be used for presenting options to customers.

For example, the metadata.category_lookup property can be used to show a dialog box to customers for the customers to be able to correct their transactions (using the Correct Transaction Categories V2), and using the correct category_l1/category_l2 pair.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
enum
required

ID of the bucket (whose criteria can be used to calculate totals).

Fixed IDs for buckets that are usable in any environment for particular use-cases (e.g. assess-dashboard for the Assess Dashboard).

Query Params
boolean

Include to ensure that category_lookup is present in the metadata of the response.

boolean

Include to ensure that bucket_lookup is present in the metadata of the response.

boolean

Include to ensure that unbucketed_categories is present in the metadata of the response.

Headers
string
required

The API Client Identifier (Service Application Identifier).

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json