List workspace projects

Returns all authorized projects of the user. If the user has admin rights, he’ll receive a list of all projects in the workspace.

Required scopes: WORKSPACE

Resource URL

GET /workspaces/:domain/projects

URL Parameters

Name	Type	Description
domain `Required`	String	The workspace domain.

GET Parameters

Name	Type	Description
membership	Boolean	If set to `true`, the admin will receive only the projects to which he belongs in the workspace.
page	Integer	The number of the successive page (results are splitted by pages of `per_page` elements each).
per_page	Integer	The number of returned elements on the page.
sort_by	String	Specifies ordering. Can be one of `name`, `create_date` or `repository_size`.
sort_direction	String	Specifies direction of ordering. Can be one of `ASC` or `DESC`.
status	String	Filters projects to the specified status. Can be one of `ACTIVE` or `CLOSED`.

Example

Request

GET https://api.buddy.works/workspaces/buddy/projects?page=1&per_page=2

Sample Response

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/projects",
  "html_url": "https://app.buddy.works/buddy",
  "projects": [
    {
      "url": "https://api.buddy.works/workspaces/buddy/projects/company-website",
      "html_url": "https://app.buddy.works/buddy/company-website",
      "name": "company-website",
      "display_name": "Company Website",
      "status": "ACTIVE"
    }
  ]
}