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

Role routes: review, staff, vacate

The Role Verbs review, staff, vacate as api.sb routes, with inputs, result, refusals and an example.

Reference for Role, one group of Role routes.

Role.review

Review checks one Role against its contract for a period and records a Role Review. Verb page.

Text
POST /{namespace}/roles/{role}/review

Path: role. Body, as JSON: the other inputs. Emits Role.reviewed.

Inputs

InputTypeRequiredDescription
roleRolerequiredThe Role to review.
periodstringrequiredThe period it covers, such as 2026-W43.

Returns

OutputTypeRequiredDescription
roleRolerequiredThe reviewed Role.
roleReviewRole ReviewrequiredThe recorded Role Review.

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/roles/role_oloMFMUeCH/review \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"period":"Example period"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "role": {
    "$id": "https://api.sb/leaseline.app/roles/role_oloMFMUeCH",
    "$type": "Role",
    "name": "Success Manager",
    "status": "filled"
  },
  "roleReview": {
    "$id": "https://api.sb/leaseline.app/role-reviews/rolereview_Eflst84AOW",
    "$type": "RoleReview",
    "role": "role_oloMFMUeCH",
    "period": "2026-W43"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Role.review",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Role.staff

Staff fills a Role with a Worker, human or agent, who then performs the Role’s Verbs under its Permissions. Verb page.

Text
POST /{namespace}/roles/{role}/staff

Path: role. Body, as JSON: the other inputs. Emits Role.staffed.

Inputs

InputTypeRequiredDescription
roleRolerequiredThe Role to fill.
workerWorkerrequiredThe Worker who fills it.

Returns

OutputTypeRequiredDescription
roleRolerequiredThe staffed Role.

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.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/roles/role_oloMFMUeCH/staff \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"worker":"worker_whZFpOKWIV"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "role": {
    "$id": "https://api.sb/leaseline.app/roles/role_oloMFMUeCH",
    "$type": "Role",
    "name": "Success Manager",
    "status": "filled"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Role.staff",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Role.vacate

Vacate takes the Worker out of a Role, and the seat’s Tasks route to the Role it escalates to until a new Worker is staffed. Verb page.

Text
POST /{namespace}/roles/{role}/vacate

Path: role. Body, as JSON: the other inputs. Emits Role.vacated.

Inputs

InputTypeRequiredDescription
roleRolerequiredThe Role to empty.
reasontextWhy the seat empties.

Returns

OutputTypeRequiredDescription
roleRolerequiredThe vacant Role.

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/roles/role_oloMFMUeCH/vacate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "role": {
    "$id": "https://api.sb/leaseline.app/roles/role_oloMFMUeCH",
    "$type": "Role",
    "name": "Success Manager",
    "status": "filled"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Role.vacate",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

Role Review

Next