Skip to content

Project Tools

Projects group related jobs and track testers across them. Testers are auto-added to a project when they complete a job within it.


Create a new project.

FieldTypeRequiredDescription
namestringYesProject name (1–200 chars)
descriptionstringNoDescription (max 2000 chars)
{
"project": {
"id": "uuid",
"name": "Landing Page Tests",
"description": "All landing page A/B tests",
"createdAt": "2025-01-15T09:00:00Z",
"updatedAt": "2025-01-15T09:00:00Z"
}
}

Update a project’s name or description.

FieldTypeRequiredDescription
project_iduuidYesProject ID
namestringNoNew name
descriptionstring | nullNoNew description (null to clear)

Delete a project. Jobs within the project are unlinked, not deleted.

FieldTypeRequired
project_iduuidYes
{ "ok": true }

Get a project’s details including job and tester counts.

FieldTypeRequired
project_iduuidYes
{
"project": {
"id": "uuid",
"name": "Landing Page Tests",
"description": "All landing page A/B tests",
"jobCount": 12,
"testerCount": 47,
"createdAt": "2025-01-15T09:00:00Z",
"updatedAt": "2025-01-20T14:00:00Z"
}
}

List projects owned by the authenticated owner. Archived projects are excluded by default.

FieldTypeRequiredDescription
include_archivedbooleanNoInclude archived projects (default false)
limitintegerNoMax results (1–100, default 50)

Archive a project. Archived projects are hidden from default listings but their jobs remain active.

FieldTypeRequired
project_iduuidYes

Unarchive a previously archived project.

FieldTypeRequired
project_iduuidYes

Assign a job to a project, reassign to a different project, or remove from its current project.

FieldTypeRequiredDescription
job_iduuidYesJob ID
project_iduuid | nullYesProject ID, or null to unlink
{ "ok": true }

List testers associated with a project. Testers are auto-added when they complete a job within the project.

FieldTypeRequired
project_iduuidYes
{
"testers": [
{
"id": "record-uuid",
"testerId": 123456,
"trusted": false,
"highValue": true,
"blocked": false,
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-18T12:00:00Z"
}
]
}

Tester IDs are numeric public IDs — owners never see tester PII.

Manually add a tester to a project. Useful for pre-populating a tester pool before creating project_testers_only jobs.

FieldTypeRequiredDescription
project_iduuidYesProject ID
tester_idinteger | uuidYesTester public ID or UUID

Update advisory flags on a project tester.

FieldTypeRequiredDescription
project_iduuidYesProject ID
tester_idinteger | uuidYesTester public ID or UUID
trustedbooleanNoMark as trusted
high_valuebooleanNoMark as high value
blockedbooleanNoBlock from project jobs

Remove a tester from a project entirely. Deletes the project-tester record.

FieldTypeRequiredDescription
project_iduuidYesProject ID
tester_idinteger | uuidYesTester public ID or UUID