Get all projects

GET 
/api/v2/project

Get all projects

Request

Query Parameters

pinned boolean
If true, include only pinned projects
Example: false
includePinned boolean
Include pinned projects along with regular projects
Example: false
page number
The page number to fetch (default: 1)
Example: 1
perPage number
Number of projects per page (default: 15)
Example: 15

Responses

200

application/json

Schema

Schema

data

object[]

required

The data items for the current page

Array [

id numberrequired

Unique identifier of the project

name stringrequired

Unique slug name of the project

projectName string

Human-friendly name of the project (not unique)

description string

projectType stringrequired

Possible values: [product, formation]

status string

Status of the project (active, completed, on-hold)

label string

Label name assigned to the project

owner stringrequired

Owner of the project

platforms string[]

Platforms supported by the project

numMembers number

Number of members in the project

versions numberrequired

Number of versions available for the project

memberContext

object

Current member context

role stringrequired

Possible values: [project-owner, project-admin, project-member]

preferences

object

required

pinned boolean

summary

object

Summary of the project

latestRelease

object

Latest release of the project

id stringrequired

version stringrequired

name string

requiredRegulationsCount numberrequired

compliantRegulationsCount numberrequired

upcomingRelease

object

Upcoming release of the project

id stringrequired

version stringrequired

name string

requiredRegulationsCount numberrequired

compliantRegulationsCount numberrequired

]

total numberrequired

The total number of items available

page numberrequired

The current page number

perPage numberrequired

The number of items per page

Example (from schema)

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "projectName": "string",
      "description": "string",
      "projectType": "product",
      "status": "string",
      "label": "string",
      "owner": "string",
      "platforms": [
        "string"
      ],
      "numMembers": 0,
      "versions": 5,
      "memberContext": {
        "role": "project-owner",
        "preferences": {
          "pinned": true
        }
      },
      "summary": {
        "latestRelease": {
          "id": "string",
          "version": "string",
          "name": "string",
          "requiredRegulationsCount": 0,
          "compliantRegulationsCount": 0
        },
        "upcomingRelease": {
          "id": "string",
          "version": "string",
          "name": "string",
          "requiredRegulationsCount": 0,
          "compliantRegulationsCount": 0
        }
      }
    }
  ],
  "total": 100,
  "page": 1,
  "perPage": 10
}

Loading...