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

Opening routes: create, get, list

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

Reference for Opening, one group of Opening routes.

Opening.create

Creates an Opening. Verb page.

Text
POST /{namespace}/openings

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

Inputs

InputTypeRequiredDescription
roleRolerequiredThe Role the Human joins, by taking a share of it.
kindstringrequiredOne of floor, contractor, employee, or cofounder.
reasonstringrequiredOne of floor, credential, edge, relationship, capital, capacity, or distribution.
hypothesisHypothesisrequiredThe result a hire must beat the incumbent Agent on.
skillslist of SkillThe Skills required, each citing the Evidence that shows the gap.
credentialslist of CredentialThe Credentials a Reserved Act in the Role requires.
commitmentstringHours per week, from a few hours to full time.
termsurlThe published terms for this kind of Opening.
listedbooleanTrue once the Opening is public; unlisted Openings reach only the talent pool.

Returns

OutputTypeRequiredDescription
openingOpeningrequiredThe Opening.

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/openings \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"role":"role_oloMFMUeCH","kind":"floor","reason":"floor","hypothesis":"hypothesis_Z1gjx1kbtc"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "opening": {
    "$id": "https://api.sb/leaseline.app/openings/opening_3rD8qFSOyQ",
    "$type": "Opening",
    "role": "role_oloMFMUeCH",
    "kind": "floor",
    "reason": "floor",
    "hypothesis": "hypothesis_Z1gjx1kbtc"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Opening.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Opening.get

Returns one Opening by id. Verb page.

Text
GET /{namespace}/openings/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
openingOpeningrequiredThe Opening.

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/openings/opening_3rD8qFSOyQ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Opening",
  "$id": "https://api.sb/leaseline.app/openings/opening_3rD8qFSOyQ",
  "opening": {
    "$id": "https://api.sb/leaseline.app/openings/opening_3rD8qFSOyQ",
    "$type": "Opening",
    "role": "role_oloMFMUeCH",
    "kind": "floor",
    "reason": "floor",
    "hypothesis": "hypothesis_Z1gjx1kbtc"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/openings/opening_3rD8qFSOyQ",
    "up": "https://api.sb/leaseline.app/openings"
  }
}

Opening.list

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

Text
GET /{namespace}/openings

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
openingslist of OpeningrequiredOne page of Openings.

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/openings?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Opening",
  "openings": [
    {
      "$id": "https://api.sb/leaseline.app/openings/opening_3rD8qFSOyQ",
      "$type": "Opening",
      "role": "role_oloMFMUeCH",
      "kind": "floor",
      "reason": "floor",
      "hypothesis": "hypothesis_Z1gjx1kbtc"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "opening_3rD8qFSOyQ"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/openings?limit=20",
    "next": "https://api.sb/leaseline.app/openings?after=opening_3rD8qFSOyQ"
  }
}

Opening

Previous

update, delete

Next