Get Locations

GET /locations

This API call is used to retrieve locations.

Responses

200 application/json

Successful Response
Hide response attributes Show response attributes object
- code string
  
  The location code.
- name string
  
  The location name.
- description string
  
  The location description.
- functionalCurrency string
  
  The location currency.
- userUsage string
  
  Indicates if location is eligible for users.
- accountUsage string
  
  Indicates if location is eligible for accounts.
401 application/json

Authentication Error. Invalid credentials.
Hide response attributes Show response attributes object
- code string
- message string
- description string
403

Authorization Error. Invalid role for request.

GET /locations

curl \
 --request GET 'https://localhost:8080/locations' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "code": "AMER",
      "name": "Americas",
      "userUsage": true,
      "description": "Americas",
      "accountUsage": true,
      "functionalCurrency": "USD"
    },
    {
      "code": "EMEA",
      "name": "Europe",
      "userUsage": true,
      "description": "Europe",
      "accountUsage": true,
      "functionalCurrency": "EUR"
    }
  ],
  "totalRecords": 2
}

Response examples (401)

{
  "code": "900901",
  "message": "Invalid Credentials",
  "description": "Access failure for API: /api/admin/v1.1.0, version: v1.1.0 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials"
}