Skip to main content
GET
/
custom_role
List Custom Roles
curl --request GET \
  --url https://api.partoo.co/v2/custom_role \
  --header 'x-APIKey: <api-key>'
{
  "page": 1,
  "max_page": 10,
  "count": 3,
  "custom_roles": [
    {
      "name": "This is My Custom Role",
      "api_id": "this_is_my_custom_role",
      "description": "It has a custom permission configuration!",
      "org_id": 42,
      "is_builtin": false
    }
  ]
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Query Parameters

​
page
integer
default:0

Page number. 30 results per page

​
per_page
integer
default:30

Number of items to return per page. Currently limited to 100.

Required range: 1 <= x <= 100
​
only_available_roles
boolean
default:false

If true: only return roles for which the requesting user has all required permissions (Custom Fields permissions are also taken into account).

Response

OK

A list of Custom Roles is returned upon success.

​
page
integer

Current page number

Example:

1

​
max_page
integer

Last page number

Example:

10

​
count
integer

Total number of Custom Roles found.

Example:

3

​
custom_roles
object[]

The list of Custom Roles.