Skip to main content
GET
/
v1
/
Outbound
Get Outbounds
curl --request GET \
  --url https://api.nlpearl.ai/v1/Outbound \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "totalAgents": 123,
    "status": 123,
    "created": "2023-11-07T05:31:56Z",
    "budgetTotal": 123,
    "budgetConsumed": 123,
    "totalLeads": 123
  }
]

Documentation Index

Fetch the complete documentation index at: https://developers.nlpearl.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Response

A list of outbounds.

​
id
string | null

The unique identifier of the outbound activity.

​
name
string | null

The name of the outbound activity.

​
totalAgents
integer<int32>

The total number of agents allocated to this outbound activity.

​
status
integer<int32>

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

​
created
string<date-time>

The date and time when the outbound activity was created.

​
budgetTotal
integer<int32> | null

The total budget allocated for this outbound activity.

​
budgetConsumed
integer<int32>

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

​
totalLeads
integer<int32>

The total number of leads associated with this outbound activity.