List Numbers

GET

https://api.agentphone.ai/v1/numbers

GET

/v1/numbers

const url = 'https://api.agentphone.ai/v1/numbers';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "data": [
    {
      "id": "string",
      "phoneNumber": "string",
      "country": "string",
      "status": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "type": "sms",
      "agentId": "string",
      "outboundSms": "enabled",
      "voiceRouting": {
        "method": "sip_trunk",
        "sipTrunkId": "string",
        "sipTrunkName": "string",
        "routingState": "pending",
        "routingError": "string"
      },
      "sipTrunkingEligible": false,
      "inboundCallsEnabled": true,
      "readReceiptsEnabled": true,
      "whatsappEnabled": false,
      "dailyNewContacts": {
        "used": 1,
        "limit": 1
      },
      "externalId": "string",
      "rcsFallbackForAlias": "string",
      "expiresAt": "string",
      "purchasedAt": "2024-01-15T09:30:00Z",
      "renewsAt": "string"
    }
  ],
  "hasMore": true,
  "total": 1
}

List the active phone numbers for this account.

Released (deleted) numbers are excluded so the count reflects the numbers the account actually holds. Fetch a single number via GET /{number_id} (which returns it regardless of status). Pass externalId to find the number you tagged with your own identifier.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitintegerOptional<=100Defaults to 20

offsetintegerOptional0-10000Defaults to 0

externalIdstring or nullOptional

Only the number tagged with this externalId

Response

Successful Response

datalist of objects

hasMoreboolean

totalinteger

Errors

422

Unprocessable Entity Error

Authentication

Headers

Query parameters

Response

Errors