ProductOSDocs

Entity reference · v1

personas

PERS-NNNNNNtable personassoft delete

User segments / archetypes that give feedback and benefit from features.

Endpoints

GET/api/v1/personas
POST/api/v1/personas
GET/api/v1/personas/{id}
PATCH/api/v1/personas/{id}
DELETE/api/v1/personas/{id}
POST/api/v1/personas/{id}/restore
GET/api/v1/personas/{id}/links/feedback
POST/api/v1/personas/{id}/links/feedback
DELETE/api/v1/personas/{id}/links/feedback/{targetId}
GET/api/v1/personas/{id}/links/themes
POST/api/v1/personas/{id}/links/themes
DELETE/api/v1/personas/{id}/links/themes/{targetId}
GET/api/v1/personas/{id}/links/features
POST/api/v1/personas/{id}/links/features
DELETE/api/v1/personas/{id}/links/features/{targetId}
GET/api/v1/personas/{id}/links/products
POST/api/v1/personas/{id}/links/products
DELETE/api/v1/personas/{id}/links/products/{targetId}
GET/api/v1/personas/{id}/links/modules
POST/api/v1/personas/{id}/links/modules
DELETE/api/v1/personas/{id}/links/modules/{targetId}

Writable fields

* required on create. PATCH treats every field as optional.

FieldTypeConstraintsNotes
name*string
rolestring
companystring
avatarstring
descriptiontext
goalsstring[]
pain_pointsstring[]
revenue_impactstring
is_draftboolean
metadatajson

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

Generated from the API's entity configuration. This page is rebuilt on every deploy, so it always matches the live API.