GET All States
Returns all states available within your subscription.
api_token
YES
Another option is to provide the API token in the header.
Your unique API token. Ex. ?api_token=YOUR_TOKEN
include
NO
Enrich the API response with more data by using includes. Ex. &include=participants;events
filters
NO
Filter the API response on multiple related entities. There are static filters and dynamic filters. Please find the possibilities in the Static and Dynamic Filter tab.
locale
NO
Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page.
Filters
More information on how to use filters can be found on our tutorials on how to filter. If you want more information on which filters to use you can check out the following endpoint
Pagination
YES
Parameters
order
No
Returns states ordered by id (asc
or desc
). Defaults to asc
&order=desc
per_page
No
The amount of results to return per page (max 50.). Defaults to 25.
&per_page=30
page
No
You can paginate using the has_more
parameter to determine if you can still propagate through the results.
&page=2
Include depth
You can use a total of 0
nested includes on this endpoint
Include options
none
Related Entities:
Get an overview and explanation of all the fields returned in the API response. The related entities for the transfers' endpoints are:
Postman
We also offer detailed postman documentation with examples and a complete up-to-date version of all our endpoints. Below is a button that lets your fork the collection or import it.
Code Example
Last updated