Skip to main content
GET
Registration summary statistics
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

GET /work/registrations/summary Description: Aggregate registration counts across the tenant’s works, grouped by society and by status. Optional societyCode narrows to a single society. Response is a BARE object (no success/data wrapper), unlike most other endpoints in this module. Authorization:
  • Required role: user or higher
Method: GET

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

societyCode
string

Response

Summary retrieved

Bare object (no success wrapper) returned by GET /work/registrations/summary.

total
integer
deadLettered
integer

Count of registrations with isDeadLettered set, over the same set as total and byStatus — honouring societyCode and nothing else. isDeadLettered is a flag, not a registrationStatus, so dead-lettered rows sit under more than one status and byStatus cannot express this. Note the scope before using it as a count beside a list: it does not honour the status or date filters that GET /work/registrations accepts, and that endpoint returns its whole filtered set unpaginated, so a count that must agree with the rows on screen should come from those rows. This field is for places where tenant-wide is the honest scope, such as a nav badge or a dashboard tile.

submissionsEnabled
boolean

Whether the PRO submission worker will run. This is an environment-level kill-switch (PRO_SUBMISSION_ENABLED), not a tenant setting: when false, queue and requeue both succeed and nothing is ever submitted, so a requeued row legitimately sits at pending indefinitely. Surface it as "submissions are paused" rather than treating the row as failed.

byStatus
object
bySociety
object