Skip to main content
GET
List Custom Roles

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:1

Page number. Starts at 1. Any value lower than 1 will be considered as 1. For the number of items per page, see the per_page query parameter.

per_page
integer
default:30

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

Required range: 1 <= x <= 100
org_id
integer

Organization ID. Only PROVIDER users can specify a different organization. If not provided, defaults to your own organization.

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.