Saltar al contenido principal
GET
/
v1
/
phone-numbers
curl -X GET "https://api.contactship.ai/v1/phone-numbers" \
  -H "x-api-key: your-api-key"

{
  "data": [
    {
      "id": "pn-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "phone_number": "+12025551234",
      "type": "outbound",
      "organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "created_at": "2026-01-15T10:00:00Z"
    },
    {
      "id": "pn-b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "phone_number": "+14155559876",
      "type": "inbound",
      "organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "created_at": "2026-02-01T08:30:00Z"
    }
  ],
  "count": 2
}

Documentation Index

Fetch the complete documentation index at: https://docs.contactship.ai/llms.txt

Use this file to discover all available pages before exploring further.

Returns the phone numbers registered to your organization. Use these numbers as the from_number_id when initiating calls via the Make AI Phone Call endpoint.

​
Headers

​
x-api-key
string
requerido
Your API key for authentication. Found in your dashboard under API settings.

​
Query Parameters

​
limit
number
predeterminado:"5"
Maximum number of records to return. Must be ≥ 0.
​
offset
number
predeterminado:"0"
Number of records to skip for pagination.
​
order
string
predeterminado:"desc"
Sort direction by creation date. Possible values: asc, desc.
​
type
string
Filter by number type. Possible values: inbound, outbound.

​
Response

​
data
array
Array of phone number objects.
​
count
number
Total number of phone numbers in your organization.

​
Error Codes

  • 401 Unauthorized — Invalid or missing API key
  • 500 Internal Server Error — Server-side error

​
Code Examples

curl -X GET "https://api.contactship.ai/v1/phone-numbers" \
  -H "x-api-key: your-api-key"

{
  "data": [
    {
      "id": "pn-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "phone_number": "+12025551234",
      "type": "outbound",
      "organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "created_at": "2026-01-15T10:00:00Z"
    },
    {
      "id": "pn-b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "phone_number": "+14155559876",
      "type": "inbound",
      "organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "created_at": "2026-02-01T08:30:00Z"
    }
  ],
  "count": 2
}