Endpoints
| Method | Path | Auth | Description |
|---|---|---|---|
GET | /api/v1/projects | Yes | List all projects for your company |
POST | /api/v1/projects | Yes | Create a new project |
GET | /api/v1/projects/{project_id} | Yes | Get a single project |
PATCH | /api/v1/projects/{project_id} | Yes | Update project name or description |
DELETE | /api/v1/projects/{project_id} | Yes | Delete a project and all its resources |
GET /projects
List all projects belonging to your company. Returns an array of project objects.Example
POST /projects
Create a new project. Onlyname is required.
Request body
A short, descriptive name for the project. Visible to all users in your company.
An optional longer description of the project’s research objective.
Response
UUID of the newly created project.
Project name.
Project description, if provided.
UUID of your company.
ISO 8601 UTC timestamp of when the project was created.
Number of simulations in this project. Starts at
0.Number of persona groups in this project. Starts at
0.Example
GET /projects/
Retrieve a single project by its ID.Path parameters
UUID of the project.
Example
PATCH /projects/
Update a project’s name or description. Only the fields you include in the request body are changed.Path parameters
UUID of the project to update.
Request body
New name for the project.
New description for the project.
Example
DELETE /projects/
Permanently delete a project.Path parameters
UUID of the project to delete.
