Short Codes

List short codes

Changed on

Returns short codes owned by the authenticated account. Apply the documented filters and pagination parameters to narrow the result set.

get/short_codes

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/short_codes
  • Auth: HTTP bearer

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": [
    {
      "record_type": "short_code",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "short_code": "12345",
      "country_code": "US",
      "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tags": [
        "test_customer"
      ],
      "created_at": "2019-01-23T18:10:02.574Z",
      "updated_at": "2019-01-23T18:10:02.574Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • 1571b0380bd7Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

  • 8f5f4e537994Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the /// response's property format changed from json-pointer to no format for status