v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Project API

Get all projects in the workspace

get/workspaces/{workspace_domain}/projects

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

Query parameters

pageinteger
Example:1

The number of the successive pages (results are split into pages of per_page elements each).

per_pageinteger
Example:20

Specifies the number of returned elements on the page. The default value is 20.

statusstring
Example:ACTIVE

Filters projects by the specified status. Can be one of ACTIVE or CLOSED

sort_bystring
Example:name

Specifies ordering. Can be one of name, create_date or repository_size

sort_directionstring
Example:ASC

Specifies the direction of the ordering. Can be one of ASC or DESC

membershipstring
Example:true

Filter projects by membership. If set to true, administrators get only the projects to which they belong in the workspace.

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

Example response

{
  "projects": [
    {
      "name": "my-project",
      "display_name": "My Project"
    }
  ]
}