Projects ~ SHIP

List projects

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

Range1 <= value <= 100

Default20

cursor?string

byTrackerConnectorId?string

byTrackerTeamId?string

byTrackerProjectId?string

byScmConnectorId?string

byScmOwner?string

byScmRepo?string

Response Body

`application/json`

curl -X GET "https://example.com/projects"

{  "data": [    {      "id": "string",      "orgId": "string",      "slug": "string",      "name": "string",      "status": "active",      "trackerConnectorId": "string",      "trackerTeamId": "string",      "trackerProjectId": "string",      "scmConnectorId": "string",      "scmOwner": "string",      "scmRepo": "string",      "llmConnectorId": "string",      "autoMerge": true,      "issueCode": "string",      "createdAt": 0,      "missingConnectorKinds": [        "tracker"      ]    }  ],  "nextCursor": "string"}

Create a project (with duplicate guard on tracker_team)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 120

tracker?ProjectTracker

Default"linear"

Value in

"linear"
"github-issues"
"none"

linearTeamKey?string

Length1 <= length

repoFullName*string

Match^[^/\s]+\/[^/\s]+$

issueCode?IssueCode

Match^[A-Z][A-Z0-9]{1,4}$

Response Body

`application/json`

curl -X POST "https://example.com/projects" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "repoFullName": "string"  }'

{  "id": "string",  "orgId": "string",  "slug": "string",  "name": "string",  "status": "active",  "trackerConnectorId": "string",  "trackerTeamId": "string",  "trackerProjectId": "string",  "scmConnectorId": "string",  "scmOwner": "string",  "scmRepo": "string",  "llmConnectorId": "string",  "autoMerge": true,  "issueCode": "string",  "createdAt": 0,  "missingConnectorKinds": [    "tracker"  ]}

Fetch a project by id

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

projectId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/projects/string"

{  "id": "string",  "orgId": "string",  "slug": "string",  "name": "string",  "status": "active",  "trackerConnectorId": "string",  "trackerTeamId": "string",  "trackerProjectId": "string",  "scmConnectorId": "string",  "scmOwner": "string",  "scmRepo": "string",  "llmConnectorId": "string",  "autoMerge": true,  "issueCode": "string",  "createdAt": 0,  "missingConnectorKinds": [    "tracker"  ]}

Update a project's name/status, or reconnect its GitHub repo / Linear team

Path Parameters

projectId*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 120

status?ProjectStatus

Value in

"active"
"paused"
"archived"

autoMerge?boolean

issueCode?IssueCode

Match^[A-Z][A-Z0-9]{1,4}$

linearTeamKey?string

Length1 <= length

repoFullName?string

Match^[^/\s]+\/[^/\s]+$

Response Body

`application/json`

curl -X PATCH "https://example.com/projects/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "orgId": "string",  "slug": "string",  "name": "string",  "status": "active",  "trackerConnectorId": "string",  "trackerTeamId": "string",  "trackerProjectId": "string",  "scmConnectorId": "string",  "scmOwner": "string",  "scmRepo": "string",  "llmConnectorId": "string",  "autoMerge": true,  "issueCode": "string",  "createdAt": 0,  "missingConnectorKinds": [    "tracker"  ]}

Delete a project

Path Parameters

projectId*string

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/projects/string"

{  "ok": true,  "id": "string"}

Projects

200application/json

401application/json

403application/json

200application/json

400application/json

403application/json

404application/json

409application/json

200application/json

404application/json

200application/json

400application/json

403application/json

404application/json

409application/json

200application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`