List all short codes

This API can be used to fetch a list of short codes from the Number Pool based on number_pool_UUID specified in the resource URI.

API Endpoint

Arguments

Returns

This API returns the list of short codes from the Number Pool matching the filters specified in the request.

The API response also contains a meta field with the following fields:

• limit: This the size of the page returned in the response.
• next: The URL that points to the next page of results.
• offset: The offset for the page returned in the response.
• previous: The URL that points to the previous page of results.
• total_count: The total number of records that match the specified filters.

Response

HTTP Status Code: 200

{
    "api_id": "614b2776-0a88-11ea-b072-0242ac110007",
    "meta": {
        "limit": 20,
        "next": "",
        "offset": 0,
        "previous": "",
        "total_count": 1
    },
    "objects": [
        {
            "added_on": "2019-10-09T11:10:59.741978Z",
            "country_iso2": "US",
            "number_pool_uuid": "{number_pool_uuid}",
            "shortcode": "{your_short_code}"
        }
    ]
}