Skip to main content

Approvals

SDK methods for the Approvals module, accessed via soat.approvals. See the Approvals module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.approvals.listApprovals()​

List approval items

  • Method: GET
  • Path: /api/v1/approvals
await soat.approvals.listApprovals({
  query: { /* + optional */ },
});

→ Request & response schema

soat.approvals.listApprovalRecurrences()​

List recurring approval groups

  • Method: GET
  • Path: /api/v1/approvals/recurrences
await soat.approvals.listApprovalRecurrences({
  query: { /* + optional */ },
});

→ Request & response schema

soat.approvals.getApproval()​

Get an approval item

  • Method: GET
  • Path: /api/v1/approvals/{approval_id}
await soat.approvals.getApproval();

→ Request & response schema

soat.approvals.approveApproval()​

Approve an approval item

  • Method: POST
  • Path: /api/v1/approvals/{approval_id}/approve
await soat.approvals.approveApproval({
  body: { /* + optional */ },
});

→ Request & response schema

soat.approvals.rejectApproval()​

Reject an approval item

  • Method: POST
  • Path: /api/v1/approvals/{approval_id}/reject
await soat.approvals.rejectApproval({
  body: { reason },
});

→ Request & response schema