Get the project's home

GET

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

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

The default branch: branches in progress with their state, and recent landings.

Authorizations

• bearer
• None

Parameters

Path Parameters

org

required

string

project

required

string

Responses

200

ProjectHome

Media typeapplication/json

object

project

required

string

defaultBranch

required

string

head

required

Any of:

string

string

null

null

inProgress

required

Array<object>

object

name

required

string

head

required

string

updatedAt

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

title

required

Any of:

string

string

null

null

files

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

additions

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

deletions

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

openThreads

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

experiment

required

boolean

status

required

string

Allowed values: ready behind threads conflict empty experiment failing changes checking

review

required

Any of:

string

string

Allowed values: approved changes

null

null

checks

required

Any of:

string

string

Allowed values: passed failed running error

null

null

overlaps

required

Array<object>

object

branch

required

string

paths

required

Array<string>

landed

required

Array<object>

object

sha

required

string

branch

required

Any of:

string

string

null

null

title

required

string

landedBy

required

string

landedAt

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

Example

{
  "inProgress": [
    {
      "updatedAt": "Infinity",
      "files": "Infinity",
      "additions": "Infinity",
      "deletions": "Infinity",
      "openThreads": "Infinity",
      "status": "ready",
      "review": "approved",
      "checks": "passed"
    }
  ],
  "landed": [
    {
      "landedAt": "Infinity"
    }
  ]
}

401

Unauthorized

Media typeapplication/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

Example

{
  "_tag": "ProjectNotFound"
}