People

List roles

Lists the available roles that can be assigned to a person to determine their access and permissions.

get/roles

Request

Query parameters

accountIdstring

NOT USED YET

limitinteger

The maximum number of results to return.

Example:200
offsetinteger

The number of items to skip before returning results.

Example:100

Response

OK

limitinteger

The maximum number of results to return.

offsetinteger

The number of items to skip before returning results.

countinteger required

The total amount of records matching the querying when "limit" is ignored.

searchstring

The term to search the records for.

Example response

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "search": "Cesar+Treutel",
  "rows": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "Viewer",
      "accountId": "F50091",
      "type": "core",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.