organization_roles

List the roles of an organization

Returns the roles defined in the organization, paginated.

Access: the caller needs either the client-level permission client_organization_roles:read or the organization-level permission organization_roles:read. Every endpoint under this organization also requires the client plan to allow at least 2 users (error 511 otherwise).

get/organizations/{id_organization}/roles

Request

  • Base URL: https://api.planvortex.com/v1.0.0
  • URL: https://api.planvortex.com/v1.0.0/organizations/{id_organization}/roles
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)

Path parameters

id_organizationstring required

Organization identifier

Query parameters

offsetinteger

Number of records to skip (pagination)

limitinteger

Maximum number of records returned (pagination)

Response

Successful operation

totalinteger

Total number of roles in the organization, ignoring pagination.

Changes

No recorded changes to this operation across all 1 revision of this API.