Projects are the top-level container for a single application or service.

List projects

GET/api/projects/overviewBearer Token

There is no GET /api/projects. This endpoint takes no query parameters and is not paged. An API key works here with any scope.

Response: 200 OK

{
  "defaultProjectId": "project-id",
  "projects": [
    { "id": "project-id", "name": "Customer Portal", "slug": "customer-portal", "defaultEnvironmentKey": "staging", "testCaseCount": 12, "openTicketCount": 3 }
  ]
}

Get project

GET/api/projects/{id}Bearer Token

Create project

POST/api/projectsBearer Token

Body:

{
  "project": {
    "name": "Customer Portal",
    "slug": "customer-portal",
    "description": "Automated verification for the portal",
    "projectType": "web"
  }
}

The fields go inside project. PUT /api/projects/{id} takes the same shape. With an API key, create, update and delete need the platform:manage scope.

Use "projectType": "api" for API projects, or "projectType": "appium" with platform for Android, iOS, Windows or macOS apps.

Update project

PUT/api/projects/{id}Bearer Token

Delete project

DELETE/api/projects/{id}Bearer Token

Runtime settings

GET/api/projects/{projectId}/runtime-settingsBearer Token

Returns the project's type, testing depths and release rhythm.

PUT/api/projects/{projectId}/runtime-settingsBearer Token

Use this endpoint to switch a project between web, API, and app (appium) testing.

{
  "projectType": "appium"
}

API projects use the selected environment baseUrl as the API base URL. An app project (appium) keeps its Appium settings in APPIUM_* variables: see Mobile Runtime.