List short codes

GET /short_codes

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const shortCode of client.shortCodes.list()) {
  console.log(shortCode.messaging_profile_id);
}

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter · object

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

Show child attributes

page · object

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

Show child attributes

Response

200

application/json

Successful response with a list of short codes.

data · object[]

Show child attributes

meta · object

Show child attributes