Get All Projects
Request
GET <REST API URL>/projects?fields=string&$skip=int&$top=int&query=string&orderBy=string&archived=booleanParameter | Description |
|---|---|
| Optional. Returns only the specified subset of the fields for each Project. Use Fields Syntax to define the subset. |
| Optional. Lets you set a number of Projects to skip before returning the first one. |
| Optional. Lets you set the maximum number of Projects 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 Projects, the following fields and tuples are supported: accessible(for: user, with: role) — Projects where the specified user has the specified role accessible(for: group, with: role) — Projects where the specified group has the specified role accessible(for: service, with: role) — Projects where the specified service has the specified role accessible(for: user, with: permission) — Projects where the specified user has the specified permission accessible(for: group, with: permission) — Projects where the specified group has the specified permission accessible(for: service, with: permission) — Projects where the specified service has the specified permission accessible(for: user) — Projects where the specified user has any permission accessible(for: group) — Projects where the specified group has any permission accessible(for: service) — Projects where the specified service has any permission accessible(with: role) — Projects where somebody has the specified role accessible(with: permission) — Projects where somebody has the specified permission after: instant — Projects created after the specified moment before: instant — Projects created before the specified moment favorite(for: user) — Returns favorite projects of the specified user has: resource — Projects with resources id: value — Project with the given ID is: global — Global project is: archived — Archived project is: favorite — My favorite project key: projectKey — Project with the specified key name: projectName — Project with the specified name resource: resource — Project with the specified resource resource(key: resourceKey, service: service) — Projects with the specified resource of service resource(service: service) — Projects with resources of the service resource(name: resourceName, service: service) — Projects with the specified resource of service |
| Optional. Returns the list of Projects sorted by a specified field. See Sorting Syntax for details. Projects support ordering by the following fields: creationTime, key, name |
| Query parameter of type boolean. |
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,
"projects": [project, ...]
}