Skip to main content

Get Dids

This request will return a list of DIDs.

get /dids

Sample​

A sample GET request to retrieve a list of DIDs rented through CarrierX:

curl -X GET \
'https://api.carrierx.com/mediator/v1/dids' \
-u 'mediator_user_123:qwerty123'

Response​

200 status code with a list of DID objects:

{
    "body": {
        "count": 1,
        "has_more": false,
        "items": [
            {
                "account_sid": "13e156f7-0d21-4ba6-9e32-c56dc2c6098f",
                "country_code": "USA",
                "did_sid": "5dbed1ba-b7e7-4337-9d9c-36ef03ac2805",
                "in_country_format": "(516) 206-5337",
                "international_format": "+1 516-206-5337",
                "phonenumber": "15162065337"
            }
        ],
        "limit": 10,
        "offset": 0,
        "pagination": {},
        "total": 1
    },
    "status": 200
}

CarrierX automatically populates this collection with DIDs routed to the specific endpoint.

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