---
title: "Retrieve a list of service agents"
method: GET
path: "/service_agents/agents"
tags: ["Service Agent"]
---

# Retrieve a list of service agents

`GET /service_agents/agents`

Fetches a list of service agents with pagination support.

## Query parameters

- `page_size` integer
- `page_token` string

## Response `200`

A list of service agents.

- object
  - `next_page_token` string — Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.
  - `result` AgentManagerAgent[]
    - `id` string, uuid — The unique identifier of the agent.
    - `customer_id` string, uuid — The unique identifier of the customer who owns this agent. Returned from the `GET /customers` response.
    - `username` string — Agent's login username, typically an email address.
    - `name` string — Display name of the agent.
    - `detail` string — Additional detail or notes about the agent.
    - `ring_method` 'ringall' | 'linear' — Method used to ring the agent for incoming calls.
    - `status` '' | 'available' | 'away' | 'busy' | 'offline' | 'ringing' — Current availability status of the agent.
    - `permission` 0 | 65535 | 1 | 15 | 16 | 32 | 64 | 240 — Permission type
    - `tag_ids` string[] — List of tag IDs assigned to this agent. Returned from the `POST /tags` or `GET /tags` response.
    - `addresses` CommonAddress[] — Agent's endpoint addresses for receiving calls.
      - `type` '' | 'agent' | 'conference' | 'email' | 'extension' | 'line' | 'sip' | 'tel' | 'web_session' — Type of address.
      - `target` string — The address endpoint. Format depends on type: phone number for tel (e.g. +14155551234), UUID for agent/conference/extension, email for email, SIP URI for sip.
      - `target_name` string — Address's name.
      - `name` string — Optional label for this address.
      - `detail` string — Additional notes about this address.
    - `direct_hash` string — The direct hash for direct access via SIP URI sip:<direct_hash>@sip.voipbin.net (the "direct." prefix is already included in the value, e.g. "direct.a1b2c3d4e5f6"). Returned from the resource's `direct_hash` field.
    - `tm_create` string, date-time — Timestamp when the agent was created.
    - `tm_update` string, date-time — Timestamp when the agent was last updated.
    - `tm_delete` string, date-time — Timestamp when the agent was deleted.

## Other responses

- `401` — Authentication required (UNAUTHENTICATED).
- `500` — Internal error (INTERNAL).

---

[API](https://skmtc.net/voipbin/apis/voipbin-api.md) · [All operations](https://skmtc.net/voipbin/apis/voipbin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voipbin/voipbin-api/versions/79e779080bcc/schema)