Skip to main content
GET
Get a project

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format

Path Parameters

projectId
string
required

Project ID or shortId

Response

Project details

id
string<uuid>
required
shortId
string | null
required
name
string
required
url
string | null
required
projectType
enum<string>
required
Available options:
web,
mobile
description
string | null
required
environments
object[]
required
browserRegion
enum<string> | null

Default proxy exit region for web runs. null keeps the provider's default networking. Web projects only.

Available options:
eu,
us,
null
prTestingEnabled
boolean

Test PR deployments automatically.

prTestingInstructions
string | null

Free-form instructions for the PR exploration agent.

Maximum string length: 2000
prTestingDebounceMinutes
integer

Quiet period before a PR deployment is tested. 0 disables debouncing.

Required range: 0 <= x <= 60
prTestingBlockMerge
boolean

Conclude the GitHub check run as failed when tests fail, so a required TesterArmy check blocks the merge. Off by default.

includeExampleMobileApp
boolean

Offer the example app as a run target. Mobile projects only.

autoDeleteOldestMobileApp
boolean

Delete the oldest unused app builds when an upload exceeds the storage quota. Mobile projects only.

accessibilityAuditEnabled
boolean

Scan visited pages with axe-core during web runs and report critical accessibility violations as non-blocking warnings. On by default. Web projects only.

createdAt
string<date-time>
updatedAt
string<date-time>