Loading ...

REST API: Get States | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Get States
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 26

REST API: Get States

0 
 /5
0 (0votes)
Open API Guide
GET/api/states

Get the states of a country and their IDs. The response is a plain list of states, not the standard response with IsError, ResponseMessage, and ResponseData.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
CountryIDIntegerYESQueryUnique ID of the country to fetch states for. See REST API: Get Countries. Country IDs differ from site to site, so take the ID from Get Countries on the same site.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/states?CountryID=786

Success Response

[
  {
    "CountryID": 786,
    "StateID": 922,
    "StateName": "England",
    "MetroID": 0
  },
  {
    "CountryID": 786,
    "StateID": 1171,
    "StateCode": "IM",
    "StateName": "Isle of Man",
    "MetroID": 0
  }
]

Error Response

{
  "Message": "No HTTP resource was found that matches the request URI 'https://your-site.com/api/states'."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestCountryID is not an integer.Check the request against the required parameters.
401 UnauthorizedMissing or invalid Bearer token on a site that only members can access. On a site open to guests the request runs as a guest instead.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenNot returned: the endpoint makes no permission check.No action needed.
500 Server ErrorInternal failure.Retry later.
404 or 405A required query parameter was left out, so the request matched a different action or none. The message reads No HTTP resource was found or The requested resource does not support http method.Send every required query parameter. The message does not mean the item you asked for is missing.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages