GET · Bearer

GET /api/v1/inboxes/:id/phone-number

Summary

Read the active phone number on an inbox Requires inbox_read. HTTP 404 not_found when COOPER_SMS is off, and in operators mode unless this account is an operator. HTTP 404 phone_number_not_found when the inbox has no active number. Another inbox on an inbox-scoped key is HTTP 404 inbox_not_found.

Request

This call has no JSON body.

Response

HTTP 200. Sample values illustrate the schema.

{
  "object": "phone_number",
  "id": "inb_example",
  "account_id": "acc_example",
  "e164": "+14155550100",
  "provider": "string",
  "provider_sid": "string",
  "number_type": "string",
  "capabilities": [
    "string"
  ],
  "status": "pending",
  "outbound": "string",
  "created_at": "2026-10-18T12:00:00.000Z"
}

Errors

  • HTTP 404 not_found
  • HTTP 404 phone_number_not_found
  • HTTP 404 inbox_not_found

Idempotency

This route does not document Idempotency-Key or client_id.