Skip to main content

​
List all roles

GET /v2/roles

​
Request

Use this request to get a list of all roles that are currently supported. 
curl -i -X GET \
  'https://api.equalsmoney.com/v2/roles' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

​
Query parameters

​
limit
integer
The maximum amount of results to return. By default, this is set to 100.Allowable values: [ 1 .. 1000 ]
​
offset
integer
The amount of results to skip. By default, this is set to 0.Allowable values: A valid integer

​
Response

If your request is successful, you’ll receive a 200 response containing a list of roles. 
{
  "limit": 100,
  "offset": 200,
  "count": 1,
  "rows": [
    {
      "accountId": "F12345",
      "id": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
      "name": "Owner",
      "type": "core"
    }
  ]
}
For more detailed information about this request and its response, see the API reference.