Get a location

GET /v1/locations/{id}

Retrieves a location info

Path parameters

  • id string Required

    Location id

    Maximum length is 50.

Responses

  • 200 application/json

    Successful response.

    Hide response attributes Show response attributes object
    • id string

      Values are in, us-tx, us-ca, eu, fr, au, uk, ca, or br.

    • name string
  • 404 application/json

    Resource not found

    Hide response attributes Show response attributes object

    An error response from the Auditzy API

    • message string

      A human-readable message providing more details about the error.

    • status string

      A status describing the situation
GET /v1/locations/{id} 
curl \
 -X GET https://api.auditzy.com/v1/locations/{id}
Response examples (200) 
{
  "data": {
    "id": "in",
    "name": "Mumbai, India"
  },
  "status": "SUCCESS"
}
Response examples (404) 
{
  "status": "FAILURE",
  "message": "Resource Not Found"
}