Get

Project

Allows to get the details of a Buddy project. Only the project members or administrators can get the data.

Required scopes: WORKSPACE

Resource URL

GET /workspaces/:domain/projects/:project_name

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
project_name
Required
StringThe name of the project.

Example

Request

GET https://api.buddy.works/workspaces/buddy/projects/company-website

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/company-website",
  "html_url": "https://app.buddy.works/buddy/company-website",
  "name": "company-website",
  "display_name": "Company Website",
  "status": "ACTIVE",
  "create_date": "2016-02-29T11:23:04Z",
  "created_by": {
    "url": "https://api.buddy.works/workspaces/buddy/member/1",
    "html_url": "https://app.buddy.works/buddy/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"
  },
  "http_repository": "https://app.buddy.works/buddy/company-website",
  "ssh_repository": "buddy@app.buddy.works:buddy/company-website",
  "default_branch": "master",
  "access": "PUBLIC",
  "fetch_submodules": true,
  "fetch_submodules_env_key": "id_workspace",
  "allow_pull_requests": true
}

Project member

Returns a single project member.

Required scopes: WORKSPACE

Resource URL

GET /workspaces/:domain/projects/:project_name/members/:member_id

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
member_id
Required
IntegerThe numerical ID of the desired user.
project_name
Required
StringThe name of the project.

Example

Request

GET https://api.buddy.works/workspaces/buddy/projects/company-website/members/1

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/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",
  "admin": true,
  "workspace_owner": true,
  "permission_set": {
    "url": "https://api.buddy.works/workspaces/buddy/permissions/1",
    "html_url": "https://app.buddy.works/buddy/permissions/edit/1",
    "id": 1,
    "name": "Developer",
    "description": null,
    "type": "DEVELOPER",
    "repository_access_level": "READ_WRITE",
    "pipeline_access_level": "READ_WRITE",
  }
}

Group in project

Returns a single user group in the specified project.

Required scopes: WORKSPACE

Resource URL

GET /workspaces/:domain/projects/:project_name/groups/:group_id

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
group_id
Required
IntegerThe numerical ID of the desired user group.
project_name
Required
StringThe name of the project.

Example

Request

GET https://api.buddy.works/workspaces/buddy/projects/company-website/groups/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/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"
      }
    }

Get Started

Sign up for free and deploy your project in less than 10 minutes.