Get project

GET 
/project/:id

Retrieve project by ID

Request

Path Parameters

id stringrequired
A unique project ID
Example: 5e9602e7a39e5a46428b457f

Responses

200

Successful operation

application/json

Schema

Schema

idstring
Project ID
Example: 50a9f72f14db3be812000233
titlestring

Project title

urlstring
Project base URL
Example: https://testomato.com
periodstring
Period of test checking - false means never check Test automatically.
Possible values: [5 minutes, 30 minutes, 1 hour, 8 hours, 1 day, 7 days, false]
Default value: 5 minutes
uptimeUrlstring

Uptime URL

uptimeEnabledstring

Uptime period in seconds - false means uptime is disabled

Possible values: [false, 15, 30, 60]

apiKeystring
apiKey that can be used for the project operations
Example: 123456
payerIdinteger

Identification of the project owner.

locationstring

Project check location

Possible values: [eu, de, gb, ca, us, tx, dc, sg, hk]

checkDefaultErrorsboolean
Default value: true
createddate-time

Date and time of project creation

userAgentstring
User agent
Default value: Testomatobot/1.0 (Linux x86_64; +https://www.testomato.com/testomatobot) minicrawler/5.2.2
timeoutinteger
Cumulated project timeout in seconds
Default value: 3
delayint64
Bulk request delay in miliseconds
Default value: 50
userIdsinteger[]

Array of users ID's with access to the project

namestringdeprecated

Project name was replaced by Project title

permissions

object

Project permissions for current user

readboolean

Can current user view results?

runboolean

Can current user run checks?

editTestboolean

editboolean

Can current user edit project settings?

manageUsersboolean

Can current user manage others?

Default value: true

apiKeyboolean

Can current user view apiKey?

Default value: true

leaveboolean

Can current user leave project?

Default value: true

Example (from schema)

{
  "id": "50a9f72f14db3be812000233",
  "title": "string",
  "url": "https://testomato.com",
  "period": "5 minutes",
  "uptimeUrl": "string",
  "uptimeEnabled": false,
  "apiKey": 123456,
  "payerId": 0,
  "location": "eu",
  "checkDefaultErrors": true,
  "created": "2024-08-19T13:18:07.486Z",
  "userAgent": "Testomatobot/1.0 (Linux x86_64; +https://www.testomato.com/testomatobot) minicrawler/5.2.2",
  "timeout": 3,
  "delay": 50,
  "userIds": [
    0
  ],
  "permissions": {
    "read": true,
    "run": true,
    "editTest": true,
    "edit": true,
    "manageUsers": true,
    "apiKey": true,
    "leave": true
  }
}

404

Object not found error

application/json

Schema

Schema

messagestring
Error message text
Default value: Object not found
codeinteger
Error code number
Default value: 404
okboolean
Default value: false
errorboolean
Default value: true

Example (from schema)

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