getApiV1Agents

getApiV1Agents<ThrowOnError>(options?: Options<GetApiV1AgentsData, ThrowOnError>): RequestResult<GetApiV1AgentsResponses, GetApiV1AgentsErrors, ThrowOnError>

Defined in: src/client/sdk.gen.ts:210

List agents

Returns all active agents available in the system

Type Parameters

Type Parameter	Default type
`ThrowOnError` extends `boolean`	`false`

Parameters

Parameter	Type
`options?`	`Options`<`GetApiV1AgentsData`, `ThrowOnError`>

Returns

RequestResult<GetApiV1AgentsResponses, GetApiV1AgentsErrors, ThrowOnError>