List short codes

GET 
/short_codes

List short codes

Query Parameters

filter object

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

page object

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

200: Successful response with a list of short codes.

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

record_type string

Possible values: [short_code]

Identifies the type of the resource.

id uuid

Identifies the type of resource.

short_code string

Short digit sequence used to address messages.

country_code string

Possible values: Value must match regular expression ^[A-Z]{2}$

ISO 3166-1 alpha-2 country code.

messaging_profile_id stringnullablerequired

Unique identifier for a messaging profile.

created_at date-time

ISO 8601 formatted date indicating when the resource was created.

updated_at date-time

ISO 8601 formatted date indicating when the resource was updated.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "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",
      "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
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/short_codes' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "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",
      "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
  }
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}