Projects

Get a project

View as Markdown
Get a single project by ID or shortId.

Authentication

AuthorizationBearer
API key authentication using Bearer token format

Path parameters

projectIdstringRequired
Project ID or shortId

Response

Project details
idstringformat: "uuid"
shortIdstring or null
namestring
urlstring or null
projectTypeenum
descriptionstring or null
environmentslist of objects
browserRegionenum or nullOptional
Default proxy exit region for web runs. null keeps the provider's default networking. Web projects only.
prTestingEnabledbooleanOptional
Test PR deployments automatically.
prTestingInstructionsstring or nullOptional<=2000 characters

Free-form instructions for the PR exploration agent.

prTestingDebounceMinutesintegerOptional0-60
Quiet period before a PR deployment is tested. 0 disables debouncing.
prTestingBlockMergebooleanOptional
Conclude the GitHub check run as failed when tests fail, so a required TesterArmy check blocks the merge. Off by default.
includeExampleMobileAppbooleanOptional
Offer the example app as a run target. Mobile projects only.
autoDeleteOldestMobileAppbooleanOptional
Delete the oldest unused app builds when an upload exceeds the storage quota. Mobile projects only.
accessibilityAuditEnabledbooleanOptional

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

createdAtdatetimeOptional
updatedAtdatetimeOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
504
Gateway Timeout Error