Get Project Details by Id - GET /projects/{id} (v8.6.0 to v8.7.0)

Get details of a specified project. To first retrieve the specific project id (id) use GET /projects.

Usage:

  1. GET /projects and get details of all visible projects
  2. GET /projects/{id} and get details of a specified project

URL

/cxrestapi/projects{id}

Method:

GET

Media Type (header):

Authorization: Bearer <access token value>
Accept: application/json;v=1.0

Parameters

Required:

id=[integer] – Unique Id of the project

Success Response:

Code: 200 OK

Error Response:

Code: 400 Bad Request
Code: 404 Not Found

Sample Response:

{
  "id": 1,
  "teamId": 1,
  "name": "Project_1",
  "isPublic": true,
  "sourceSettingsLink": {
    "type": "local",
    "rel": "source",
    "uri": null
  },
  "link": {
    "rel": "self",
    "uri": "/projects/1"
  }
}

Notes:

Retrieves details of a specified project. If the request fails, it returns an error response.