Get Long Code Number Details

Get the details of a specific Long code nnumber that you own.

Get Long Code number by ID

get

This endpoint returns the information of a Long Code Number assigned to the workspace given its ID. You may use the EndpointID as well to search for your long code number.

Authorizations
Path parameters
workspaceIdstring · uuidRequired

The ID for the workspace.

Example: d386a801-ee8d-4aba-a7e4-78671bd3b11e
longCodeNumberIdstringRequired

Your long code number/endpoint ID.

Example: 3d7eb12b-9101-450d-923b-5ffcd9e989a9
Responses
200
OK
application/json
Responseall of
get
GET /workspaces/{workspaceId}/numbers-long-code/{longCodeNumberId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "41e3cf43-4386-464a-a1ee-e6ef6fd6883d",
  "endpointId": "41e3cf43-4386-464a-a1ee-e6ef6fd6883d",
  "numberString": "+14155552671",
  "countryCode": "US",
  "type": "local",
  "capabilities": {
    "voice": {
      "inbound": true,
      "outbound": true
    },
    "sms": {
      "inbound": true,
      "outbound": true
    },
    "mms": {
      "inbound": true,
      "outbound": true
    }
  },
  "createdAt": "2025-08-01T15:23:30.395Z",
  "updatedAt": "2025-08-01T15:23:30.395Z",
  "order": {
    "countryCode": "US",
    "type": "local",
    "capabilities": [
      "voice"
    ],
    "prefix": "text",
    "status": "draft",
    "createdAt": "2025-08-01T15:23:30.395Z",
    "updatedAt": "2025-08-01T15:23:30.395Z"
  },
  "deprovisionAt": "2025-08-01T15:23:30.395Z",
  "endpoint": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "long-code-number",
    "instanceId": "1551f382-6870-4480-8f9b-f5ab34936288",
    "name": "+14155552671",
    "capabilities": [
      {
        "name": "sms",
        "inbound": {
          "status": "active",
          "issues": [
            "subscription-is-not-active"
          ]
        },
        "outbound": {
          "status": "active",
          "destinationStatuses": {
            "active": 1,
            "inactive": 1,
            "available": 1,
            "unavailable": 1
          },
          "supportsDestinations": true,
          "issues": [
            "subscription-is-not-active"
          ]
        }
      }
    ],
    "dependencies": [
      {
        "type": "connector",
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateRef": "text",
        "capabilities": [
          "voice"
        ]
      }
    ],
    "issues": [
      "subscription-is-not-active"
    ],
    "provisioningStatus": "provisioned",
    "createdAt": "2025-08-01T15:23:30.395Z",
    "updatedAt": "2025-08-01T15:23:30.395Z"
  }
}

Last updated

Was this helpful?