HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Get a list of token groups

get
https://api.spirii.com/v2/token-groups

This endpoint allows you to get a paginated list of token groups. It is possible to set query parameters to filter the results. A token group is an access management mechanism where only tokens inside a group can authorize charging at specified locations.

The group always grants access to the location. This means the location's public setting and opening hours are overruled by a token inside the group.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length ≤ 50

Search for token groups by name.

integer
≥ 1

Filter by a specific customer ID.

boolean

Filter by active or inactive tokens.

string
enum
Defaults to id

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

Allowed:
string
enum
Defaults to desc

Set the direction of sorting.

Allowed:
number
≥ 0
Defaults to 0

Skip the first N items in the result set.

number
1 to 1000
Defaults to 500

Limit the returned amount of tokens.

Responses

400

Bad Request provided. A message will describe the issue.

403

Authorization header JWT token is invalid or not provided.

500

Internal Server Error.

Updated 8 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago