curl -X GET \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer YOUR_API_KEY" \
--globoff "https://api.telnyx.com/v2/short_codes?page[size]=10"
Parameters
In Query
page[number]
integer
(1)optional
The page number to load
Default:
1
page[size]
integer
(1 - 250)optional
The size of the page
Default:
20
filter[messaging_profile_id]
string
optional
Filter by Messaging Profile ID. Use the string `null` for phone numbers without assigned profiles. A synonym for the `/messaging_profiles/{id}/short_codes` endpoint when querying about an extant profile.
Responses
200
Successful response with a list of short codes.
default
Unexpected error
Success Response
{
"data": {
"country_code": "US",
"created_at": "2019-01-23T18:10:02.574Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"record_type": "short_code",
"short_code": "12345",
"updated_at": "2019-01-23T18:10:02.574Z"
},
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
Previous:
Messaging ProfilesNext:
TwexitWas this page helpful?