Entity reference · v1
personas
PERS-NNNNNNtable personassoft deleteUser segments / archetypes that give feedback and benefit from features.
Endpoints
GET
/api/v1/personasPOST
/api/v1/personasGET
/api/v1/personas/{id}PATCH
/api/v1/personas/{id}DELETE
/api/v1/personas/{id}POST
/api/v1/personas/{id}/restoreGET
/api/v1/personas/{id}/links/feedbackPOST
/api/v1/personas/{id}/links/feedbackDELETE
/api/v1/personas/{id}/links/feedback/{targetId}GET
/api/v1/personas/{id}/links/themesPOST
/api/v1/personas/{id}/links/themesDELETE
/api/v1/personas/{id}/links/themes/{targetId}GET
/api/v1/personas/{id}/links/featuresPOST
/api/v1/personas/{id}/links/featuresDELETE
/api/v1/personas/{id}/links/features/{targetId}GET
/api/v1/personas/{id}/links/productsPOST
/api/v1/personas/{id}/links/productsDELETE
/api/v1/personas/{id}/links/products/{targetId}GET
/api/v1/personas/{id}/links/modulesPOST
/api/v1/personas/{id}/links/modulesDELETE
/api/v1/personas/{id}/links/modules/{targetId}Writable fields
* required on create. PATCH treats every field as optional.
| Field | Type | Constraints | Notes |
|---|---|---|---|
| name* | string | ||
| role | string | ||
| company | string | ||
| avatar | string | ||
| description | text | ||
| goals | string[] | ||
| pain_points | string[] | ||
| revenue_impact | string | ||
| is_draft | boolean | ||
| metadata | json |
Listing & filtering
- Pagination:
?limit=50&offset=0· max limit 200 - Default sort:
?sort=name&order=asc - Sortable fields: created_at · updated_at · name · id_number
- Search (?q=): name, role, description
- Filters: ?company= ?revenue_impact= ?is_draft= , repeat any filter to OR multiple values
- Trash: hidden by default; pass
?include_deleted=true - Expand:
?expand=feedback,themes
Examples
curlbash
curl 'https://productos.ca/api/v1/personas?limit=10' \
-H "Authorization: Bearer $TOKEN"Try it out
Paste a token and hit a real endpoint. The request goes from your browser straight to /api/v1/personas. The token is held in this page only for the request and is never stored.
Try it out
Issue tokens in Settings → API tokens. Token never leaves this page.
GET/api/v1/personas?limit=3