Skip to main content
GET
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
personas
List personas
curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas \
  --header 'Authorization: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "picture": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "profile": {
      "name": "<string>",
      "archetype": "<string>",
      "topic_tag": "<string>"
    },
    "demographic": {
      "age_from": 123,
      "age_to": 123,
      "gender": "<string>",
      "country": "<string>",
      "language": "<string>",
      "education_level": "<string>",
      "education_field": "<string>",
      "occupation": "<string>",
      "income": 123,
      "living_context": "<string>"
    },
    "internal_compass": {
      "job_to_be_done": "<string>",
      "values_and_personality_traits": "<string>",
      "motivations": "<string>",
      "strategic_goal": "<string>"
    },
    "behavioural_map": {
      "lifestyle_and_primary_tasks": "<string>",
      "media_consumption": "<string>",
      "typical_quote": "<string>"
    },
    "resistance": {
      "pain_points": "<string>",
      "purchase_barriers": "<string>",
      "core_questions": "<string>",
      "key_buying_triggers": "<string>"
    },
    "connection": {
      "product_need": "<string>",
      "why_loves_category": "<string>",
      "summary": "<string>"
    },
    "version": {
      "name": "<string>",
      "changes": "<string>",
      "is_active": true,
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z"
    },
    "archived": true
  }
]

Authorizations

Authorization
string
header
required

Path Parameters

organization_id
string<uuid>
required

A UUID string identifying the organization.

workspace_id
string<uuid>
required

A UUID string identifying the workspace.

Query Parameters

archived
boolean

Include archived personas when set to true. Defaults to false.

profile_archetype
string

Exact match on profile_archetype.

Partial case-insensitive match on profile_name, profile_archetype, or profile_topic_tag.

version_source
string

Exact match on version_source (ai | manual | csv).

Response

200 - application/json
id
string<uuid>
required
read-only
organization_id
string<uuid>
required
workspace_id
string<uuid>
required
picture
string | null
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
profile
object
required
demographic
object
required
internal_compass
object
required
behavioural_map
object
required
resistance
object
required
connection
object
required
version
object
required
archived
boolean