List phone numbers assigned to the caller workspace

Overview

Public API (v1)

Agents

Campaigns

Calls & analytics

Phone numbers

Chatbots & knowledge bases

Integrations & CRM

Speech analysis

Commerce

Workflows

Workspace

List phone numbers assigned to the caller workspace

curl --request GET \
  --url https://api.pineyard.ai/phone-numbers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.pineyard.ai/phone-numbers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "id": "<string>",
      "e164": "<string>",
      "country": "<string>",
      "region": "<string>",
      "capabilities": {},
      "assignedAt": "2023-11-07T05:31:56Z",
      "inboundAgentId": "<string>",
      "inboundAgentName": "<string>",
      "inboundReady": true
    }
  ]
}

GET

phone-numbers

List phone numbers assigned to the caller workspace

curl --request GET \
  --url https://api.pineyard.ai/phone-numbers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.pineyard.ai/phone-numbers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "id": "<string>",
      "e164": "<string>",
      "country": "<string>",
      "region": "<string>",
      "capabilities": {},
      "assignedAt": "2023-11-07T05:31:56Z",
      "inboundAgentId": "<string>",
      "inboundAgentName": "<string>",
      "inboundReady": true
    }
  ]
}

Required scope: phone_numbers.view

Authorizations

Authorization

string

header

required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Response

items

object[]

required

Show child attributes