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

ICP routes: create, get, list

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

Reference for ICP, one group of ICP routes.

ICP.create

Creates an ICP. Verb page.

Text
POST /{namespace}/icps

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

Inputs

InputTypeRequiredDescription
descriptiontextrequiredWho they are and what they do.

Returns

OutputTypeRequiredDescription
icpICPrequiredThe ICP.

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/icps \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"description":"Renewal tracking for up to 200 units."}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "icp": {
    "$id": "https://api.sb/leaseline.app/icps/icp_EwhsJU4AOW",
    "$type": "ICP",
    "description": "Renewal tracking for up to 200 units."
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "ICP.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

ICP.get

Returns one ICP by id. Verb page.

Text
GET /{namespace}/icps/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
icpICPrequiredThe ICP.

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/icps/icp_EwhsJU4AOW \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "ICP",
  "$id": "https://api.sb/leaseline.app/icps/icp_EwhsJU4AOW",
  "icp": {
    "$id": "https://api.sb/leaseline.app/icps/icp_EwhsJU4AOW",
    "$type": "ICP",
    "description": "Renewal tracking for up to 200 units."
  },
  "links": {
    "self": "https://api.sb/leaseline.app/icps/icp_EwhsJU4AOW",
    "up": "https://api.sb/leaseline.app/icps"
  }
}

ICP.list

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

Text
GET /{namespace}/icps

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
icpslist of ICPrequiredOne page of ICPs.

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/icps?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "ICP",
  "icps": [
    {
      "$id": "https://api.sb/leaseline.app/icps/icp_EwhsJU4AOW",
      "$type": "ICP",
      "description": "Renewal tracking for up to 200 units."
    }
  ],
  "meta": {
    "limit": 20,
    "after": "icp_EwhsJU4AOW"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/icps?limit=20",
    "next": "https://api.sb/leaseline.app/icps?after=icp_EwhsJU4AOW"
  }
}

ICP

Previous

update, delete

Next