user-groupPersonas

The Personas API allows you to manage user archetypes for your projects. Personas define target audience characteristics, goals, and pain points.

The Persona Object

Field
Type
Description

id

UUID

Unique identifier for the persona.

project_id

UUID

ID of the parent project.

name

string

The name of the persona (e.g., "Developer Dave").

user_role

string

The role title (e.g., "Primary User", "Admin").

tagline

string

A short catchy summary.

avatar_description

string

Prompt description for the persona's avatar.

demographics

object

JSON field for age, location, income, etc.

psychographics

object

JSON field for motivations, values, etc.

behavioral_patterns

object

JSON field for habits and tech usage.

goals_and_needs

object

JSON field for what the user wants to achieve.

pain_points

object

JSON field for user frustrations.

narrative

object

JSON field for the persona's background story.

List Personas

GET /crud/personas

Retrieve personas, optionally filtered by project.

Query Parameters

Parameter
Type
Default
Description

project_id

UUID

-

Recommended. Filter personas by project.

limit

integer

100

Number of records to return.

offset

integer

0

Number of records to skip.

search

string

-

Search term for name or tagline.

Example Request

Get a Persona

GET /crud/personas?id={personaId}

Retrieve details for a specific persona.

Example Request

Create a Persona

POST /crud/personas

Create a new persona for a project.

Request Body

Update a Persona

PUT /crud/personas

Update an existing persona. Note that id must be passed in the request body.

Request Body

Delete a Persona

DELETE /crud/personas?id={personaId}

Delete a specific persona.

Example Request

Batch Operations

The Personas API supports batch creation, updates, and deletions.

Batch Create

POST /crud/personas

Batch Update

PUT /crud/personas

Batch Delete

DELETE /crud/personas

Note: Batch delete requires an array of objects with id.

Last updated

Was this helpful?