Starting project

GET

/project/{id}/start

const url = 'https://testomato.com/api/project/5e9602e7a39e5a46428b457f/start?tests=55ae166c25b395537a8b6029&tests=510fa4a3bd96e74c0200000b';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://testomato.com/api/project/5e9602e7a39e5a46428b457f/start?tests=55ae166c25b395537a8b6029&tests=510fa4a3bd96e74c0200000b' \
  --header 'Authorization: Bearer <token>'

Start all checks in project

Authorizations

ApiToken

Parameters

Path Parameters

required

string

A unique project ID

Example

5e9602e7a39e5a46428b457f

Query Parameters

tests

Array<string>

Array of test IDs to run

Example

[
  "55ae166c25b395537a8b6029",
  "510fa4a3bd96e74c0200000b"
]

Responses

200

Job started successfully

application/json

object

projectId

A unique Project ID

string

jobId

A unique ID for each job

string

start

Value ok indicates your tests have successfully started

string

results

The URL where you can view your results

string

Example

{
  "projectId": "5e95ddf7a39e5a44428b4581",
  "jobId": "5e9602e7a39e5a46428b457f",
  "start": "ok",
  "results": "https://testomato.com/api/project/5e95ddf7a39e5a44428b4581/job/5e9602e7a39e5a46428b457f/results"
}

401

The API token is missing, malformed or expired. Request a new one from POST /api/authenticate.

application/json

object

message

Error message text

string

default: Access denied! Please log in to access this resource.

code

Error code number

integer

default: 401

boolean

error

boolean

default: true

Example

{
  "message": "Access denied! Please log in to access this resource.",
  "code": 401,
  "ok": false,
  "error": true
}

403

The token is valid but the operation is not allowed. Two distinct causes:

the subscription plan does not include API access — every endpoint returns this, regardless of the resource
the account lacks the required role on the project — reading needs read, changing checks needs editTests, and so on. See Project permissions.

application/json

object

message

Error message text

string

default: Sorry! Your current plan does not support access to Testomato API.

code

Error code number

integer

default: 403

boolean

error

boolean

default: true

Example

{
  "message": "Sorry! Your current plan does not support access to Testomato API.",
  "code": 403,
  "ok": false,
  "error": true
}