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

Handle routes: create, get, list

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

Reference for Handle, one group of Handle routes.

Handle.create

Creates a Handle. Verb page.

Text
POST /{namespace}/handles

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

Inputs

InputTypeRequiredDescription
venuestringrequiredThe venue it lives on, by id.
namestringrequiredThe name as the platform shows it, such as @example.
sharedbooleanTrue for a Studio account shared across sibling Startups; every Post names the Startup it speaks for.
agentbooleanTrue when an Agent runs it; its bio says so.
integrationIntegrationThe Integration credential it publishes through.

Returns

OutputTypeRequiredDescription
handleHandlerequiredThe Handle.

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/handles \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"venue":"Example venue","name":"Leaseline"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "handle": {
    "$id": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc",
    "$type": "Handle",
    "venue": "Example venue",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Handle.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Handle.get

Returns one Handle by id. Verb page.

Text
GET /{namespace}/handles/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
handleHandlerequiredThe Handle.

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/handles/handle_FcnNwYQujc \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Handle",
  "$id": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc",
  "handle": {
    "$id": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc",
    "$type": "Handle",
    "venue": "Example venue",
    "name": "Leaseline"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc",
    "up": "https://api.sb/leaseline.app/handles"
  },
  "actions": {
    "connect": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc/connect"
  }
}

Handle.list

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

Text
GET /{namespace}/handles

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
handleslist of HandlerequiredOne page of Handles.

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/handles?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Handle",
  "handles": [
    {
      "$id": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc",
      "$type": "Handle",
      "venue": "Example venue",
      "name": "Leaseline"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "handle_FcnNwYQujc"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/handles?limit=20",
    "next": "https://api.sb/leaseline.app/handles?after=handle_FcnNwYQujc"
  }
}

Handle

Previous

update

Next