Enjovia API

List redeem locations

GET /redeem-locations
Bearer auth

Get a list of redeem locations for the current account

Query parameters

  • per_page integer

    Default value is 15.

  • page integer

    Default value is 1.

  • filter[tags][] object

    Filter by custom tags

    Hide filter[tags][] attribute Show filter[tags][] attribute object
    • * string Additional properties
  • sort string

    Sort redeem locations by one or more fields. Use '-' prefix for descending order. Available fields: name, address, created_at, updated_at Default: -updated_at

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • data array[object]

      Redeem location information needed for API operations

      Hide data attributes Show data attributes object
      • id string(uuid)

        Location UUID used in Redeem-Location-ID header

      • name string

        Location display name

      • is_active boolean

        Whether the location is currently active

    • meta object
      Hide meta attributes Show meta attributes object
      • current_page integer
      • per_page integer
      • total integer
GET /redeem-locations 
curl \
 --request GET 'https://api.gb.enjovia.app/redeem-locations' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Main Street Location",
      "is_active": true
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 20,
    "total": 5
  }
}