Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthPersona

Persona routes: create, get, list

The Persona Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Persona, one group of Persona routes.

Persona.create

Creates a Persona. Verb page.

Text
POST /{namespace}/personas

Body, as JSON: the inputs. Emits Persona.created.

Inputs

InputTypeRequiredDescription
jobtextrequiredWhat they come to get done.
fromstringLineage: the slot it compiles from, as Hypothesis#<slot>@v<version>.
icpICPA Persona is one named role inside an ICP, such as its buyer or its admin.
roleRoleThe Role whose Permissions a Persona signs in with, so an App compiles its Dashboards and Verbs from one record.

Returns

OutputTypeRequiredDescription
personaPersonarequiredThe Persona.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/personas \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job":"Example job"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "persona": {
    "$id": "https://api.sb/leaseline.app/personas/persona_YdpO6wSexq",
    "$type": "Persona",
    "job": "Example job"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Persona.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Persona.get

Returns one Persona by id. Verb page.

Text
GET /{namespace}/personas/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Persona.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
personaPersonarequiredThe Persona.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/personas/persona_YdpO6wSexq \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Persona",
  "$id": "https://api.sb/leaseline.app/personas/persona_YdpO6wSexq",
  "persona": {
    "$id": "https://api.sb/leaseline.app/personas/persona_YdpO6wSexq",
    "$type": "Persona",
    "job": "Example job"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/personas/persona_YdpO6wSexq",
    "up": "https://api.sb/leaseline.app/personas"
  }
}

Persona.list

Returns Personas, newest first, one page at a time. Verb page.

Text
GET /{namespace}/personas

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
personaslist of PersonarequiredOne page of Personas.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/personas?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Persona",
  "personas": [
    {
      "$id": "https://api.sb/leaseline.app/personas/persona_YdpO6wSexq",
      "$type": "Persona",
      "job": "Example job"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "persona_YdpO6wSexq"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/personas?limit=20",
    "next": "https://api.sb/leaseline.app/personas?after=persona_YdpO6wSexq"
  }
}

Persona

Previous

update, delete

Next