Skip to content

by startups.studio

by Startups.Studio

API Legal & trust

Control routes

Every Control Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for Control.

Noun	System	Run by
Control	Compliance	Compliance Officer

Control.get

Returns one Control by id. Verb page.

Text

GET /{namespace}/controls/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Control.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`control`	Control	required	The Control.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use 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/controls/control_o4pMmXUeCH \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "$type": "Control",
  "$id": "https://api.sb/leaseline.app/controls/control_o4pMmXUeCH",
  "control": {
    "$id": "https://api.sb/leaseline.app/controls/control_o4pMmXUeCH",
    "$type": "Control",
    "objective": "Example objective",
    "kind": "Example kind",
    "inheritance": "inherited",
    "criteria": [
      "criterion_GWSHmCK100"
    ]
  },
  "links": {
    "self": "https://api.sb/leaseline.app/controls/control_o4pMmXUeCH",
    "up": "https://api.sb/leaseline.app/controls"
  }
}

Control.list

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

Text

GET /{namespace}/controls

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

Inputs

Input	Type	Required	Description
`limit`	`integer`		At most this many records, up to 100. The default is 20.
`after`	`string`		The cursor from the previous page.
`where`	`string`		A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`		Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`		True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`		Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`		Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`		Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`		How many levels of related records to embed. The default is 1.
`q`	`string`		Words to match across the text properties, ranked by relevance.
`match`	`string`		Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`controls`	list of Control	required	One page of Controls.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use 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/controls?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "$type": "Control",
  "controls": [
    {
      "$id": "https://api.sb/leaseline.app/controls/control_o4pMmXUeCH",
      "$type": "Control",
      "objective": "Example objective",
      "kind": "Example kind",
      "inheritance": "inherited",
      "criteria": [
        "criterion_GWSHmCK100"
      ]
    }
  ],
  "meta": {
    "limit": 20,
    "after": "control_o4pMmXUeCH"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/controls?limit=20",
    "next": "https://api.sb/leaseline.app/controls?after=control_o4pMmXUeCH"
  }
}

withdraw

Previous

Criterion

Next