Get a project

GET

/api/orgs/{org}/projects/{project}

const url = 'https://api-dev.wrktr.com/api/orgs/example/projects/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api-dev.wrktr.com/api/orgs/example/projects/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer
None

Parameters

Path Parameters

org

required

string

project

required

string

Responses

200

Project

application/json

object

required

string

org

required

string

name

required

string

remote

required

string

defaultBranch

required

string

lastPushAt

required

Any of:

string
null

string

visibility

required

string

Allowed values: private public

role

required

Any of:

string
null

string

Allowed values: owner member

forkedFrom

required

Any of:

object
null

object

org

required

string

name

required

string

Example

{
  "visibility": "private",
  "role": "owner"
}

401

Unauthorized

application/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound

application/json

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

Example

{
  "_tag": "ProjectNotFound"
}