Period routes: get, list, update

Reference for Period, one group of Period routes.

Period.get

Returns one Period by id. Verb page.

Text

GET /{namespace}/periods/{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 Period.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`period`	Period	required	The Period.

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/periods/period_VEVuYACTsH \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "$type": "Period",
  "$id": "https://api.sb/leaseline.app/periods/period_VEVuYACTsH",
  "period": {
    "$id": "https://api.sb/leaseline.app/periods/period_VEVuYACTsH",
    "$type": "Period",
    "month": "2026-10-22",
    "status": "Open"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/periods/period_VEVuYACTsH",
    "up": "https://api.sb/leaseline.app/periods"
  },
  "actions": {
    "close": "https://api.sb/leaseline.app/periods/period_VEVuYACTsH/close",
    "lock": "https://api.sb/leaseline.app/periods/period_VEVuYACTsH/lock",
    "recognize": "https://api.sb/leaseline.app/periods/period_VEVuYACTsH/recognize"
  }
}

Period.list

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

Text

GET /{namespace}/periods

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

Inputs

Input	Type	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
`periods`	list of Period	required	One page of Periods.

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/periods?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "$type": "Period",
  "periods": [
    {
      "$id": "https://api.sb/leaseline.app/periods/period_VEVuYACTsH",
      "$type": "Period",
      "month": "2026-10-22",
      "status": "Open"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "period_VEVuYACTsH"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/periods?limit=20",
    "next": "https://api.sb/leaseline.app/periods?after=period_VEVuYACTsH"
  }
}

Period.update

Changes the given properties of a Period. Verb page.

Text

PATCH /{namespace}/periods/{id}

Path: id. Body, as JSON: the other inputs. Emits Period.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Period.
`month`	`date`		The first day of the month it covers.

Returns

Output	Type	Required	Description
`period`	Period	required	The Period.

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 -X PATCH https://api.sb/leaseline.app/periods/period_VEVuYACTsH \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"month":"2026-10-22"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "period": {
    "$id": "https://api.sb/leaseline.app/periods/period_VEVuYACTsH",
    "$type": "Period",
    "month": "2026-10-22",
    "status": "Open"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Period.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Period.getCopy Anchor Link

Period.listCopy Anchor Link

Period.updateCopy Anchor Link

Period.get

Period.list

Period.update