Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APILegal & trustAgreement

Agreement routes: create, get, list

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

Reference for Agreement, one group of Agreement routes.

Agreement.create

Creates an Agreement. Verb page.

Text
POST /{namespace}/agreements

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

Inputs

InputTypeRequiredDescription
termtextHow long it runs and how it ends.
signedAtdatetimeWhen the last Party signed.
terminatedAtdatetimeWhen it ended under its term; it stays on record.
payoutSchedulestringFor a Supplier’s Agreement: how often the released earned balance pays out.
clearanceDaysintegerFor a Supplier’s Agreement: days an Order’s earnings wait after confirmation before they can pay out.

Returns

OutputTypeRequiredDescription
agreementAgreementrequiredThe Agreement.

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/agreements \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"term":"Example term"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "agreement": {
    "$id": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY",
    "$type": "Agreement",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Agreement.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Agreement.get

Returns one Agreement by id. Verb page.

Text
GET /{namespace}/agreements/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
agreementAgreementrequiredThe Agreement.

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/agreements/agreement_zHIUnX8LwY \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Agreement",
  "$id": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY",
  "agreement": {
    "$id": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY",
    "$type": "Agreement",
    "status": "draft"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY",
    "up": "https://api.sb/leaseline.app/agreements"
  },
  "actions": {
    "sign": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY/sign",
    "terminate": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY/terminate"
  }
}

Agreement.list

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

Text
GET /{namespace}/agreements

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
agreementslist of AgreementrequiredOne page of Agreements.

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/agreements?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Agreement",
  "agreements": [
    {
      "$id": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY",
      "$type": "Agreement",
      "status": "draft"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "agreement_zHIUnX8LwY"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/agreements?limit=20",
    "next": "https://api.sb/leaseline.app/agreements?after=agreement_zHIUnX8LwY"
  }
}

Agreement

Previous

update

Next