Get project

GET

/project/{id}

const url = 'https://testomato.com/api/project/5e9602e7a39e5a46428b457f';
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 \
  --header 'Authorization: Bearer <token>'

Retrieve project by ID

Authorizations

ApiToken

Parameters

Path Parameters

required

string

A unique project ID

Example

5e9602e7a39e5a46428b457f

Responses

200

Successful operation

application/json

object

Project ID

string

title

Project title

string

url

Project base URL

string

period

Period of test checking — false means tests are not run automatically.

string

default: 5 minutes

Allowed values: 5 minutes 30 minutes 1 hour 8 hours 1 day 7 days

uptimeUrl

Uptime URL

string

uptimeEnabled

Uptime period in seconds - false means uptime is disabled

string

Allowed values: 15 30 60

apiKey

ApiKey that can be used for the project operations

string

payerId

Identification of the project owner.

integer

location

Project check location

string

Allowed values: eu de gb ca us tx dc sg hk

checkDefaultErrors

boolean

default: true

created

Date and time of project creation

string format: date-time

userAgent

User agent

string

default: Testomatobot/1.0 (Linux x86_64; +https://testomato.com/bot) minicrawler/5.2.7

timeout

Cumulated project timeout in seconds

integer

default: 3

delay

Bulk request delay in milliseconds

integer format: int64

default: 50

userIds

Array of user IDs with access to the project

Array<integer>

status

Last known check status of the project. null until the first run.

string

nullable

sslStatus

Derived state of the TLS certificate:

ok — valid, and more days left than sslAlertPeriod
soon — valid, but expiring within sslAlertPeriod
expired — no days left
nossl — the project URL is not https://
noinfo — not checked yet

string

Allowed values: ok soon expired nossl noinfo

sslExpiration

Certificate expiry in ISO 8601. null when there is nothing to report.

string format: date-time

nullable

sslDaysLeft

Days until the certificate expires. Absent until the first SSL check ran.

integer

sslAlertPeriod

How many days before expiry the certificate counts as expiring soon.

integer

httpsRedirectEnabled

Whether Testomato checks that the HTTP version redirects to HTTPS.

boolean

httpsRedirectStatus

Result of the last HTTPS redirect check. null until it first ran.

string

nullable

Allowed values: ok failed unreachable

httpsRedirectFinalUrl

URL the HTTP version ended on, after following redirects.

string

nullable

httpsRedirectCheckedAt

When the HTTPS redirect was last checked, in ISO 8601.

string format: date-time

nullable

webPushEnabled

Whether browser push notifications are enabled for this project.

boolean

securityMonitoringEnabled

Whether the security panel (including the Shodan network scan) is enabled.

boolean

isWordPress

Whether the site was detected as WordPress. null before detection ran.

boolean

nullable

name

Project name was replaced by Project title

string

permissions

Project permissions for current user

object

read

Can the current user view results?

boolean

run

Can the current user run checks?

boolean

editTest

Can the current user edit tests?

boolean

edit

Can the current user edit project settings?

boolean

manageUsers

Can the current user manage other users?

boolean

default: true

apiKey

Can the current user view the API key?

boolean

default: true

leave

Can the current user leave the project?

boolean

default: true

Example

{
  "id": "50a9f72f14db3be812000233",
  "url": "https://testomato.com",
  "period": "5 minutes",
  "uptimeEnabled": false,
  "apiKey": 123456,
  "location": "eu",
  "checkDefaultErrors": true,
  "userAgent": "Testomatobot/1.0 (Linux x86_64; +https://testomato.com/bot) minicrawler/5.2.7",
  "timeout": 3,
  "delay": 50,
  "status": "ok",
  "sslStatus": "ok",
  "sslExpiration": "2026-12-31T23:59:59+00:00",
  "sslDaysLeft": 47,
  "sslAlertPeriod": 14,
  "httpsRedirectEnabled": true,
  "httpsRedirectStatus": "ok",
  "httpsRedirectFinalUrl": "https://testomato.com/",
  "httpsRedirectCheckedAt": "2026-09-08T06:29:38+00:00",
  "webPushEnabled": false,
  "securityMonitoringEnabled": false,
  "isWordPress": true,
  "permissions": {
    "manageUsers": true,
    "apiKey": true,
    "leave": true
  }
}

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
}

404

Object not found error

application/json

object

message

Error message text

string

default: Object not found

code

Error code number

integer

default: 404

boolean

error

boolean

default: true

Example

{
  "message": "Object not found",
  "code": 404,
  "ok": false,
  "error": true
}