Skip to content
InstaHuman

Projects

Create a Project

Section titled “Create a Project”
POST /projects

Request Body

Section titled “Request Body”
{
  "name": "Landing Page Tests",
  "description": "All landing page A/B tests"
}
FieldTypeRequiredDescription
namestringYesProject name (1–200 chars)
descriptionstringNoDescription (max 2000 chars)

Response

Section titled “Response”
{
  "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"
}

List Projects

Section titled “List Projects”
GET /projects

Query Parameters

Section titled “Query Parameters”
ParamTypeDescription
includeArchivedbooleanInclude archived projects (default false)
limitintegerMax results (default 50, max 100)

Response

Section titled “Response”
{
  "data": [
    {
      "id": "uuid",
      "name": "Landing Page Tests",
      "description": "All landing page A/B tests",
      "jobCount": 12,
      "testerCount": 47,
      "archivedAt": null,
      "createdAt": "2025-01-15T09:00:00Z",
      "updatedAt": "2025-01-20T14:00:00Z"
    }
  ]
}

Get a Project

Section titled “Get a Project”
GET /projects/:id

Response

Section titled “Response”
{
  "id": "uuid",
  "name": "Landing Page Tests",
  "description": "All landing page A/B tests",
  "jobCount": 12,
  "testerCount": 47,
  "archivedAt": null,
  "createdAt": "2025-01-15T09:00:00Z",
  "updatedAt": "2025-01-20T14:00:00Z"
}

Update a Project

Section titled “Update a Project”
PATCH /projects/:id

Request Body

Section titled “Request Body”
{
  "name": "Updated Name",
  "description": "Updated description"
}

Both fields are optional. Pass null for description to clear it.

Delete a Project

Section titled “Delete a Project”
DELETE /projects/:id

Jobs within the project are unlinked, not deleted.

Response

Section titled “Response”
{ "ok": true }

Archive

Section titled “Archive”
POST /projects/:id/archive

Hidden from default listings. Jobs remain active.

Unarchive

Section titled “Unarchive”
POST /projects/:id/unarchive

Assign Job to Project

Section titled “Assign Job to Project”
POST /jobs/:id/project

Request Body

Section titled “Request Body”
{ "projectId": "project-uuid" }

Pass null for projectId to unlink.

Tester Management

Section titled “Tester Management”

List Testers

Section titled “List Testers”
GET /projects/:id/testers

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

Response

Section titled “Response”
{
  "data": [
    {
      "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.

Add Tester

Section titled “Add Tester”
POST /projects/:id/testers

Manually add a tester to a project.

Request Body

Section titled “Request Body”
{ "testerId": 123456 }

Accepts numeric public ID or UUID.

Update Tester

Section titled “Update Tester”
PATCH /projects/:id/testers/:testerId

Request Body

Section titled “Request Body”
{
  "trusted": true,
  "highValue": false,
  "blocked": false
}

All fields optional.

Remove Tester

Section titled “Remove Tester”
DELETE /projects/:id/testers/:testerId

Deletes the project-tester record entirely.