Get All Project Details - GET /projects (v8.7.0)

Get details of all visible projects. The retrieval of project details should be performed after creating a project. To create a project use the POST/projects API.

Usage:

1. POST /projects and create new project with default configuration settings
2. GET /projects and get details of all projects
   

URL

/cxrestapi/projects

Method:

GET

Media Type (header):

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

Parameters

Optional:

projectName=[string] – Unique name of a specific project or projects
teamId=[string] – Unique Id of a specific team or teams.

Query String

Optional (example only):

/projects?projectName=myProject&teamId=00000000-1111-1111-b111-989c9070eb11

Success Response:

Code: 200 OK

Error Response:

Code: 400 Bad Request

Sample Response:

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

Notes:

Retrieves details of all visible projects. If the request fails, it returns an error response. Project Id (id) can be used to get details of a specific project using GET/projects/{id}. Team Id (id) can be used to create a new project with default configuration setting using POST /projects.