Skip to main content

Get Partner Logins

This request returns a list of partner logins.

get /oauth/logins

Sample​

A sample GET request to get partner logins matching the criteria in the request URL:

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

Response​

200 status code with a list of Partner Login objects:

{
    "count": 1,
    "has_more": false,
    "items": [
        {
            "login": "carrierx_partner",
            "login_sid": "abcf6b1f-7281-4da9-a4d6-3fb53e3a76de",
            "partner_sid": "edebf627-ebce-4f77-8160-75db76154168",
            "token_scopes": [
                "partners.read",
                "partners.update"
            ]
        }
    ],
    "limit": 10,
    "offset": 0,
    "pagination": {},
    "total": 1
}

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

Required Scopes​

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

  • oauth.manage
  • oauth.read