API / V1

Projects

7 endpoints in this section.

GET/api/v1/projects

Requires read scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
page	number	No	Page number for paginated results.	-
pageSize	number	No	Number of items returned per page.	-
sortField	string	No	Field used to sort results.	createdAt, name, status
sortDirection	string	No	Sort order direction.	asc, desc
statusFilter	string	No	Filter projects by lifecycle status.	-

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

POST/api/v1/projects

Create Project

Requires write scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
name	string	Yes	Human-readable name.	-
description	string	No	Short textual description.	-
status	string	Yes	Current status value for filtering or updates.	ACTIVE, PAUSED, FINISHED, ARCHIVED, DISCARDED

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

GET/api/v1/projects/{projectId}

Fetch Project's Details

Requires read scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
projectId	string	Yes	Unique identifier of the project.	-

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

PATCH/api/v1/projects/{projectId}

Update Project

Requires write scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
projectId	string	Yes	Unique identifier of the project.	-
name	string	No	Human-readable name.	-
description	string	No	Short textual description.	-
status	string	No	Current status value for filtering or updates.	ACTIVE, PAUSED, FINISHED, ARCHIVED, DISCARDED

Security Warning:

At least one of name/description/status must be provided.

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

GET/api/v1/projects/{projectId}/github/repositories

Fetch Project's GitHub Repositories

Requires read scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
projectId	string	Yes	Unique identifier of the project.	-

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

POST/api/v1/projects/{projectId}/github/repositories

Link Repository to Project

Requires write scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
projectId	string	Yes	Unique identifier of the project.	-
repositoryFullName	string	Yes	Repository in owner/repo format.	-
branch	string	Yes	Repository branch name.	-

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

DELETE/api/v1/projects/{projectId}/github/repositories/{repositoryId}

Unlink Repository from Project

Requires write scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
projectId	string	Yes	Unique identifier of the project.	-
repositoryId	string	Yes	Linked repository record ID.	-

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.