Outbound

Get Outbounds

Retreive all the Outbounds

get/v1/Outbound

Request

Base URL
https://api.nlpearl.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v1/Outbound/get.ts
A function with typed inputs. Its response is checked against the schema.

A list of outbounds.

idstring nullable

The unique identifier of the outbound activity.

namestring nullable

The name of the outbound activity.

totalAgentsinteger

The total number of agents allocated to this outbound activity.

statusinteger

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

createdstring date-time

The date and time when the outbound activity was created.

budgetTotalinteger nullable

The total budget allocated for this outbound activity.

budgetConsumedinteger

The amount of the budget that has been consumed so far.

totalLeadsinteger

The total number of leads associated with this outbound activity.

No recorded changes to this operation across all 1 revision of this API.