Hub 2020.1 Help

Get All Organization Roles of a Organization


GET <REST API URL>/organizations/{organization id}/organizationroles?fields=string&$skip=int&$top=int&query=string&orderBy=string




Optional. Returns only the specified subset of the fields for each OrganizationRole. Use Fields Syntax to define the subset.


Optional. Lets you set a number of OrganizationRoles to skip before returning the first one.


Optional. Lets you set the maximum number of OrganizationRoles to return.


Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the OrganizationRoles, the following fields and tuples are supported:

group: group — Project roles owned by the given group

id: value — Role in organization with the given ID

organization: organization — Organization roles granted for the given organization

permission: permission — Organization roles granted with the given permission

role: role — Project roles granted with the given role

user: user — Project roles owned by the given user


Optional. Returns the list of OrganizationRoles sorted by a specified field. See Sorting Syntax for details. OrganizationRoles support ordering by the following fields: organization, role


Response Code


200 OK

Successful request.

400 Bad Request

At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.

403 Forbidden

The requester has no access to the requested resource.

404 Not Found

The requested resource was not found.

500 Internal Server Error

Failed to process request because of the server error. For details, check the error message in the response.

Response body

{ "skip": int, "top": int, "total": int, "organizationroles": [organizationRole, ...] }
Last modified: 20 October 2020