List
Projects in workspace
Returns all projects of the authorized user. Users with admin rights get 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 , administrators get only the projects to which they belong in the workspace. |
page | Integer | The number of the successive pages (results are split into pages of per_page elements each). |
per_page | Integer | Specifies the number of returned elements on the page. The default value is 20. |
sort_by | String | Specifies ordering. Can be one of name , create_date or repository_size . |
sort_direction | String | Specifies the direction of ordering. Can be one of ASC or DESC . |
status | String | Filters projects by 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"
}
]
}
Members
List all members of the specified project. The authorized user must have admin rights in the project to get the information about permissions in that project.
Required scopes: WORKSPACE
Resource URL
GET /workspaces/:domain/projects/:project_name/members
URL Parameters
Name | Type | Description |
---|---|---|
domain Required | String | The workspace domain. |
project_name Required | String | The name of the project. |
GET Parameters
Name | Type | Description |
---|---|---|
page | Integer | The number of the successive pages (results are split into pages of per_page elements each). |
per_page | Integer | Specifies the number of returned elements on a page. |
sort_by | String | Specifies the ordering. Can be one of email or name . |
sort_direction | String | Specifies the direction of the ordering. Can be one of ASC or DESC . |
Example
Request
GET https://api.buddy.works/workspaces/buddy/projects/company-website/members?page=1&per_page=2&sort_by=name&sort_direction=ASC
Sample Response
HTTP
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
{
"url": "https://api.buddy.works/workspaces/buddy/project/company-website/members",
"html_url": "https://app.buddy.works/buddy/company-website/members",
"members": [
{
"url": "https://api.buddy.works/workspaces/buddy/projects/2/member/1",
"html_url": "https://app.buddy.works/buddy/company-website/members/profile/1",
"id": 1,
"name": "Mike Benson",
"avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png"
}
]
}
Groups
Lists all groups assigned to the specified project. The authorized user must have admin rights in the project to get the information about permissions in that project.
Required scopes: WORKSPACE
Resource URL
GET /workspaces/:domain/projects/:project_name/groups
URL Parameters
Name | Type | Description |
---|---|---|
domain Required | String | The workspace domain. |
project_name Required | String | The name of the project. |
GET Parameters
Name | Type | Description |
---|---|---|
page | Integer | The number of the successive pages (results are split into pages of per_page elements each). |
per_page | Integer | Specifies the number of returned elements on a page. |
sort_by | String | Specifies the ordering. Can be one of email or name . |
sort_direction | String | Specifies the direction of the ordering. Can be one of ASC or DESC . |
Example
Request
GET https://api.buddy.works/workspaces/buddy/projects/company-website/groups
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/2/groups",
"html_url": "https://app.buddy.works/buddy/company-website/team",
"groups": [
{
"url": "https://api.buddy.works/workspaces/buddy/projects/2/group/2",
"html_url": "https://app.buddy.works/buddy/company-website/team",
"id": 2,
"name": "Developers",
"permission_set": {
"url": "https://api.buddy.works/workspaces/buddy/permissions/2",
"html_url": "https://app.buddy.works/buddy/permissions/edit/2",
"id": 2,
"name": "Read-only",
"description": null,
"type": "READ_ONLY",
"repository_access_level": "READ_ONLY",
"pipeline_access_level": "READ_ONLY",
"sandbox_access_level": "READ_ONLY"
}
}
]
}
Last modified on August 26, 2024