Query parameters
limitinteger | default: 10
Limit the number of objects to return, ranging between 1 and 20.
pageinteger | default: 1
The current page used to display the pagination results.
Response
objectstring
This will always contain list for this endpoint.
dataarray
An array of up to limit agency resources. If no agencies are available, an empty array is returned.
metaobject
Additional information about the list.
import Blutui from 'blutui'
const blutui = new Blutui('ey....')
blutui.agencies.list()
Response
{
"object": "list",
"data": [
{
"id": "9af3accc-1536-4336-8cc3-3b3b2a96c18a",
"object": "agency",
"name": "Flume",
"email": "jayan@flume.agency",
"slug": "flume",
"url": "https://flume.agency",
"location": "NZ",
"timezone": "UTC",
"avatar": null,
"description": null,
"trial_mode": false,
"is_agency": false,
"is_aws_customer": false,
"created_at": 1703713667,
"updated_at": 1721087098
},
{...},
{...}
],
"meta": {
"has_more": false,
"current_page": 1,
"from": 1,
"to": 3,
"total": 3,
"per_page": 10,
"last_page": 1
}
}