Menu

Personas

2 endpoints in the Mattering Sales API.

GETPOST personas/ User APIService tier

List personas, or create one with POST. derived from route

URL

  • User APIhttps://sales.mattering.io/api/user/v1/personas/
  • Service tierhttps://sales.mattering.io/api/internal/personas/

Query parameters

NameDefault
archived_onlynone
include_archivednone
keywordnone
limit100
space_idnone

Body keys (JSON)

KeyRequiredDefault
nameoptional or conditionalnone
space_idoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Pagination

Accepts limit and offset and the server caps limit at 500. Check the response for a total or count field.

Responses

200 data and meta envelope, legacy keys repeated beside data

{
  "data": {
    "personas": [
      {
        "name": "...",
        "summary": "...",
        "icon": "...",
        "color": "...",
        "created_at": "2026-01-01T00:00:00Z",
        "updated_at": "2026-01-01T00:00:00Z",
        "id": "...",
        "is_archived": true,
        "completeness": "...",
        "demographics": "...",
        "psychographics": "..."
      }
    ]
  },
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}

201 data and meta envelope, legacy keys repeated beside data

{
  "data": {
    "persona": {
      "name": "...",
      "summary": "...",
      "icon": "...",
      "color": "...",
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-01T00:00:00Z",
      "id": "...",
      "is_archived": true,
      "completeness": "...",
      "demographics": "...",
      "psychographics": "..."
    }
  },
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400name_required
401unauthorized
404space_not_found_or_forbidden

Example

curl -X POST "https://sales.mattering.io/api/user/v1/personas/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "...",
  "space_id": "..."
}'

Source: CRMCore/internal_api.py (internal_api.personas)

GETPATCHDELETE personas/{persona_id}/ User APIService tier

Read, update or delete one of the personas by id. derived from route

URL

  • User APIhttps://sales.mattering.io/api/user/v1/personas/{persona_id}/
  • Service tierhttps://sales.mattering.io/api/internal/personas/{persona_id}/

Path parameters

NameType
persona_iduuid

Responses

200 data and meta envelope, legacy keys repeated beside data

{
  "data": {
    "persona": {
      "name": "...",
      "summary": "...",
      "icon": "...",
      "color": "...",
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-01T00:00:00Z",
      "id": "...",
      "is_archived": true,
      "completeness": "...",
      "demographics": "...",
      "psychographics": "..."
    },
    "deleted": true
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400name_required
400no_writable_fields
401unauthorized
404not_found

Example

curl -X GET "https://sales.mattering.io/api/user/v1/personas/PERSONA_ID/" \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: CRMCore/internal_api.py (internal_api.persona_detail)

All Sales resources
Start Free Explore our Products