List User Roles

The List User Roles API allows you to fetch a list of user roles within Zenput.
Below is a sample call and a full description of input parameters, and success and error output formats.

$ curl -H 'X-API-TOKEN: <API_TOKEN>' \
    'https://www.zenput.com/api/v3/userroles/?start=0&limit=1'

Input parameters
All input parameters are optional.

Name

Type

Description

external_key

text

Filter results to given external key.

limit

integer

Number of results to return per page.

start

integer

The initial index from which to return the results.

meta_only

boolean

Return only data within the meta key.

Output format (success)

{
  "meta": {
    "status_code": 200,
    "count": 999,
    "next": "https://www.zenput.com/api/v3/teams/?limit=1&start=1",
    "previous": null
  },
  "data": [
    {
      "id": 2,
      "name": "User role name",
      "parent": {
        "id": 1,
        "name": "Parent user role"
      },
      "children": [
        {
          "id": 3,
          "name": "Child user role"
        }
      ],
      "default_permission": {
        "id": 2,
        "name": "Manager"
      }
    }
  ]
}