latestOpenAPI 3.1.02026-08-2251540275.6 KB

bf198f94879a

projects

Get a project

Get a single project by ID or shortId.

get/v1/projects/{projectId}

Path parameters

projectIdstring required

Project ID or shortId

Headers

Authorizationstring required

API key authentication using Bearer token format

Response

Project details

browserRegion'eu' | 'us'

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

prTestingEnabledboolean

Test PR deployments automatically.

prTestingInstructionsstring nullable

Free-form instructions for the PR exploration agent.

prTestingDebounceMinutesinteger

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

prTestingBlockMergeboolean

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

includeExampleMobileAppboolean

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

autoDeleteOldestMobileAppboolean

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

accessibilityAuditEnabledboolean

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

idstring uuid required

shortIdstring nullable required

namestring required

urlstring nullable required

projectType'web' | 'mobile' required

descriptionstring nullable required

createdAtstring date-time

updatedAtstring date-time