VOvoucherifyio
Locations

Get Location

Returns a location object.

get/v1/locations/{locationId}

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/locations/{locationId}
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, locations

Path parameters

locationIdstring required
Example:loc_NoMGXmHO9OUs7iz9mGWpamma

The unique location ID.

Response

Returns a location object.

idstring required

Unique location ID, assigned by the Voucherify API.

object'location' required

The type of the object represented by JSON. This object stores information about a location.

namestring required

Location name.

created_atstring date-time required

Timestamp representing the date and time when the location was created. The value is shown in the ISO 8601 format.

updated_atstring date-time nullable required

Timestamp representing the date and time when the location was updated. The value is shown in the ISO 8601 format.

Example response

{
  "id": "loc_NoMGXmHO9OUs7iz9mGWpamma",
  "shape": {
    "distance": {
      "center": "geo:40.79372699823857,-74.15092132694554"
    }
  },
  "created_at": "2022-02-14T15:12:06.817Z",
  "updated_at": "2022-03-14T15:12:06.817Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.