1. Documentation
2. API
3. Authorizations
4. List

Listing Authorizations

Get a list of Authorizations, reverse ordered by created date. Use parameters to filter the list.

HTTP Request

GET https://utilityapi.com/api/v2/authorizations

Examples

# Get a list of all Authorizations
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/authorizations'

# Get some specific Authorizations 123 and 456
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/authorizations?uids=123,456'

# Get all archived Authorizations
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/authorizations?is_archived=true'

# Get the Authorizations that were created from a specific referral
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/authorizations?referrals=abcd1234'

# Get the Authorizations for a specific user
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/authorizations?users=6744'

Query Parameters

Response

Returns an AuthorizationListing object containing a list of Authorization objects from newest to oldest. If the number of results is over 1000, or the value set by limit, a next parameter will have the link to the next in the series of lists.

// Example result
{
    "authorizations": [
        {"uid": "12837438", "created": ...},
        {"uid": "12837438", "created": ...},
        ...
    ],
    "next": null,
}

AuthorizationListing

This is the object that contains the Authorization results for the request. We don't just return a straight list of results so that we can paginate results if needed. Currently, the maximum results per request is set at 1000.

// Example AuthorizationListing
{
    "authorizations": [...],
    "next": null,
}

HTTP Response Codes