curl -X GET "https://api.contactship.ai/v1/phone-numbers" \
-H "x-api-key: your-api-key"
const response = await fetch('https://api.contactship.ai/v1/phone-numbers', {
headers: { 'x-api-key': 'your-api-key' },
});
const { data, pagination } = await response.json();
console.log(`${pagination.total_rows} phone numbers available`);
import requests
response = requests.get(
'https://api.contactship.ai/v1/phone-numbers',
headers={'x-api-key': 'your-api-key'},
)
result = response.json()
for number in result['data']:
print(f"{number['phone_number']} ({number['type']}) — id: {number['id']}")
{
"statusCode": 200,
"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"
}
],
"pagination": {
"page": 1,
"total_rows": 2,
"total_pages": 1
}
}
Números de teléfono
List Phone Numbers
Retrieve all phone numbers associated with your organization
GET
/
v1
/
phone-numbers
curl -X GET "https://api.contactship.ai/v1/phone-numbers" \
-H "x-api-key: your-api-key"
const response = await fetch('https://api.contactship.ai/v1/phone-numbers', {
headers: { 'x-api-key': 'your-api-key' },
});
const { data, pagination } = await response.json();
console.log(`${pagination.total_rows} phone numbers available`);
import requests
response = requests.get(
'https://api.contactship.ai/v1/phone-numbers',
headers={'x-api-key': 'your-api-key'},
)
result = response.json()
for number in result['data']:
print(f"{number['phone_number']} ({number['type']}) — id: {number['id']}")
{
"statusCode": 200,
"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"
}
],
"pagination": {
"page": 1,
"total_rows": 2,
"total_pages": 1
}
}
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
string
requerido
Your API key for authentication. Found in your dashboard under API settings.
Query Parameters
number
predeterminado:"5"
Maximum number of records to return. Must be ≥ 0.
number
predeterminado:"0"
Number of records to skip for pagination.
string
predeterminado:"desc"
Sort direction by creation date. Possible values:
asc, desc.string
Filter by number type. Possible values:
inbound, outbound.Response
The response containsstatusCode, a data array, and pagination with page, total_rows, and total_pages.
array
Array of phone number objects.
Mostrar Phone number object
Mostrar Phone number object
string
Unique identifier of the phone number (UUID). Use this as
from_number_id when making calls.string
The phone number in E.164 format (e.g.
+12025551234).string
Number type:
inbound or outbound.string
UUID of the organization that owns this number.
string
Timestamp when the number was added (ISO 8601).
object
Pagination metadata:
page, total_rows, and total_pages.Error Codes
401 Unauthorized— Invalid or missing API key500 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"
const response = await fetch('https://api.contactship.ai/v1/phone-numbers', {
headers: { 'x-api-key': 'your-api-key' },
});
const { data, pagination } = await response.json();
console.log(`${pagination.total_rows} phone numbers available`);
import requests
response = requests.get(
'https://api.contactship.ai/v1/phone-numbers',
headers={'x-api-key': 'your-api-key'},
)
result = response.json()
for number in result['data']:
print(f"{number['phone_number']} ({number['type']}) — id: {number['id']}")
{
"statusCode": 200,
"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"
}
],
"pagination": {
"page": 1,
"total_rows": 2,
"total_pages": 1
}
}