Skip to main content
GET
Get a list of token groups

Authorizations

Authorization
string
header
required

Authorization: Bearer <SPIRII_API_KEY>

Query Parameters

Search for token groups by name.

Maximum string length: 50
Example:

"Premium Users Group"

customerId
integer<integer>

Filter by a specific customer ID.

Required range: x >= 1
Example:

67890

disabled
boolean

Filter by active or inactive tokens.

sortBy
enum<string>
default:id

When set, returned token groups will be sorted by one of the available properties.

Available options:
id,
name,
createdAt,
updatedAt
sortDirection
enum<string>
default:desc

Set the direction of sorting.

Available options:
asc,
desc
offset
number
default:0

Skip the first N items in the result set.

Required range: x >= 0
limit
number
default:500

Limit the returned amount of tokens.

Required range: 1 <= x <= 1000

Response

Returned list of token groups.

data
object[]
required

A list of Token Groups.

count
integer
required

Total number of token groups matching the query.

Required range: x >= 1
Example:

500