Docs
API Reference

Forms

Read-only compliance templates, rules, and submissions

Form writes (attach, submit, void, amend, template authoring) stay in the Servicebay app and Cloud Functions. The API exposes the same documents read-only so integrators can inspect compliance state.

Required scope: forms:read (templates, rules, and submissions — writes stay in the app).

  • GET/organisations/{orgId}/form-templates
  • GET/organisations/{orgId}/form-templates/{templateId}
  • GET/organisations/{orgId}/form-templates/{templateId}/versions
  • GET/organisations/{orgId}/form-templates/{templateId}/versions/{versionId}
  • GET/organisations/{orgId}/form-templates/{templateId}/versions/{versionId}/translations/{locale}
  • GET/organisations/{orgId}/form-rules
  • GET/organisations/{orgId}/form-submissions
  • GET/organisations/{orgId}/form-submissions/{submissionId}
  • GET/organisations/{orgId}/form-submissions/{submissionId}/signatures
  • GET/organisations/{orgId}/form-submissions/{submissionId}/events

Privacy

GPS, contributors, and submitDevice are omitted unless you pass ?include=audit.

List filters: ticketId (order order), isOpen=true (order createdAt asc), customerItemId (order submittedAt desc).