Short Code Numbers
Overview
A short number (4-6 digits) used for sending and receiving SMS and MMS messages to mobile phones in a single country. Short code numbers are strictly domestic and are not recommended for sending international traffic.
API Access
The following API requests can only be made using a valid access key, and attached to an access role, with an access policy that at least specifies the permissions to the resources outlined in each section below. Learn more about API access.
List Short Code Numbers
In order to retrieve all short code numbers available in your workspace you can use this request.
Get a list of all short code numbers assigned to your workspace. The results can be paginated. To learn more about the pagination, please refer to the pagination section on API Access Common API Usage section.
The ID for the workspace.
d386a801-ee8d-4aba-a7e4-78671bd3b11e
Limits the number of results to return per page. The default value is 10 and maximum is 99. If the nextPageToken is defined on response, you can use it to get remaining numbers. To know more, refer to the pagination section.
10
Pagination token that keeps of track of the current position in the list. Use it to query remaining results. If not provided, the first page is returned. To learn more about the pagination, please refer to the pagination section on API Access Common API Usage section.
Order in which to retrieve the results. By default, the orders are in ascending order date. To get the results in descending order, set this parameter to true.
false
GET /workspaces/{workspaceId}/numbers-short-code HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*
OK
{
"nextPageToken": "text",
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"endpointId": "123e4567-e89b-12d3-a456-426614174000",
"type": "dedicated",
"numberString": "text",
"countryCode": "US",
"capabilities": {
"voice": {
"inbound": true,
"outbound": true
},
"sms": {
"inbound": true,
"outbound": true
},
"mms": {
"inbound": true,
"outbound": true
}
},
"createdAt": "2025-08-01T15:31:36.492Z",
"updatedAt": "2025-08-01T15:31:36.492Z",
"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:31:36.492Z",
"updatedAt": "2025-08-01T15:31:36.492Z"
}
}
]
}
curl "https://api.bird.com/workspaces/{workpaceId}/numbers-short-code/" \
-H 'Authorization: Bearer <your-access-key>'
Get a Short Code Number
In order to retrieve the details of a short code number available in your workspace you can use this request.
This endpoint returns the previously created short code number by its ID.
The ID for the workspace.
d386a801-ee8d-4aba-a7e4-78671bd3b11e
Your short code number/endpoint ID.
65b18a3d-6515-4ee5-bd6d-6d638cf9bc78
GET /workspaces/{workspaceId}/numbers-short-code/{shortCodeNumberId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"endpointId": "123e4567-e89b-12d3-a456-426614174000",
"type": "dedicated",
"numberString": "text",
"countryCode": "US",
"capabilities": {
"voice": {
"inbound": true,
"outbound": true
},
"sms": {
"inbound": true,
"outbound": true
},
"mms": {
"inbound": true,
"outbound": true
}
},
"createdAt": "2025-08-01T15:31:36.492Z",
"updatedAt": "2025-08-01T15:31:36.492Z",
"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:31:36.492Z",
"updatedAt": "2025-08-01T15:31:36.492Z"
}
}
curl "https://api.bird.com/workspaces/{workpaceId}/numbers-short-code/{shorCodeNumberId}" \
-H 'Authorization: Bearer <your-access-key>'
Last updated
Was this helpful?