Get Subscribers

This request returns a list of subscribers.

get	/subscribers

Sample Request

This is a sample GET request to retrieve subscribers matching the criteria in the request URL:

curl -X GET \
'https://api.carrierx.com/conference/v1/subscribers' \
-u '[your_user_name]:[your_password]'

Sample Response

200 status code with a list of Subscriber objects:

{
    "last": 1,
    "offset": 0,
    "subscribers": [
        {
            "authenticationToken": "MWMx0BU1YZE0MV==",
            "created": 1586872518000,
            "didGroupReferences": [],
            "externalId": -1,
            "firstName": "CarrierX",
            "lastName": "",
            "login": "test_carrierx_conference_135",
            "parentSid": "zzpF93QCVvfYYJb2KdPSzGW6lqGLB3qm",
            "role": 3,
            "sid": "rB0M9.EzXfaO4keb-opANwfb7CHx1Ph1"
        },
        {
            "authenticationToken": "MWMx0BU1YZE0MV=",
            "callback": {
                "id": 779127,
                "url": "https://mywebsite.com/new-url"
            },
            "created": 1603107611000,
            "details": "some details about subscriber",
            "didGroupReferences": [
                {
                    "didGroupId": 731,
                    "state": 0
                }
            ],
            "externalId": -1,
            "firstName": "John",
            "lastName": "Smith",
            "login": "test_john_smith_conference_164",
            "parentSid": "rB0M9.EzXfaO4keb-opANwfb7CHx1Ph1",
            "phoneNumber": "9197473626",
            "role": 2,
            "sid": "6v9u9-p35vZo1Cxq0qKkQn9X57T5cfAj"
        }
    ],
    "total": 2
}

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