Retrieve a list of all Short Codes in the Proxy Number Pool for the Service

GET /v1/Services/{ServiceSid}/ShortCodes

TODO: Resource-level docs

Retrieve a list of all Short Codes in the Proxy Number Pool for the Service. A maximum of 100 records will be returned per page.

Path parameters

Query parameters

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • meta object
      Hide meta attributes Show meta attributes
    • short_codes array[object]
      Hide short_codes attributes Show short_codes attributes
      • account_sid string | null

        The SID of the Account that created the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • capabilities object(phone-number-capabilities) | null

        The capabilities of the short code

        Hide capabilities attributes Show capabilities attributes
      • date_created string(date-time) | null

        The ISO 8601 date and time in GMT when the resource was created

      • date_updated string(date-time) | null

        The ISO 8601 date and time in GMT when the resource was last updated

      • is_reserved boolean | null

        Whether the short code should be reserved for manual assignment to participants only

      • iso_country string | null

        The ISO Country Code

      • service_sid string | null

        The SID of the resource's parent Service

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KS[0-9a-fA-F]{32}$.

      • short_code string | null

        The short code's number

      • sid string | null

        The unique string that identifies the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^SC[0-9a-fA-F]{32}$.

      • url string(uri) | null

        The absolute URL of the ShortCode resource
GET /v1/Services/{ServiceSid}/ShortCodes 
curl \
 -X GET https://proxy.twilio.com/v1/Services/{ServiceSid}/ShortCodes \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "short_codes": [
    {
      "account_sid": "string",
      "capabilities": {
        "fax": true,
        "mms": true,
        "sms": true,
        "voice": true
      },
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "is_reserved": true,
      "iso_country": "string",
      "service_sid": "string",
      "short_code": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ]
}