GET All States
Returns all states available within your subscription.
Last updated
Returns all states available within your subscription.
Last updated
Name | Required? | Description |
---|---|---|
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
YES
Parameter | Required | Description | Example |
---|---|---|---|
You can use a total of 0
nested includes on this endpoint
none
Get an overview and explanation of all the fields returned in the API response. The related entities for the transfers' endpoints are:
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.
Field | Description | Type |
---|---|---|
id
Refers to the id of the state
integer
state
Displays the state of the state
string
name
Displays the full name of the state
string
short_name
Displays the short name of the state
string
developer_name
Displays the developer name of the state
string
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
select
NO
Select specific fields on the base entity. Read how to select fields in our tutorial.
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.
N/A
N/A
Not available for this endpoint.
N/A
N/A
N/A
Not available for this endpoint.
N/A
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