Locations

List locations

Lists the locations the authenticated app has been granted access to.

GEThttps://api.maple.inc/v1/locationsAPI key

Authorization

Send your API key as Authorization: Bearer <key>: mpk_test_… against the sandbox (https://api.staging.maple.inc/v1), mpk_live_… against production. See Authentication. The samples read the key from MAPLE_KEY and the base URL from MAPLE_BASE, as set up in the Quickstart.

Responses

200 OK

object string required

Always list.
data object[] required
data[].object string required

Always location.
data[].id string required
data[].name string or null required
data[].status string required

One of active, inactive, paused.
data[].timezone string or null required
data[].phone string or null required
data[].address object required
data[].address.line1 string or null required
data[].address.line2 string or null required
data[].address.city string or null required
data[].address.region string or null required
data[].address.postal_code string or null required
data[].address.country string or null required

Errors

400 Bad request DeveloperApiBadRequest
401 Unauthorized DeveloperApiUnauthorized
403 Forbidden DeveloperApiForbidden
429 Too many requests DeveloperApiRateLimited

Every error body names the error in _tag, explains it in message, and says where to report it in feedback. See Errors.

A 429 also sends Retry-After: Seconds to wait before retrying; also returned as retry_after in the body.

List locations

curl "$MAPLE_BASE/locations" \
  -H "Authorization: Bearer $MAPLE_KEY"

import os
import requests

r = requests.get(
    f"{os.environ['MAPLE_BASE']}/locations",
    headers={"Authorization": f"Bearer {os.environ['MAPLE_KEY']}"},
    timeout=30,
)
r.raise_for_status()
print(r.json())

const res = await fetch(`${process.env.MAPLE_BASE}/locations`, {
  headers: {
    Authorization: `Bearer ${process.env.MAPLE_KEY}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

{
  "object": "list",
  "data": [
    {
      "object": "location",
      "id": "string",
      "name": "string",
      "status": "active",
      "timezone": "string",
      "phone": "+15555550123",
      "address": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "region": "string",
        "postal_code": "string",
        "country": "string"
      }
    }
  ]
}

{
  "_tag": "DeveloperApiBadRequest",
  "code": "string",
  "message": "string",
  "feedback": "string"
}