Skip to main content

Project Group

A Project Group is a container for related projects. This API allows you to create, retrieve, update, and delete project groups.

Authentication​

Include the API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Endpoints​

Create a Project Group​

POST /project-group

Parameters:​

  • name (required): The name of the project group.

Example Request Body​

{
  "name": "dev"
}

Response​

{
  "id": "12345",
  "name": "dev"
}

A successful response returns the newly created project group's id and name.

Get a Project Group​

Retrieve a project group by its unique id or its name.

GET /project-group/:id
GET /project-group/:name

Response​

{
  "id": "12345",
  "name": "dev",
  "projects": []
}

The response includes the project group's id, name, and a list of associated projects.

Update a Project Group​

Update the details of an existing project group.

PUT /project-group/:id

Parameters:​

  • name (required): The new name for the project group.

Example Request Body​

{
  "name": "new_name"
}

Response​

{
  "id": "12345",
  "name": "new_name"
}

The response returns the updated project group's id and name.

Delete a Project Group​

DELETE /project-group/:id

Response​

{
  "message": "Project group deleted"
}

The response confirms the deletion of the project group.