List Access Roles

GET /api/v2/roles.json

Get or search for one or more Access Roles.

Scopes

Requires either the roles or roles.readonly OAuth scope.

Query Parameters

Accepts the following query parameters:

id:in
Return Access Roles by a comma-separated list of IDs.

reference

Used to find a single Access Role by its reference property. The title must match the correct spelling (case-insensitive) - does not permit partial matches.

reference:in

A comma-separated list of references to find one or more Access Roles. The titles must match the correct spelling (case-insensitive) - does not permit partial matches.

title

Used to find a single Access Role by its title property. The title must match the correct spelling (case-insensitive) - does not permit partial matches.

title:in

A comma-separated list of titles to find one or more Access Roles. The titles must match the correct spelling (case-insensitive) - does not permit partial matches.

JSON response

Evance will return a JSON object containing the following properties:

success
A successful search request containing zero or more results will always return a true value.

status
An integer matching the HTTP response code. A successful request will have a status of 200.

data
An array containing zero or more Access Role data objects.

pagination
Search results include a pagination object contain information about the current page, total pages, the limit per page and the total number of results available.

limit - the number of results to return per page
page - the current page number
total - the total number of available results
totalPages - the total number of available pages of results

links
An object containing links to traverse available search results.

self - the URL for the current search.
previous - a URL for the previous results page, or null if there isn't one.
next - a URL for the next results page, or null if there isn't one

Example response

In the example below you're able to see examples of Access Roles.


{
    "success": true,
    "status": 200,
    "data": [
        {
            "id": 53245,
            "reference": "trade-account",
            "title": "Trade Account",
            "deniedUrl": null,
            "approvalMethod": "admin",
            "emailValidationUrl": null,
            "adminPendingUrl": null,
            "adminApprovedUrl": null,
            "adminRejectedUrl": null,
            "adminApprovalEmail": "administrator@example.com",
            "createdOn": "2022-05-21T15:54:05+00:00",
            "modifiedOn": "2022-05-21T15:54:05+00:00"
        }
    ],
    "pagination": {
        "page": 1,
        "limit": 100,
        "total": 1,
        "totalPages": 1
    },
    "links": {
        "self": "https://examples.evance.me/api/v2/geozones.json",
        "previous": null,
        "next": null
    }
}

List Access Roles

Scopes

Query Parameters

JSON response

Example response

Website builder

Themes

Partners

Resources

Evance