Skip to main content
GET
Get Assistants
List assistants in the workspace. Most integrations call this during setup so an operator can choose which assistant should handle calls.

When to use

  • Populate an assistant picker in your internal admin UI.
  • Find the agent_id required by outbound call and campaign APIs.
  • Filter for assistants configured for the channel you are integrating, such as outbound calls or web calls.

Integration notes

  • Store the selected agent_id in your database rather than looking it up before every call.
  • If an assistant is edited in the dashboard, its ID remains the stable integration handle.
  • Use GET /agent/{agent_id} when you need details for one assistant.

Headers

X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Query Parameters

limit
integer
default:10

Number of items to return (default: 20, max: 100).

Example:

50

offset
integer
default:0

Number of items to skip (default: 0).

Example:

20

Response

Successful Response: A list of assistants.

status
string
data
object