Skip to main content
GET
/
v1
/
terminal
/
locations
List all terminal locations
curl --request GET \
  --url https://api.yorlet.com/v1/terminal/locations \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "terminal.location",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "country": "<string>",
        "postal_code": "<string>",
        "state": "<string>"
      },
      "display_name": "<string>",
      "marketing": {
        "brand": {
          "color": "<string>",
          "icon": "<string>"
        },
        "description": "<string>",
        "featured_photo": "<string>",
        "photos": [
          "<string>"
        ]
      },
      "account": "<string>",
      "deleted": false,
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

List all terminal locations

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required