Get All Groups of a Organization

Request

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

Parameter	Description
`fields`	Optional. Returns only the specified subset of the fields for each Group. Use Fields Syntax to define the subset.
`$skip`	Optional. Lets you set a number of Groups to skip before returning the first one.
`$top`	Optional. Lets you set the maximum number of Groups to return.
`query`	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 Groups, the following fields and tuples are supported: access(project: project, with: role) — Groups that have the given role in the given project access(project: project, with: permission) — Groups that have the given permission in the given project access(project: project) — Groups that have some role in the given project access(organization: organization, with: role) — Groups that have the specified role assigned in the specified organization access(organization: organization, with: permission) — Groups that have the specified permission granted in the specified organization access(organization: organization) — Groups that have any role assigned in the specified organization access(with: role) — Groups that have the given role assigned anywhere access(with: permission) — Groups that have the given permission granted anywhere has: ownRole — Groups with own roles has: user — Groups with users has: subgroup — Groups with subgroups has: icon — Groups with an icon id: value — Group with the given ID is: allUsers — All users group is: registeredUsers — Registered users group is: autoJoin — Groups with enabled auto join is: required2FA — Groups with required two-factor authentication name: groupName — Group with the given name ownRole: role — Groups that have the given role as an own role parent: group — Subgroups of the given group project: project — Groups from the given project subgroup: group — Group that contains the given group as subgroup team: team — Groups included to the given project team user: user — Groups that immediately contain the given user
`orderBy`	Optional. Returns the list of Groups sorted by a specified field. See Sorting Syntax for details. Groups support ordering by the following fields: name

Response

Response Code	Meaning
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, 
    "groups": [userGroup, ...]
  }

Last modified: 7 November 2024