Agents

List agents at a location

List agents at a location.

GET

/business/locations/{location_id}/agents

curl --request GET \
  --url 'https://api-example.kickcall.ai/api/v1/business/locations/{location_id}/agents?page=1&per_page=25&sort=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "created_at": "2025-07-10T12:00:00.000Z",
      "id": 980,
      "location_id": 340,
      "location_name": "Downtown",
      "name": "Alex",
      "phone_number": "+14165550111",
      "response_engine": "conversation_flow",
      "telephony_assignments": []
    }
  ],
  "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: Agents.

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

location_idintegerrequired

Query Parameters

pageintegerquerydefault:1

Required range: 1 <= x

per_pageintegerquerydefault:25

Required range: 1 <= x <= 100

sortstringquery

Sort field, optionally prefixed with - for descending.

Response

OK — Paginated agents

dataobject[]

Show child attributes

linksobject

Show child attributes

metaobject

Show child attributes

Still need help? Ask the team