Back to PipedriveGet all roles
Returns all the roles within the company.
Input
type: object
properties:
parameters:
type: object
properties:
start:
type: integer
default: 0
description: Pagination start
limit:
type: integer
description: Items shown per page
Output
title: getRolesResponse200
type: object
properties:
success:
type: boolean
description: If the response is successful or not
data:
type: array
description: The array of roles
items:
title: fullRole
description: The details of the sub-role
type: object
properties:
parent_role_id:
type: integer
description: The ID of the parent role
name:
type: string
description: The name of the role
id:
type: integer
description: The ID of the role
active_flag:
type: boolean
description: Whether the role is active or not
assignment_count:
type: string
description: The number of users assigned to this role
sub_role_count:
type: string
description: The number of sub-roles
level:
type: integer
description: The level of role in the role hierarchy
additional_data:
description: The additional data in the role list
type: object
properties:
pagination:
description: The pagination details in the role list
type: object
properties:
start:
type: integer
description: Pagination start
limit:
type: integer
description: Items shown per page
more_items_in_collection:
type: boolean
description: Whether there are more list items in the collection than displayed