VoidTrack Docs
API Reference

Teams

List teams you have access to

GET
/teams

Authorization

apiKey
AuthorizationBearer <token>

Workspace scoped API key, printed once by pnpm seed or POST /api-keys.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/teams"
{  "teams": [    {      "id": "string",      "key": "string",      "name": "string",      "personal": true,      "cyclesEnabled": true,      "cycleLengthWeeks": 0,      "estimateScale": "none",      "states": [        {          "id": "string",          "name": "string",          "type": "string"        }      ]    }  ]}

Create a team (admin only)

POST
/teams

Authorization

apiKey
AuthorizationBearer <token>

Workspace scoped API key, printed once by pnpm seed or POST /api-keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

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

List every shared team in the workspace, joined or not (admin only)

GET
/teams/all

Authorization

apiKey
AuthorizationBearer <token>

Workspace scoped API key, printed once by pnpm seed or POST /api-keys.

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/teams/all"
{  "teams": [    {      "id": "string",      "key": "string",      "name": "string",      "joined": true    }  ]}

Update team settings

PATCH
/teams/{key}

Workspace admins, or the owner for personal spaces.

Authorization

apiKey
AuthorizationBearer <token>

Workspace scoped API key, printed once by pnpm seed or POST /api-keys.

In: header

Path Parameters

key*string

Team key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

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

Delete a team (admin only)

DELETE
/teams/{key}

Personal spaces cannot be deleted.

Authorization

apiKey
AuthorizationBearer <token>

Workspace scoped API key, printed once by pnpm seed or POST /api-keys.

In: header

Path Parameters

key*string

Team key

Query Parameters

deleteProjects?string

'true' to delete projects sole to this team; otherwise they're detached

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/teams/string"
{  "deleted": true,  "deletedProjects": 0,  "detachedProjects": 0}

Join a shared team (admin only)

POST
/teams/{key}/join

Authorization

apiKey
AuthorizationBearer <token>

Workspace scoped API key, printed once by pnpm seed or POST /api-keys.

In: header

Path Parameters

key*string

Team key

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/teams/string/join"
{  "ok": true}

Get a team's roster plus workspace member context

GET
/teams/{key}/members

Authorization

apiKey
AuthorizationBearer <token>

Workspace scoped API key, printed once by pnpm seed or POST /api-keys.

In: header

Path Parameters

key*string

Team key

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/teams/string/members"
{  "members": [    {      "id": "string",      "name": "string",      "email": "user@example.com"    }  ],  "workspaceMembers": [    {      "id": "string",      "name": "string",      "email": "user@example.com"    }  ]}

Add a workspace member to the team

POST
/teams/{key}/members

Authorization

apiKey
AuthorizationBearer <token>

Workspace scoped API key, printed once by pnpm seed or POST /api-keys.

In: header

Path Parameters

key*string

Team key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/teams/string/members" \  -H "Content-Type: application/json" \  -d '{    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"  }'
{  "ok": true}

Remove a member from the team

DELETE
/teams/{key}/members/{userId}

Authorization

apiKey
AuthorizationBearer <token>

Workspace scoped API key, printed once by pnpm seed or POST /api-keys.

In: header

Path Parameters

key*string

Team key

userId*string

User id

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/teams/string/members/string"
{  "ok": true}

Get a team's PR-trigger rules, workflow states, and linked projects

GET
/teams/{key}/workflows

Authorization

apiKey
AuthorizationBearer <token>

Workspace scoped API key, printed once by pnpm seed or POST /api-keys.

In: header

Path Parameters

key*string

Team key

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/teams/string/workflows"
{  "workflows": [    {      "id": "string",      "trigger": "pr_opened",      "projectId": "string",      "targetStateId": "string"    }  ],  "states": [    {      "id": "string",      "name": "string",      "type": "string",      "color": "string",      "position": 0    }  ],  "projects": [    {      "id": "string",      "name": "string"    }  ]}

Create or replace a team's PR-trigger rule

POST
/teams/{key}/workflows

Upserts on (team, trigger, project).

Authorization

apiKey
AuthorizationBearer <token>

Workspace scoped API key, printed once by pnpm seed or POST /api-keys.

In: header

Path Parameters

key*string

Team key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/teams/string/workflows" \  -H "Content-Type: application/json" \  -d '{    "trigger": "pr_opened",    "targetStateId": "eafb8fcc-87f3-4385-a8ff-60605f7497b0"  }'
{  "id": "string",  "trigger": "pr_opened",  "projectId": "string",  "targetStateId": "string"}

Delete a team's PR-trigger rule

DELETE
/teams/{key}/workflows/{id}

Authorization

apiKey
AuthorizationBearer <token>

Workspace scoped API key, printed once by pnpm seed or POST /api-keys.

In: header

Path Parameters

key*string

Team key

id*string

Workflow rule id

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/teams/string/workflows/string"
{  "ok": true}

Projects

Previous Page

Updates

Next Page