Fetch Project Details

POST

/v2/api/project/batch

Retrieve detailed information for multiple projects by providing a list of their unique project_ids. This endpoint is ideal for bulk-fetching project metadata in a single request, improving efficiency and reducing the number of API calls.

What Does It Do?

Accepts an array of project IDs and returns the corresponding project details.

Delivers complete metadata for each project, including creation/modification info and visibility status.

Required Input:

project_ids (in body): An array of integer IDs representing the projects to be retrieved.

How to Find Your Project ID

If you're unsure about the project_id, follow this guide:
How to View Project ID

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///v2/api/project/batch' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "project_ids": [
        1,
        2
    ]
}'

Response Example

{
    "success": true,
    "message": "Projects found successfully.",
    "data": [
        {
            "id": 2,
            "created_by": "user@example.com",
            "created_on": "2024-01-23T16:49:01.320701Z",
            "modified_by": "user@example.com",
            "modified_on": "2024-09-09T22:39:02.737244Z",
            "project_name": "Example Project",
            "team_visibility": false,
            "is_deleted": false,
            "team": 2
        }
    ]
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Projects found successfully

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Delete Project

Add Recent Project

Fetch Project Details

How to Find Your Project ID#

Request

Responses

How to Find Your Project ID