v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Short Codes

List short codes

get/short_codes

Query parameters

messaging_profile_idstring

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.

Consolidated filter parameter (deepObject style). Originally: filter[messaging_profile_id]

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Response

Successful response with a list of short codes.

Example 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",
      "tags": [
        "test_customer"
      ],
      "updated_at": "2019-01-23T18:10:02.574Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}