# api ## Pages - [Quire API](https://docs.quirelms.com/api/index.md) — The Quire REST API. Every collection is cursor paginated; offset is not offered anywhere. Every error is an RFC 9457 problem document with a stable `code` and one of ten `category` values. - [Read one audit checkpoint](https://docs.quirelms.com/api/audit/getAuditCheckpoint/index.md) — ### Quire permissions Required capability: `report/viewAudit`. Credential scopes: `audit:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one auditentry](https://docs.quirelms.com/api/audit/getAuditEntry/index.md) — ### Quire permissions Required capability: `report/viewAudit`. Credential scopes: `audit:read`. The acting subject must also be allowed to perform this action in the organisation. - [List audit checkpoints deleted since a point in time](https://docs.quirelms.com/api/audit/listAuditCheckpointDeletions/index.md) — Tombstones of deleted audit checkpoints, kept for 90 days. ### Quire permissions Required capability: `report/viewAudit`. Credential scopes: `audit:read`. The acting subject must also be allowed to perform this action in the organisation. - [List audit checkpoints](https://docs.quirelms.com/api/audit/listAuditCheckpoints/index.md) — Signed checkpoints for this organisation’s audit chain, including public verification metadata. Checkpoint rows are read through the reporting connection and are always limited to this organisation’s chain; private signing keys are never exposed. ### Quire permissions Required capability: `report/viewAudit`. Credential scopes: `audit:read`. The acting subject must also be allowed to perform this action in the organisation. - [List auditentries](https://docs.quirelms.com/api/audit/listAuditEntries/index.md) — The audit trail, oldest first. Redacted entries keep their place in the chain with their personal fields removed. `audit:read` is a privileged scope. ### Quire permissions Required capability: `report/viewAudit`. Credential scopes: `audit:read`. The acting subject must also be allowed to perform this action in the organisation. - [List auditentries deleted since a point in time](https://docs.quirelms.com/api/audit/listAuditEntryDeletions/index.md) — Tombstones of deleted auditentries, kept for 90 days. ### Quire permissions Required capability: `report/viewAudit`. Credential scopes: `audit:read`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 automationrule operations](https://docs.quirelms.com/api/automation/bulkAutomationRules/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `automation/manage`. Credential scopes: `automation:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create an automation rule](https://docs.quirelms.com/api/automation/createAutomationRule/index.md) — ### Quire permissions Required capability: `automation/manage`. Credential scopes: `automation:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete an automation rule without erasing its run history](https://docs.quirelms.com/api/automation/deleteAutomationRule/index.md) — ### Quire permissions Required capability: `automation/manage`. Credential scopes: `automation:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one automationrule](https://docs.quirelms.com/api/automation/getAutomationRule/index.md) — ### Quire permissions Required capability: `automation/manage`. Credential scopes: `automation:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one automationrule by external identifier](https://docs.quirelms.com/api/automation/getAutomationRuleByExternalId/index.md) — ### Quire permissions Required capability: `automation/manage`. Credential scopes: `automation:read`. The acting subject must also be allowed to perform this action in the organisation. - [List automationrules deleted since a point in time](https://docs.quirelms.com/api/automation/listAutomationRuleDeletions/index.md) — Tombstones of deleted automationrules, kept for 90 days. ### Quire permissions Required capability: `automation/manage`. Credential scopes: `automation:read`. The acting subject must also be allowed to perform this action in the organisation. - [List automationrules](https://docs.quirelms.com/api/automation/listAutomationRules/index.md) — Tenant automation rules. Only administrators who may manage automation can read their conditions and actions. ### Quire permissions Required capability: `automation/manage`. Credential scopes: `automation:read`. The acting subject must also be allowed to perform this action in the organisation. - [Change an automation rule](https://docs.quirelms.com/api/automation/updateAutomationRule/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `automation/manage`. Credential scopes: `automation:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update an automation rule by external identifier](https://docs.quirelms.com/api/automation/upsertAutomationRule/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `automation/manage`. Credential scopes: `automation:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 calendarevent operations](https://docs.quirelms.com/api/calendar/bulkCalendarEvents/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `calendar/manage`. Credential scopes: `calendar:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add an event to a calendar](https://docs.quirelms.com/api/calendar/createCalendarEvent/index.md) — ### Quire permissions Required capability: `calendar/manage`. Credential scopes: `calendar:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a platform calendar broadcast](https://docs.quirelms.com/api/calendar/createPlatformCalendarBroadcast/index.md) — Creates an audited event in shared platform storage. Time zone and recurrence rules are validated by the calendar service. ### Quire permissions Required capability: `platform/calendar_broadcast`. Credential scopes: `calendar:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete an event, every occurrence of a series](https://docs.quirelms.com/api/calendar/deleteCalendarEvent/index.md) — ### Quire permissions Required capability: `calendar/manage`. Credential scopes: `calendar:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one calendarevent](https://docs.quirelms.com/api/calendar/getCalendarEvent/index.md) — ### Quire permissions Required capability: `calendar/manage`. Credential scopes: `calendar:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one calendarevent by external identifier](https://docs.quirelms.com/api/calendar/getCalendarEventByExternalId/index.md) — ### Quire permissions Required capability: `calendar/manage`. Credential scopes: `calendar:read`. The acting subject must also be allowed to perform this action in the organisation. - [List calendarevents deleted since a point in time](https://docs.quirelms.com/api/calendar/listCalendarEventDeletions/index.md) — Tombstones of deleted calendarevents, kept for 90 days. ### Quire permissions Required capability: `calendar/manage`. Credential scopes: `calendar:read`. The acting subject must also be allowed to perform this action in the organisation. - [List calendarevents](https://docs.quirelms.com/api/calendar/listCalendarEvents/index.md) — Calendar events. A recurring event carries its rule; occurrences are expanded by the calendar feed. ### Quire permissions Required capability: `calendar/manage`. Credential scopes: `calendar:read`. The acting subject must also be allowed to perform this action in the organisation. - [List platform calendar broadcasts](https://docs.quirelms.com/api/calendar/listPlatformCalendarBroadcasts/index.md) — Lists shared platform events and withdrawn history without operator identities or audit details. ### Quire permissions Required capability: `platform/calendar_broadcast`. Credential scopes: `calendar:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read a live platform calendar broadcast](https://docs.quirelms.com/api/calendar/readPlatformCalendarBroadcast/index.md) — Returns one live shared platform event. Withdrawn events remain in the administrative list. ### Quire permissions Required capability: `platform/calendar_broadcast`. Credential scopes: `calendar:read`. The acting subject must also be allowed to perform this action in the organisation. - [Change an event, every occurrence of a series](https://docs.quirelms.com/api/calendar/updateCalendarEvent/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `calendar/manage`. Credential scopes: `calendar:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update a platform calendar broadcast](https://docs.quirelms.com/api/calendar/updatePlatformCalendarBroadcast/index.md) — Replaces a live shared event through the audited calendar service; withdrawn events cannot be edited. ### Quire permissions Required capability: `platform/calendar_broadcast`. Credential scopes: `calendar:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a calendar event by external identifier](https://docs.quirelms.com/api/calendar/upsertCalendarEvent/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `calendar/manage`. Credential scopes: `calendar:write`. The acting subject must also be allowed to perform this action in the organisation. - [Withdraw a platform calendar broadcast](https://docs.quirelms.com/api/calendar/withdrawPlatformCalendarBroadcast/index.md) — Idempotently withdraws a shared event from tenant calendars and records a platform audit entry on the first change. ### Quire permissions Required capability: `platform/calendar_broadcast`. Credential scopes: `calendar:write`. The acting subject must also be allowed to perform this action in the organisation. - [Activate a badge so it can be awarded](https://docs.quirelms.com/api/certificates/activateBadge/index.md) — ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a criterion to a badge](https://docs.quirelms.com/api/certificates/addCriterionBadge/index.md) — ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Archive a badge](https://docs.quirelms.com/api/certificates/archiveBadge/index.md) — Stops new awards and keeps the hosted document live for holders. ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 badgeaward operations](https://docs.quirelms.com/api/certificates/bulkBadgeAwards/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `badge/award`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 badge operations](https://docs.quirelms.com/api/certificates/bulkBadges/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 certificate operations](https://docs.quirelms.com/api/certificates/bulkCertificates/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `certificate/issue`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a badge](https://docs.quirelms.com/api/certificates/createBadge/index.md) — ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Award a badge to a person](https://docs.quirelms.com/api/certificates/createBadgeAward/index.md) — ### Quire permissions Required capability: `badge/award`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Issue a certificate to a person](https://docs.quirelms.com/api/certificates/createCertificate/index.md) — ### Quire permissions Required capability: `certificate/issue`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a badge that has never been awarded (archive one that has)](https://docs.quirelms.com/api/certificates/deleteBadge/index.md) — ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Return a badge to draft](https://docs.quirelms.com/api/certificates/draftBadge/index.md) — ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one badge](https://docs.quirelms.com/api/certificates/getBadge/index.md) — ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one badgeaward](https://docs.quirelms.com/api/certificates/getBadgeAward/index.md) — ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one badgeaward by external identifier](https://docs.quirelms.com/api/certificates/getBadgeAwardByExternalId/index.md) — ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one badge by external identifier](https://docs.quirelms.com/api/certificates/getBadgeByExternalId/index.md) — ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one certificate](https://docs.quirelms.com/api/certificates/getCertificate/index.md) — ### Quire permissions Required capability: `certificate/manage`. Credential scopes: `certificates:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one certificate by external identifier](https://docs.quirelms.com/api/certificates/getCertificateByExternalId/index.md) — ### Quire permissions Required capability: `certificate/manage`. Credential scopes: `certificates:read`. The acting subject must also be allowed to perform this action in the organisation. - [List badgeawards deleted since a point in time](https://docs.quirelms.com/api/certificates/listBadgeAwardDeletions/index.md) — Tombstones of deleted badgeawards, kept for 90 days. ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:read`. The acting subject must also be allowed to perform this action in the organisation. - [List badgeawards](https://docs.quirelms.com/api/certificates/listBadgeAwards/index.md) — Badges awarded to people, as Open Badges assertions. ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:read`. The acting subject must also be allowed to perform this action in the organisation. - [List badges deleted since a point in time](https://docs.quirelms.com/api/certificates/listBadgeDeletions/index.md) — Tombstones of deleted badges, kept for 90 days. ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:read`. The acting subject must also be allowed to perform this action in the organisation. - [List badges](https://docs.quirelms.com/api/certificates/listBadges/index.md) — Badge classes: what a badge is for, its criteria, and where it can be awarded. ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:read`. The acting subject must also be allowed to perform this action in the organisation. - [List certificates deleted since a point in time](https://docs.quirelms.com/api/certificates/listCertificateDeletions/index.md) — Tombstones of deleted certificates, kept for 90 days. ### Quire permissions Required capability: `certificate/manage`. Credential scopes: `certificates:read`. The acting subject must also be allowed to perform this action in the organisation. - [List certificates](https://docs.quirelms.com/api/certificates/listCertificates/index.md) — Issued certificates, with the public verification code and their validity. ### Quire permissions Required capability: `certificate/manage`. Credential scopes: `certificates:read`. The acting subject must also be allowed to perform this action in the organisation. - [Reissue a certificate with the person's current details](https://docs.quirelms.com/api/certificates/reissueCertificate/index.md) — ### Quire permissions Required capability: `certificate/issue`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Remove a criterion from a badge](https://docs.quirelms.com/api/certificates/removeCriterionBadge/index.md) — ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Revoke an awarded badge](https://docs.quirelms.com/api/certificates/revokeBadgeAward/index.md) — Marks the award revoked, sets its bit on the published revocation list so verifiers stop accepting it, and is audited. The award stays readable with its revoked_at. Revoking an award that is already revoked is a conflict. ### Quire permissions Required capability: `badge/revoke`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Revoke a certificate](https://docs.quirelms.com/api/certificates/revokeCertificate/index.md) — Its verification page then says it was revoked, and why. ### Quire permissions Required capability: `certificate/revoke`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a badge](https://docs.quirelms.com/api/certificates/updateBadge/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a badge by external identifier](https://docs.quirelms.com/api/certificates/upsertBadge/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `badge/manage`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Issue a certificate by external identifier, or return the one that has it](https://docs.quirelms.com/api/certificates/upsertCertificate/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `certificate/issue`. Credential scopes: `certificates:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a person to a cohort](https://docs.quirelms.com/api/cohorts/addCohortMember/index.md) — ### Quire permissions Required capability: `cohort/manage`. Credential scopes: `cohorts:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 cohortmember operations](https://docs.quirelms.com/api/cohorts/bulkCohortMembers/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `cohort/manage`. Credential scopes: `cohorts:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 cohort operations](https://docs.quirelms.com/api/cohorts/bulkCohorts/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `cohort/manage`. Credential scopes: `cohorts:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a cohort](https://docs.quirelms.com/api/cohorts/createCohort/index.md) — ### Quire permissions Required capability: `cohort/manage`. Credential scopes: `cohorts:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a cohort](https://docs.quirelms.com/api/cohorts/deleteCohort/index.md) — ### Quire permissions Required capability: `cohort/manage`. Credential scopes: `cohorts:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one cohort](https://docs.quirelms.com/api/cohorts/getCohort/index.md) — ### Quire permissions Required capability: `cohort/view`. Credential scopes: `cohorts:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one cohort by external identifier](https://docs.quirelms.com/api/cohorts/getCohortByExternalId/index.md) — ### Quire permissions Required capability: `cohort/view`. Credential scopes: `cohorts:read`. The acting subject must also be allowed to perform this action in the organisation. - [List cohorts deleted since a point in time](https://docs.quirelms.com/api/cohorts/listCohortDeletions/index.md) — Tombstones of deleted cohorts, kept for 90 days. ### Quire permissions Required capability: `cohort/view`. Credential scopes: `cohorts:read`. The acting subject must also be allowed to perform this action in the organisation. - [List members](https://docs.quirelms.com/api/cohorts/listCohortMembers/index.md) — The people in a cohort, and whether each came from the rule or was added by hand. The id of a member is their user id. ### Quire permissions Required capability: `cohort/view`. Credential scopes: `cohorts:read`. The acting subject must also be allowed to perform this action in the organisation. - [List cohorts](https://docs.quirelms.com/api/cohorts/listCohorts/index.md) — Site and category cohorts. A dynamic cohort carries its rule and is recomputed; a static one is managed by hand. ### Quire permissions Required capability: `cohort/view`. Credential scopes: `cohorts:read`. The acting subject must also be allowed to perform this action in the organisation. - [Take a person out of a cohort](https://docs.quirelms.com/api/cohorts/removeCohortMember/index.md) — ### Quire permissions Required capability: `cohort/manage`. Credential scopes: `cohorts:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Change a cohort](https://docs.quirelms.com/api/cohorts/updateCohort/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `cohort/manage`. Credential scopes: `cohorts:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a cohort by external identifier](https://docs.quirelms.com/api/cohorts/upsertCohort/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `cohort/manage`. Credential scopes: `cohorts:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one activitycompletion](https://docs.quirelms.com/api/completions/getActivityCompletion/index.md) — ### Quire permissions Required capability: `completion/viewOthers`. Credential scopes: `completions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read an activity completion rule](https://docs.quirelms.com/api/completions/getCompletionRule/index.md) — Returns the activity completion mode, selected conditions, module-supported rules and available condition names. The activity ID is the rule resource ID. ### Quire permissions Required capability: `activity/update`. Credential scopes: `completions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one coursecompletion](https://docs.quirelms.com/api/completions/getCourseCompletion/index.md) — ### Quire permissions Required capability: `completion/viewOthers`. Credential scopes: `completions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List activitycompletions deleted since a point in time](https://docs.quirelms.com/api/completions/listActivityCompletionDeletions/index.md) — Tombstones of deleted activitycompletions, kept for 90 days. ### Quire permissions Required capability: `completion/viewOthers`. Credential scopes: `completions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List activitycompletions](https://docs.quirelms.com/api/completions/listActivityCompletions/index.md) — Activity completion per person. The id is stable for an activity and a person. ### Quire permissions Required capability: `completion/viewOthers`. Credential scopes: `completions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List coursecompletions deleted since a point in time](https://docs.quirelms.com/api/completions/listCourseCompletionDeletions/index.md) — Tombstones of deleted coursecompletions, kept for 90 days. ### Quire permissions Required capability: `completion/viewOthers`. Credential scopes: `completions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List coursecompletions](https://docs.quirelms.com/api/completions/listCourseCompletions/index.md) — Course completion per person. The id is stable for a course and a person. ### Quire permissions Required capability: `completion/viewOthers`. Credential scopes: `completions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Update an activity completion rule](https://docs.quirelms.com/api/completions/updateCompletionRule/index.md) — Replaces the activity completion configuration, validates it against the module, and schedules affected learners for reevaluation. ### Quire permissions Required capability: `activity/update`. Credential scopes: `completions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add an answer to a lesson page](https://docs.quirelms.com/api/courses/addAnswerLessonPage/index.md) — The page answers with its answers, including the new one. ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Approve a glossary entry](https://docs.quirelms.com/api/courses/approveGlossaryEntry/index.md) — ### Quire permissions Required capability: `glossary/approve`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Archive a course](https://docs.quirelms.com/api/courses/archiveCourse/index.md) — ### Quire permissions Required capability: `course/archive`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 activity operations](https://docs.quirelms.com/api/courses/bulkActivities/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `activity/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 category operations](https://docs.quirelms.com/api/courses/bulkCategories/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `category/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 choiceoption operations](https://docs.quirelms.com/api/courses/bulkChoiceOptions/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `choice/manage`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 course operations](https://docs.quirelms.com/api/courses/bulkCourses/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `course/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 databasefield operations](https://docs.quirelms.com/api/courses/bulkDatabaseFields/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `dbmod/manage`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 glossaryentry operations](https://docs.quirelms.com/api/courses/bulkGlossaryEntries/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `glossary/write`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 lessonpage operations](https://docs.quirelms.com/api/courses/bulkLessonPages/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 section operations](https://docs.quirelms.com/api/courses/bulkSections/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `course/update`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 template operations](https://docs.quirelms.com/api/courses/bulkTemplates/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `template/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 wikipage operations](https://docs.quirelms.com/api/courses/bulkWikiPages/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `wiki/edit`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add an activity to a course section](https://docs.quirelms.com/api/courses/createActivity/index.md) — ### Quire permissions Required capability: `activity/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a category](https://docs.quirelms.com/api/courses/createCategory/index.md) — ### Quire permissions Required capability: `category/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add an option to a poll](https://docs.quirelms.com/api/courses/createChoiceOption/index.md) — ### Quire permissions Required capability: `choice/manage`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a course](https://docs.quirelms.com/api/courses/createCourse/index.md) — ### Quire permissions Required capability: `course/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a section to a course](https://docs.quirelms.com/api/courses/createCourseSection/index.md) — ### Quire permissions Required capability: `course/update`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a field to a database](https://docs.quirelms.com/api/courses/createDatabaseField/index.md) — ### Quire permissions Required capability: `dbmod/manage`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add an entry to a glossary](https://docs.quirelms.com/api/courses/createGlossaryEntry/index.md) — ### Quire permissions Required capability: `glossary/write`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a page to a lesson](https://docs.quirelms.com/api/courses/createLessonPage/index.md) — ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a course template](https://docs.quirelms.com/api/courses/createTemplate/index.md) — ### Quire permissions Required capability: `template/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a page to a wiki](https://docs.quirelms.com/api/courses/createWikiPage/index.md) — ### Quire permissions Required capability: `wiki/edit`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete an activity](https://docs.quirelms.com/api/courses/deleteActivity/index.md) — ### Quire permissions Required capability: `activity/delete`. Credential scopes: `courses:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a category and everything in it](https://docs.quirelms.com/api/courses/deleteCategory/index.md) — ### Quire permissions Required capability: `category/manage`. Credential scopes: `courses:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Remove a poll option nobody has chosen](https://docs.quirelms.com/api/courses/deleteChoiceOption/index.md) — ### Quire permissions Required capability: `choice/manage`. Credential scopes: `courses:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Move a course to the recycle bin](https://docs.quirelms.com/api/courses/deleteCourse/index.md) — ### Quire permissions Required capability: `course/update`. Credential scopes: `courses:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a database field and its values](https://docs.quirelms.com/api/courses/deleteDatabaseField/index.md) — ### Quire permissions Required capability: `dbmod/manage`. Credential scopes: `courses:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a glossary entry](https://docs.quirelms.com/api/courses/deleteGlossaryEntry/index.md) — ### Quire permissions Required capability: `glossary/write`. Credential scopes: `courses:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a lesson page and its answers](https://docs.quirelms.com/api/courses/deleteLessonPage/index.md) — ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a section and its activities](https://docs.quirelms.com/api/courses/deleteSection/index.md) — ### Quire permissions Required capability: `course/update`. Credential scopes: `courses:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a course template](https://docs.quirelms.com/api/courses/deleteTemplate/index.md) — ### Quire permissions Required capability: `template/create`. Credential scopes: `courses:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one accessrestriction](https://docs.quirelms.com/api/courses/getAccessRestriction/index.md) — ### Quire permissions Required capability: `activity/update`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one activity](https://docs.quirelms.com/api/courses/getActivity/index.md) — ### Quire permissions Required capability: `activity/view`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one activity by external identifier](https://docs.quirelms.com/api/courses/getActivityByExternalId/index.md) — ### Quire permissions Required capability: `activity/view`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one attendancesession](https://docs.quirelms.com/api/courses/getAttendanceSession/index.md) — ### Quire permissions Required capability: `attendance/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one attendancesession by external identifier](https://docs.quirelms.com/api/courses/getAttendanceSessionByExternalId/index.md) — ### Quire permissions Required capability: `attendance/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one attendancestatus](https://docs.quirelms.com/api/courses/getAttendanceStatus/index.md) — ### Quire permissions Required capability: `attendance/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one attendancestatus by external identifier](https://docs.quirelms.com/api/courses/getAttendanceStatusByExternalId/index.md) — ### Quire permissions Required capability: `attendance/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one category](https://docs.quirelms.com/api/courses/getCategory/index.md) — ### Quire permissions Required capability: `course/view_hidden`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one category by external identifier](https://docs.quirelms.com/api/courses/getCategoryByExternalId/index.md) — ### Quire permissions Required capability: `course/view_hidden`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one checklistitem](https://docs.quirelms.com/api/courses/getChecklistItem/index.md) — ### Quire permissions Required capability: `checklist/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one checklistitem by external identifier](https://docs.quirelms.com/api/courses/getChecklistItemByExternalId/index.md) — ### Quire permissions Required capability: `checklist/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one choiceoption](https://docs.quirelms.com/api/courses/getChoiceOption/index.md) — ### Quire permissions Required capability: `choice/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one choiceoption by external identifier](https://docs.quirelms.com/api/courses/getChoiceOptionByExternalId/index.md) — ### Quire permissions Required capability: `choice/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one course](https://docs.quirelms.com/api/courses/getCourse/index.md) — ### Quire permissions Required capability: `course/view_hidden`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one course by external identifier](https://docs.quirelms.com/api/courses/getCourseByExternalId/index.md) — ### Quire permissions Required capability: `course/view_hidden`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one coursejob](https://docs.quirelms.com/api/courses/getCourseJob/index.md) — ### Quire permissions Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one databasefield](https://docs.quirelms.com/api/courses/getDatabaseField/index.md) — ### Quire permissions Required capability: `dbmod/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one databasefield by external identifier](https://docs.quirelms.com/api/courses/getDatabaseFieldByExternalId/index.md) — ### Quire permissions Required capability: `dbmod/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one facetofacesession](https://docs.quirelms.com/api/courses/getFacetofaceSession/index.md) — ### Quire permissions Required capability: `facetoface/manage_sessions`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one facetofacesession by external identifier](https://docs.quirelms.com/api/courses/getFacetofaceSessionByExternalId/index.md) — ### Quire permissions Required capability: `facetoface/manage_sessions`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one feedbackitem](https://docs.quirelms.com/api/courses/getFeedbackItem/index.md) — ### Quire permissions Required capability: `feedback/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one feedbackitem by external identifier](https://docs.quirelms.com/api/courses/getFeedbackItemByExternalId/index.md) — ### Quire permissions Required capability: `feedback/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one glossaryentry](https://docs.quirelms.com/api/courses/getGlossaryEntry/index.md) — ### Quire permissions Required capability: `glossary/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one glossaryentry by external identifier](https://docs.quirelms.com/api/courses/getGlossaryEntryByExternalId/index.md) — ### Quire permissions Required capability: `glossary/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one job](https://docs.quirelms.com/api/courses/getJob/index.md) — ### Quire permissions Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one lessonpage](https://docs.quirelms.com/api/courses/getLessonPage/index.md) — ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one lessonpage by external identifier](https://docs.quirelms.com/api/courses/getLessonPageByExternalId/index.md) — ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one livesessionmeeting](https://docs.quirelms.com/api/courses/getLivesessionMeeting/index.md) — ### Quire permissions Required capability: `livesession/manage_meetings`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one livesessionmeeting by external identifier](https://docs.quirelms.com/api/courses/getLivesessionMeetingByExternalId/index.md) — ### Quire permissions Required capability: `livesession/manage_meetings`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one livesessionrecording](https://docs.quirelms.com/api/courses/getLivesessionRecording/index.md) — ### Quire permissions Required capability: `livesession/manage_recordings`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one livesessionrecording by external identifier](https://docs.quirelms.com/api/courses/getLivesessionRecordingByExternalId/index.md) — ### Quire permissions Required capability: `livesession/manage_recordings`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one section](https://docs.quirelms.com/api/courses/getSection/index.md) — ### Quire permissions Required capability: `course/view_hidden`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one section by external identifier](https://docs.quirelms.com/api/courses/getSectionByExternalId/index.md) — ### Quire permissions Required capability: `course/view_hidden`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one template](https://docs.quirelms.com/api/courses/getTemplate/index.md) — ### Quire permissions Required capability: `template/create`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one template by external identifier](https://docs.quirelms.com/api/courses/getTemplateByExternalId/index.md) — ### Quire permissions Required capability: `template/create`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one templateversion](https://docs.quirelms.com/api/courses/getTemplateVersion/index.md) — ### Quire permissions Required capability: `template/create`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one wikipage](https://docs.quirelms.com/api/courses/getWikiPage/index.md) — ### Quire permissions Required capability: `wiki/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one wikipage by external identifier](https://docs.quirelms.com/api/courses/getWikiPageByExternalId/index.md) — ### Quire permissions Required capability: `wiki/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one wikipageversion](https://docs.quirelms.com/api/courses/getWikiPageVersion/index.md) — ### Quire permissions Required capability: `wiki/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one workshopdimension](https://docs.quirelms.com/api/courses/getWorkshopDimension/index.md) — ### Quire permissions Required capability: `workshop/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one workshopdimension by external identifier](https://docs.quirelms.com/api/courses/getWorkshopDimensionByExternalId/index.md) — ### Quire permissions Required capability: `workshop/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Hide a live course from learners](https://docs.quirelms.com/api/courses/hideCourse/index.md) — ### Quire permissions Required capability: `course/update`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [List accessrestrictions deleted since a point in time](https://docs.quirelms.com/api/courses/listAccessRestrictionDeletions/index.md) — Tombstones of deleted accessrestrictions, kept for 90 days. ### Quire permissions Required capability: `activity/update`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List activities](https://docs.quirelms.com/api/courses/listActivities/index.md) — Every activity of every module: filter by module_type for one kind, for example assignment or quiz, and by course_id for one course. The module-specific settings live on the activity and are returned in display. ### Quire permissions Required capability: `activity/view`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List activities deleted since a point in time](https://docs.quirelms.com/api/courses/listActivityDeletions/index.md) — Tombstones of deleted activities, kept for 90 days. ### Quire permissions Required capability: `activity/view`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List attendancesessions](https://docs.quirelms.com/api/courses/listAttendanceSessions/index.md) — The sessions of an attendance activity with their time, group and self-marking rules. The self-marking password is never served; has_self_mark_password says whether one is set. Requires attendance/manage on the activity; filter by activity_id or course_id. Hard deletions have no feed. ### Quire permissions Required capability: `attendance/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List attendancestatuses](https://docs.quirelms.com/api/courses/listAttendanceStatuses/index.md) — The statuses a session can be marked with, in order: acronym, description and the points each is worth. Requires attendance/manage on the activity; filter by activity_id or course_id. Hard deletions have no feed. ### Quire permissions Required capability: `attendance/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List categories](https://docs.quirelms.com/api/courses/listCategories/index.md) — The course category tree. `path` lists the ancestors from the root, so a client can rebuild the tree from one walk. ### Quire permissions Required capability: `course/view_hidden`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List categories deleted since a point in time](https://docs.quirelms.com/api/courses/listCategoryDeletions/index.md) — Tombstones of deleted categories, kept for 90 days. ### Quire permissions Required capability: `course/view_hidden`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List checklistitems](https://docs.quirelms.com/api/courses/listChecklistItems/index.md) — The items the teacher put on a checklist, in order, with indent, due date, whether each is required and the activity it is linked to. Items a learner added to their own list are not served. Requires checklist/manage on the activity; filter by activity_id or course_id. Hard deletions have no feed. ### Quire permissions Required capability: `checklist/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List choiceoptions](https://docs.quirelms.com/api/courses/listChoiceOptions/index.md) — The options of a choice activity, in order, with their answer limit and how many have been taken. Requires choice/manage on the activity; filter by activity_id or course_id. Hard deletions have no feed. Writes save the poll's whole option list the way its editor does: an option somebody has chosen cannot be removed. ### Quire permissions Required capability: `choice/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List accessrestrictions](https://docs.quirelms.com/api/courses/listCourseAccessRestrictions/index.md) — Restriction settings for course sections and activities. A null rule means the target has no access restriction; deleted targets remain marked with target_deleted_at. ### Quire permissions Required capability: `activity/update`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read messages in a course tutor transcript](https://docs.quirelms.com/api/courses/listCourseAiTutorTranscriptMessages/index.md) — Returns one cursor-paged message page for a transcript in this course. Each request requires the course-scoped ai/tutor_transcript_view capability and is recorded by the audited transcript-read service. ### Quire permissions Required capability: `ai/tutor_transcript_view`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List tutor transcripts in a course](https://docs.quirelms.com/api/courses/listCourseAiTutorTranscripts/index.md) — Returns transcript metadata for conversations in this course. The calling person needs the course-scoped ai/tutor_transcript_view capability; listing does not read or audit transcript messages. ### Quire permissions Required capability: `ai/tutor_transcript_view`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List courses deleted since a point in time](https://docs.quirelms.com/api/courses/listCourseDeletions/index.md) — Tombstones of deleted courses, kept for 90 days. ### Quire permissions Required capability: `course/view_hidden`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List coursejobs deleted since a point in time](https://docs.quirelms.com/api/courses/listCourseJobDeletions/index.md) — Tombstones of deleted coursejobs, kept for 90 days. ### Quire permissions Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List coursejobs](https://docs.quirelms.com/api/courses/listCourseJobs/index.md) — Progress for course work requested by the calling person. Source files, options, results, reports, and failure details are not served. ### Quire permissions Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List packages](https://docs.quirelms.com/api/courses/listCoursePackages/index.md) — One row per package version referenced by a visible SCORM or IMSCP activity in this course; activity_id identifies the first visible reference. Processing state and aggregate size are shown, while file versions, manifests, same-origin acknowledgements, launch secrets, storage addresses, and hashes are omitted. ### Quire permissions Required capability: `activity/view`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List sections](https://docs.quirelms.com/api/courses/listCourseSections/index.md) — The sections of a course in display order. Read at the course, which is where the capability is checked. ### Quire permissions Required capability: `course/view_hidden`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List courses](https://docs.quirelms.com/api/courses/listCourses/index.md) — Courses, in every state. A course in the recycle bin has deleted_at set and is listed only with include_deleted=true. Moving a course between draft, live, hidden and archived is an action, because each move has its own capability and its own checks. ### Quire permissions Required capability: `course/view_hidden`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List databasefields](https://docs.quirelms.com/api/courses/listDatabaseFields/index.md) — The fields of a database activity, in order, with their type and configuration. Requires dbmod/manage on the activity; filter by activity_id or course_id. Hard deletions have no feed. Writes save the database's whole field list the way its editor does, so the other fields keep their identifiers; deleting a field deletes its values from every record. ### Quire permissions Required capability: `dbmod/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List facetofacesessions](https://docs.quirelms.com/api/courses/listFacetofaceSessions/index.md) — The sessions of a face to face activity with their capacity, bookings, state, trainers and time slots (each slot names its room). Requires facetoface/manage_sessions on the activity; filter by activity_id, course_id or state. Hard deletions have no feed. ### Quire permissions Required capability: `facetoface/manage_sessions`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List feedbackitems](https://docs.quirelms.com/api/courses/listFeedbackItems/index.md) — The questions and layout items of a feedback or survey activity, in order, with their configuration and conditions. Requires feedback/manage on the activity; filter by activity_id or course_id. Hard deletions have no feed. ### Quire permissions Required capability: `feedback/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List glossaryentries](https://docs.quirelms.com/api/courses/listGlossaryEntries/index.md) — Glossary entries with their aliases and the categories they are filed under, including entries still waiting for approval (approved is false). Requires glossary/manage on the activity; filter by activity_id or course_id. Hard deletions have no feed. ### Quire permissions Required capability: `glossary/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List jobs](https://docs.quirelms.com/api/courses/listJobs/index.md) — Cursor-paged status for the calling person’s course, resource, question-import, assignment and grade-import jobs. Job inputs, outputs, payloads, reports and errors are omitted. The underlying stores do not provide a shared deletion feed. Platform queue operations use the separately guarded platform API. ### Quire permissions Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List lessonpages](https://docs.quirelms.com/api/courses/listLessonPages/index.md) — The pages of a lesson with their answers, scores and jumps. Answers carry the score that marks them right, so this is an author's view: it requires lesson/manage_pages on the activity, and filter by activity_id or course_id. Hard deletions have no feed. ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List livesessionmeetings](https://docs.quirelms.com/api/courses/listLivesessionMeetings/index.md) — The meetings of a live session activity with their time, state and how their attendance was collected. The provider's meeting reference and the guest link are never served. Requires livesession/manage_meetings on the activity; filter by activity_id, course_id or state. Hard deletions have no feed. ### Quire permissions Required capability: `livesession/manage_meetings`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List livesessionrecordings](https://docs.quirelms.com/api/courses/listLivesessionRecordings/index.md) — The recordings of a live session activity with their state, duration, who may watch them (visibility) and how long they stay available. Every recording is listed whatever its visibility, so this is a manager's view: it requires livesession/manage_recordings on the activity. The provider's reference is not served. Filter by activity_id, course_id, meeting_id or state. Hard deletions have no feed. ### Quire permissions Required capability: `livesession/manage_recordings`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List sections deleted since a point in time](https://docs.quirelms.com/api/courses/listSectionDeletions/index.md) — Tombstones of deleted sections, kept for 90 days. ### Quire permissions Required capability: `course/view_hidden`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List templates deleted since a point in time](https://docs.quirelms.com/api/courses/listTemplateDeletions/index.md) — Tombstones of deleted templates, kept for 90 days. ### Quire permissions Required capability: `template/create`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List templateversions](https://docs.quirelms.com/api/courses/listTemplateTemplateVersions/index.md) — Published, immutable template versions. Archive keys and hashes are private storage metadata. ### Quire permissions Required capability: `template/create`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List templates](https://docs.quirelms.com/api/courses/listTemplates/index.md) — Named course templates. Publishing from a course queues an immutable version; the version appears after the backup job completes. ### Quire permissions Required capability: `template/create`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List wikipageversions](https://docs.quirelms.com/api/courses/listWikiPageVersions/index.md) — The saved history of each wiki page, one row per version, insert-only. The id is derived from the page and the version. Requires wiki/manage on the activity; filter by activity_id, course_id or page_id. ### Quire permissions Required capability: `wiki/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List wikipages](https://docs.quirelms.com/api/courses/listWikiPages/index.md) — Wiki pages with their current body. A collaborative wiki has one subwiki; an individual wiki has one per person or group, named by subwiki_user_id and subwiki_group_id. The collaborative editing state and edit locks are not served. Requires wiki/manage on the activity; filter by activity_id or course_id. Hard deletions have no feed. Writes: a page is saved as the credential's person in their own space, so a collaborative wiki is shared and an individual wiki gets one space per person; there is no delete, because the wiki keeps every version. ### Quire permissions Required capability: `wiki/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [List workshopdimensions](https://docs.quirelms.com/api/courses/listWorkshopDimensions/index.md) — The assessment dimensions of a workshop, in order: the aspects a reviewer grades. Requires workshop/manage on the activity; filter by activity_id or course_id. Hard deletions have no feed. ### Quire permissions Required capability: `workshop/manage`. Credential scopes: `courses:read`. The acting subject must also be allowed to perform this action in the organisation. - [Move a lesson page to follow another, or to the start](https://docs.quirelms.com/api/courses/moveLessonPage/index.md) — ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Publish a course](https://docs.quirelms.com/api/courses/publishCourse/index.md) — Runs the publish check; send accept_warnings true to publish past warnings. A blocking issue always refuses. ### Quire permissions Required capability: `course/publish`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Publish an immutable template version from a course](https://docs.quirelms.com/api/courses/publishTemplate/index.md) — Queues a backup job. A new version appears after the job succeeds. ### Quire permissions Required capability: `template/publish`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Remove an answer from a lesson page](https://docs.quirelms.com/api/courses/removeAnswerLessonPage/index.md) — ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Reopen an archived or hidden course](https://docs.quirelms.com/api/courses/reopenCourse/index.md) — ### Quire permissions Required capability: `course/publish`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Restore an earlier version of a wiki page as a new version](https://docs.quirelms.com/api/courses/restoreWikiPage/index.md) — ### Quire permissions Required capability: `wiki/revert`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Make a lesson page the page learners start on](https://docs.quirelms.com/api/courses/setStartLessonPage/index.md) — ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Send an approved glossary entry back to waiting for approval](https://docs.quirelms.com/api/courses/unapproveGlossaryEntry/index.md) — ### Quire permissions Required capability: `glossary/approve`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change an activity's name, visibility, group mode or module settings](https://docs.quirelms.com/api/courses/updateActivity/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `activity/update`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change an answer on a lesson page](https://docs.quirelms.com/api/courses/updateAnswerLessonPage/index.md) — ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Rename a category, or show or hide it](https://docs.quirelms.com/api/courses/updateCategory/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `category/manage`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a poll option's text or answer limit](https://docs.quirelms.com/api/courses/updateChoiceOption/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `choice/manage`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a database field](https://docs.quirelms.com/api/courses/updateDatabaseField/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `dbmod/manage`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a glossary entry: its concept, definition, aliases, categories or linking](https://docs.quirelms.com/api/courses/updateGlossaryEntry/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `glossary/write`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a lesson page's title, body, time limit or annotations](https://docs.quirelms.com/api/courses/updateLessonPage/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Rename a section, or show or hide it](https://docs.quirelms.com/api/courses/updateSection/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `course/update`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Edit a course template](https://docs.quirelms.com/api/courses/updateTemplate/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `template/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Save a new version of a wiki page, or rename it](https://docs.quirelms.com/api/courses/updateWikiPage/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `wiki/edit`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update an activity by external identifier](https://docs.quirelms.com/api/courses/upsertActivity/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `activity/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a category by external identifier](https://docs.quirelms.com/api/courses/upsertCategory/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `category/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a poll option by external identifier](https://docs.quirelms.com/api/courses/upsertChoiceOption/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `choice/manage`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a course by external identifier, or return the one that has it](https://docs.quirelms.com/api/courses/upsertCourse/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `course/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a database field by external identifier](https://docs.quirelms.com/api/courses/upsertDatabaseField/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `dbmod/manage`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a glossary entry by external identifier](https://docs.quirelms.com/api/courses/upsertGlossaryEntry/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `glossary/write`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a lesson page by external identifier](https://docs.quirelms.com/api/courses/upsertLessonPage/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `lesson/manage_pages`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a section by external identifier](https://docs.quirelms.com/api/courses/upsertSection/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `course/update`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or reconcile a course template by external identifier](https://docs.quirelms.com/api/courses/upsertTemplate/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `template/create`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or save a wiki page by external identifier](https://docs.quirelms.com/api/courses/upsertWikiPage/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `wiki/edit`. Credential scopes: `courses:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a platform global email suppression](https://docs.quirelms.com/api/email/addPlatformEmailSuppression/index.md) — ### Quire permissions Required capability: `platform/global_suppression_manage`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 emailmessage operations](https://docs.quirelms.com/api/email/bulkEmailMessages/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `email/campaign_manage`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Send a templated email to a person](https://docs.quirelms.com/api/email/createEmailMessage/index.md) — ### Quire permissions Required capability: `email/campaign_manage`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Discard an email template draft](https://docs.quirelms.com/api/email/discardEmailTemplateDraft/index.md) — Discards the draft of one message's template at one scope and language. The published version, if any, is unchanged. Requires an idempotency key. ### Quire permissions Required capability: `email_template/edit`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Discard a platform email template draft](https://docs.quirelms.com/api/email/discardPlatformEmailTemplateDraft/index.md) — ### Quire permissions Required capability: `platform/email_templates_edit`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one emailevent](https://docs.quirelms.com/api/email/getEmailEvent/index.md) — ### Quire permissions Required capability: `email/view_log`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one emailmessage](https://docs.quirelms.com/api/email/getEmailMessage/index.md) — ### Quire permissions Required capability: `email/view_log`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one emailmessage by external identifier](https://docs.quirelms.com/api/email/getEmailMessageByExternalId/index.md) — ### Quire permissions Required capability: `email/view_log`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one emailsuppression](https://docs.quirelms.com/api/email/getEmailSuppression/index.md) — ### Quire permissions Required capability: `email/configure`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one emailtemplate](https://docs.quirelms.com/api/email/getEmailTemplate/index.md) — ### Quire permissions Required capability: `email/configure`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one emailtemplate by external identifier](https://docs.quirelms.com/api/email/getEmailTemplateByExternalId/index.md) — ### Quire permissions Required capability: `email/configure`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one senderdomain](https://docs.quirelms.com/api/email/getSenderDomain/index.md) — ### Quire permissions Required capability: `email/configure`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [List emailevents deleted since a point in time](https://docs.quirelms.com/api/email/listEmailEventDeletions/index.md) — Tombstones of deleted emailevents, kept for 90 days. ### Quire permissions Required capability: `email/view_log`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [List emailevents](https://docs.quirelms.com/api/email/listEmailEvents/index.md) — Append-only email delivery events. Only event time, state, and source are served; message linkage, provider identifiers, and event details remain private. ### Quire permissions Required capability: `email/view_log`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [List emailmessages deleted since a point in time](https://docs.quirelms.com/api/email/listEmailMessageDeletions/index.md) — Tombstones of deleted emailmessages, kept for 90 days. ### Quire permissions Required capability: `email/view_log`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [List emailmessages](https://docs.quirelms.com/api/email/listEmailMessages/index.md) — Every email sent or queued, with its delivery state. The body is not served: it held personal data for one recipient. Creating one sends a templated email to one person through the email platform; a suppressed recipient is recorded with state suppressed rather than refused. ### Quire permissions Required capability: `email/view_log`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [List emailsuppressions deleted since a point in time](https://docs.quirelms.com/api/email/listEmailSuppressionDeletions/index.md) — Tombstones of deleted emailsuppressions, kept for 90 days. ### Quire permissions Required capability: `email/configure`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [List emailsuppressions](https://docs.quirelms.com/api/email/listEmailSuppressions/index.md) — Active tenant email suppression records. Platform-wide suppression entries, message linkage, and actor identities are not served. ### Quire permissions Required capability: `email/configure`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [List emailtemplates deleted since a point in time](https://docs.quirelms.com/api/email/listEmailTemplateDeletions/index.md) — Tombstones of deleted emailtemplates, kept for 90 days. ### Quire permissions Required capability: `email/configure`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read an email template's draft, published version and history](https://docs.quirelms.com/api/email/listEmailTemplateVersions/index.md) — Returns the draft, the published version and every version of one message's template at one scope and language. A message with no override at that scope answers with no versions and inherits its wording. ### Quire permissions Required capability: `email_template/edit`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [List emailtemplates](https://docs.quirelms.com/api/email/listEmailTemplates/index.md) — Email template overrides per message, scope and language. The published content is versioned. ### Quire permissions Required capability: `email/configure`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [List platform global email suppressions](https://docs.quirelms.com/api/email/listPlatformEmailSuppressions/index.md) — Lists global email blocks without provider details or tenant suppression records. ### Quire permissions Required capability: `platform/global_suppression_manage`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [List platform email templates](https://docs.quirelms.com/api/email/listPlatformEmailTemplates/index.md) — ### Quire permissions Required capability: `platform/email_templates_view`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [List senderdomains deleted since a point in time](https://docs.quirelms.com/api/email/listSenderDomainDeletions/index.md) — Tombstones of deleted senderdomains, kept for 90 days. ### Quire permissions Required capability: `email/configure`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [List senderdomains](https://docs.quirelms.com/api/email/listSenderDomains/index.md) — Email sender domains and verification state. Provider identifiers, DNS record values, preflight details, and provider failure text are not served. ### Quire permissions Required capability: `email/configure`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [Preview a platform email template](https://docs.quirelms.com/api/email/previewPlatformEmailTemplate/index.md) — ### Quire permissions Required capability: `platform/email_templates_view`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [Publish an email template draft](https://docs.quirelms.com/api/email/publishEmailTemplate/index.md) — Runs the publish checks on the draft and publishes it. Blocking findings refuse the publish; warnings are returned with the published version. Requires an idempotency key. ### Quire permissions Required capability: `email_template/edit`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Publish a platform email template draft](https://docs.quirelms.com/api/email/publishPlatformEmailTemplate/index.md) — ### Quire permissions Required capability: `platform/email_templates_publish`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read platform email deliverability](https://docs.quirelms.com/api/email/readPlatformDeliverability/index.md) — Returns per-tenant 30-day delivery counts and aggregate suppression counts. Email addresses, message content and provider responses are omitted. ### Quire permissions Required capability: `platform/email_view`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read a platform global email suppression](https://docs.quirelms.com/api/email/readPlatformEmailSuppression/index.md) — ### Quire permissions Required capability: `platform/global_suppression_manage`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read a platform email template language and versions](https://docs.quirelms.com/api/email/readPlatformEmailTemplate/index.md) — ### Quire permissions Required capability: `platform/email_templates_view`. Credential scopes: `email:read`. The acting subject must also be allowed to perform this action in the organisation. - [Remove a platform global email suppression](https://docs.quirelms.com/api/email/removePlatformEmailSuppression/index.md) — ### Quire permissions Required capability: `platform/global_suppression_manage`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Restore an email template version as the draft](https://docs.quirelms.com/api/email/restoreEmailTemplateVersion/index.md) — Copies an earlier version into the draft. Publish the draft to use it. Requires an idempotency key. ### Quire permissions Required capability: `email_template/edit`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Restore a platform email template version as a draft](https://docs.quirelms.com/api/email/restorePlatformEmailTemplateVersion/index.md) — ### Quire permissions Required capability: `platform/email_templates_edit`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Save an email template draft](https://docs.quirelms.com/api/email/saveEmailTemplateDraft/index.md) — Creates or replaces the draft of one message's template at one scope and language. Publishing is a separate action. Requires an idempotency key. ### Quire permissions Required capability: `email_template/edit`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Save a platform email template draft](https://docs.quirelms.com/api/email/savePlatformEmailTemplateDraft/index.md) — ### Quire permissions Required capability: `platform/email_templates_edit`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Send a template test to the operator's verified email](https://docs.quirelms.com/api/email/testSendPlatformEmailTemplate/index.md) — ### Quire permissions Required capability: `platform/email_templates_test`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Unpublish an email template](https://docs.quirelms.com/api/email/unpublishEmailTemplate/index.md) — Stops using the published override at this scope and language, so the message inherits its wording again. Requires an idempotency key. ### Quire permissions Required capability: `email_template/edit`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Unpublish a platform email template](https://docs.quirelms.com/api/email/unpublishPlatformEmailTemplate/index.md) — ### Quire permissions Required capability: `platform/email_templates_publish`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Send a templated email once under an external identifier](https://docs.quirelms.com/api/email/upsertEmailMessage/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `email/campaign_manage`. Credential scopes: `email:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 enrolmentmethod operations](https://docs.quirelms.com/api/enrolments/bulkEnrolmentMethods/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `enrol/configure_method`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 enrolment operations](https://docs.quirelms.com/api/enrolments/bulkEnrolments/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `enrol/manage`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add an enrolment method to a course](https://docs.quirelms.com/api/enrolments/createCourseEnrolmentMethod/index.md) — ### Quire permissions Required capability: `enrol/configure_method`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Enrol a person in a course](https://docs.quirelms.com/api/enrolments/createEnrolment/index.md) — ### Quire permissions Required capability: `enrol/manage`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Unenrol](https://docs.quirelms.com/api/enrolments/deleteEnrolment/index.md) — ### Quire permissions Required capability: `enrol/manage`. Credential scopes: `enrolments:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete an enrolment method](https://docs.quirelms.com/api/enrolments/deleteEnrolmentMethod/index.md) — ### Quire permissions Required capability: `enrol/configure_method`. Credential scopes: `enrolments:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Switch an enrolment method off](https://docs.quirelms.com/api/enrolments/disableEnrolmentMethod/index.md) — Existing enrolments stay; no new ones are made through the method. Guest access also ends for the people it admitted. ### Quire permissions Required capability: `enrol/configure_method`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Switch an enrolment method on](https://docs.quirelms.com/api/enrolments/enableEnrolmentMethod/index.md) — New enrolments through the method are accepted again. ### Quire permissions Required capability: `enrol/configure_method`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one enrolment](https://docs.quirelms.com/api/enrolments/getEnrolment/index.md) — ### Quire permissions Required capability: `enrol/view_participants`. Credential scopes: `enrolments:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one enrolment by external identifier](https://docs.quirelms.com/api/enrolments/getEnrolmentByExternalId/index.md) — ### Quire permissions Required capability: `enrol/view_participants`. Credential scopes: `enrolments:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one enrolmentmethod](https://docs.quirelms.com/api/enrolments/getEnrolmentMethod/index.md) — ### Quire permissions Required capability: `enrol/configure_method`. Credential scopes: `enrolments:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one enrolmentmethod by external identifier](https://docs.quirelms.com/api/enrolments/getEnrolmentMethodByExternalId/index.md) — ### Quire permissions Required capability: `enrol/configure_method`. Credential scopes: `enrolments:read`. The acting subject must also be allowed to perform this action in the organisation. - [List enrolmentmethods](https://docs.quirelms.com/api/enrolments/listCourseEnrolmentMethods/index.md) — The enrolment methods configured on a course: manual, self, cohort sync, meta link and the rest. ### Quire permissions Required capability: `enrol/configure_method`. Credential scopes: `enrolments:read`. The acting subject must also be allowed to perform this action in the organisation. - [List enrolments deleted since a point in time](https://docs.quirelms.com/api/enrolments/listEnrolmentDeletions/index.md) — Tombstones of deleted enrolments, kept for 90 days. ### Quire permissions Required capability: `enrol/view_participants`. Credential scopes: `enrolments:read`. The acting subject must also be allowed to perform this action in the organisation. - [List enrolmentmethods deleted since a point in time](https://docs.quirelms.com/api/enrolments/listEnrolmentMethodDeletions/index.md) — Tombstones of deleted enrolmentmethods, kept for 90 days. ### Quire permissions Required capability: `enrol/configure_method`. Credential scopes: `enrolments:read`. The acting subject must also be allowed to perform this action in the organisation. - [List enrolments](https://docs.quirelms.com/api/enrolments/listEnrolments/index.md) — Who is enrolled in which course, through which method, and whether the enrolment is active. ### Quire permissions Required capability: `enrol/view_participants`. Credential scopes: `enrolments:read`. The acting subject must also be allowed to perform this action in the organisation. - [Reactivate a suspended enrolment](https://docs.quirelms.com/api/enrolments/reactivateEnrolment/index.md) — ### Quire permissions Required capability: `enrol/manage`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Suspend an enrolment](https://docs.quirelms.com/api/enrolments/suspendEnrolment/index.md) — The person keeps their work and loses access until the enrolment is reactivated. ### Quire permissions Required capability: `enrol/manage`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Synchronise a source-following method now](https://docs.quirelms.com/api/enrolments/syncEnrolmentMethod/index.md) — Cohort, course meta link and category methods enrol and remove people to match their source. ### Quire permissions Required capability: `enrol/configure_method`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change when an enrolment starts and ends](https://docs.quirelms.com/api/enrolments/updateEnrolment/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `enrol/manage`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change an enrolment method](https://docs.quirelms.com/api/enrolments/updateEnrolmentMethod/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `enrol/configure_method`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or reconcile an enrolment by external identifier](https://docs.quirelms.com/api/enrolments/upsertEnrolment/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `enrol/manage`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update an enrolment method by external identifier](https://docs.quirelms.com/api/enrolments/upsertEnrolmentMethod/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `enrol/configure_method`. Credential scopes: `enrolments:write`. The acting subject must also be allowed to perform this action in the organisation. - [Make a storage target the default](https://docs.quirelms.com/api/files/activateStorageTarget/index.md) — Switches new files to this checked target and can enqueue moving existing files. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `files:write`. The acting subject must also be allowed to perform this action in the organisation. - [Check a storage target](https://docs.quirelms.com/api/files/checkStorageTarget/index.md) — Probes the target and applies the tenant's data-region policy before it can be activated. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `files:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a tenant storage target](https://docs.quirelms.com/api/files/createStorageTarget/index.md) — Stores and seals a tenant's bucket credentials. The response omits the endpoint, bucket name, prefix, and credentials; the target must pass a check before activation. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `files:write`. The acting subject must also be allowed to perform this action in the organisation. - [Remove a storage target](https://docs.quirelms.com/api/files/deleteStorageTarget/index.md) — Removes an inactive target only when it holds no files. Active or in-use targets are refused. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `files:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one file](https://docs.quirelms.com/api/files/getFile/index.md) — ### Quire permissions Credential scopes: `files:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one file by external identifier](https://docs.quirelms.com/api/files/getFileByExternalId/index.md) — ### Quire permissions Credential scopes: `files:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one fileversion](https://docs.quirelms.com/api/files/getFileVersion/index.md) — ### Quire permissions Credential scopes: `files:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one storagetarget](https://docs.quirelms.com/api/files/getStorageTarget/index.md) — ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `files:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one videoasset](https://docs.quirelms.com/api/files/getVideoAsset/index.md) — ### Quire permissions Required capability: `activity/view`. Credential scopes: `files:read`. The acting subject must also be allowed to perform this action in the organisation. - [List videoassets](https://docs.quirelms.com/api/files/listCourseVideoAssets/index.md) — Video processing status for files owned by this course. Provider asset identifiers, source versions, and provider error details are not served. ### Quire permissions Required capability: `activity/view`. Credential scopes: `files:read`. The acting subject must also be allowed to perform this action in the organisation. - [List files deleted since a point in time](https://docs.quirelms.com/api/files/listFileDeletions/index.md) — Tombstones of deleted files, kept for 90 days. ### Quire permissions Credential scopes: `files:read`. The acting subject must also be allowed to perform this action in the organisation. - [List file versions](https://docs.quirelms.com/api/files/listFileVersions/index.md) — Metadata for versions of a file uploaded by the calling person. File content is read through the file download surface. ### Quire permissions Credential scopes: `files:read`. The acting subject must also be allowed to perform this action in the organisation. - [List files](https://docs.quirelms.com/api/files/listFiles/index.md) — Files the calling person uploaded. The content itself is downloaded from /api/files/{id} with the same access checks as the product. ### Quire permissions Credential scopes: `files:read`. The acting subject must also be allowed to perform this action in the organisation. - [List storage targets deleted since a point in time](https://docs.quirelms.com/api/files/listStorageTargetDeletions/index.md) — Tombstones of deleted storage targets, kept for 90 days. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `files:read`. The acting subject must also be allowed to perform this action in the organisation. - [List storage targets](https://docs.quirelms.com/api/files/listStorageTargets/index.md) — Tenant storage target status and region metadata. Endpoints, bucket names, prefixes, credentials, key references, validation errors, and move diagnostics are omitted. Updated-since and hard-deletion feeds support synchronization. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `files:read`. The acting subject must also be allowed to perform this action in the organisation. - [List videoassets deleted since a point in time](https://docs.quirelms.com/api/files/listVideoAssetDeletions/index.md) — Tombstones of deleted videoassets, kept for 90 days. ### Quire permissions Required capability: `activity/view`. Credential scopes: `files:read`. The acting subject must also be allowed to perform this action in the organisation. - [Use deployment storage for new files](https://docs.quirelms.com/api/files/restoreDeploymentStorage/index.md) — Makes the deployment's storage the default for new files. Existing files remain on their recorded targets. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `files:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one forumdiscussion](https://docs.quirelms.com/api/forums/getForumDiscussion/index.md) — ### Quire permissions Required capability: `comment/moderate`. Credential scopes: `forums:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one forumdiscussion by external identifier](https://docs.quirelms.com/api/forums/getForumDiscussionByExternalId/index.md) — ### Quire permissions Required capability: `comment/moderate`. Credential scopes: `forums:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one forumpost](https://docs.quirelms.com/api/forums/getForumPost/index.md) — ### Quire permissions Required capability: `comment/moderate`. Credential scopes: `forums:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one forumpost by external identifier](https://docs.quirelms.com/api/forums/getForumPostByExternalId/index.md) — ### Quire permissions Required capability: `comment/moderate`. Credential scopes: `forums:read`. The acting subject must also be allowed to perform this action in the organisation. - [List forumdiscussions deleted since a point in time](https://docs.quirelms.com/api/forums/listForumDiscussionDeletions/index.md) — Tombstones of deleted forumdiscussions, kept for 90 days. ### Quire permissions Required capability: `comment/moderate`. Credential scopes: `forums:read`. The acting subject must also be allowed to perform this action in the organisation. - [List forumdiscussions](https://docs.quirelms.com/api/forums/listForumDiscussions/index.md) — Forum discussions. ### Quire permissions Required capability: `comment/moderate`. Credential scopes: `forums:read`. The acting subject must also be allowed to perform this action in the organisation. - [List forumposts deleted since a point in time](https://docs.quirelms.com/api/forums/listForumPostDeletions/index.md) — Tombstones of deleted forumposts, kept for 90 days. ### Quire permissions Required capability: `comment/moderate`. Credential scopes: `forums:read`. The acting subject must also be allowed to perform this action in the organisation. - [List forumposts](https://docs.quirelms.com/api/forums/listForumPosts/index.md) — Forum posts. Private replies are never served here: they are between their author and one recipient. ### Quire permissions Required capability: `comment/moderate`. Credential scopes: `forums:read`. The acting subject must also be allowed to perform this action in the organisation. - [Mark a gradebook column with this rubric or marking guide](https://docs.quirelms.com/api/grades/attachRubric/index.md) — An assignment's column is chosen by the assignment's own settings and is refused here. ### Quire permissions Required capability: `grade/managegradingforms`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 gradeitem operations](https://docs.quirelms.com/api/grades/bulkGradeItems/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 grade operations](https://docs.quirelms.com/api/grades/bulkGrades/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `grade/edit`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 outcome operations](https://docs.quirelms.com/api/grades/bulkOutcomes/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 rubric operations](https://docs.quirelms.com/api/grades/bulkRubrics/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `grade/managegradingforms`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 scale operations](https://docs.quirelms.com/api/grades/bulkScales/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Clear an overridden grade](https://docs.quirelms.com/api/grades/clearOverrideGrade/index.md) — The cell goes back to the mark the activity or the formula produced. ### Quire permissions Required capability: `grade/override`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Copy a rubric or marking guide into a course, or into the shared templates](https://docs.quirelms.com/api/grades/copyRubric/index.md) — The copy has its own criteria, records its source, and is made ready for marking. It is how a form that has already marked work is changed. ### Quire permissions Required capability: `grade/managegradingforms`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a manual or calculated column to a course gradebook](https://docs.quirelms.com/api/grades/createCourseGradeItem/index.md) — ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a rubric or marking guide in a course, ready for marking](https://docs.quirelms.com/api/grades/createCourseRubric/index.md) — ### Quire permissions Required capability: `grade/managegradingforms`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Set a grade](https://docs.quirelms.com/api/grades/createGrade/index.md) — ### Quire permissions Required capability: `grade/edit`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a learning outcome](https://docs.quirelms.com/api/grades/createOutcome/index.md) — ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a grading scale](https://docs.quirelms.com/api/grades/createScale/index.md) — ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a gradebook column](https://docs.quirelms.com/api/grades/deleteGradeItem/index.md) — ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete an outcome that no column reports](https://docs.quirelms.com/api/grades/deleteOutcome/index.md) — ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a rubric or marking guide that no column uses](https://docs.quirelms.com/api/grades/deleteRubric/index.md) — ### Quire permissions Required capability: `grade/managegradingforms`. Credential scopes: `grades:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a scale that nothing uses](https://docs.quirelms.com/api/grades/deleteScale/index.md) — ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Stop marking a gradebook column with this rubric or marking guide](https://docs.quirelms.com/api/grades/detachRubric/index.md) — ### Quire permissions Required capability: `grade/managegradingforms`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one grade](https://docs.quirelms.com/api/grades/getGrade/index.md) — ### Quire permissions Required capability: `grade/viewhidden`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one grade by external identifier](https://docs.quirelms.com/api/grades/getGradeByExternalId/index.md) — ### Quire permissions Required capability: `grade/viewhidden`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one gradeitem](https://docs.quirelms.com/api/grades/getGradeItem/index.md) — ### Quire permissions Required capability: `grade/view`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one gradeitem by external identifier](https://docs.quirelms.com/api/grades/getGradeItemByExternalId/index.md) — ### Quire permissions Required capability: `grade/view`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one outcome](https://docs.quirelms.com/api/grades/getOutcome/index.md) — ### Quire permissions Required capability: `grade/view`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one outcome by external identifier](https://docs.quirelms.com/api/grades/getOutcomeByExternalId/index.md) — ### Quire permissions Required capability: `grade/view`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one rubric](https://docs.quirelms.com/api/grades/getRubric/index.md) — ### Quire permissions Required capability: `grade/edit`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one rubric by external identifier](https://docs.quirelms.com/api/grades/getRubricByExternalId/index.md) — ### Quire permissions Required capability: `grade/edit`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one scale](https://docs.quirelms.com/api/grades/getScale/index.md) — ### Quire permissions Required capability: `grade/view`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one scale by external identifier](https://docs.quirelms.com/api/grades/getScaleByExternalId/index.md) — ### Quire permissions Required capability: `grade/view`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [List gradeitems](https://docs.quirelms.com/api/grades/listCourseGradeItems/index.md) — The gradebook columns of a course: one per graded activity, plus manual, calculated, category and course totals. ### Quire permissions Required capability: `grade/view`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [List rubrics](https://docs.quirelms.com/api/grades/listCourseRubrics/index.md) — Ready rubrics and marking guides available to a course, including tenant-shared definitions. Drafts and marker-only canned comments are omitted. ### Quire permissions Required capability: `grade/edit`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [List grades deleted since a point in time](https://docs.quirelms.com/api/grades/listGradeDeletions/index.md) — Tombstones of deleted grades, kept for 90 days. ### Quire permissions Required capability: `grade/viewhidden`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [List gradeitems deleted since a point in time](https://docs.quirelms.com/api/grades/listGradeItemDeletions/index.md) — Tombstones of deleted gradeitems, kept for 90 days. ### Quire permissions Required capability: `grade/view`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [List grades](https://docs.quirelms.com/api/grades/listGrades/index.md) — Grades per person per gradebook item, with the raw grade, the final grade after overrides and aggregation, and the feedback. ### Quire permissions Required capability: `grade/viewhidden`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [List outcomes deleted since a point in time](https://docs.quirelms.com/api/grades/listOutcomeDeletions/index.md) — Tombstones of deleted outcomes, kept for 90 days. ### Quire permissions Required capability: `grade/view`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [List outcomes](https://docs.quirelms.com/api/grades/listOutcomes/index.md) — Tenant and course learning outcomes. Only tenant grade readers may list this configuration resource. ### Quire permissions Required capability: `grade/view`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [List rubrics deleted since a point in time](https://docs.quirelms.com/api/grades/listRubricDeletions/index.md) — Tombstones of deleted rubrics, kept for 90 days. ### Quire permissions Required capability: `grade/edit`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [List scales deleted since a point in time](https://docs.quirelms.com/api/grades/listScaleDeletions/index.md) — Tombstones of deleted scales, kept for 90 days. ### Quire permissions Required capability: `grade/view`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [List scales](https://docs.quirelms.com/api/grades/listScales/index.md) — Tenant and course grading scales. Only tenant grade readers may list this configuration resource. ### Quire permissions Required capability: `grade/view`. Credential scopes: `grades:read`. The acting subject must also be allowed to perform this action in the organisation. - [Change a grade, its feedback, or whether it is excluded, hidden or locked](https://docs.quirelms.com/api/grades/updateGrade/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `grade/edit`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a gradebook column](https://docs.quirelms.com/api/grades/updateGradeItem/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change an outcome's full name or scale](https://docs.quirelms.com/api/grades/updateOutcome/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a rubric or marking guide that has not marked any work](https://docs.quirelms.com/api/grades/updateRubric/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `grade/managegradingforms`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Rename a scale or change its rungs](https://docs.quirelms.com/api/grades/updateScale/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Set a grade by external identifier](https://docs.quirelms.com/api/grades/upsertGrade/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `grade/edit`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a gradebook column by external identifier](https://docs.quirelms.com/api/grades/upsertGradeItem/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a learning outcome by external identifier](https://docs.quirelms.com/api/grades/upsertOutcome/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a rubric or marking guide by external identifier](https://docs.quirelms.com/api/grades/upsertRubric/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `grade/managegradingforms`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a grading scale by external identifier](https://docs.quirelms.com/api/grades/upsertScale/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `grade/manage`. Credential scopes: `grades:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a person to a group](https://docs.quirelms.com/api/groups/addGroupMember/index.md) — ### Quire permissions Required capability: `group/manage`. Credential scopes: `groups:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 groupmember operations](https://docs.quirelms.com/api/groups/bulkGroupMembers/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `group/manage`. Credential scopes: `groups:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 grouping operations](https://docs.quirelms.com/api/groups/bulkGroupings/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `grouping/manage`. Credential scopes: `groups:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 group operations](https://docs.quirelms.com/api/groups/bulkGroups/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `group/manage`. Credential scopes: `groups:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a group in a course](https://docs.quirelms.com/api/groups/createCourseGroup/index.md) — ### Quire permissions Required capability: `group/manage`. Credential scopes: `groups:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a grouping in a course](https://docs.quirelms.com/api/groups/createCourseGrouping/index.md) — ### Quire permissions Required capability: `grouping/manage`. Credential scopes: `groups:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a group](https://docs.quirelms.com/api/groups/deleteGroup/index.md) — ### Quire permissions Required capability: `group/manage`. Credential scopes: `groups:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a grouping](https://docs.quirelms.com/api/groups/deleteGrouping/index.md) — ### Quire permissions Required capability: `grouping/manage`. Credential scopes: `groups:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one group](https://docs.quirelms.com/api/groups/getGroup/index.md) — ### Quire permissions Required capability: `group/viewAllGroups`. Credential scopes: `groups:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one group by external identifier](https://docs.quirelms.com/api/groups/getGroupByExternalId/index.md) — ### Quire permissions Required capability: `group/viewAllGroups`. Credential scopes: `groups:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one grouping](https://docs.quirelms.com/api/groups/getGrouping/index.md) — ### Quire permissions Required capability: `group/viewAllGroups`. Credential scopes: `groups:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one grouping by external identifier](https://docs.quirelms.com/api/groups/getGroupingByExternalId/index.md) — ### Quire permissions Required capability: `group/viewAllGroups`. Credential scopes: `groups:read`. The acting subject must also be allowed to perform this action in the organisation. - [List groupings](https://docs.quirelms.com/api/groups/listCourseGroupings/index.md) — Groupings of a course: named sets of groups an activity can be restricted to. A grouping is created with its groups and is not edited in place, the way the course groups page treats it: delete it and create it again to change it. ### Quire permissions Required capability: `group/viewAllGroups`. Credential scopes: `groups:read`. The acting subject must also be allowed to perform this action in the organisation. - [List groups](https://docs.quirelms.com/api/groups/listCourseGroups/index.md) — The groups of a course. ### Quire permissions Required capability: `group/viewAllGroups`. Credential scopes: `groups:read`. The acting subject must also be allowed to perform this action in the organisation. - [List groups deleted since a point in time](https://docs.quirelms.com/api/groups/listGroupDeletions/index.md) — Tombstones of deleted groups, kept for 90 days. ### Quire permissions Required capability: `group/viewAllGroups`. Credential scopes: `groups:read`. The acting subject must also be allowed to perform this action in the organisation. - [List members](https://docs.quirelms.com/api/groups/listGroupMembers/index.md) — The people in a group. The id of a member is their user id. ### Quire permissions Required capability: `group/viewAllGroups`. Credential scopes: `groups:read`. The acting subject must also be allowed to perform this action in the organisation. - [List groupings deleted since a point in time](https://docs.quirelms.com/api/groups/listGroupingDeletions/index.md) — Tombstones of deleted groupings, kept for 90 days. ### Quire permissions Required capability: `group/viewAllGroups`. Credential scopes: `groups:read`. The acting subject must also be allowed to perform this action in the organisation. - [Take a person out of a group](https://docs.quirelms.com/api/groups/removeGroupMember/index.md) — ### Quire permissions Required capability: `group/manage`. Credential scopes: `groups:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Change a group](https://docs.quirelms.com/api/groups/updateGroup/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `group/manage`. Credential scopes: `groups:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a group by external identifier](https://docs.quirelms.com/api/groups/upsertGroup/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `group/manage`. Credential scopes: `groups:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a grouping by external identifier, or return the one that has it](https://docs.quirelms.com/api/groups/upsertGrouping/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `grouping/manage`. Credential scopes: `groups:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 aiprovider operations](https://docs.quirelms.com/api/integrations/bulkAIProviderSettings/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `ai/configure`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 hubspotfieldmapping operations](https://docs.quirelms.com/api/integrations/bulkHubSpotFieldMappings/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 hubspotsyncmapping operations](https://docs.quirelms.com/api/integrations/bulkHubSpotSyncMappings/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 integrationconnection operations](https://docs.quirelms.com/api/integrations/bulkIntegrationConnections/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 syncmapping operations](https://docs.quirelms.com/api/integrations/bulkSyncMappings/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add and activate an AI provider](https://docs.quirelms.com/api/integrations/createAiProvider/index.md) — ### Quire permissions Required capability: `ai/configure`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Issue an API key](https://docs.quirelms.com/api/integrations/createApiKey/index.md) — Creates an audited key for the calling administrator. The raw token and prefix are returned once in this response and are never included in later reads. ### Quire permissions Required capability: `api/manage_keys`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a hubspotfieldmapping](https://docs.quirelms.com/api/integrations/createHubSpotFieldMapping/index.md) — ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a hubspotsyncmapping](https://docs.quirelms.com/api/integrations/createHubSpotSyncMapping/index.md) — ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a syncmapping](https://docs.quirelms.com/api/integrations/createSyncMapping/index.md) — ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a hubspotfieldmapping](https://docs.quirelms.com/api/integrations/deleteHubSpotFieldMapping/index.md) — ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a hubspotsyncmapping](https://docs.quirelms.com/api/integrations/deleteHubSpotSyncMapping/index.md) — ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Disconnect the HubSpot portal while retaining its installation record](https://docs.quirelms.com/api/integrations/deleteIntegrationConnection/index.md) — ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a syncmapping](https://docs.quirelms.com/api/integrations/deleteSyncMapping/index.md) — ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Disable an AI provider](https://docs.quirelms.com/api/integrations/disableAiProvider/index.md) — Stops the provider being used for new requests. The setting stays readable, and bindings to it stop resolving until they are pointed at another provider. ### Quire permissions Required capability: `ai/configure`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one aiprovider](https://docs.quirelms.com/api/integrations/getAiProvider/index.md) — ### Quire permissions Required capability: `ai/configure`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one aiprovider by external identifier](https://docs.quirelms.com/api/integrations/getAiProviderByExternalId/index.md) — ### Quire permissions Required capability: `ai/configure`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one apikey](https://docs.quirelms.com/api/integrations/getApiKey/index.md) — ### Quire permissions Required capability: `api/manage_keys`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one hubspotfieldmapping](https://docs.quirelms.com/api/integrations/getHubSpotFieldMapping/index.md) — ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one hubspotsyncmapping](https://docs.quirelms.com/api/integrations/getHubSpotSyncMapping/index.md) — ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one integrationconnection](https://docs.quirelms.com/api/integrations/getIntegrationConnection/index.md) — ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one syncmapping](https://docs.quirelms.com/api/integrations/getSyncMapping/index.md) — ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [List ai provider settings](https://docs.quirelms.com/api/integrations/listAIProviderSettings/index.md) — Tenant-owned AI provider settings. Endpoints, credential envelopes, key references, validation errors, and creator identity are omitted, and the credential sent on creation is write-only. A provider is probed before it is activated, and a configuration is never edited: add a new one and disable the old. An external identifier finds the setting it named and creates one only when there is none. Disabled settings remain available for synchronization. ### Quire permissions Required capability: `ai/configure`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [List api keys](https://docs.quirelms.com/api/integrations/listAPIKeys/index.md) — Tenant API key metadata for integration administrators. Issuance and rotation return a raw token only once; later reads omit the token, key prefix, secret hash, IP allowlist, acting-user identity, and rotation links. Updated-since and hard-deletion feeds support credential synchronization. ### Quire permissions Required capability: `api/manage_keys`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [List api keys deleted since a point in time](https://docs.quirelms.com/api/integrations/listApiKeyDeletions/index.md) — Tombstones of deleted api keys, kept for 90 days. ### Quire permissions Required capability: `api/manage_keys`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [List hubspotfieldmappings deleted since a point in time](https://docs.quirelms.com/api/integrations/listHubSpotFieldMappingDeletions/index.md) — Tombstones of deleted hubspotfieldmappings, kept for 90 days. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [List hubspotfieldmappings](https://docs.quirelms.com/api/integrations/listHubSpotFieldMappings/index.md) — HubSpot property mappings and conflict rules managed by the same service as the administrator page. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [List hubspotsyncmappings deleted since a point in time](https://docs.quirelms.com/api/integrations/listHubSpotSyncMappingDeletions/index.md) — Tombstones of deleted hubspotsyncmappings, kept for 90 days. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [List hubspotsyncmappings](https://docs.quirelms.com/api/integrations/listHubSpotSyncMappings/index.md) — Explicit one-to-one object links supported by the HubSpot sync engine: users to contacts, tenant-level static groups to companies and courses to courses. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [List integrationconnections](https://docs.quirelms.com/api/integrations/listIntegrationConnections/index.md) — Installed integration metadata. The sealed refresh token and its reference are never included. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [List syncmappings deleted since a point in time](https://docs.quirelms.com/api/integrations/listSyncMappingDeletions/index.md) — Tombstones of deleted syncmappings, kept for 90 days. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [List syncmappings](https://docs.quirelms.com/api/integrations/listSyncMappings/index.md) — Provider-neutral local-to-remote object links. The current mapping store contains HubSpot links; provider identifies each link and writes use the owning integration service. Changed-since and hard-deletion feeds support incremental sync. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:read`. The acting subject must also be allowed to perform this action in the organisation. - [Revoke an API key](https://docs.quirelms.com/api/integrations/revokeApiKey/index.md) — Immediately disables the key and records the action in the audit log. ### Quire permissions Required capability: `api/manage_keys`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Rotate an API key](https://docs.quirelms.com/api/integrations/rotateApiKey/index.md) — Creates a successor key and keeps the current key working for the requested overlap. The successor's raw token is returned once. ### Quire permissions Required capability: `api/manage_keys`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Start a HubSpot OAuth installation](https://docs.quirelms.com/api/integrations/startHubSpotConnection/index.md) — Returns the provider authorization URL. The callback installs the portal for the calling tenant and stores its sealed refresh token outside this API. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update a hubspotfieldmapping](https://docs.quirelms.com/api/integrations/updateHubSpotFieldMapping/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `hubspot/manage`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add an AI provider, or find the one already added, by external identifier](https://docs.quirelms.com/api/integrations/upsertAiProvider/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `ai/configure`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one invoice](https://docs.quirelms.com/api/invoices/getInvoice/index.md) — ### Quire permissions Required capability: `store/manage`. Credential scopes: `invoices:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one invoice by external identifier](https://docs.quirelms.com/api/invoices/getInvoiceByExternalId/index.md) — ### Quire permissions Required capability: `store/manage`. Credential scopes: `invoices:read`. The acting subject must also be allowed to perform this action in the organisation. - [List invoices deleted since a point in time](https://docs.quirelms.com/api/invoices/listInvoiceDeletions/index.md) — Tombstones of deleted invoices, kept for 90 days. ### Quire permissions Required capability: `store/manage`. Credential scopes: `invoices:read`. The acting subject must also be allowed to perform this action in the organisation. - [List invoices](https://docs.quirelms.com/api/invoices/listInvoices/index.md) — Invoices issued by this organisation for its orders. Fiscal records are created by checkout and cannot be changed through this API. ### Quire permissions Required capability: `store/manage`. Credential scopes: `invoices:read`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 ai conversation operations](https://docs.quirelms.com/api/me/bulkAIConversations/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Finish an upload session, which scans and stores the file](https://docs.quirelms.com/api/me/completeMyUpload/index.md) — ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Confirm a privacy request with the token sent to the person on file](https://docs.quirelms.com/api/me/confirmMyDataRequest/index.md) — ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Start a tutor conversation in a course](https://docs.quirelms.com/api/me/createAIConversation/index.md) — ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Request a copy, portability, erasure, or correction of your own data](https://docs.quirelms.com/api/me/createMyDataRequest/index.md) — Sends a confirmation link to the calling person’s address on file; processing waits for confirmation. ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Grant or withdraw one of the calling person’s optional consents](https://docs.quirelms.com/api/me/decideMyConsent/index.md) — The same minor-account restrictions and append-only consent evidence as the privacy page apply. ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Enrol the calling person in a course that allows self enrolment](https://docs.quirelms.com/api/me/enrolMe/index.md) — With the enrolment key when the course asks for one. A wrong key is refused and repeated attempts are paused, as on the course page. An enrolment that needs approval or a free place answers deferred. ### Quire permissions Required capability: `enrol/self`. Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one ai conversation](https://docs.quirelms.com/api/me/getAIConversation/index.md) — ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read the calling person](https://docs.quirelms.com/api/me/getMe/index.md) — ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one effective optional-purpose decision](https://docs.quirelms.com/api/me/getMyConsent/index.md) — ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one of the calling person’s privacy requests](https://docs.quirelms.com/api/me/getMyDataRequest/index.md) — ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one invoice for the calling buyer’s own order](https://docs.quirelms.com/api/me/getMyInvoice/index.md) — ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one effective notification preference](https://docs.quirelms.com/api/me/getMyNotificationPreference/index.md) — ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one of the calling buyer’s own orders](https://docs.quirelms.com/api/me/getMyOrder/index.md) — ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one of the calling person's quiz attempts with its questions](https://docs.quirelms.com/api/me/getMyQuizAttempt/index.md) — The attempt as the quiz player shows it: the current page's questions with their saved responses, the timer and what review is open. ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [List ai conversations](https://docs.quirelms.com/api/me/listAIConversations/index.md) — Tutor conversations owned by the calling person. This resource returns safe metadata only; use the messages route to page through the caller's own transcript. ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [List messages in an AI conversation](https://docs.quirelms.com/api/me/listAiConversationMessages/index.md) — Returns the calling person's own tutor messages in ordinal order. Other learners' conversations are indistinguishable from missing IDs; teacher transcript review remains separately audited. ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [Page through the calling person’s consent evidence](https://docs.quirelms.com/api/me/listMyConsentHistory/index.md) — Every recorded policy and optional-purpose decision for this person, newest first. Network evidence is not disclosed. ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [List the calling person’s effective optional-purpose decisions](https://docs.quirelms.com/api/me/listMyConsents/index.md) — ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [List the courses the calling person takes, with their progress](https://docs.quirelms.com/api/me/listMyCourses/index.md) — ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [List the calling person’s privacy requests](https://docs.quirelms.com/api/me/listMyDataRequests/index.md) — ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [List invoices for the calling buyer’s own orders](https://docs.quirelms.com/api/me/listMyInvoices/index.md) — Only invoices tied to an order with buyer_id equal to the person this credential represents. ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [List the calling person’s effective notification preferences](https://docs.quirelms.com/api/me/listMyNotificationPreferences/index.md) — Includes catalogue defaults and organisation locks, not only saved overrides. A locked_reason_key tells the client why a choice cannot change. ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [List the calling buyer’s own orders](https://docs.quirelms.com/api/me/listMyOrders/index.md) — Only orders whose buyer_id is the person this credential represents. Guest orders with no buyer_id are not claimed by email. ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [List the calling person’s active sessions on this organisation](https://docs.quirelms.com/api/me/listMySessions/index.md) — Returns active tenant-bound sessions that still exist in the sign-in store. Device addresses, credential values and sessions from other organisations are omitted. ### Quire permissions Credential scopes: `me:read`. The acting subject must also be allowed to perform this action in the organisation. - [Mark an activity complete, or not, by hand](https://docs.quirelms.com/api/me/markMyActivityComplete/index.md) — Only for an activity whose completion is set to manual, and only in a course the calling person is enrolled in. ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Start a forum discussion, or reply to a post](https://docs.quirelms.com/api/me/postInForum/index.md) — Without parent_id a new discussion is started with subject as its title; with it, a reply. The forum's type, groups, posting window and moderation apply as they do on the forum page. ### Quire permissions Required capability: `forum/post`. Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Revoke one of the calling person’s sessions on this organisation](https://docs.quirelms.com/api/me/revokeMySession/index.md) — Writes a tenant-scoped revocation record. The Better Auth session is not deleted, so a session the person also uses on another organisation is unaffected there. ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Save responses in a quiz attempt](https://docs.quirelms.com/api/me/saveMyQuizAttempt/index.md) — ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Send a message as the calling person](https://docs.quirelms.com/api/me/sendMyMessage/index.md) — ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Start a quiz attempt](https://docs.quirelms.com/api/me/startMyQuizAttempt/index.md) — The quiz's password, attempt limit, delay between attempts and opening times apply as they do in the quiz player. ### Quire permissions Required capability: `quiz/attempt`. Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Save and optionally submit the calling person's assignment work](https://docs.quirelms.com/api/me/submitMyAssignment/index.md) — Online text and uploaded files are saved as the draft, then submitted for marking when submit is true. The assignment's dates, file limits, team rules and submission statement apply as they do on the assignment page. ### Quire permissions Required capability: `assignment/submit`. Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Submit a quiz attempt for grading](https://docs.quirelms.com/api/me/submitMyQuizAttempt/index.md) — ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change one of the calling person’s notification preferences](https://docs.quirelms.com/api/me/updateMyNotificationPreference/index.md) — Organisation locks, unavailable channels, and mandatory security notices are enforced by the same service as the preferences page. ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Upload a file for a submission, a post or a quiz answer](https://docs.quirelms.com/api/me/uploadMyFile/index.md) — The upload session API, as the calling person. With content_base64 the file is stored and scanned at once and its file_id returned. Without it a session is opened: PUT the bytes to put.url, then complete the session; the address goes straight to object storage where the deployment uses it. ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Withdraw one of the calling person’s open privacy requests](https://docs.quirelms.com/api/me/withdrawMyDataRequest/index.md) — ### Quire permissions Credential scopes: `me:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 message operations](https://docs.quirelms.com/api/messages/bulkMessages/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Credential scopes: `messages:write`. The acting subject must also be allowed to perform this action in the organisation. - [Send a message as the calling person](https://docs.quirelms.com/api/messages/createMessage/index.md) — ### Quire permissions Credential scopes: `messages:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete one of the calling person's messages](https://docs.quirelms.com/api/messages/deleteMessage/index.md) — ### Quire permissions Credential scopes: `messages:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one conversation](https://docs.quirelms.com/api/messages/getConversation/index.md) — ### Quire permissions Credential scopes: `messages:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one conversation by external identifier](https://docs.quirelms.com/api/messages/getConversationByExternalId/index.md) — ### Quire permissions Credential scopes: `messages:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one message](https://docs.quirelms.com/api/messages/getMessage/index.md) — ### Quire permissions Credential scopes: `messages:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one message by external identifier](https://docs.quirelms.com/api/messages/getMessageByExternalId/index.md) — ### Quire permissions Credential scopes: `messages:read`. The acting subject must also be allowed to perform this action in the organisation. - [List conversations deleted since a point in time](https://docs.quirelms.com/api/messages/listConversationDeletions/index.md) — Tombstones of deleted conversations, kept for 90 days. ### Quire permissions Credential scopes: `messages:read`. The acting subject must also be allowed to perform this action in the organisation. - [List conversations](https://docs.quirelms.com/api/messages/listConversations/index.md) — The conversations the calling person is a member of. Nobody reads anybody else's messages through the API. ### Quire permissions Credential scopes: `messages:read`. The acting subject must also be allowed to perform this action in the organisation. - [List messages deleted since a point in time](https://docs.quirelms.com/api/messages/listMessageDeletions/index.md) — Tombstones of deleted messages, kept for 90 days. ### Quire permissions Credential scopes: `messages:read`. The acting subject must also be allowed to perform this action in the organisation. - [List messages](https://docs.quirelms.com/api/messages/listMessages/index.md) — Messages in the conversations the calling person is a member of. ### Quire permissions Credential scopes: `messages:read`. The acting subject must also be allowed to perform this action in the organisation. - [Edit one of the calling person's messages](https://docs.quirelms.com/api/messages/updateMessage/index.md) — Fields absent from the body are left as they are. ### Quire permissions Credential scopes: `messages:write`. The acting subject must also be allowed to perform this action in the organisation. - [Send a message once under an external identifier](https://docs.quirelms.com/api/messages/upsertMessage/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Credential scopes: `messages:write`. The acting subject must also be allowed to perform this action in the organisation. - [Publish a global platform announcement](https://docs.quirelms.com/api/notifications/createPlatformAnnouncement/index.md) — Publishes or schedules an audience-targeted announcement through the audited platform service. Requires an idempotency key. ### Quire permissions Required capability: `platform/announcements_manage`. Credential scopes: `notifications:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one notification](https://docs.quirelms.com/api/notifications/getNotification/index.md) — ### Quire permissions Credential scopes: `notifications:read`. The acting subject must also be allowed to perform this action in the organisation. - [List notifications deleted since a point in time](https://docs.quirelms.com/api/notifications/listNotificationDeletions/index.md) — Tombstones of deleted notifications, kept for 90 days. ### Quire permissions Credential scopes: `notifications:read`. The acting subject must also be allowed to perform this action in the organisation. - [List notifications](https://docs.quirelms.com/api/notifications/listNotifications/index.md) — The calling person's notifications, oldest first in a walk, with whether each has been read. ### Quire permissions Credential scopes: `notifications:read`. The acting subject must also be allowed to perform this action in the organisation. - [List global platform announcements](https://docs.quirelms.com/api/notifications/listPlatformAnnouncements/index.md) — Returns global announcement text, audience rules and publication dates without publisher identities or audit records. ### Quire permissions Required capability: `platform/announcements_manage`. Credential scopes: `notifications:read`. The acting subject must also be allowed to perform this action in the organisation. - [Withdraw a global platform announcement](https://docs.quirelms.com/api/notifications/retractPlatformAnnouncement/index.md) — Withdraws a currently live platform announcement and records the audited action. ### Quire permissions Required capability: `platform/announcements_manage`. Credential scopes: `notifications:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 coupon operations](https://docs.quirelms.com/api/orders/bulkCoupons/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 product operations](https://docs.quirelms.com/api/orders/bulkProducts/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a coupon](https://docs.quirelms.com/api/orders/createCoupon/index.md) — ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a product](https://docs.quirelms.com/api/orders/createProduct/index.md) — ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:write`. The acting subject must also be allowed to perform this action in the organisation. - [Retire a product, which leaves the storefront while its orders keep it](https://docs.quirelms.com/api/orders/deleteProduct/index.md) — ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one coupon](https://docs.quirelms.com/api/orders/getCoupon/index.md) — ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one coupon by external identifier](https://docs.quirelms.com/api/orders/getCouponByExternalId/index.md) — ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one order](https://docs.quirelms.com/api/orders/getOrder/index.md) — ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one order by external identifier](https://docs.quirelms.com/api/orders/getOrderByExternalId/index.md) — ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one product](https://docs.quirelms.com/api/orders/getProduct/index.md) — ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one product by external identifier](https://docs.quirelms.com/api/orders/getProductByExternalId/index.md) — ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:read`. The acting subject must also be allowed to perform this action in the organisation. - [List coupons deleted since a point in time](https://docs.quirelms.com/api/orders/listCouponDeletions/index.md) — Tombstones of deleted coupons, kept for 90 days. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:read`. The acting subject must also be allowed to perform this action in the organisation. - [List coupons](https://docs.quirelms.com/api/orders/listCoupons/index.md) — Store coupon terms and redemption counts. Codes and eligibility are visible only to store managers. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:read`. The acting subject must also be allowed to perform this action in the organisation. - [List orders deleted since a point in time](https://docs.quirelms.com/api/orders/listOrderDeletions/index.md) — Tombstones of deleted orders, kept for 90 days. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:read`. The acting subject must also be allowed to perform this action in the organisation. - [List orders](https://docs.quirelms.com/api/orders/listOrders/index.md) — Orders placed in the storefront, with their totals, refunds and who issued the invoice. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:read`. The acting subject must also be allowed to perform this action in the organisation. - [List products deleted since a point in time](https://docs.quirelms.com/api/orders/listProductDeletions/index.md) — Tombstones of deleted products, kept for 90 days. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:read`. The acting subject must also be allowed to perform this action in the organisation. - [List products](https://docs.quirelms.com/api/orders/listProducts/index.md) — What the organisation sells: courses, programs, bundles, memberships and seat packs, with their current prices. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:read`. The acting subject must also be allowed to perform this action in the organisation. - [Mark an order paid outside the provider](https://docs.quirelms.com/api/orders/markPaidOrder/index.md) — For an invoice paid by bank transfer: the order is settled and fulfilled as if the provider had confirmed it. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:write`. The acting subject must also be allowed to perform this action in the organisation. - [Refund an order, in full or in part](https://docs.quirelms.com/api/orders/refundOrder/index.md) — Refunds through the payment provider the order was paid with, and revokes what it granted when the refund is full. ### Quire permissions Required capability: `store/refund`. Credential scopes: `orders:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a coupon while preserving omitted terms](https://docs.quirelms.com/api/orders/updateCoupon/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change, reprice or publish a product](https://docs.quirelms.com/api/orders/updateProduct/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a coupon by external identifier](https://docs.quirelms.com/api/orders/upsertCoupon/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a product by external identifier](https://docs.quirelms.com/api/orders/upsertProduct/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `store/manage`. Credential scopes: `orders:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 orgunit operations](https://docs.quirelms.com/api/org_units/bulkOrgUnits/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `orgunit/manage`. Credential scopes: `org_units:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create an organisation unit](https://docs.quirelms.com/api/org_units/createOrgUnit/index.md) — ### Quire permissions Required capability: `orgunit/manage`. Credential scopes: `org_units:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete an organisation unit with no current assignments](https://docs.quirelms.com/api/org_units/deleteOrgUnit/index.md) — ### Quire permissions Required capability: `orgunit/manage`. Credential scopes: `org_units:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one orgunit](https://docs.quirelms.com/api/org_units/getOrgUnit/index.md) — ### Quire permissions Required capability: `orgunit/view`. Credential scopes: `org_units:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one orgunit by external identifier](https://docs.quirelms.com/api/org_units/getOrgUnitByExternalId/index.md) — ### Quire permissions Required capability: `orgunit/view`. Credential scopes: `org_units:read`. The acting subject must also be allowed to perform this action in the organisation. - [List orgunits deleted since a point in time](https://docs.quirelms.com/api/org_units/listOrgUnitDeletions/index.md) — Tombstones of deleted orgunits, kept for 90 days. ### Quire permissions Required capability: `orgunit/view`. Credential scopes: `org_units:read`. The acting subject must also be allowed to perform this action in the organisation. - [List orgunits](https://docs.quirelms.com/api/org_units/listOrgUnits/index.md) — Tenant organisational units and their hierarchy. People assignments and approver identities are not included. ### Quire permissions Required capability: `orgunit/view`. Credential scopes: `org_units:read`. The acting subject must also be allowed to perform this action in the organisation. - [Rename or move an organisation unit](https://docs.quirelms.com/api/org_units/updateOrgUnit/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `orgunit/manage`. Credential scopes: `org_units:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update an organisation unit by external identifier](https://docs.quirelms.com/api/org_units/upsertOrgUnit/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `orgunit/manage`. Credential scopes: `org_units:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 position operations](https://docs.quirelms.com/api/positions/bulkPositions/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `orgunit/manage`. Credential scopes: `positions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a position](https://docs.quirelms.com/api/positions/createPosition/index.md) — ### Quire permissions Required capability: `orgunit/manage`. Credential scopes: `positions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete an unassigned position](https://docs.quirelms.com/api/positions/deletePosition/index.md) — ### Quire permissions Required capability: `orgunit/manage`. Credential scopes: `positions:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one position](https://docs.quirelms.com/api/positions/getPosition/index.md) — ### Quire permissions Required capability: `orgunit/view`. Credential scopes: `positions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one position by external identifier](https://docs.quirelms.com/api/positions/getPositionByExternalId/index.md) — ### Quire permissions Required capability: `orgunit/view`. Credential scopes: `positions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List positions deleted since a point in time](https://docs.quirelms.com/api/positions/listPositionDeletions/index.md) — Tombstones of deleted positions, kept for 90 days. ### Quire permissions Required capability: `orgunit/view`. Credential scopes: `positions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List positions](https://docs.quirelms.com/api/positions/listPositions/index.md) — Tenant position titles and their hierarchy. User assignments are not included. ### Quire permissions Required capability: `orgunit/view`. Credential scopes: `positions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Rename or move a position](https://docs.quirelms.com/api/positions/updatePosition/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `orgunit/manage`. Credential scopes: `positions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a position by external identifier](https://docs.quirelms.com/api/positions/upsertPosition/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `orgunit/manage`. Credential scopes: `positions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Verify, approve, extend, refuse, rectify, decide, or resume a privacy case](https://docs.quirelms.com/api/privacy/actOnDataRequest/index.md) — ### Quire permissions Required capability: `privacy/request`. Credential scopes: `privacy:write`. The acting subject must also be allowed to perform this action in the organisation. - [Assess, notify, or close a platform breach](https://docs.quirelms.com/api/privacy/actOnPlatformBreach/index.md) — ### Quire permissions Required capability: `platform/breaches_manage`. Credential scopes: `privacy:write`. The acting subject must also be allowed to perform this action in the organisation. - [Announce a subprocessor change](https://docs.quirelms.com/api/privacy/announcePlatformSubprocessorChange/index.md) — ### Quire permissions Required capability: `platform/subprocessors_manage`. Credential scopes: `privacy:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 policydocument operations](https://docs.quirelms.com/api/privacy/bulkPolicyDocuments/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `privacy/manage`. Credential scopes: `privacy:write`. The acting subject must also be allowed to perform this action in the organisation. - [Open an audited platform breach record](https://docs.quirelms.com/api/privacy/createPlatformBreach/index.md) — ### Quire permissions Required capability: `platform/breaches_manage`. Credential scopes: `privacy:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a custom policy document](https://docs.quirelms.com/api/privacy/createPolicyDocument/index.md) — ### Quire permissions Required capability: `privacy/manage`. Credential scopes: `privacy:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read a privacy case, its tasks, and its timeline](https://docs.quirelms.com/api/privacy/getDataRequest/index.md) — ### Quire permissions Required capability: `privacy/request`. Credential scopes: `privacy:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read a platform breach and its timeline](https://docs.quirelms.com/api/privacy/getPlatformBreach/index.md) — ### Quire permissions Required capability: `platform/breaches_view`. Credential scopes: `privacy:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one policydocument](https://docs.quirelms.com/api/privacy/getPolicyDocument/index.md) — ### Quire permissions Required capability: `privacy/manage`. Credential scopes: `privacy:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one policydocument by external identifier](https://docs.quirelms.com/api/privacy/getPolicyDocumentByExternalId/index.md) — ### Quire permissions Required capability: `privacy/manage`. Credential scopes: `privacy:read`. The acting subject must also be allowed to perform this action in the organisation. - [List the organisation’s privacy case queue](https://docs.quirelms.com/api/privacy/listDataRequests/index.md) — ### Quire permissions Required capability: `privacy/request`. Credential scopes: `privacy:read`. The acting subject must also be allowed to perform this action in the organisation. - [List platform breach records](https://docs.quirelms.com/api/privacy/listPlatformBreaches/index.md) — ### Quire permissions Required capability: `platform/breaches_view`. Credential scopes: `privacy:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read platform subprocessor change history](https://docs.quirelms.com/api/privacy/listPlatformSubprocessorChanges/index.md) — ### Quire permissions Required capability: `platform/subprocessors_manage`. Credential scopes: `privacy:read`. The acting subject must also be allowed to perform this action in the organisation. - [List platform subprocessors](https://docs.quirelms.com/api/privacy/listPlatformSubprocessors/index.md) — ### Quire permissions Required capability: `platform/subprocessors_manage`. Credential scopes: `privacy:read`. The acting subject must also be allowed to perform this action in the organisation. - [List policydocuments deleted since a point in time](https://docs.quirelms.com/api/privacy/listPolicyDocumentDeletions/index.md) — Tombstones of deleted policydocuments, kept for 90 days. ### Quire permissions Required capability: `privacy/manage`. Credential scopes: `privacy:read`. The acting subject must also be allowed to perform this action in the organisation. - [List policydocuments](https://docs.quirelms.com/api/privacy/listPolicyDocuments/index.md) — Tenant legal-policy documents and their current published locale versions. A document with no published version is listed with an empty `published_versions`. Drafts, archived versions, author identities, and internal change summaries are never served. Writes create a custom policy, change who must accept it, save a draft and publish a draft; publishing is audited and can require everyone to accept again. ### Quire permissions Required capability: `privacy/manage`. Credential scopes: `privacy:read`. The acting subject must also be allowed to perform this action in the organisation. - [Open a privacy case as an organisation privacy officer](https://docs.quirelms.com/api/privacy/openDataRequest/index.md) — ### Quire permissions Required capability: `privacy/request`. Credential scopes: `privacy:write`. The acting subject must also be allowed to perform this action in the organisation. - [Publish a draft version of a policy](https://docs.quirelms.com/api/privacy/publishPolicyDocument/index.md) — Makes the draft the current version for its language and archives the one before it. Publishing cannot be undone, is audited, and when the draft requires re-acceptance everyone it applies to is asked to accept it at their next sign-in. ### Quire permissions Required capability: `privacy/manage`. Credential scopes: `privacy:write`. The acting subject must also be allowed to perform this action in the organisation. - [Save a draft version of a policy in one language](https://docs.quirelms.com/api/privacy/saveDraftPolicyDocument/index.md) — Creates the next draft for the language, or replaces the open one. A draft is never served and affects nobody until it is published. Text that still carries template placeholders is flagged in the answer. ### Quire permissions Required capability: `privacy/manage`. Credential scopes: `privacy:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change who a policy applies to and whether it must be accepted](https://docs.quirelms.com/api/privacy/updatePolicyDocument/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `privacy/manage`. Credential scopes: `privacy:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a custom policy, or change who it applies to, by external identifier](https://docs.quirelms.com/api/privacy/upsertPolicyDocument/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `privacy/manage`. Credential scopes: `privacy:write`. The acting subject must also be allowed to perform this action in the organisation. - [Approve a plan that was submitted for review](https://docs.quirelms.com/api/programs/approveLearningPlan/index.md) — The caller must be an approver of the pending review. The plan becomes active. ### Quire permissions Required capability: `learningplan/review`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 certificationassignment operations](https://docs.quirelms.com/api/programs/bulkCertificationAssignments/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `certification/assign`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 certification operations](https://docs.quirelms.com/api/programs/bulkCertifications/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `certification/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 competency operations](https://docs.quirelms.com/api/programs/bulkCompetencies/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 competencyframework operations](https://docs.quirelms.com/api/programs/bulkCompetencyFrameworks/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 learningplan operations](https://docs.quirelms.com/api/programs/bulkLearningPlans/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `learningplan/manage_others`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 programassignment operations](https://docs.quirelms.com/api/programs/bulkProgramAssignments/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `program/assign`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 programitem operations](https://docs.quirelms.com/api/programs/bulkProgramItems/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 programset operations](https://docs.quirelms.com/api/programs/bulkProgramSets/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 program operations](https://docs.quirelms.com/api/programs/bulkPrograms/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a certification](https://docs.quirelms.com/api/programs/createCertification/index.md) — ### Quire permissions Required capability: `certification/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Assign a certification to a person](https://docs.quirelms.com/api/programs/createCertificationAssignment/index.md) — ### Quire permissions Required capability: `certification/assign`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a competency in a framework](https://docs.quirelms.com/api/programs/createCompetency/index.md) — ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a competency framework](https://docs.quirelms.com/api/programs/createCompetencyFramework/index.md) — ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Assign a learning plan to a person from a template](https://docs.quirelms.com/api/programs/createLearningPlan/index.md) — ### Quire permissions Required capability: `learningplan/manage_others`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a programme](https://docs.quirelms.com/api/programs/createProgram/index.md) — ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Assign a programme to a person](https://docs.quirelms.com/api/programs/createProgramAssignment/index.md) — ### Quire permissions Required capability: `program/assign`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a course to a course set](https://docs.quirelms.com/api/programs/createProgramProgramItem/index.md) — ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a course set to a programme](https://docs.quirelms.com/api/programs/createProgramProgramSet/index.md) — ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a certification](https://docs.quirelms.com/api/programs/deleteCertification/index.md) — ### Quire permissions Required capability: `certification/manage`. Credential scopes: `programs:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a competency that has no children](https://docs.quirelms.com/api/programs/deleteCompetency/index.md) — ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete an empty competency framework](https://docs.quirelms.com/api/programs/deleteCompetencyFramework/index.md) — ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a programme](https://docs.quirelms.com/api/programs/deleteProgram/index.md) — ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Withdraw a programme assignment](https://docs.quirelms.com/api/programs/deleteProgramAssignment/index.md) — ### Quire permissions Required capability: `program/assign`. Credential scopes: `programs:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Take a course out of a course set](https://docs.quirelms.com/api/programs/deleteProgramItem/index.md) — ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a course set and its items](https://docs.quirelms.com/api/programs/deleteProgramSet/index.md) — ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one certification](https://docs.quirelms.com/api/programs/getCertification/index.md) — ### Quire permissions Required capability: `certification/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one certificationassignment](https://docs.quirelms.com/api/programs/getCertificationAssignment/index.md) — ### Quire permissions Required capability: `certification/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one certificationassignment by external identifier](https://docs.quirelms.com/api/programs/getCertificationAssignmentByExternalId/index.md) — ### Quire permissions Required capability: `certification/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one certification by external identifier](https://docs.quirelms.com/api/programs/getCertificationByExternalId/index.md) — ### Quire permissions Required capability: `certification/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one competency](https://docs.quirelms.com/api/programs/getCompetency/index.md) — ### Quire permissions Required capability: `competency/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one competency by external identifier](https://docs.quirelms.com/api/programs/getCompetencyByExternalId/index.md) — ### Quire permissions Required capability: `competency/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one competencyframework](https://docs.quirelms.com/api/programs/getCompetencyFramework/index.md) — ### Quire permissions Required capability: `competency/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one competencyframework by external identifier](https://docs.quirelms.com/api/programs/getCompetencyFrameworkByExternalId/index.md) — ### Quire permissions Required capability: `competency/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one learningplan](https://docs.quirelms.com/api/programs/getLearningPlan/index.md) — ### Quire permissions Required capability: `learningplan/manage_others`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one learningplan by external identifier](https://docs.quirelms.com/api/programs/getLearningPlanByExternalId/index.md) — ### Quire permissions Required capability: `learningplan/manage_others`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one program](https://docs.quirelms.com/api/programs/getProgram/index.md) — ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one programassignment](https://docs.quirelms.com/api/programs/getProgramAssignment/index.md) — ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one programassignment by external identifier](https://docs.quirelms.com/api/programs/getProgramAssignmentByExternalId/index.md) — ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one program by external identifier](https://docs.quirelms.com/api/programs/getProgramByExternalId/index.md) — ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one programitem](https://docs.quirelms.com/api/programs/getProgramItem/index.md) — ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one programset](https://docs.quirelms.com/api/programs/getProgramSet/index.md) — ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Link an activity to a competency](https://docs.quirelms.com/api/programs/linkActivityCompetency/index.md) — ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Link a course to a competency](https://docs.quirelms.com/api/programs/linkCourseCompetency/index.md) — Linking again changes whether and how completing the course awards the competency. ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [List certificationassignments deleted since a point in time](https://docs.quirelms.com/api/programs/listCertificationAssignmentDeletions/index.md) — Tombstones of deleted certificationassignments, kept for 90 days. ### Quire permissions Required capability: `certification/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List certificationassignments](https://docs.quirelms.com/api/programs/listCertificationAssignments/index.md) — Who holds or is working towards which certification, and whether they are compliant. ### Quire permissions Required capability: `certification/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List certifications deleted since a point in time](https://docs.quirelms.com/api/programs/listCertificationDeletions/index.md) — Tombstones of deleted certifications, kept for 90 days. ### Quire permissions Required capability: `certification/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List certifications](https://docs.quirelms.com/api/programs/listCertifications/index.md) — Certifications: a programme that has to be recompleted within a validity window to stay compliant. ### Quire permissions Required capability: `certification/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List competencies](https://docs.quirelms.com/api/programs/listCompetencies/index.md) — Competencies, each in one framework, arranged in a tree by `path`. ### Quire permissions Required capability: `competency/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List competencies deleted since a point in time](https://docs.quirelms.com/api/programs/listCompetencyDeletions/index.md) — Tombstones of deleted competencies, kept for 90 days. ### Quire permissions Required capability: `competency/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List competencyframeworks deleted since a point in time](https://docs.quirelms.com/api/programs/listCompetencyFrameworkDeletions/index.md) — Tombstones of deleted competencyframeworks, kept for 90 days. ### Quire permissions Required capability: `competency/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List competencyframeworks](https://docs.quirelms.com/api/programs/listCompetencyFrameworks/index.md) — Competency frameworks. ### Quire permissions Required capability: `competency/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List learningplans deleted since a point in time](https://docs.quirelms.com/api/programs/listLearningPlanDeletions/index.md) — Tombstones of deleted learningplans, kept for 90 days. ### Quire permissions Required capability: `learningplan/manage_others`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List learningplans](https://docs.quirelms.com/api/programs/listLearningPlans/index.md) — Personal learning plans. ### Quire permissions Required capability: `learningplan/manage_others`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List programassignments deleted since a point in time](https://docs.quirelms.com/api/programs/listProgramAssignmentDeletions/index.md) — Tombstones of deleted programassignments, kept for 90 days. ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List programassignments](https://docs.quirelms.com/api/programs/listProgramAssignments/index.md) — Who is assigned to which programme and how far they are through it. ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List programs deleted since a point in time](https://docs.quirelms.com/api/programs/listProgramDeletions/index.md) — Tombstones of deleted programs, kept for 90 days. ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List programitems deleted since a point in time](https://docs.quirelms.com/api/programs/listProgramItemDeletions/index.md) — Tombstones of deleted programitems, kept for 90 days. ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List programitems](https://docs.quirelms.com/api/programs/listProgramProgramItems/index.md) — The courses in each course set of a programme. ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List programsets](https://docs.quirelms.com/api/programs/listProgramProgramSets/index.md) — The course sets of a programme, in their order, each with the rule that completes it. ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List programsets deleted since a point in time](https://docs.quirelms.com/api/programs/listProgramSetDeletions/index.md) — Tombstones of deleted programsets, kept for 90 days. ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [List programs](https://docs.quirelms.com/api/programs/listPrograms/index.md) — Programmes: sequences of courses a person is assigned to and completes as a whole. ### Quire permissions Required capability: `program/view`. Credential scopes: `programs:read`. The acting subject must also be allowed to perform this action in the organisation. - [Map a competency to one in another framework](https://docs.quirelms.com/api/programs/mapCompetency/index.md) — ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Publish a certification](https://docs.quirelms.com/api/programs/publishCertification/index.md) — ### Quire permissions Required capability: `certification/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Publish a competency framework](https://docs.quirelms.com/api/programs/publishCompetencyFramework/index.md) — A published framework is offered wherever competencies are linked and rated. ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Publish a programme](https://docs.quirelms.com/api/programs/publishProgram/index.md) — A programme with no course sets cannot be published. ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Rate a person on a competency](https://docs.quirelms.com/api/programs/rateCompetency/index.md) — The manual rating a teacher gives on the course rating screen, recorded with its evidence and audit entry. ### Quire permissions Required capability: `competency/rate`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Send a submitted plan back to its owner](https://docs.quirelms.com/api/programs/rejectLearningPlan/index.md) — A reason is required. The plan returns to draft with the reason attached. ### Quire permissions Required capability: `learningplan/review`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Put the items of a course set in a new order](https://docs.quirelms.com/api/programs/reorderItemsProgramSet/index.md) — Send every live item of the set, in the order they should appear. ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Put the course sets of a programme in a new order](https://docs.quirelms.com/api/programs/reorderSetsProgram/index.md) — Send every live set of the programme, in the order they should appear. ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Remove an activity link from a competency](https://docs.quirelms.com/api/programs/unlinkActivityCompetency/index.md) — ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Remove a course link from a competency](https://docs.quirelms.com/api/programs/unlinkCourseCompetency/index.md) — ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Remove a mapping between two competencies](https://docs.quirelms.com/api/programs/unmapCompetency/index.md) — ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Unpublish a certification](https://docs.quirelms.com/api/programs/unpublishCertification/index.md) — ### Quire permissions Required capability: `certification/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Withdraw a competency framework from use](https://docs.quirelms.com/api/programs/unpublishCompetencyFramework/index.md) — ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Unpublish a programme](https://docs.quirelms.com/api/programs/unpublishProgram/index.md) — ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a certification](https://docs.quirelms.com/api/programs/updateCertification/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `certification/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change or move a competency](https://docs.quirelms.com/api/programs/updateCompetency/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a competency framework](https://docs.quirelms.com/api/programs/updateCompetencyFramework/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a programme](https://docs.quirelms.com/api/programs/updateProgram/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a course set](https://docs.quirelms.com/api/programs/updateProgramSet/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a certification by external identifier](https://docs.quirelms.com/api/programs/upsertCertification/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `certification/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a competency by external identifier](https://docs.quirelms.com/api/programs/upsertCompetency/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a competency framework by external identifier](https://docs.quirelms.com/api/programs/upsertCompetencyFramework/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `competency/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Assign a learning plan by external identifier](https://docs.quirelms.com/api/programs/upsertLearningPlan/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `learningplan/manage_others`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a programme by external identifier](https://docs.quirelms.com/api/programs/upsertProgram/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `program/manage`. Credential scopes: `programs:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 questionbank operations](https://docs.quirelms.com/api/questions/bulkQuestionBanks/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `question/view`. Credential scopes: `questions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 question operations](https://docs.quirelms.com/api/questions/bulkQuestions/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `question/view`. Credential scopes: `questions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a question](https://docs.quirelms.com/api/questions/createQuestion/index.md) — ### Quire permissions Credential scopes: `questions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a questionbank](https://docs.quirelms.com/api/questions/createQuestionBank/index.md) — ### Quire permissions Credential scopes: `questions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a question](https://docs.quirelms.com/api/questions/deleteQuestion/index.md) — ### Quire permissions Credential scopes: `questions:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one question](https://docs.quirelms.com/api/questions/getQuestion/index.md) — ### Quire permissions Required capability: `question/view`. Credential scopes: `questions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one questionbank](https://docs.quirelms.com/api/questions/getQuestionBank/index.md) — ### Quire permissions Required capability: `question/view`. Credential scopes: `questions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one questionbank by external identifier](https://docs.quirelms.com/api/questions/getQuestionBankByExternalId/index.md) — ### Quire permissions Required capability: `question/view`. Credential scopes: `questions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one question by external identifier](https://docs.quirelms.com/api/questions/getQuestionByExternalId/index.md) — ### Quire permissions Required capability: `question/view`. Credential scopes: `questions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one questionversion](https://docs.quirelms.com/api/questions/getQuestionVersion/index.md) — ### Quire permissions Required capability: `question/view`. Credential scopes: `questions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List questionbanks deleted since a point in time](https://docs.quirelms.com/api/questions/listQuestionBankDeletions/index.md) — Tombstones of deleted questionbanks, kept for 90 days. Filter by scope_type and scope_id to read one course, category or activity without tenant-wide question access. Tombstones without a recoverable scope require tenant-wide access. ### Quire permissions Required capability: `question/view`. Credential scopes: `questions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List questionbanks](https://docs.quirelms.com/api/questions/listQuestionBanks/index.md) — Question banks, at the tenant, a category, a course or a quiz. ### Quire permissions Required capability: `question/view`. Credential scopes: `questions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List questions deleted since a point in time](https://docs.quirelms.com/api/questions/listQuestionDeletions/index.md) — Tombstones of deleted questions, kept for 90 days. Filter by scope_type and scope_id to read one course, category or activity without tenant-wide question access. Tombstones without a recoverable scope require tenant-wide access. ### Quire permissions Required capability: `question/view`. Credential scopes: `questions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List questionversions](https://docs.quirelms.com/api/questions/listQuestionVersions/index.md) — Cursor-paged immutable question content history. The learner-facing stem and marking defaults are readable with question/view; answer payloads, hints and feedback are withheld and the author-only answer-key operation is separate. ### Quire permissions Required capability: `question/view`. Credential scopes: `questions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List questions](https://docs.quirelms.com/api/questions/listQuestions/index.md) — Questions in the bank. The content is versioned; `latest_version_id` and `ready_version_id` name the versions. ### Quire permissions Required capability: `question/view`. Credential scopes: `questions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read a question version answer key](https://docs.quirelms.com/api/questions/readQuestionVersionAnswers/index.md) — Returns the stored answer payload only to a person who can edit the question: question/edit_own for their own question or question/edit_any for another author’s question. ### Quire permissions Credential scopes: `questions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Update a question](https://docs.quirelms.com/api/questions/updateQuestion/index.md) — Fields absent from the body are left as they are. ### Quire permissions Credential scopes: `questions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update a questionbank](https://docs.quirelms.com/api/questions/updateQuestionBank/index.md) — Fields absent from the body are left as they are. ### Quire permissions Credential scopes: `questions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a question by external identifier](https://docs.quirelms.com/api/questions/upsertQuestion/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Credential scopes: `questions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a questionbank by external identifier](https://docs.quirelms.com/api/questions/upsertQuestionBank/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Credential scopes: `questions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one quizattempt](https://docs.quirelms.com/api/quiz_attempts/getQuizAttempt/index.md) — ### Quire permissions Required capability: `grade/viewhidden`. Credential scopes: `quiz_attempts:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one quizattempt by external identifier](https://docs.quirelms.com/api/quiz_attempts/getQuizAttemptByExternalId/index.md) — ### Quire permissions Required capability: `grade/viewhidden`. Credential scopes: `quiz_attempts:read`. The acting subject must also be allowed to perform this action in the organisation. - [Mark one response in a finished attempt](https://docs.quirelms.com/api/quiz_attempts/gradeResponseQuizAttempt/index.md) — The grader's own mark for a question, with an optional comment, as the quiz report's manual grading does: the attempt total and the gradebook follow, and the change is audited. ### Quire permissions Required capability: `quiz/grade`. Credential scopes: `quiz_attempts:write`. The acting subject must also be allowed to perform this action in the organisation. - [List quizattempts deleted since a point in time](https://docs.quirelms.com/api/quiz_attempts/listQuizAttemptDeletions/index.md) — Tombstones of deleted quizattempts, kept for 90 days. ### Quire permissions Required capability: `grade/viewhidden`. Credential scopes: `quiz_attempts:read`. The acting subject must also be allowed to perform this action in the organisation. - [List quizattempts](https://docs.quirelms.com/api/quiz_attempts/listQuizAttempts/index.md) — Quiz attempts with their state, timing and total mark. Previews are excluded. ### Quire permissions Required capability: `grade/viewhidden`. Credential scopes: `quiz_attempts:read`. The acting subject must also be allowed to perform this action in the organisation. - [Set the accommodation of the attempt's person on this quiz](https://docs.quirelms.com/api/quiz_attempts/overrideQuizAttempt/index.md) — Replaces the person's own accommodation on the quiz (a different opening or closing time, time limit or number of attempts), creating it when there is none. The body is the whole accommodation: a field left out or null falls back to the quiz's own setting. Open attempts of the person have their deadline recalculated, and the change is audited. ### Quire permissions Required capability: `quiz/manage`. Credential scopes: `quiz_attempts:write`. The acting subject must also be allowed to perform this action in the organisation. - [Remove the accommodation of the attempt's person on this quiz](https://docs.quirelms.com/api/quiz_attempts/removeOverrideQuizAttempt/index.md) — Deletes the person's own accommodation so the quiz's settings apply again, and recalculates the deadline of their open attempts. A person with no accommodation of their own is a conflict. A group accommodation is not touched. ### Quire permissions Required capability: `quiz/manage`. Credential scopes: `quiz_attempts:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 reportschedule operations](https://docs.quirelms.com/api/reports/bulkReportSchedules/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `report/schedule`. Credential scopes: `reports:write`. The acting subject must also be allowed to perform this action in the organisation. - [Schedule a saved report for delivery](https://docs.quirelms.com/api/reports/createReportSchedule/index.md) — ### Quire permissions Required capability: `report/schedule`. Credential scopes: `reports:write`. The acting subject must also be allowed to perform this action in the organisation. - [Stop a report schedule](https://docs.quirelms.com/api/reports/deleteReportSchedule/index.md) — ### Quire permissions Required capability: `report/schedule`. Credential scopes: `reports:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one activitylog](https://docs.quirelms.com/api/reports/getActivityLog/index.md) — ### Quire permissions Required capability: `report/view`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one aiusage](https://docs.quirelms.com/api/reports/getAiUsage/index.md) — ### Quire permissions Required capability: `ai/configure`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one report](https://docs.quirelms.com/api/reports/getReport/index.md) — ### Quire permissions Required capability: `report/view`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one report by external identifier](https://docs.quirelms.com/api/reports/getReportByExternalId/index.md) — ### Quire permissions Required capability: `report/view`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one reportrun](https://docs.quirelms.com/api/reports/getReportRun/index.md) — ### Quire permissions Required capability: `report/viewAudit`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one reportrun by external identifier](https://docs.quirelms.com/api/reports/getReportRunByExternalId/index.md) — ### Quire permissions Required capability: `report/viewAudit`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one reportschedule](https://docs.quirelms.com/api/reports/getReportSchedule/index.md) — ### Quire permissions Required capability: `report/schedule`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one reportschedule by external identifier](https://docs.quirelms.com/api/reports/getReportScheduleByExternalId/index.md) — ### Quire permissions Required capability: `report/schedule`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one visible SCORM attempt result](https://docs.quirelms.com/api/reports/getScormAttempt/index.md) — ### Quire permissions Required capability: `scorm/view_reports`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [List ai usage records](https://docs.quirelms.com/api/reports/listAIUsageRecords/index.md) — Tenant AI usage and cost records. Actor, request, and interaction identifiers are omitted, and prompts and responses are not joined. Settled time is the change timestamp; usage rows have no deletion feed. ### Quire permissions Required capability: `ai/configure`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [List activitylogs](https://docs.quirelms.com/api/reports/listCourseActivityLogs/index.md) — Course-scoped learning events from the tenant-filtered reporting view. Event time is the changed-since timestamp; actor and object identifiers, session data, event metadata, and result payloads are omitted. The append-only stream has no per-event deletion feed. ### Quire permissions Required capability: `report/view`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [List reports deleted since a point in time](https://docs.quirelms.com/api/reports/listReportDeletions/index.md) — Tombstones of deleted reports, kept for 90 days. ### Quire permissions Required capability: `report/viewAudit`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [List reportruns deleted since a point in time](https://docs.quirelms.com/api/reports/listReportRunDeletions/index.md) — Tombstones of deleted reportruns, kept for 90 days. ### Quire permissions Required capability: `report/viewAudit`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [List reportruns](https://docs.quirelms.com/api/reports/listReportRuns/index.md) — The record of each time a report ran: who, how long, how many rows, and whether it came from cache. ### Quire permissions Required capability: `report/viewAudit`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [List reportschedules deleted since a point in time](https://docs.quirelms.com/api/reports/listReportScheduleDeletions/index.md) — Tombstones of deleted reportschedules, kept for 90 days. ### Quire permissions Required capability: `report/viewAudit`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [List reportschedules](https://docs.quirelms.com/api/reports/listReportSchedules/index.md) — Recurring report deliveries, including recurrence, recipients, and the last delivery result. ### Quire permissions Required capability: `report/schedule`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [List reports](https://docs.quirelms.com/api/reports/listReports/index.md) — Saved report definitions, stock and custom. ### Quire permissions Required capability: `report/view`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [List visible SCORM attempt results for one activity](https://docs.quirelms.com/api/reports/listScormAttempts/index.md) — Returns grade-related attempt summaries visible to the caller in this activity. updated_since returns changed live attempts; run a full collection walk to reconcile deleted attempts. SCORM runtime data, learner responses, and launch credentials are excluded. ### Quire permissions Required capability: `scorm/view_reports`. Credential scopes: `reports:read`. The acting subject must also be allowed to perform this action in the organisation. - [Send this report schedule now](https://docs.quirelms.com/api/reports/sendNowReportSchedule/index.md) — ### Quire permissions Required capability: `report/schedule`. Credential scopes: `reports:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a report schedule](https://docs.quirelms.com/api/reports/updateReportSchedule/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `report/schedule`. Credential scopes: `reports:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or reconcile a report schedule by external identifier](https://docs.quirelms.com/api/reports/upsertReportSchedule/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `report/schedule`. Credential scopes: `reports:write`. The acting subject must also be allowed to perform this action in the organisation. - [Assign an authorization role](https://docs.quirelms.com/api/roles/assignPlatformAuthorizationRole/index.md) — Assigns a role to an account at platform or tenant context after checking the live assignment matrix and capability intersection. ### Quire permissions Required capability: `platform/roles_assign`. Credential scopes: `roles:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 roleassignment operations](https://docs.quirelms.com/api/roles/bulkRoleAssignments/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `role/assign`. Credential scopes: `roles:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a platform role capability](https://docs.quirelms.com/api/roles/changePlatformRoleCapability/index.md) — Changes one platform capability on a role and enforces owner and administrator lockout protections. ### Quire permissions Required capability: `platform/roles_manage`. Credential scopes: `roles:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a platform role assignment matrix](https://docs.quirelms.com/api/roles/changePlatformRoleMatrix/index.md) — Replaces the roles a role may assign or switch to, subject to platform role-management authorization. ### Quire permissions Required capability: `platform/roles_manage`. Credential scopes: `roles:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a platform role context override](https://docs.quirelms.com/api/roles/changePlatformRoleOverride/index.md) — Changes a role permission at the platform or a tenant context after resolving the tenant-owned context path. ### Quire permissions Required capability: `platform/roles_manage`. Credential scopes: `roles:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a platform authorization role](https://docs.quirelms.com/api/roles/createPlatformAuthorizationRole/index.md) — Creates a custom platform role after checking the acting owner's permissions and administrator lockout rules. Requires an idempotency key. ### Quire permissions Required capability: `platform/roles_manage`. Credential scopes: `roles:write`. The acting subject must also be allowed to perform this action in the organisation. - [Give a person a role at a context](https://docs.quirelms.com/api/roles/createRoleAssignment/index.md) — ### Quire permissions Required capability: `role/assign`. Credential scopes: `roles:write`. The acting subject must also be allowed to perform this action in the organisation. - [Take a role away](https://docs.quirelms.com/api/roles/deleteRoleAssignment/index.md) — ### Quire permissions Required capability: `role/assign`. Credential scopes: `roles:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one context](https://docs.quirelms.com/api/roles/getContext/index.md) — ### Quire permissions Required capability: `role/review`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one role](https://docs.quirelms.com/api/roles/getRole/index.md) — ### Quire permissions Required capability: `user/view`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one roleassignment](https://docs.quirelms.com/api/roles/getRoleAssignment/index.md) — ### Quire permissions Required capability: `user/view`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one roleassignment by external identifier](https://docs.quirelms.com/api/roles/getRoleAssignmentByExternalId/index.md) — ### Quire permissions Required capability: `user/view`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one role by external identifier](https://docs.quirelms.com/api/roles/getRoleByExternalId/index.md) — ### Quire permissions Required capability: `user/view`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one rolecapability](https://docs.quirelms.com/api/roles/getRoleCapability/index.md) — ### Quire permissions Required capability: `role/review`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [Grant a platform operator role](https://docs.quirelms.com/api/roles/grantPlatformOperatorRole/index.md) — Grants or changes a person's legacy operator or owner role. Self-removal is refused. Requires platform role-assignment capability and an idempotency key. ### Quire permissions Required capability: `platform/roles_assign`. Credential scopes: `roles:write`. The acting subject must also be allowed to perform this action in the organisation. - [List contexts deleted since a point in time](https://docs.quirelms.com/api/roles/listContextDeletions/index.md) — Tombstones of deleted contexts, kept for 90 days. ### Quire permissions Required capability: `role/review`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [List contexts](https://docs.quirelms.com/api/roles/listContexts/index.md) — Tenant authorization contexts used by role assignments and overrides. A parent link is included only when the parent context belongs to the same tenant; materialised ancestry paths are private. ### Quire permissions Required capability: `role/review`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [List platform authorization roles](https://docs.quirelms.com/api/roles/listPlatformAuthorizationRoles/index.md) — Returns platform role definitions, capability permissions, context overrides, and assignable and switchable role matrices. Requires platform role-management capability. ### Quire permissions Required capability: `platform/roles_manage`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [List platform operators](https://docs.quirelms.com/api/roles/listPlatformOperators/index.md) — Returns platform operator names, email addresses, role names and assignment dates. Requires platform role-management capability. ### Quire permissions Required capability: `platform/roles_manage`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [List roleassignments deleted since a point in time](https://docs.quirelms.com/api/roles/listRoleAssignmentDeletions/index.md) — Tombstones of deleted roleassignments, kept for 90 days. ### Quire permissions Required capability: `user/view`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [List roleassignments](https://docs.quirelms.com/api/roles/listRoleAssignments/index.md) — Who holds which role where. `context_kind` and `context_ref_id` name the tenant, category, course or activity the role applies at. Assigning or removing a role is a permission change: it needs the privileged roles:write scope and role/assign at that context. ### Quire permissions Required capability: `user/view`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [List rolecapabilities](https://docs.quirelms.com/api/roles/listRoleCapabilities/index.md) — The explicit tenant role permission rows. The stable UUIDv8 id is derived from the role and capability pair; permission values are stored overrides, not the effective result of context inheritance. ### Quire permissions Required capability: `role/review`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [List rolecapabilities deleted since a point in time](https://docs.quirelms.com/api/roles/listRoleCapabilityDeletions/index.md) — Tombstones of deleted rolecapabilities, kept for 90 days. ### Quire permissions Required capability: `role/review`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [List roles deleted since a point in time](https://docs.quirelms.com/api/roles/listRoleDeletions/index.md) — Tombstones of deleted roles, kept for 90 days. ### Quire permissions Required capability: `user/view`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [List roles](https://docs.quirelms.com/api/roles/listRoles/index.md) — The roles defined in this organisation, each derived from an archetype. ### Quire permissions Required capability: `user/view`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [Remove a platform operator role](https://docs.quirelms.com/api/roles/removePlatformOperatorRole/index.md) — Removes a person's platform operator assignment. Operators cannot remove their own role. Requires platform role-assignment capability. ### Quire permissions Required capability: `platform/roles_assign`. Credential scopes: `roles:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Search accounts for platform role assignment](https://docs.quirelms.com/api/roles/searchPlatformOperatorAccounts/index.md) — Searches by account name or email and returns at most 20 matching identities. Requires platform role-assignment capability. ### Quire permissions Required capability: `platform/roles_assign`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [Search platform role override contexts](https://docs.quirelms.com/api/roles/searchPlatformRoleContexts/index.md) — Searches existing tenant, category, course, activity or user authorization contexts by a two-character-or-longer label query. Non-tenant searches require a tenant. Returns at most 20 minimal selector records and requires platform role-management capability. ### Quire permissions Required capability: `platform/roles_manage`. Credential scopes: `roles:read`. The acting subject must also be allowed to perform this action in the organisation. - [Give a person a role by external identifier, or return the assignment that has it](https://docs.quirelms.com/api/roles/upsertRoleAssignment/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `role/assign`. Credential scopes: `roles:write`. The acting subject must also be allowed to perform this action in the organisation. - [Problem](https://docs.quirelms.com/api/schemas/Problem/index.md) — An RFC 9457 problem document. `code` is the stable identifier to switch on; `category` is the taxonomy member to bucket on when the code is not recognised. - [Approve a database record](https://docs.quirelms.com/api/submissions/approveDatabaseRecord/index.md) — ### Quire permissions Required capability: `dbmod/approve`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 databaserecord operations](https://docs.quirelms.com/api/submissions/bulkDatabaseRecords/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `dbmod/write`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 workshopsubmission operations](https://docs.quirelms.com/api/submissions/bulkWorkshopSubmissions/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `workshop/manage`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a record to a database](https://docs.quirelms.com/api/submissions/createDatabaseRecord/index.md) — ### Quire permissions Required capability: `dbmod/write`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a teacher's example submission to a workshop](https://docs.quirelms.com/api/submissions/createWorkshopSubmission/index.md) — ### Quire permissions Required capability: `workshop/manage`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a database record](https://docs.quirelms.com/api/submissions/deleteDatabaseRecord/index.md) — ### Quire permissions Required capability: `dbmod/write`. Credential scopes: `submissions:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Grant the submitter an extension](https://docs.quirelms.com/api/submissions/extendSubmission/index.md) — Sets a new due date for this person only; null removes an extension. ### Quire permissions Required capability: `assignment/grant_extension`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one attendancelog](https://docs.quirelms.com/api/submissions/getAttendanceLog/index.md) — ### Quire permissions Required capability: `attendance/view_reports`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one attendancelog by external identifier](https://docs.quirelms.com/api/submissions/getAttendanceLogByExternalId/index.md) — ### Quire permissions Required capability: `attendance/view_reports`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one chatmessage](https://docs.quirelms.com/api/submissions/getChatMessage/index.md) — ### Quire permissions Required capability: `chat/moderate`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one checklisttick](https://docs.quirelms.com/api/submissions/getChecklistTick/index.md) — ### Quire permissions Required capability: `checklist/tick_other`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one checklisttick by external identifier](https://docs.quirelms.com/api/submissions/getChecklistTickByExternalId/index.md) — ### Quire permissions Required capability: `checklist/tick_other`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one choiceanswer](https://docs.quirelms.com/api/submissions/getChoiceAnswer/index.md) — ### Quire permissions Required capability: `choice/view_results`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one databaserecord](https://docs.quirelms.com/api/submissions/getDatabaseRecord/index.md) — ### Quire permissions Required capability: `dbmod/manage`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one databaserecord by external identifier](https://docs.quirelms.com/api/submissions/getDatabaseRecordByExternalId/index.md) — ### Quire permissions Required capability: `dbmod/manage`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one facetofaceattendance](https://docs.quirelms.com/api/submissions/getFacetofaceAttendance/index.md) — ### Quire permissions Required capability: `facetoface/take_attendance`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one facetofacesignup](https://docs.quirelms.com/api/submissions/getFacetofaceSignup/index.md) — ### Quire permissions Required capability: `facetoface/manage_sessions`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one facetofacesignup by external identifier](https://docs.quirelms.com/api/submissions/getFacetofaceSignupByExternalId/index.md) — ### Quire permissions Required capability: `facetoface/manage_sessions`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one feedbackresponse](https://docs.quirelms.com/api/submissions/getFeedbackResponse/index.md) — ### Quire permissions Required capability: `feedback/view_responses`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one lessonattempt](https://docs.quirelms.com/api/submissions/getLessonAttempt/index.md) — ### Quire permissions Required capability: `lesson/view_reports`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one lessonattempt by external identifier](https://docs.quirelms.com/api/submissions/getLessonAttemptByExternalId/index.md) — ### Quire permissions Required capability: `lesson/view_reports`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one livesessionattendance](https://docs.quirelms.com/api/submissions/getLivesessionAttendance/index.md) — ### Quire permissions Required capability: `livesession/manage`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one submission](https://docs.quirelms.com/api/submissions/getSubmission/index.md) — ### Quire permissions Required capability: `grade/viewhidden`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one submission by external identifier](https://docs.quirelms.com/api/submissions/getSubmissionByExternalId/index.md) — ### Quire permissions Required capability: `grade/viewhidden`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one workshopassessment](https://docs.quirelms.com/api/submissions/getWorkshopAssessment/index.md) — ### Quire permissions Required capability: `workshop/view_all_assessments`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one workshopassessment by external identifier](https://docs.quirelms.com/api/submissions/getWorkshopAssessmentByExternalId/index.md) — ### Quire permissions Required capability: `workshop/view_all_assessments`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one workshopsubmission](https://docs.quirelms.com/api/submissions/getWorkshopSubmission/index.md) — ### Quire permissions Required capability: `workshop/view_all_assessments`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one workshopsubmission by external identifier](https://docs.quirelms.com/api/submissions/getWorkshopSubmissionByExternalId/index.md) — ### Quire permissions Required capability: `workshop/view_all_assessments`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List attendancelogs](https://docs.quirelms.com/api/submissions/listAttendanceLogs/index.md) — Who was marked with which status at which session, with the remark and who marked them. Requires attendance/view_reports on the activity; filter by activity_id, course_id, session_id or user_id. Temporary users' marks are not served. Hard deletions have no feed. ### Quire permissions Required capability: `attendance/view_reports`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List chatmessages](https://docs.quirelms.com/api/submissions/listChatMessages/index.md) — The messages kept in a chat, including those held for moderation (state pending) and system messages. Every message is returned whichever group conversation it belongs to, so this is a moderator's view: it requires chat/moderate on the activity. A message has no edit time, so updated_at is the time it was sent, and messages older than the chat's retention are removed by the chat itself. Filter by activity_id, course_id, group_id or user_id. Reactions and flags are not served. Hard deletions have no feed. ### Quire permissions Required capability: `chat/moderate`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List checklistticks](https://docs.quirelms.com/api/submissions/listChecklistTicks/index.md) — Who has ticked which teacher item, by the learner, by a teacher, or automatically when the linked activity was completed (source). A learner's own ticks of items they added, and evidence files, are not served. Requires checklist/tick_other on the activity, the permission the module's own tick export needs; filter by activity_id, course_id, item_id or user_id. Hard deletions have no feed. ### Quire permissions Required capability: `checklist/tick_other`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List choiceanswers](https://docs.quirelms.com/api/submissions/listChoiceAnswers/index.md) — Who chose which option. An answer has no identifier of its own, so the id is derived from the activity, the person and the option, and updated_at is the time it was given. The poll's publish_mode and publish_names govern what learners see; a reviewer holding choice/view_results sees every answer, as on the activity's own page. Filter by activity_id or course_id. Hard deletions have no feed. ### Quire permissions Required capability: `choice/view_results`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List databaserecords](https://docs.quirelms.com/api/submissions/listDatabaseRecords/index.md) — Records people added to a database activity. values is an object keyed by database field id. Records waiting for approval are included (approved is false). Requires dbmod/manage on the activity; filter by activity_id or course_id. Hard deletions have no feed. ### Quire permissions Required capability: `dbmod/manage`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List facetofaceattendance](https://docs.quirelms.com/api/submissions/listFacetofaceAttendance/index.md) — Attendance marked at face to face sessions: status, minutes attended and who marked it. The id is derived from the session and the person, and updated_at is the time it was marked. Requires facetoface/take_attendance on the activity; filter by activity_id, course_id, session_id or user_id. Hard deletions have no feed. ### Quire permissions Required capability: `facetoface/take_attendance`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List facetofacesignups](https://docs.quirelms.com/api/submissions/listFacetofaceSignups/index.md) — Sign-ups to face to face sessions: person, state (booked, waitlisted, pending approval and the like), seat or waitlist position, who decided and when. Requires facetoface/manage_sessions on the activity; filter by activity_id, course_id, session_id, user_id or state. A learner sees only their own sign-up on the activity's page, and reads nothing here. Hard deletions have no feed. ### Quire permissions Required capability: `facetoface/manage_sessions`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List feedbackresponses](https://docs.quirelms.com/api/submissions/listFeedbackResponses/index.md) — One row per submitted response, with its answers in values keyed by feedback item id. Requires feedback/view_responses on the activity, the permission the module's own row-level export needs; filter by activity_id or course_id. An anonymous activity's rows carry no person (user_id is null), no group and no time, and are ordered by their random identifier, so the list cannot be lined up with anything else. An activity holding fewer than 5 responses serves none, the same floor as its analysis and CSV export. Responses have no timestamp, so there is no updated_since filter. Hard deletions have no feed. ### Quire permissions Required capability: `feedback/view_responses`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List lessonattempts](https://docs.quirelms.com/api/submissions/listLessonAttempts/index.md) — Lesson attempts with their state, timing and score. The pages seen, the timed branch and each page's responses are not served. Requires lesson/view_reports on the activity; filter by activity_id or course_id. Hard deletions have no feed. ### Quire permissions Required capability: `lesson/view_reports`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List livesessionattendance](https://docs.quirelms.com/api/submissions/listLivesessionAttendance/index.md) — Who attended each meeting, the minutes, and whether the provider reported it or a teacher marked it. The id is derived from the meeting and the person. Requires livesession/manage on the activity, the permission that collects attendance on the activity's page; filter by activity_id, course_id, meeting_id or user_id. Hard deletions have no feed. ### Quire permissions Required capability: `livesession/manage`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List submissions deleted since a point in time](https://docs.quirelms.com/api/submissions/listSubmissionDeletions/index.md) — Tombstones of deleted submissions, kept for 90 days. ### Quire permissions Required capability: `grade/viewhidden`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List submissions](https://docs.quirelms.com/api/submissions/listSubmissions/index.md) — Assignment submissions. `latest` marks the current attempt; earlier attempts are kept. ### Quire permissions Required capability: `grade/viewhidden`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List workshopassessments](https://docs.quirelms.com/api/submissions/listWorkshopAssessments/index.md) — Peer and example assessments of workshop submissions, with the grade given, the grade for the assessment and each dimension's value in fields. The reviewer is named, which a learner never sees; requires workshop/view_all_assessments on the activity. Filter by activity_id or course_id. Hard deletions have no feed. ### Quire permissions Required capability: `workshop/view_all_assessments`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [List workshopsubmissions](https://docs.quirelms.com/api/submissions/listWorkshopSubmissions/index.md) — Workshop submissions, including the teacher's example submissions (is_example, with no author). Requires workshop/view_all_assessments on the activity; filter by activity_id or course_id. Hard deletions have no feed. Writes: a teacher adds example submissions and publishes or withdraws a submission; learners' own submissions are made on the workshop's page. ### Quire permissions Required capability: `workshop/view_all_assessments`. Credential scopes: `submissions:read`. The acting subject must also be allowed to perform this action in the organisation. - [Lock a submission against changes](https://docs.quirelms.com/api/submissions/lockSubmission/index.md) — ### Quire permissions Required capability: `assignment/grade`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Mark a submission](https://docs.quirelms.com/api/submissions/markSubmission/index.md) — Records the mark and feedback the way the marking page does, so the gradebook, the marking workflow and the audit trail behave the same. Only the current attempt that has been handed in can be marked. ### Quire permissions Required capability: `assignment/grade`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Publish a workshop submission so every participant can read it](https://docs.quirelms.com/api/submissions/publishWorkshopSubmission/index.md) — ### Quire permissions Required capability: `workshop/manage`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Reopen a submission for another attempt](https://docs.quirelms.com/api/submissions/reopenSubmission/index.md) — The person's work is kept; the assignment's reopen rules decide whether it is a new attempt or the same one. ### Quire permissions Required capability: `assignment/grade`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Move a submission through the marking workflow](https://docs.quirelms.com/api/submissions/setWorkflowStateSubmission/index.md) — Includes releasing the mark to the learner, when the assignment uses the marking workflow. ### Quire permissions Required capability: `assignment/grade`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Send an approved database record back to waiting for approval](https://docs.quirelms.com/api/submissions/unapproveDatabaseRecord/index.md) — ### Quire permissions Required capability: `dbmod/approve`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Unlock a submission](https://docs.quirelms.com/api/submissions/unlockSubmission/index.md) — ### Quire permissions Required capability: `assignment/grade`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Withdraw a published workshop submission](https://docs.quirelms.com/api/submissions/unpublishWorkshopSubmission/index.md) — ### Quire permissions Required capability: `workshop/manage`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a database record's values](https://docs.quirelms.com/api/submissions/updateDatabaseRecord/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `dbmod/write`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a database record by external identifier](https://docs.quirelms.com/api/submissions/upsertDatabaseRecord/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `dbmod/write`. Credential scopes: `submissions:write`. The acting subject must also be allowed to perform this action in the organisation. - [audit](https://docs.quirelms.com/api/tags/audit/index.md) - [automation](https://docs.quirelms.com/api/tags/automation/index.md) - [calendar](https://docs.quirelms.com/api/tags/calendar/index.md) - [certificates](https://docs.quirelms.com/api/tags/certificates/index.md) - [cohorts](https://docs.quirelms.com/api/tags/cohorts/index.md) - [completions](https://docs.quirelms.com/api/tags/completions/index.md) - [courses](https://docs.quirelms.com/api/tags/courses/index.md) - [email](https://docs.quirelms.com/api/tags/email/index.md) - [enrolments](https://docs.quirelms.com/api/tags/enrolments/index.md) - [files](https://docs.quirelms.com/api/tags/files/index.md) - [forums](https://docs.quirelms.com/api/tags/forums/index.md) - [grades](https://docs.quirelms.com/api/tags/grades/index.md) - [groups](https://docs.quirelms.com/api/tags/groups/index.md) - [integrations](https://docs.quirelms.com/api/tags/integrations/index.md) - [invoices](https://docs.quirelms.com/api/tags/invoices/index.md) - [me](https://docs.quirelms.com/api/tags/me/index.md) - [messages](https://docs.quirelms.com/api/tags/messages/index.md) - [notifications](https://docs.quirelms.com/api/tags/notifications/index.md) - [orders](https://docs.quirelms.com/api/tags/orders/index.md) - [org_units](https://docs.quirelms.com/api/tags/org_units/index.md) - [positions](https://docs.quirelms.com/api/tags/positions/index.md) - [privacy](https://docs.quirelms.com/api/tags/privacy/index.md) - [programs](https://docs.quirelms.com/api/tags/programs/index.md) - [questions](https://docs.quirelms.com/api/tags/questions/index.md) - [quiz_attempts](https://docs.quirelms.com/api/tags/quiz_attempts/index.md) - [reports](https://docs.quirelms.com/api/tags/reports/index.md) - [roles](https://docs.quirelms.com/api/tags/roles/index.md) - [submissions](https://docs.quirelms.com/api/tags/submissions/index.md) - [tenants](https://docs.quirelms.com/api/tags/tenants/index.md) - [users](https://docs.quirelms.com/api/tags/users/index.md) - [webhooks](https://docs.quirelms.com/api/tags/webhooks/index.md) - [Change platform billing account entitlements](https://docs.quirelms.com/api/tenants/actOnPlatformBillingAccount/index.md) — Applies an audited plan, trial, feature or quota change to a billing account. Requires an idempotency key and a reason. ### Quire permissions Required capability: `platform/billing_manage`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Retry or cancel a platform job](https://docs.quirelms.com/api/tenants/actOnPlatformJob/index.md) — Retries a failed job or cancels a pending job through the platform queue service. Requires an idempotency key. ### Quire permissions Required capability: `platform/jobs_manage`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Activate an OAuth client](https://docs.quirelms.com/api/tenants/activateOAuthClient/index.md) — ### Quire permissions Required capability: `oauth/manage_clients`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Add a custom tenant domain](https://docs.quirelms.com/api/tenants/addTenantDomain/index.md) — Starts DNS verification and returns the TXT and CNAME records the tenant must publish. The domain is not active until verification succeeds. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 organisation operations](https://docs.quirelms.com/api/tenants/bulkTenants/index.md) — Needs a platform credential: a key or token whose person holds a platform role, with the privileged tenants:write scope. A credential of an ordinary organisation member is refused whatever its scopes. Each operation runs on its own and reports its own outcome. An Idempotency-Key is required. ### Quire permissions Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Request a plan change](https://docs.quirelms.com/api/tenants/changeTenantPlan/index.md) — Requests an upgrade or downgrade through the billing service. Provider approval links are returned only when the buyer must approve the change; billing-account identifiers and provider references are omitted. Require an idempotency key because the provider may perform a payment operation. ### Quire permissions Required capability: `billing/manage`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a tenant subdomain](https://docs.quirelms.com/api/tenants/changeTenantSubdomain/index.md) — Changes the tenant's Quire subdomain after checking for hostname conflicts. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Register an OAuth client](https://docs.quirelms.com/api/tenants/createOAuthClient/index.md) — Registers a tenant OAuth client. A confidential client secret is returned once and is not included in later reads. ### Quire permissions Required capability: `oauth/manage_clients`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create an organisation with its first administrator](https://docs.quirelms.com/api/tenants/createTenant/index.md) — Needs a platform credential: a key or token whose person holds a platform role, with the privileged tenants:write scope. A credential of an ordinary organisation member is refused whatever its scopes. ### Quire permissions Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create tenant authentication connection](https://docs.quirelms.com/api/tenants/createTenantAuthConnection/index.md) — Creates an OIDC, SAML, LDAP, or social sign-in connection through the existing audited identity service. The submitted secret is write-only and is sealed by the identity service. Requires an idempotency key. ### Quire permissions Required capability: `auth/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Deactivate an OAuth client](https://docs.quirelms.com/api/tenants/deactivateOAuthClient/index.md) — Disables the client and revokes its active access tokens. ### Quire permissions Required capability: `oauth/manage_clients`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Revert a tenant string override](https://docs.quirelms.com/api/tenants/deleteMessageOverride/index.md) — Removes this organisation's wording for one message so the language pack's own wording applies again. The removal appears in /message_overrides/deletions. Refused with 404 when there is no override to remove. Requires an idempotency key. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Delete an OAuth client](https://docs.quirelms.com/api/tenants/deleteOAuthClient/index.md) — Deletes a client and its associated tokens, codes, and consent records. ### Quire permissions Required capability: `oauth/manage_clients`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Schedule an organisation for deletion](https://docs.quirelms.com/api/tenants/deleteTenant/index.md) — Needs a platform credential: a key or token whose person holds a platform role, with the privileged tenants:write scope. A credential of an ordinary organisation member is refused whatever its scopes. Needs tenants:delete and the platform owner role. The organisation is suspended and purged after the retention window, and can be restored until then. ### Quire permissions Credential scopes: `tenants:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete tenant authentication connection](https://docs.quirelms.com/api/tenants/deleteTenantAuthConnection/index.md) — Removes the tenant identity provider connection through the existing audited identity service. Requires an idempotency key. ### Quire permissions Required capability: `auth/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read one messageoverride](https://docs.quirelms.com/api/tenants/getMessageOverride/index.md) — ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one oauthclient](https://docs.quirelms.com/api/tenants/getOAuthClient/index.md) — ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one tenant](https://docs.quirelms.com/api/tenants/getTenant/index.md) — ### Quire permissions Required capability: `tenant/brand`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read tenant AI budget and rate limits](https://docs.quirelms.com/api/tenants/getTenantAiBudget/index.md) — Returns the tenant's AI monthly budget, exhaustion policy, warning thresholds, rate limits, concurrency limits, and tutor retention period. ### Quire permissions Required capability: `ai/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read tenant authentication settings](https://docs.quirelms.com/api/tenants/getTenantAuthSettings/index.md) — Returns the tenant sign-in and multi-factor policy, identity provider connection metadata, and roles. Provider secrets are write-only; the response reports only whether a secret is configured. ### Quire permissions Required capability: `auth/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read tenant branding settings](https://docs.quirelms.com/api/tenants/getTenantBranding/index.md) — Returns allowlisted theme settings, versioned public image URLs and the address of the uploaded display font. Compiled CSS and stored image and font bytes are omitted. ### Quire permissions Required capability: `tenant/brand`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read general tenant configuration](https://docs.quirelms.com/api/tenants/getTenantConfiguration/index.md) — Returns the allowlisted tenant name, subdomain, data region, language and time-zone defaults, and disabled module and feature IDs. Pending domain verification data and arbitrary tenant settings are omitted. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one tenantdomain](https://docs.quirelms.com/api/tenants/getTenantDomain/index.md) — ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read tenant email sender settings](https://docs.quirelms.com/api/tenants/getTenantEmailSettings/index.md) — Returns provider configuration metadata and sender preferences. Credentials are write-only; only a safe configuration summary is returned. ### Quire permissions Required capability: `email/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one tenantsettings](https://docs.quirelms.com/api/tenants/getTenantSettings/index.md) — ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read tenant sign-in page content](https://docs.quirelms.com/api/tenants/getTenantSignInContent/index.md) — Returns allowlisted welcome text, maintenance notice, image description, and a public versioned image URL. Uploaded image bytes are omitted. ### Quire permissions Required capability: `tenant/brand`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read tenant video provider settings](https://docs.quirelms.com/api/tenants/getTenantVideoSettings/index.md) — Returns the deployment provider and tenant-owned provider settings. Stored credentials are write-only; only has_credential is returned. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Install a platform licence](https://docs.quirelms.com/api/tenants/installPlatformLicence/index.md) — Installs an offline-verified licence and applies its plan tier. Requires an idempotency key. The submitted token is never returned. ### Quire permissions Required capability: `platform/licence_manage`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [List message overrides deleted since a point in time](https://docs.quirelms.com/api/tenants/listMessageOverrideDeletions/index.md) — Tombstones of deleted message overrides, kept for 90 days. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List message overrides](https://docs.quirelms.com/api/tenants/listMessageOverrides/index.md) — This organisation's replacements for product wording, per language. `id` is derived from the locale and message identifier, so it is stable across edits of the same override. The editor's identity is not served. Updated-since and hard-deletion feeds support synchronization; reverting an override removes it. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List oauth clients deleted since a point in time](https://docs.quirelms.com/api/tenants/listOAuthClientDeletions/index.md) — Tombstones of deleted oauth clients, kept for 90 days. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List oauth clients](https://docs.quirelms.com/api/tenants/listOAuthClients/index.md) — Tenant OAuth client metadata for administrators. Secret hashes, redirect URIs, service identities, creator identity, and token or consent records are omitted. Updated-since and hard-deletion feeds support credential synchronization. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List an organisation's metered add-ons](https://docs.quirelms.com/api/tenants/listOrganisationAddons/index.md) — A platform credential's view of one organisation's add-ons, budgets and this month's spend. ### Quire permissions Required capability: `platform/tenants_view`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List registered tenant databases](https://docs.quirelms.com/api/tenants/listPlatformDatabases/index.md) — Returns database labels, regions, status and tenant counts. Connection references and credentials are omitted. ### Quire permissions Required capability: `platform/databases_view`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List failed platform jobs](https://docs.quirelms.com/api/tenants/listPlatformFailedJobs/index.md) — Returns failed job identifiers, retry counts and timestamps. Job outputs and payloads are never returned. ### Quire permissions Required capability: `platform/jobs_view`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List platform job queue health](https://docs.quirelms.com/api/tenants/listPlatformJobQueues/index.md) — Returns aggregate waiting, active, failed and completed queue counts without job payloads. ### Quire permissions Required capability: `platform/jobs_view`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List platform plans](https://docs.quirelms.com/api/tenants/listPlatformPlans/index.md) — Returns the platform plan catalogue used when provisioning organisations. Requires both the tenant read scope and the platform tenant-management capability. ### Quire permissions Required capability: `platform/tenants_manage`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List platform usage metering](https://docs.quirelms.com/api/tenants/listPlatformUsage/index.md) — Returns metered account resource totals and estimation flags without payment credentials or tenant personal data. ### Quire permissions Required capability: `platform/usage_view`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List metered add-ons](https://docs.quirelms.com/api/tenants/listTenantAddons/index.md) — Returns video streaming minutes and AI usage for the calling organisation: whether it holds each, its monthly budget, and this month's spend against it. ### Quire permissions Required capability: `billing/manage`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List tenants deleted since a point in time](https://docs.quirelms.com/api/tenants/listTenantDeletions/index.md) — Tombstones of deleted tenants, kept for 90 days. ### Quire permissions Required capability: `tenant/brand`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List tenant domains deleted since a point in time](https://docs.quirelms.com/api/tenants/listTenantDomainDeletions/index.md) — Tombstones of deleted tenant domains, kept for 90 days. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List tenant domains](https://docs.quirelms.com/api/tenants/listTenantDomains/index.md) — Registered domain metadata for the credential's tenant. Pending verification challenges and certificate diagnostics are omitted. Updated-since and hard-deletion feeds support synchronization. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List available plans](https://docs.quirelms.com/api/tenants/listTenantPlans/index.md) — Returns the current tenant's plan and the public plans available to billing administrators. Account identifiers, approval links, invoices, and payment credentials are omitted. ### Quire permissions Required capability: `billing/manage`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List tenant settings](https://docs.quirelms.com/api/tenants/listTenantSettings/index.md) — The organisation's allowlisted general settings, including name, subdomain, data region, language, time zone, and disabled module or feature IDs. Arbitrary tenant settings and pending-domain verification data are not exposed. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [List tenants](https://docs.quirelms.com/api/tenants/listTenants/index.md) — The organisation the credential belongs to. A credential is bound to one tenant, so this collection always holds exactly one; a platform operator manages tenants in the console. ### Quire permissions Required capability: `tenant/brand`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Make a tenant domain primary](https://docs.quirelms.com/api/tenants/makeTenantDomainPrimary/index.md) — Selects a registered tenant address as primary. The current primary address cannot be removed until another address replaces it. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Set a tenant string override](https://docs.quirelms.com/api/tenants/putMessageOverride/index.md) — Creates or replaces this organisation's wording for one catalogue message in one language pack. The value must keep the base message's placeholders; a mismatch is refused and nothing is saved. Requires an idempotency key. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Read platform database health](https://docs.quirelms.com/api/tenants/readPlatformDatabaseHealth/index.md) — Returns database reachability and migration status. Connection references, credentials and raw database errors are omitted. ### Quire permissions Required capability: `platform/databases_view`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read installed platform licence status](https://docs.quirelms.com/api/tenants/readPlatformLicence/index.md) — Returns the installed licence status and public signing key identifiers. Licence tokens and provider or private-key material are never returned. ### Quire permissions Required capability: `platform/licence_view`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read platform overview](https://docs.quirelms.com/api/tenants/readPlatformOverview/index.md) — Returns aggregate tenant, operator, dead-letter and pending-event counts. Requires an active platform operator with console access. ### Quire permissions Required capability: `platform/console_access`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read platform system health](https://docs.quirelms.com/api/tenants/readPlatformSystemHealth/index.md) — Returns every service, queue and dependency check with its state, latency, what was measured and what to do about it. Message ids carry their values so a client can render them in its own language; an English rendering is returned beside them. Connection strings and credentials are omitted. ### Quire permissions Required capability: `platform/health_view`. Credential scopes: `tenants:read`. The acting subject must also be allowed to perform this action in the organisation. - [Register a tenant database](https://docs.quirelms.com/api/tenants/registerPlatformDatabase/index.md) — Registers a database using a server-side secret reference. The reference is write-only and never appears in a response. ### Quire permissions Required capability: `platform/databases_manage`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Reinstate a suspended organisation](https://docs.quirelms.com/api/tenants/reinstateTenant/index.md) — Needs a platform credential: a key or token whose person holds a platform role, with the privileged tenants:write scope. A credential of an ordinary organisation member is refused whatever its scopes. ### Quire permissions Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Detach an organisation's metered add-on](https://docs.quirelms.com/api/tenants/removeOrganisationAddon/index.md) — Detaches the add-on. Usage already counted this month stays in the rollup but is no longer billed. Requires a reason. ### Quire permissions Required capability: `platform/billing_manage`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Remove a tenant domain](https://docs.quirelms.com/api/tenants/removeTenantDomain/index.md) — Removes a pending challenge or a non-primary custom domain. The platform subdomain and current primary are protected. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Rotate an OAuth client secret](https://docs.quirelms.com/api/tenants/rotateSecretOAuthClient/index.md) — Replaces a confidential client's secret and returns the new secret once. ### Quire permissions Required capability: `oauth/manage_clients`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Attach or change an organisation's metered add-on](https://docs.quirelms.com/api/tenants/setOrganisationAddon/index.md) — Attaches the add-on under the billing account that pays for the organisation, or changes it: the quantity the plan includes (null keeps it), the monthly budget (null for no ceiling) and what happens when it is spent. Requires a reason, which the platform audit trail records. ### Quire permissions Required capability: `platform/billing_manage`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Buy, stop or budget a metered add-on](https://docs.quirelms.com/api/tenants/setTenantAddon/index.md) — Buys the add-on with a monthly budget (null for no ceiling) and what happens when it is spent, or stops it when enabled is false. Only the organisation holding the billing account may call this. Audited. ### Quire permissions Required capability: `billing/manage`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Start an audited platform impersonation](https://docs.quirelms.com/api/tenants/startPlatformImpersonation/index.md) — Starts a time-limited tenant session with a required reason and returns its one-time handoff URL. Requires an idempotency key. ### Quire permissions Required capability: `platform/impersonate`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Suspend an organisation](https://docs.quirelms.com/api/tenants/suspendTenant/index.md) — Needs a platform credential: a key or token whose person holds a platform role, with the privileged tenants:write scope. A credential of an ordinary organisation member is refused whatever its scopes. ### Quire permissions Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update an OAuth client](https://docs.quirelms.com/api/tenants/updateOAuthClient/index.md) — Updates a client's name, redirect URIs, grants, scopes, and optional service identity. Narrowing scopes also revokes tokens that carry removed scopes. ### Quire permissions Required capability: `oauth/manage_clients`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update tenant AI budget and rate limits](https://docs.quirelms.com/api/tenants/updateTenantAiBudget/index.md) — Updates the tenant AI monthly budget, exhaustion policy, warnings, usage limits, and tutor retention through the existing audited AI settings service. Requires an idempotency key. ### Quire permissions Required capability: `ai/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update tenant authentication connection](https://docs.quirelms.com/api/tenants/updateTenantAuthConnection/index.md) — Updates an existing tenant identity provider connection through the audited identity service. An empty or omitted secret keeps the stored credential. Requires an idempotency key. ### Quire permissions Required capability: `auth/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update tenant authentication policy](https://docs.quirelms.com/api/tenants/updateTenantAuthSettings/index.md) — Updates sign-in methods, password rules, multi-factor requirements, self-registration, guest access, and session limits through the existing audited tenant authentication service. Requires an idempotency key. ### Quire permissions Required capability: `auth/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update tenant branding settings](https://docs.quirelms.com/api/tenants/updateTenantBranding/index.md) — Updates validated theme settings through the branding service. Optional logo and favicon values are base64 image data, and font_file is a base64 WOFF2 display font of at most 200 KB (it is checked, its metrics read and a metric-matched fallback generated; sending it without font_display selects it, and null removes it). Stored image and font bytes are never returned. Requires an idempotency key. ### Quire permissions Required capability: `tenant/brand`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update general tenant configuration](https://docs.quirelms.com/api/tenants/updateTenantConfiguration/index.md) — Replaces the tenant name, language and time-zone defaults, and disabled module and feature IDs. Other tenant configuration is managed through its dedicated settings resources. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update tenant email sender settings](https://docs.quirelms.com/api/tenants/updateTenantEmailSettings/index.md) — Updates the tenant provider, credentials, sender identity, tracking, and inbound reply policy through the existing validator and audited settings service. Credentials are write-only; an empty provider secret keeps the stored value. Requires an idempotency key. ### Quire permissions Required capability: `email/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update tenant sign-in page content](https://docs.quirelms.com/api/tenants/updateTenantSignInContent/index.md) — Updates the public sign-in page welcome, notice, accessible image description, and optional base64 image through the audited branding service. Image bytes are write-only. Requires an idempotency key. ### Quire permissions Required capability: `tenant/brand`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update a tenant video provider](https://docs.quirelms.com/api/tenants/updateTenantVideoSettings/index.md) — Saves provider settings and an optional credential. Credentials are write-only; omit credential to keep the stored value or pass null to remove it. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create an organisation at an address, or return the one there](https://docs.quirelms.com/api/tenants/upsertTenant/index.md) — Needs a platform credential: a key or token whose person holds a platform role, with the privileged tenants:write scope. A credential of an ordinary organisation member is refused whatever its scopes. The external identifier is the organisation's address, its slug. Answers 201 when it was created and 200 when it was already there. ### Quire permissions Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Verify a tenant domain](https://docs.quirelms.com/api/tenants/verifyTenantDomain/index.md) — Checks the TXT ownership record and registers the domain only after Quire can resolve the expected value. ### Quire permissions Required capability: `tenant/configure`. Credential scopes: `tenants:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 profilefield operations](https://docs.quirelms.com/api/users/bulkProfileFields/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `profilefield/declare`. Credential scopes: `users:write`. The acting subject must also be allowed to perform this action in the organisation. - [Apply up to 500 user operations](https://docs.quirelms.com/api/users/bulkUsers/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `user/invite`. Credential scopes: `users:write`. The acting subject must also be allowed to perform this action in the organisation. - [Declare a profile field](https://docs.quirelms.com/api/users/createProfileField/index.md) — ### Quire permissions Required capability: `profilefield/declare`. Credential scopes: `users:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create a user](https://docs.quirelms.com/api/users/createUser/index.md) — ### Quire permissions Required capability: `user/invite`. Credential scopes: `users:write`. The acting subject must also be allowed to perform this action in the organisation. - [Remove a profile field declaration](https://docs.quirelms.com/api/users/deleteProfileField/index.md) — ### Quire permissions Required capability: `profilefield/remove`. Credential scopes: `users:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Delete a person](https://docs.quirelms.com/api/users/deleteUser/index.md) — ### Quire permissions Required capability: `user/delete`. Credential scopes: `users:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Read one identity](https://docs.quirelms.com/api/users/getIdentity/index.md) — ### Quire permissions Required capability: `user/view`. Credential scopes: `users:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one profilefield](https://docs.quirelms.com/api/users/getProfileField/index.md) — ### Quire permissions Required capability: `profilefield/viewAll`. Credential scopes: `users:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one profilefield by external identifier](https://docs.quirelms.com/api/users/getProfileFieldByExternalId/index.md) — ### Quire permissions Required capability: `profilefield/viewAll`. Credential scopes: `users:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one user](https://docs.quirelms.com/api/users/getUser/index.md) — ### Quire permissions Required capability: `user/view`. Credential scopes: `users:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one user by external identifier](https://docs.quirelms.com/api/users/getUserByExternalId/index.md) — ### Quire permissions Required capability: `user/view`. Credential scopes: `users:read`. The acting subject must also be allowed to perform this action in the organisation. - [List identities deleted since a point in time](https://docs.quirelms.com/api/users/listIdentityDeletions/index.md) — Tombstones of deleted identities, kept for 90 days. The user path parameter scopes results to that person's deletions. Entries contain only the deleted identifier and timestamp. ### Quire permissions Required capability: `user/view`. Credential scopes: `users:read`. The acting subject must also be allowed to perform this action in the organisation. - [List profilefields deleted since a point in time](https://docs.quirelms.com/api/users/listProfileFieldDeletions/index.md) — Tombstones of deleted profilefields, kept for 90 days. ### Quire permissions Required capability: `profilefield/viewAll`. Credential scopes: `users:read`. The acting subject must also be allowed to perform this action in the organisation. - [List profilefields](https://docs.quirelms.com/api/users/listProfileFields/index.md) — Custom profile field definitions. Field settings and profile values are not served. ### Quire permissions Required capability: `profilefield/viewAll`. Credential scopes: `users:read`. The acting subject must also be allowed to perform this action in the organisation. - [List users deleted since a point in time](https://docs.quirelms.com/api/users/listUserDeletions/index.md) — Tombstones of deleted users, kept for 90 days. ### Quire permissions Required capability: `user/view`. Credential scopes: `users:read`. The acting subject must also be allowed to perform this action in the organisation. - [List identities](https://docs.quirelms.com/api/users/listUserIdentities/index.md) — Linked sign-in provider metadata for a person in this organisation. Provider subjects, tokens, passwords and other credential material are never returned. ### Quire permissions Required capability: `user/view`. Credential scopes: `users:read`. The acting subject must also be allowed to perform this action in the organisation. - [List users](https://docs.quirelms.com/api/users/listUsers/index.md) — People in this organisation. A person has one credential across organisations and one membership here; the email is the credential, the rest is the membership. ### Quire permissions Required capability: `user/view`. Credential scopes: `users:read`. The acting subject must also be allowed to perform this action in the organisation. - [Reinstate a suspended person](https://docs.quirelms.com/api/users/reinstateUser/index.md) — ### Quire permissions Required capability: `user/suspend`. Credential scopes: `users:write`. The acting subject must also be allowed to perform this action in the organisation. - [Suspend a person](https://docs.quirelms.com/api/users/suspendUser/index.md) — Blocks sign-in, ends their sessions and stops notifications. Nothing they made is changed, and every API key and token they issued stops working. ### Quire permissions Required capability: `user/suspend`. Credential scopes: `users:write`. The acting subject must also be allowed to perform this action in the organisation. - [Change a profile field declaration](https://docs.quirelms.com/api/users/updateProfileField/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `profilefield/update`. Credential scopes: `users:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update a user](https://docs.quirelms.com/api/users/updateUser/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `user/invite`. Credential scopes: `users:write`. The acting subject must also be allowed to perform this action in the organisation. - [Declare or change a profile field by external identifier](https://docs.quirelms.com/api/users/upsertProfileField/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `profilefield/declare`. Credential scopes: `users:write`. The acting subject must also be allowed to perform this action in the organisation. - [Create or update a user by external identifier](https://docs.quirelms.com/api/users/upsertUser/index.md) — The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile. ### Quire permissions Required capability: `user/invite`. Credential scopes: `users:write`. The acting subject must also be allowed to perform this action in the organisation. - [activity.created](https://docs.quirelms.com/api/webhooks/activity.created/index.md) — Delivered when activity.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [activity.deleted](https://docs.quirelms.com/api/webhooks/activity.deleted/index.md) — Delivered when activity.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [activity.moved](https://docs.quirelms.com/api/webhooks/activity.moved/index.md) — Delivered when activity.moved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [activity.updated](https://docs.quirelms.com/api/webhooks/activity.updated/index.md) — Delivered when activity.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [activity_completion.changed](https://docs.quirelms.com/api/webhooks/activity_completion.changed/index.md) — Delivered when activity_completion.changed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [assignment_extension.granted](https://docs.quirelms.com/api/webhooks/assignment_extension.granted/index.md) — Delivered when assignment_extension.granted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [assignment_identities.revealed](https://docs.quirelms.com/api/webhooks/assignment_identities.revealed/index.md) — Delivered when assignment_identities.revealed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [assignment_submission.graded](https://docs.quirelms.com/api/webhooks/assignment_submission.graded/index.md) — Delivered when assignment_submission.graded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [assignment_submission.reopened](https://docs.quirelms.com/api/webhooks/assignment_submission.reopened/index.md) — Delivered when assignment_submission.reopened occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [assignment_submission.submitted](https://docs.quirelms.com/api/webhooks/assignment_submission.submitted/index.md) — Delivered when assignment_submission.submitted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [assignment_workflow.changed](https://docs.quirelms.com/api/webhooks/assignment_workflow.changed/index.md) — Delivered when assignment_workflow.changed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [badge.awarded](https://docs.quirelms.com/api/webhooks/badge.awarded/index.md) — Delivered when badge.awarded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [badge.revoked](https://docs.quirelms.com/api/webhooks/badge.revoked/index.md) — Delivered when badge.revoked occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [blog_entry.published](https://docs.quirelms.com/api/webhooks/blog_entry.published/index.md) — Delivered when blog_entry.published occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [book_chapter.viewed](https://docs.quirelms.com/api/webhooks/book_chapter.viewed/index.md) — Delivered when book_chapter.viewed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [Apply up to 500 webhooksubscription operations](https://docs.quirelms.com/api/webhooks/bulkWebhookSubscriptions/index.md) — Each operation runs in its own transaction and reports its own outcome; the response is 200 with a summary and one result per operation. With atomic true, up to 100 operations run in one transaction and the first failure fails them all. An Idempotency-Key is required. ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:write`. The acting subject must also be allowed to perform this action in the organisation. - [bulk_action.finished](https://docs.quirelms.com/api/webhooks/bulk_action.finished/index.md) — Delivered when bulk_action.finished occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [bulk_action.started](https://docs.quirelms.com/api/webhooks/bulk_action.started/index.md) — Delivered when bulk_action.started occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [bulk_operation.completed](https://docs.quirelms.com/api/webhooks/bulk_operation.completed/index.md) — Delivered when bulk_operation.completed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [bulk_operation.failed](https://docs.quirelms.com/api/webhooks/bulk_operation.failed/index.md) — Delivered when bulk_operation.failed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [bulk_operation.progressed](https://docs.quirelms.com/api/webhooks/bulk_operation.progressed/index.md) — Delivered when bulk_operation.progressed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [bulk_operation.started](https://docs.quirelms.com/api/webhooks/bulk_operation.started/index.md) — Delivered when bulk_operation.started occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [calendar_connection.created](https://docs.quirelms.com/api/webhooks/calendar_connection.created/index.md) — Delivered when calendar_connection.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [calendar_connection.failed](https://docs.quirelms.com/api/webhooks/calendar_connection.failed/index.md) — Delivered when calendar_connection.failed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [calendar_connection.revoked](https://docs.quirelms.com/api/webhooks/calendar_connection.revoked/index.md) — Delivered when calendar_connection.revoked occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [calendar_event.created](https://docs.quirelms.com/api/webhooks/calendar_event.created/index.md) — Delivered when calendar_event.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [calendar_event.deleted](https://docs.quirelms.com/api/webhooks/calendar_event.deleted/index.md) — Delivered when calendar_event.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [calendar_event.updated](https://docs.quirelms.com/api/webhooks/calendar_event.updated/index.md) — Delivered when calendar_event.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [calendar_feed_token.created](https://docs.quirelms.com/api/webhooks/calendar_feed_token.created/index.md) — Delivered when calendar_feed_token.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [calendar_feed_token.revoked](https://docs.quirelms.com/api/webhooks/calendar_feed_token.revoked/index.md) — Delivered when calendar_feed_token.revoked occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [calendar_sync.conflict_resolved](https://docs.quirelms.com/api/webhooks/calendar_sync.conflict_resolved/index.md) — Delivered when calendar_sync.conflict_resolved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [category.created](https://docs.quirelms.com/api/webhooks/category.created/index.md) — Delivered when category.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [category.deleted](https://docs.quirelms.com/api/webhooks/category.deleted/index.md) — Delivered when category.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [category.moved](https://docs.quirelms.com/api/webhooks/category.moved/index.md) — Delivered when category.moved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [category.updated](https://docs.quirelms.com/api/webhooks/category.updated/index.md) — Delivered when category.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [certificate.issued](https://docs.quirelms.com/api/webhooks/certificate.issued/index.md) — Delivered when certificate.issued occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [certificate.reissued](https://docs.quirelms.com/api/webhooks/certificate.reissued/index.md) — Delivered when certificate.reissued occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [certificate.revoked](https://docs.quirelms.com/api/webhooks/certificate.revoked/index.md) — Delivered when certificate.revoked occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [certification.assigned](https://docs.quirelms.com/api/webhooks/certification.assigned/index.md) — Delivered when certification.assigned occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [certification.certified](https://docs.quirelms.com/api/webhooks/certification.certified/index.md) — Delivered when certification.certified occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [certification.expired](https://docs.quirelms.com/api/webhooks/certification.expired/index.md) — Delivered when certification.expired occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [certification.lapsed](https://docs.quirelms.com/api/webhooks/certification.lapsed/index.md) — Delivered when certification.lapsed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [certification.reminded](https://docs.quirelms.com/api/webhooks/certification.reminded/index.md) — Delivered when certification.reminded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [certification.revoked](https://docs.quirelms.com/api/webhooks/certification.revoked/index.md) — Delivered when certification.revoked occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [certification.window_opened](https://docs.quirelms.com/api/webhooks/certification.window_opened/index.md) — Delivered when certification.window_opened occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [choice_answer.recorded](https://docs.quirelms.com/api/webhooks/choice_answer.recorded/index.md) — Delivered when choice_answer.recorded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [cohort.created](https://docs.quirelms.com/api/webhooks/cohort.created/index.md) — Delivered when cohort.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [cohort.deleted](https://docs.quirelms.com/api/webhooks/cohort.deleted/index.md) — Delivered when cohort.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [cohort.rule_recomputed](https://docs.quirelms.com/api/webhooks/cohort.rule_recomputed/index.md) — Delivered when cohort.rule_recomputed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [cohort.updated](https://docs.quirelms.com/api/webhooks/cohort.updated/index.md) — Delivered when cohort.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [cohort_member.added](https://docs.quirelms.com/api/webhooks/cohort_member.added/index.md) — Delivered when cohort_member.added occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [cohort_member.removed](https://docs.quirelms.com/api/webhooks/cohort_member.removed/index.md) — Delivered when cohort_member.removed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [comment.created](https://docs.quirelms.com/api/webhooks/comment.created/index.md) — Delivered when comment.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [comment.deleted](https://docs.quirelms.com/api/webhooks/comment.deleted/index.md) — Delivered when comment.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [comment.updated](https://docs.quirelms.com/api/webhooks/comment.updated/index.md) — Delivered when comment.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [competency.proficiency_achieved](https://docs.quirelms.com/api/webhooks/competency.proficiency_achieved/index.md) — Delivered when competency.proficiency_achieved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [competency.rated](https://docs.quirelms.com/api/webhooks/competency.rated/index.md) — Delivered when competency.rated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course.archived](https://docs.quirelms.com/api/webhooks/course.archived/index.md) — Delivered when course.archived occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course.created](https://docs.quirelms.com/api/webhooks/course.created/index.md) — Delivered when course.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course.deleted](https://docs.quirelms.com/api/webhooks/course.deleted/index.md) — Delivered when course.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course.hidden](https://docs.quirelms.com/api/webhooks/course.hidden/index.md) — Delivered when course.hidden occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course.published](https://docs.quirelms.com/api/webhooks/course.published/index.md) — Delivered when course.published occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course.reset_completed](https://docs.quirelms.com/api/webhooks/course.reset_completed/index.md) — Delivered when course.reset_completed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course.restored_from_bin](https://docs.quirelms.com/api/webhooks/course.restored_from_bin/index.md) — Delivered when course.restored_from_bin occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion.changed](https://docs.quirelms.com/api/webhooks/course_completion.changed/index.md) — Delivered when course_completion.changed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion_request.approved](https://docs.quirelms.com/api/webhooks/course_completion_request.approved/index.md) — Delivered when course_completion_request.approved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion_request.cancelled](https://docs.quirelms.com/api/webhooks/course_completion_request.cancelled/index.md) — Delivered when course_completion_request.cancelled occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion_request.delegated](https://docs.quirelms.com/api/webhooks/course_completion_request.delegated/index.md) — Delivered when course_completion_request.delegated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion_request.expired](https://docs.quirelms.com/api/webhooks/course_completion_request.expired/index.md) — Delivered when course_completion_request.expired occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion_request.fulfilled](https://docs.quirelms.com/api/webhooks/course_completion_request.fulfilled/index.md) — Delivered when course_completion_request.fulfilled occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion_request.rejected](https://docs.quirelms.com/api/webhooks/course_completion_request.rejected/index.md) — Delivered when course_completion_request.rejected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion_request.reminded](https://docs.quirelms.com/api/webhooks/course_completion_request.reminded/index.md) — Delivered when course_completion_request.reminded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion_request.step_activated](https://docs.quirelms.com/api/webhooks/course_completion_request.step_activated/index.md) — Delivered when course_completion_request.step_activated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion_request.step_approved](https://docs.quirelms.com/api/webhooks/course_completion_request.step_approved/index.md) — Delivered when course_completion_request.step_approved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion_request.step_rejected](https://docs.quirelms.com/api/webhooks/course_completion_request.step_rejected/index.md) — Delivered when course_completion_request.step_rejected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion_request.submitted](https://docs.quirelms.com/api/webhooks/course_completion_request.submitted/index.md) — Delivered when course_completion_request.submitted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_completion_request.unrouted](https://docs.quirelms.com/api/webhooks/course_completion_request.unrouted/index.md) — Delivered when course_completion_request.unrouted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_job.completed](https://docs.quirelms.com/api/webhooks/course_job.completed/index.md) — Delivered when course_job.completed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_job.failed](https://docs.quirelms.com/api/webhooks/course_job.failed/index.md) — Delivered when course_job.failed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [course_template.published](https://docs.quirelms.com/api/webhooks/course_template.published/index.md) — Delivered when course_template.published occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [Create a webhooksubscription](https://docs.quirelms.com/api/webhooks/createWebhookSubscription/index.md) — ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:write`. The acting subject must also be allowed to perform this action in the organisation. - [dbmod_record.approval_changed](https://docs.quirelms.com/api/webhooks/dbmod_record.approval_changed/index.md) — Delivered when dbmod_record.approval_changed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [dbmod_record.created](https://docs.quirelms.com/api/webhooks/dbmod_record.created/index.md) — Delivered when dbmod_record.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [Delete a webhooksubscription](https://docs.quirelms.com/api/webhooks/deleteWebhookSubscription/index.md) — ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:delete`. The acting subject must also be allowed to perform this action in the organisation. - [Disable a subscription](https://docs.quirelms.com/api/webhooks/disableWebhookSubscription/index.md) — ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:write`. The acting subject must also be allowed to perform this action in the organisation. - [Enable a subscription](https://docs.quirelms.com/api/webhooks/enableWebhookSubscription/index.md) — A subscription that never acknowledged its ping is sent another, and enables when the endpoint answers. ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:write`. The acting subject must also be allowed to perform this action in the organisation. - [enrolment.created](https://docs.quirelms.com/api/webhooks/enrolment.created/index.md) — Delivered when enrolment.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment.deleted](https://docs.quirelms.com/api/webhooks/enrolment.deleted/index.md) — Delivered when enrolment.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment.expired](https://docs.quirelms.com/api/webhooks/enrolment.expired/index.md) — Delivered when enrolment.expired occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment.reactivated](https://docs.quirelms.com/api/webhooks/enrolment.reactivated/index.md) — Delivered when enrolment.reactivated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment.started](https://docs.quirelms.com/api/webhooks/enrolment.started/index.md) — Delivered when enrolment.started occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment.suspended](https://docs.quirelms.com/api/webhooks/enrolment.suspended/index.md) — Delivered when enrolment.suspended occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment.updated](https://docs.quirelms.com/api/webhooks/enrolment.updated/index.md) — Delivered when enrolment.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_method.created](https://docs.quirelms.com/api/webhooks/enrolment_method.created/index.md) — Delivered when enrolment_method.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_method.deleted](https://docs.quirelms.com/api/webhooks/enrolment_method.deleted/index.md) — Delivered when enrolment_method.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_method.disabled](https://docs.quirelms.com/api/webhooks/enrolment_method.disabled/index.md) — Delivered when enrolment_method.disabled occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_method.enabled](https://docs.quirelms.com/api/webhooks/enrolment_method.enabled/index.md) — Delivered when enrolment_method.enabled occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_method.updated](https://docs.quirelms.com/api/webhooks/enrolment_method.updated/index.md) — Delivered when enrolment_method.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_request.approved](https://docs.quirelms.com/api/webhooks/enrolment_request.approved/index.md) — Delivered when enrolment_request.approved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_request.cancelled](https://docs.quirelms.com/api/webhooks/enrolment_request.cancelled/index.md) — Delivered when enrolment_request.cancelled occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_request.delegated](https://docs.quirelms.com/api/webhooks/enrolment_request.delegated/index.md) — Delivered when enrolment_request.delegated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_request.expired](https://docs.quirelms.com/api/webhooks/enrolment_request.expired/index.md) — Delivered when enrolment_request.expired occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_request.fulfilled](https://docs.quirelms.com/api/webhooks/enrolment_request.fulfilled/index.md) — Delivered when enrolment_request.fulfilled occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_request.rejected](https://docs.quirelms.com/api/webhooks/enrolment_request.rejected/index.md) — Delivered when enrolment_request.rejected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_request.reminded](https://docs.quirelms.com/api/webhooks/enrolment_request.reminded/index.md) — Delivered when enrolment_request.reminded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_request.step_activated](https://docs.quirelms.com/api/webhooks/enrolment_request.step_activated/index.md) — Delivered when enrolment_request.step_activated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_request.step_approved](https://docs.quirelms.com/api/webhooks/enrolment_request.step_approved/index.md) — Delivered when enrolment_request.step_approved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_request.step_rejected](https://docs.quirelms.com/api/webhooks/enrolment_request.step_rejected/index.md) — Delivered when enrolment_request.step_rejected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_request.submitted](https://docs.quirelms.com/api/webhooks/enrolment_request.submitted/index.md) — Delivered when enrolment_request.submitted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_request.unrouted](https://docs.quirelms.com/api/webhooks/enrolment_request.unrouted/index.md) — Delivered when enrolment_request.unrouted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_sync.completed](https://docs.quirelms.com/api/webhooks/enrolment_sync.completed/index.md) — Delivered when enrolment_sync.completed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_sync.drift_detected](https://docs.quirelms.com/api/webhooks/enrolment_sync.drift_detected/index.md) — Delivered when enrolment_sync.drift_detected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_sync.failed](https://docs.quirelms.com/api/webhooks/enrolment_sync.failed/index.md) — Delivered when enrolment_sync.failed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [enrolment_sync.halted](https://docs.quirelms.com/api/webhooks/enrolment_sync.halted/index.md) — Delivered when enrolment_sync.halted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [feedback_response.submitted](https://docs.quirelms.com/api/webhooks/feedback_response.submitted/index.md) — Delivered when feedback_response.submitted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [file.created](https://docs.quirelms.com/api/webhooks/file.created/index.md) — Delivered when file.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [file.upload_rejected](https://docs.quirelms.com/api/webhooks/file.upload_rejected/index.md) — Delivered when file.upload_rejected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [forum_discussion.created](https://docs.quirelms.com/api/webhooks/forum_discussion.created/index.md) — Delivered when forum_discussion.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [forum_discussion.locked](https://docs.quirelms.com/api/webhooks/forum_discussion.locked/index.md) — Delivered when forum_discussion.locked occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [forum_discussion.pinned](https://docs.quirelms.com/api/webhooks/forum_discussion.pinned/index.md) — Delivered when forum_discussion.pinned occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [forum_post.created](https://docs.quirelms.com/api/webhooks/forum_post.created/index.md) — Delivered when forum_post.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [forum_post.deleted](https://docs.quirelms.com/api/webhooks/forum_post.deleted/index.md) — Delivered when forum_post.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [forum_post.updated](https://docs.quirelms.com/api/webhooks/forum_post.updated/index.md) — Delivered when forum_post.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [Read one outboxevent](https://docs.quirelms.com/api/webhooks/getOutboxEvent/index.md) — ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:read`. The acting subject must also be allowed to perform this action in the organisation. - [Inspect a webhook delivery and its signed request](https://docs.quirelms.com/api/webhooks/getWebhookDelivery/index.md) — The signed body is available while its originating event is retained. It and the request headers are shown only to webhook managers. ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one webhooksubscription](https://docs.quirelms.com/api/webhooks/getWebhookSubscription/index.md) — ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:read`. The acting subject must also be allowed to perform this action in the organisation. - [Read one webhooksubscription by external identifier](https://docs.quirelms.com/api/webhooks/getWebhookSubscriptionByExternalId/index.md) — ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:read`. The acting subject must also be allowed to perform this action in the organisation. - [glossary_entry.approval_changed](https://docs.quirelms.com/api/webhooks/glossary_entry.approval_changed/index.md) — Delivered when glossary_entry.approval_changed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [glossary_entry.created](https://docs.quirelms.com/api/webhooks/glossary_entry.created/index.md) — Delivered when glossary_entry.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [grade.overridden](https://docs.quirelms.com/api/webhooks/grade.overridden/index.md) — Delivered when grade.overridden occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [grade.updated](https://docs.quirelms.com/api/webhooks/grade.updated/index.md) — Delivered when grade.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [grade_item.created](https://docs.quirelms.com/api/webhooks/grade_item.created/index.md) — Delivered when grade_item.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [grade_item.deleted](https://docs.quirelms.com/api/webhooks/grade_item.deleted/index.md) — Delivered when grade_item.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [grade_item.updated](https://docs.quirelms.com/api/webhooks/grade_item.updated/index.md) — Delivered when grade_item.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [gradebook.exported](https://docs.quirelms.com/api/webhooks/gradebook.exported/index.md) — Delivered when gradebook.exported occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [gradebook.imported](https://docs.quirelms.com/api/webhooks/gradebook.imported/index.md) — Delivered when gradebook.imported occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [gradebook.recalculated](https://docs.quirelms.com/api/webhooks/gradebook.recalculated/index.md) — Delivered when gradebook.recalculated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [group.created](https://docs.quirelms.com/api/webhooks/group.created/index.md) — Delivered when group.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [group.deleted](https://docs.quirelms.com/api/webhooks/group.deleted/index.md) — Delivered when group.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [group.member_added](https://docs.quirelms.com/api/webhooks/group.member_added/index.md) — Delivered when group.member_added occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [group.member_removed](https://docs.quirelms.com/api/webhooks/group.member_removed/index.md) — Delivered when group.member_removed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [group.self_selection_opened](https://docs.quirelms.com/api/webhooks/group.self_selection_opened/index.md) — Delivered when group.self_selection_opened occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [grouping.created](https://docs.quirelms.com/api/webhooks/grouping.created/index.md) — Delivered when grouping.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [hubspot_deal.stage_changed](https://docs.quirelms.com/api/webhooks/hubspot_deal.stage_changed/index.md) — Delivered when hubspot_deal.stage_changed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [interactive_attempt.completed](https://docs.quirelms.com/api/webhooks/interactive_attempt.completed/index.md) — Delivered when interactive_attempt.completed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [interactive_attempt.started](https://docs.quirelms.com/api/webhooks/interactive_attempt.started/index.md) — Delivered when interactive_attempt.started occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan.approved](https://docs.quirelms.com/api/webhooks/learning_plan.approved/index.md) — Delivered when learning_plan.approved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan.completed](https://docs.quirelms.com/api/webhooks/learning_plan.completed/index.md) — Delivered when learning_plan.completed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan.created](https://docs.quirelms.com/api/webhooks/learning_plan.created/index.md) — Delivered when learning_plan.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_request.approved](https://docs.quirelms.com/api/webhooks/learning_plan_request.approved/index.md) — Delivered when learning_plan_request.approved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_request.cancelled](https://docs.quirelms.com/api/webhooks/learning_plan_request.cancelled/index.md) — Delivered when learning_plan_request.cancelled occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_request.delegated](https://docs.quirelms.com/api/webhooks/learning_plan_request.delegated/index.md) — Delivered when learning_plan_request.delegated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_request.expired](https://docs.quirelms.com/api/webhooks/learning_plan_request.expired/index.md) — Delivered when learning_plan_request.expired occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_request.fulfilled](https://docs.quirelms.com/api/webhooks/learning_plan_request.fulfilled/index.md) — Delivered when learning_plan_request.fulfilled occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_request.rejected](https://docs.quirelms.com/api/webhooks/learning_plan_request.rejected/index.md) — Delivered when learning_plan_request.rejected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_request.reminded](https://docs.quirelms.com/api/webhooks/learning_plan_request.reminded/index.md) — Delivered when learning_plan_request.reminded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_request.step_activated](https://docs.quirelms.com/api/webhooks/learning_plan_request.step_activated/index.md) — Delivered when learning_plan_request.step_activated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_request.step_approved](https://docs.quirelms.com/api/webhooks/learning_plan_request.step_approved/index.md) — Delivered when learning_plan_request.step_approved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_request.step_rejected](https://docs.quirelms.com/api/webhooks/learning_plan_request.step_rejected/index.md) — Delivered when learning_plan_request.step_rejected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_request.submitted](https://docs.quirelms.com/api/webhooks/learning_plan_request.submitted/index.md) — Delivered when learning_plan_request.submitted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_request.unrouted](https://docs.quirelms.com/api/webhooks/learning_plan_request.unrouted/index.md) — Delivered when learning_plan_request.unrouted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_waiver_request.approved](https://docs.quirelms.com/api/webhooks/learning_plan_waiver_request.approved/index.md) — Delivered when learning_plan_waiver_request.approved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_waiver_request.cancelled](https://docs.quirelms.com/api/webhooks/learning_plan_waiver_request.cancelled/index.md) — Delivered when learning_plan_waiver_request.cancelled occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_waiver_request.delegated](https://docs.quirelms.com/api/webhooks/learning_plan_waiver_request.delegated/index.md) — Delivered when learning_plan_waiver_request.delegated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_waiver_request.expired](https://docs.quirelms.com/api/webhooks/learning_plan_waiver_request.expired/index.md) — Delivered when learning_plan_waiver_request.expired occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_waiver_request.fulfilled](https://docs.quirelms.com/api/webhooks/learning_plan_waiver_request.fulfilled/index.md) — Delivered when learning_plan_waiver_request.fulfilled occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_waiver_request.rejected](https://docs.quirelms.com/api/webhooks/learning_plan_waiver_request.rejected/index.md) — Delivered when learning_plan_waiver_request.rejected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_waiver_request.reminded](https://docs.quirelms.com/api/webhooks/learning_plan_waiver_request.reminded/index.md) — Delivered when learning_plan_waiver_request.reminded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_waiver_request.step_activated](https://docs.quirelms.com/api/webhooks/learning_plan_waiver_request.step_activated/index.md) — Delivered when learning_plan_waiver_request.step_activated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_waiver_request.step_approved](https://docs.quirelms.com/api/webhooks/learning_plan_waiver_request.step_approved/index.md) — Delivered when learning_plan_waiver_request.step_approved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_waiver_request.step_rejected](https://docs.quirelms.com/api/webhooks/learning_plan_waiver_request.step_rejected/index.md) — Delivered when learning_plan_waiver_request.step_rejected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_waiver_request.submitted](https://docs.quirelms.com/api/webhooks/learning_plan_waiver_request.submitted/index.md) — Delivered when learning_plan_waiver_request.submitted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [learning_plan_waiver_request.unrouted](https://docs.quirelms.com/api/webhooks/learning_plan_waiver_request.unrouted/index.md) — Delivered when learning_plan_waiver_request.unrouted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [lesson_attempt.completed](https://docs.quirelms.com/api/webhooks/lesson_attempt.completed/index.md) — Delivered when lesson_attempt.completed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [lesson_attempt.started](https://docs.quirelms.com/api/webhooks/lesson_attempt.started/index.md) — Delivered when lesson_attempt.started occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [Recent payloads of one event, for mapping fields](https://docs.quirelms.com/api/webhooks/listHookSamples/index.md) — Up to three of the most recent events of that type in this organisation, newest first, in the delivered data shape. When there are none yet, the catalog example is returned so the editor always has something to map. ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:read`. The acting subject must also be allowed to perform this action in the organisation. - [List outboxevents](https://docs.quirelms.com/api/webhooks/listOutboxEvents/index.md) — Tenant event dispatch status. Event payloads, actor context, ordering keys, and subscriber error details are not served. ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:read`. The acting subject must also be allowed to perform this action in the organisation. - [List the delivery history of a webhook subscription](https://docs.quirelms.com/api/webhooks/listWebhookDeliveries/index.md) — The latest thirty days of attempts, filtered by event type, status, or time. updated_since uses the immutable delivery time. ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:read`. The acting subject must also be allowed to perform this action in the organisation. - [List webhooksubscriptions deleted since a point in time](https://docs.quirelms.com/api/webhooks/listWebhookSubscriptionDeletions/index.md) — Tombstones of deleted webhooksubscriptions, kept for 90 days. ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:read`. The acting subject must also be allowed to perform this action in the organisation. - [List webhooksubscriptions](https://docs.quirelms.com/api/webhooks/listWebhookSubscriptions/index.md) — Where signed event deliveries go. A new subscription is sent a webhook.ping and stays disabled until the endpoint acknowledges it, which catches a mistyped URL when it is configured rather than at the first real event. At most 25 per organisation. ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:read`. The acting subject must also be allowed to perform this action in the organisation. - [manager.assigned](https://docs.quirelms.com/api/webhooks/manager.assigned/index.md) — Delivered when manager.assigned occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [manager.removed](https://docs.quirelms.com/api/webhooks/manager.removed/index.md) — Delivered when manager.removed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [notification.created](https://docs.quirelms.com/api/webhooks/notification.created/index.md) — Delivered when notification.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [orgunit.created](https://docs.quirelms.com/api/webhooks/orgunit.created/index.md) — Delivered when orgunit.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [orgunit.deleted](https://docs.quirelms.com/api/webhooks/orgunit.deleted/index.md) — Delivered when orgunit.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [orgunit.moved](https://docs.quirelms.com/api/webhooks/orgunit.moved/index.md) — Delivered when orgunit.moved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [orgunit.updated](https://docs.quirelms.com/api/webhooks/orgunit.updated/index.md) — Delivered when orgunit.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [package.extracted](https://docs.quirelms.com/api/webhooks/package.extracted/index.md) — Delivered when package.extracted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [package.rejected](https://docs.quirelms.com/api/webhooks/package.rejected/index.md) — Delivered when package.rejected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [position.assigned](https://docs.quirelms.com/api/webhooks/position.assigned/index.md) — Delivered when position.assigned occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [position.unassigned](https://docs.quirelms.com/api/webhooks/position.unassigned/index.md) — Delivered when position.unassigned occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning.decided](https://docs.quirelms.com/api/webhooks/prior_learning.decided/index.md) — Delivered when prior_learning.decided occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning.submitted](https://docs.quirelms.com/api/webhooks/prior_learning.submitted/index.md) — Delivered when prior_learning.submitted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning_request.approved](https://docs.quirelms.com/api/webhooks/prior_learning_request.approved/index.md) — Delivered when prior_learning_request.approved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning_request.cancelled](https://docs.quirelms.com/api/webhooks/prior_learning_request.cancelled/index.md) — Delivered when prior_learning_request.cancelled occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning_request.delegated](https://docs.quirelms.com/api/webhooks/prior_learning_request.delegated/index.md) — Delivered when prior_learning_request.delegated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning_request.expired](https://docs.quirelms.com/api/webhooks/prior_learning_request.expired/index.md) — Delivered when prior_learning_request.expired occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning_request.fulfilled](https://docs.quirelms.com/api/webhooks/prior_learning_request.fulfilled/index.md) — Delivered when prior_learning_request.fulfilled occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning_request.rejected](https://docs.quirelms.com/api/webhooks/prior_learning_request.rejected/index.md) — Delivered when prior_learning_request.rejected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning_request.reminded](https://docs.quirelms.com/api/webhooks/prior_learning_request.reminded/index.md) — Delivered when prior_learning_request.reminded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning_request.step_activated](https://docs.quirelms.com/api/webhooks/prior_learning_request.step_activated/index.md) — Delivered when prior_learning_request.step_activated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning_request.step_approved](https://docs.quirelms.com/api/webhooks/prior_learning_request.step_approved/index.md) — Delivered when prior_learning_request.step_approved occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning_request.step_rejected](https://docs.quirelms.com/api/webhooks/prior_learning_request.step_rejected/index.md) — Delivered when prior_learning_request.step_rejected occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning_request.submitted](https://docs.quirelms.com/api/webhooks/prior_learning_request.submitted/index.md) — Delivered when prior_learning_request.submitted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [prior_learning_request.unrouted](https://docs.quirelms.com/api/webhooks/prior_learning_request.unrouted/index.md) — Delivered when prior_learning_request.unrouted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [profile_field.declared](https://docs.quirelms.com/api/webhooks/profile_field.declared/index.md) — Delivered when profile_field.declared occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [profile_field.removed](https://docs.quirelms.com/api/webhooks/profile_field.removed/index.md) — Delivered when profile_field.removed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [profile_field.updated](https://docs.quirelms.com/api/webhooks/profile_field.updated/index.md) — Delivered when profile_field.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [program.assigned](https://docs.quirelms.com/api/webhooks/program.assigned/index.md) — Delivered when program.assigned occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [program.completed](https://docs.quirelms.com/api/webhooks/program.completed/index.md) — Delivered when program.completed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [program.unassigned](https://docs.quirelms.com/api/webhooks/program.unassigned/index.md) — Delivered when program.unassigned occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [program_set.unlocked](https://docs.quirelms.com/api/webhooks/program_set.unlocked/index.md) — Delivered when program_set.unlocked occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [question.created](https://docs.quirelms.com/api/webhooks/question.created/index.md) — Delivered when question.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [question.deleted](https://docs.quirelms.com/api/webhooks/question.deleted/index.md) — Delivered when question.deleted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [question.status_changed](https://docs.quirelms.com/api/webhooks/question.status_changed/index.md) — Delivered when question.status_changed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [question.version_created](https://docs.quirelms.com/api/webhooks/question.version_created/index.md) — Delivered when question.version_created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [question_bank.exported](https://docs.quirelms.com/api/webhooks/question_bank.exported/index.md) — Delivered when question_bank.exported occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [question_bank.imported](https://docs.quirelms.com/api/webhooks/question_bank.imported/index.md) — Delivered when question_bank.imported occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [quiz.layout_changed](https://docs.quirelms.com/api/webhooks/quiz.layout_changed/index.md) — Delivered when quiz.layout_changed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [quiz_attempt.abandoned](https://docs.quirelms.com/api/webhooks/quiz_attempt.abandoned/index.md) — Delivered when quiz_attempt.abandoned occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [quiz_attempt.manually_graded](https://docs.quirelms.com/api/webhooks/quiz_attempt.manually_graded/index.md) — Delivered when quiz_attempt.manually_graded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [quiz_attempt.regraded](https://docs.quirelms.com/api/webhooks/quiz_attempt.regraded/index.md) — Delivered when quiz_attempt.regraded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [quiz_attempt.started](https://docs.quirelms.com/api/webhooks/quiz_attempt.started/index.md) — Delivered when quiz_attempt.started occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [quiz_attempt.submitted](https://docs.quirelms.com/api/webhooks/quiz_attempt.submitted/index.md) — Delivered when quiz_attempt.submitted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [rating.recorded](https://docs.quirelms.com/api/webhooks/rating.recorded/index.md) — Delivered when rating.recorded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [rating.withdrawn](https://docs.quirelms.com/api/webhooks/rating.withdrawn/index.md) — Delivered when rating.withdrawn occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [Queue webhook deliveries for replay](https://docs.quirelms.com/api/webhooks/replayWebhookDeliveries/index.md) — Replay selected delivery IDs or failures in the last specified number of hours. Replays receive a fresh webhook-id and are signed with the current secret. ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:write`. The acting subject must also be allowed to perform this action in the organisation. - [resource.viewed](https://docs.quirelms.com/api/webhooks/resource.viewed/index.md) — Delivered when resource.viewed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [Rotate the signing secret](https://docs.quirelms.com/api/webhooks/rotateSecretWebhookSubscription/index.md) — Both secrets sign every delivery during the overlap, up to 168 hours, so the consumer can switch without dropping one. ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:write`. The acting subject must also be allowed to perform this action in the organisation. - [scorm_attempt.completed](https://docs.quirelms.com/api/webhooks/scorm_attempt.completed/index.md) — Delivered when scorm_attempt.completed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [scorm_attempt.started](https://docs.quirelms.com/api/webhooks/scorm_attempt.started/index.md) — Delivered when scorm_attempt.started occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [seat.allocated](https://docs.quirelms.com/api/webhooks/seat.allocated/index.md) — Delivered when seat.allocated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [seat.reclaimed](https://docs.quirelms.com/api/webhooks/seat.reclaimed/index.md) — Delivered when seat.reclaimed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [seat_pool.created](https://docs.quirelms.com/api/webhooks/seat_pool.created/index.md) — Delivered when seat_pool.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [seat_pool.exhausted](https://docs.quirelms.com/api/webhooks/seat_pool.exhausted/index.md) — Delivered when seat_pool.exhausted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [seat_pool.expired](https://docs.quirelms.com/api/webhooks/seat_pool.expired/index.md) — Delivered when seat_pool.expired occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [seat_pool.updated](https://docs.quirelms.com/api/webhooks/seat_pool.updated/index.md) — Delivered when seat_pool.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [Subscribe a REST hook](https://docs.quirelms.com/api/webhooks/subscribeHook/index.md) — Creates a webhook subscription for one event, the way Zapier and Make subscribe a trigger. Store the returned id to unsubscribe. ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:write`. The acting subject must also be allowed to perform this action in the organisation. - [Unsubscribe a REST hook](https://docs.quirelms.com/api/webhooks/unsubscribeHook/index.md) — ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:write`. The acting subject must also be allowed to perform this action in the organisation. - [Update a webhooksubscription](https://docs.quirelms.com/api/webhooks/updateWebhookSubscription/index.md) — Fields absent from the body are left as they are. ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:write`. The acting subject must also be allowed to perform this action in the organisation. - [user.created](https://docs.quirelms.com/api/webhooks/user.created/index.md) — Delivered when user.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [user.status_changed](https://docs.quirelms.com/api/webhooks/user.status_changed/index.md) — Delivered when user.status_changed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [user_profile.updated](https://docs.quirelms.com/api/webhooks/user_profile.updated/index.md) — Delivered when user_profile.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [Send the verification ping again](https://docs.quirelms.com/api/webhooks/verifyWebhookSubscription/index.md) — ### Quire permissions Required capability: `webhook/manage`. Credential scopes: `webhooks:write`. The acting subject must also be allowed to perform this action in the organisation. - [waitlist.joined](https://docs.quirelms.com/api/webhooks/waitlist.joined/index.md) — Delivered when waitlist.joined occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [waitlist.left](https://docs.quirelms.com/api/webhooks/waitlist.left/index.md) — Delivered when waitlist.left occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [waitlist.offer_accepted](https://docs.quirelms.com/api/webhooks/waitlist.offer_accepted/index.md) — Delivered when waitlist.offer_accepted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [waitlist.offer_declined](https://docs.quirelms.com/api/webhooks/waitlist.offer_declined/index.md) — Delivered when waitlist.offer_declined occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [waitlist.offer_expired](https://docs.quirelms.com/api/webhooks/waitlist.offer_expired/index.md) — Delivered when waitlist.offer_expired occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [waitlist.offered](https://docs.quirelms.com/api/webhooks/waitlist.offered/index.md) — Delivered when waitlist.offered occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [wiki_page.updated](https://docs.quirelms.com/api/webhooks/wiki_page.updated/index.md) — Delivered when wiki_page.updated occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [workshop_assessment.submitted](https://docs.quirelms.com/api/webhooks/workshop_assessment.submitted/index.md) — Delivered when workshop_assessment.submitted occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [workshop_grades.computed](https://docs.quirelms.com/api/webhooks/workshop_grades.computed/index.md) — Delivered when workshop_grades.computed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [workshop_phase.changed](https://docs.quirelms.com/api/webhooks/workshop_phase.changed/index.md) — Delivered when workshop_phase.changed occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock. - [workshop_submission.created](https://docs.quirelms.com/api/webhooks/workshop_submission.created/index.md) — Delivered when workshop_submission.created occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock.