Skip to main content
GET
/
v1
/
Outbound
Get Outbounds
curl --request GET \
  --url https://api.nlpearl.ai/v1/Outbound \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.nlpearl.ai/v1/Outbound"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nlpearl.ai/v1/Outbound', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nlpearl.ai/v1/Outbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nlpearl.ai/v1/Outbound"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.nlpearl.ai/v1/Outbound")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.nlpearl.ai/v1/Outbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "<string>",
    "name": "<string>",
    "totalAgents": 123,
    "status": 123,
    "created": "2023-11-07T05:31:56Z",
    "budgetTotal": 123,
    "budgetConsumed": 123,
    "totalLeads": 123
  }
]
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

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.