Get All Organizations
Request
GET <REST API URL>/organizations?fields=string&$skip=int&$top=int&query=string&orderBy=stringParameter | Description |
|---|---|
fields | Optional. Returns only the specified subset of the fields for each Organization. Use Fields Syntax to define the subset. |
$skip | Optional. Lets you set a number of Organizations to skip before returning the first one. |
$top | Optional. Lets you set the maximum number of Organizations 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 Organizations, the following fields and tuples are supported: accessible(for: user, with: role) — Returns organizations where the specified user has the specified role accessible(for: group, with: role) — Returns organizations where the specified group has the specified role accessible(for: user, with: permission) — Returns organizations where the specified user has the specified permission accessible(for: group, with: permission) — Returns organizations where the specified group has the specified permission accessible(for: user) — Returns organizations where the specified user has any permission accessible(for: group) — Returns organizations where the specified group has any permission accessible(with: role) — Returns organizations where somebody has the specified role accessible(with: permission) — Returns organizations where somebody has the specified permission after: instant — Returns organizations that were created after the specified moment before: instant — Returns organizations that were created before the specified moment group: group — Returns organizations that immediately contain the given group has: project — Returns organizations that contain at least one project has: user — Returns organizations that contain at least one user has: group — Returns organizations that contain at least one group has: team — Returns organizations that contain at least one project team id: value — Organization with the given ID name: organizationName — Returns organization with the specified name project: project — Returns organizations that immediately contain the given project team: team — Returns organizations that immediately contain the given project team user: user — Returns organizations that contain the given user |
orderBy | Optional. Returns the list of Organizations sorted by a specified field. See Sorting Syntax for details. Organizations support ordering by the following fields: creationTime, 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,
"organizations": [organization, ...]
}