Locations

List locations for the business

List locations for the business.

GET

/business/locations

curl --request GET \
  --url 'https://api-example.kickcall.ai/api/v1/business/locations?page=1&per_page=25' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "address": {
        "city": "Toronto",
        "country": "CA",
        "platform_language": "en",
        "postal_code": "M5V 2T6",
        "state": "ON",
        "street_address": "100 Main St",
        "time_zone": "America/Toronto"
      },
      "agents": [
        {
          "id": 980,
          "name": "Alex"
        }
      ],
      "business_hours": {
        "monday": {
          "close": "17:00",
          "open": "09:00"
        }
      },
      "business_id": 286,
      "contact_email": "downtown@acme.example",
      "contact_name": "Front Desk",
      "contact_phone": "+14165550101",
      "holidays": [],
      "id": 340,
      "name": "Downtown",
      "physical_location_exists": true,
      "user_ids": [
        91,
        92
      ]
    }
  ],
  "links": {
    "first": "https://api-example.kickcall.ai/api/v1/...?...&page=1",
    "last": "https://api-example.kickcall.ai/api/v1/...?...&page=1",
    "next": null,
    "prev": null,
    "self": "https://api-example.kickcall.ai/api/v1/...?...&page=1"
  },
  "meta": {
    "count": 1,
    "total_count": 1,
    "total_pages": 1
  }
}

Audience: Business portal. Auth: Business/agency JWT or API key; usually header Business-Id. Resource: Locations.

Authorizations

Authorizationstringheaderrequired

JWT from OTP login, or business/agency API key string.

Query Parameters

pageintegerquerydefault:1

Required range: 1 <= x

per_pageintegerquerydefault:25

Required range: 1 <= x <= 100

Response

OK — Paginated locations

dataobject[]

Show child attributes

linksobject

Show child attributes

metaobject

Show child attributes

Still need help? Ask the team