Loading ...

REST API: Get Countries | Axero Documentation

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

REST API: Get Countries

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

Get the list of countries and their IDs. Each site numbers its countries itself, so take IDs from this call on the same site. The response is a plain list of countries, 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.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/countries

Success Response

[
  {
    "CountryID": 195,
    "CountryCode": "AF",
    "CountryName": "Afghanistan",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1
  },
  {
    "CountryID": 20,
    "CountryCode": "AL",
    "CountryName": "Albania",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1
  },
  {
    "CountryID": 61,
    "CountryCode": "DZ",
    "CountryName": "Algeria",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1
  },
  {
    "CountryID": 24,
    "CountryCode": "AS",
    "CountryName": "American Samoa",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1
  },
  {
    "CountryID": 16,
    "CountryCode": "AD",
    "CountryName": "Andorra",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1
  },
  {
    "CountryID": 196,
    "CountryCode": "AO",
    "CountryName": "Angola",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1
  },
  {
    "CountryID": 19,
    "CountryCode": "AI",
    "CountryName": "Anguilla",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1
  },
  {
    "CountryID": 22,
    "CountryCode": "AQ",
    "CountryName": "Antarctica",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1
  },
  {
    "CountryID": 18,
    "CountryCode": "AG",
    "CountryName": "Antigua and Barbuda",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1
  },
  {
    "CountryID": 23,
    "CountryCode": "AR",
    "CountryName": "Argentina",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1
  }
]

Error Response

You do not have sufficient permissions to perform this action.

Error Handling

Status CodeLikely CauseNext Action
401 UnauthorizedNo valid Bearer token on a site that allows members only; on other sites the call runs as a guest.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.

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