List Agent Numbers

curl --request GET \
  --url https://api.example.com/api/v1/agents/{agent_id}/phone-numbers \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/api/v1/agents/{agent_id}/phone-numbers', 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.example.com/api/v1/agents/{agent_id}/phone-numbers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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.example.com/api/v1/agents/{agent_id}/phone-numbers"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/agents/{agent_id}/phone-numbers")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": 123,
    "phone_number": "<string>",
    "provider": "<string>",
    "status": "<string>",
    "country_code": "<string>",
    "capabilities": [],
    "friendly_name": "<string>",
    "organization_id": 123,
    "workflow_id": 123,
    "workflow_name": "<string>",
    "outbound_workflows": [],
    "monthly_cost_usd": 123,
    "monthly_cost_pln": 123,
    "provider_number_id": "<string>",
    "purchased_at": "2023-11-07T05:31:56Z",
    "assigned_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "order_id": 123,
    "order_status": "<string>",
    "order_status_reason": "<string>",
    "outbound_commitment_until": "2023-11-07T05:31:56Z"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

api

agents

{agent_id}

phone-numbers

List Agent Numbers

curl --request GET \
  --url https://api.example.com/api/v1/agents/{agent_id}/phone-numbers \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/api/v1/agents/{agent_id}/phone-numbers', 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.example.com/api/v1/agents/{agent_id}/phone-numbers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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.example.com/api/v1/agents/{agent_id}/phone-numbers"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/agents/{agent_id}/phone-numbers")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": 123,
    "phone_number": "<string>",
    "provider": "<string>",
    "status": "<string>",
    "country_code": "<string>",
    "capabilities": [],
    "friendly_name": "<string>",
    "organization_id": 123,
    "workflow_id": 123,
    "workflow_name": "<string>",
    "outbound_workflows": [],
    "monthly_cost_usd": 123,
    "monthly_cost_pln": 123,
    "provider_number_id": "<string>",
    "purchased_at": "2023-11-07T05:31:56Z",
    "assigned_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "order_id": 123,
    "order_status": "<string>",
    "order_status_reason": "<string>",
    "outbound_commitment_until": "2023-11-07T05:31:56Z"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).

Headers

authorization

string | null

X-API-Key

string | null

Path Parameters

agent_id

required

The agent's ID: the public agent_ + 20 characters identifier shown in the dashboard (recommended), or the legacy number. Both address the same agent.

Pattern: ^agent_[A-Za-z0-9]{20}$

Example:

"agent_7fK2mQ9xLp3RtV8wYb1N"

Response

Successful Response

integer

required

phone_number

string

required

provider

string

required

status

string

required

country_code

string | null

capabilities

string[]

friendly_name

string | null

organization_id

integer | null

workflow_id

integer | null

workflow_name

string | null

outbound_workflows

OutboundAgent · object[]

Show child attributes

monthly_cost_usd

number | null

monthly_cost_pln

number | null

provider_number_id

string | null

purchased_at

string<date-time> | null

assigned_at

string<date-time> | null

created_at

string<date-time> | null

order_id

integer | null

order_status

string | null

order_status_reason

string | null

outbound_commitment_until

string<date-time> | null

Start

Endpoints

List Agent Numbers

Authorizations

Headers

Path Parameters

Response