Get All Projects
Request
GET <REST API URL>/projects?fields=string&$skip=int&$top=int&query=string&orderBy=string&archived=booleanParameter | Description |
|---|---|
fields | Optional. Returns only the specified subset of the fields for each Project. Use Fields Syntax to define the subset. |
$skip | Optional. Lets you set a number of Projects to skip before returning the first one. |
$top | Optional. Lets you set the maximum number of Projects 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 Projects, the following fields and tuples are supported: accessible(for: user, with: role) — Returns projects where the specified user has the specified role accessible(for: group, with: role) — Returns projects where the specified group has the specified role accessible(for: service, with: role) — Returns projects where the specified service has the specified role accessible(for: user, with: permission) — Returns projects where the specified user has the specified permission accessible(for: group, with: permission) — Returns projects where the specified group has the specified permission accessible(for: service, with: permission) — Returns projects where the specified service has the specified permission accessible(for: user) — Returns projects where the specified user has any permission accessible(for: group) — Returns projects where the specified group has any permission accessible(for: service) — Returns projects where the specified service has any permission accessible(with: role) — Returns projects where somebody has the specified role accessible(with: permission) — Returns projects where somebody has the specified permission after: instant — Returns projects that were created after the specified moment before: instant — Returns projects that were created before the specified moment favorite(for: user) — Returns favorite projects of the specified user has: resource — Returns projects with at least one resource has: organization — Returns projects that are assigned to an organization id: value — Project with the given ID is: global — Returns Global projects is: archived — Returns archived projects is: favorite — Returns favorite projects of the current user key: projectKey — Returns project with the specified key name: projectName — Returns project with the specified name organization: organization — Returns projects that are assigned to the specified organization resource: resource — Returns project with the specified resource resource(key: resourceKey, service: service) — Returns project with the resource of the specified service resource(name: resourceName, service: service) — Returns project with the resource of the specified service resource(service: service) — Returns projects with at least one resource of the specified service |
orderBy | 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, organization |
archived | 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, ...]
}