Sign in
Profiles

List short codes associated with a messaging profile

Returns the short codes currently associated with the specified messaging profile.

get/messaging_profiles/{id}/short_codes

Path parameters

idstring uuid required

The id of the messaging profile to retrieve

Query parameters

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 messaging profile 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
  }
}

Changes

Changed in 2 of the 61 revisions of this API.7

  • 1571b0380bd73See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 4XX

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from object/ to / for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 4XX

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379944See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 4XX

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status 4XX

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog