Get DIDs

This request returns a list of DIDs that have been rented.

get	/phonenumber/dids

Sample

A sample GET request to get rented DIDs matching the criteria in the request URL:

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/dids' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a list of DID objects:

{
    "count": 1,
    "has_more": true,
    "items": [
        {
            "active_capabilities": 4,
            "attributes": {},
            "callback_url": null,
            "campaign_sid": null,
            "capabilities": 7,
            "classification_sid": "17f4d954-d635-4cda-912b-c2a2fa3a6860",
            "country_code": "USA",
            "did_group_sid": null,
            "did_sid": "e8df62d5-07a3-4189-a67e-87585067c5fe",
            "in_country_format": "(516) 206-5574",
            "international_format": "+1 516-206-5574",
            "lata": null,
            "locality": "NEW YORK",
            "lrn_sid": null,
            "name": "N/A",   
            "ocn": "251F",
            "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
            "phonenumber": "15162065574",
            "porting_pin": null,
            "price": "0.6",
            "state": "NY",
            "status": "assigned",
            "string_key_1": null,
            "string_key_2": null,
            "transformations": [],
            "trunk_group_sid": null
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {
        "next": "https://api.carrierx.com/core/v2/phonenumber/dids?limit=1&offset=1"
    },
    "total": 2
}

This request is enabled for Pagination, Result Filtering, and Field Filtering.

Required Scopes

To get information about Partner objects, the partner must have one of the following scopes enabled:

• partners.manage
• partners.read

Query Arguments

Parameter	Data Type	Description
trunk_group_sid	string	The trunk group secure ID, used to return DIDs only for a specific trunk group.
with_related	boolean	Determines if the partner information related to the phone number should be shown. Values accepted in this field are true and false. The default value is false.