Skip to main content

GET List Projects

Retrieve a list of all projects or a specific project based on the provided query parameters

Updated this week

API Endpoint


{{apiUrl}}/api/v1/projects?startAt={{startAt}}&limit={{limit}}&key={{projectKey}}

Headers


To authenticate the API request, you need to provide the Vansah Connect Token that is generated from the Jira workspace's Vansah configuration page.

Authorization

{{vansahConnectToken}}


Generate a Token from Vansah

Request Query Parameters


startAt

{{startAt}}

Optional Rows start at e.g start at 5 out of 15 rows , it will fetch 10 rows from 5 to 15 (for pagination)

limit

{{limit}}

Optional Number of projects to be displayed , default 50

key

{{projectKey}}

'Optional' Jira Project Key (Required for connect API calls), e.g. ("TEST", "PRODAPP")

Example Response Body


{

"success": true,

"message": "Projects returned successfully",

"pagination": {

"total": 16,

"startAt": 0,

"limit": 6

},

"data": [

{

"identifier": "5602ff61-de35-11ef-9c82-56bd4ac65cf0",

"name": "AT",

"key": "AT",

"status": 1

},

{

"identifier": "61ddf152-ea06-11ef-9c82-56bd4ac65cf0",

"name": "CAL",

"key": "CAL",

"status": 1

},

{

"identifier": "bab76e8c-e20d-11ef-9c82-56bd4ac65cf0",

"name": "CCP",

"key": "CCP",

"status": 1

},

{

"identifier": "9506f9b8-d1df-11ef-9c82-56bd4ac65cf0",

"name": "CP2",

"key": "CP2",

"status": 1

},

{

"identifier": "0b1a8ab2-fdb4-11ef-b619-a6332c493f52",

"name": "CSPM",

"key": "CSPM",

"status": 1

},

{

"identifier": "84f4f411-da0d-11ef-9c82-56bd4ac65cf0",

"name": "DT",

"key": "DT",

"status": 1

}

]

}

Did this answer your question?