Skip to main content
GET
List the Agents of a workspace

Authorizations

x-api-key
string
header
required

Copy the API key as provided by the Bridge Console.

Path Parameters

workspaceId
string<uuid>
required

Unique identifier of the workspace (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

Query Parameters

type
enum<string> | null

Only return Agents of this type. Kinds of Agent exposed by the public API.

Available options:
LEADSCOUT,
SERVICE_AGENT
limit
integer
default:20

Number of Agents per page

Required range: 1 <= x <= 100
cursor
string | null

Cursor provided on a previous request to get the next page

Response

Successful Response

Response body for listing the Agents of a workspace.

agents
AgentResponse · object[]
required

Array of Agents.

cursor
string | null

Cursor to be sent on the next page request. Null on the last page.