> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt > Use this file to discover all available pages before exploring further. # List briefing recipients > List the recipients the caller can see, with each one's status and times: every recipient of a briefing owned by an organisation where they hold `briefings:view`, that organisation's own members on briefings others sent, and the caller's own records. Filter by `briefing` for one briefing's gap view, by `user` for a member's history, or by `state` and `briefing_status` for the outstanding report. Each recipient carries `user_name`, so the list needs no access to the users themselves. This operation does not support `include`, so the response has no `included` member. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v3/briefing-recipients openapi: 3.1.0 info: contact: email: support@ctrl-hub.com name: Ctrl Hub url: https://www.ctrl-hub.com description: > Ctrl Hub is the all-in-one platform for high-risk industries like utilities, construction, infrastructure, and renewables. We help teams manage everything from risk assessments and HAVS exposure to vehicle and equipment checks, with a guaranteed minimum of 200% ROI. license: name: MIT License url: https://opensource.org/licenses/MIT summary: An API for managing your compliance and risk posture termsOfService: https://www.ctrl-hub.com/terms-conditions title: Ctrl Hub version: 1.0.0 servers: - description: Production url: https://api.ctrl-hub.com - description: Staging url: https://api.ctrl-hub.dev - description: Development url: https://api.ctrl-hub.run security: [] tags: - description: | Actions are follow-ups assigned to users and teams, produced manually or by domain producers such as the data-capture workflow runner. name: Actions - description: | Audit events are the events that are logged by the system. name: Audit Events - description: | View the platform's health and availability. name: Status - description: > User-owned dashboards composed of cards on a fixed-slot bento layout. Cards come from a per-domain registry; the API stores their config as opaque JSON. name: Dashboards - description: > Copies of a mobile device's local database, sent by the operative on request so that people in their organisation can recover work that never reached the server. Kept for 30 days, and visible to people granted `device-backups:view` in the organisation each is filed against. name: Device Backups - description: > A record of documents the platform generated and handed over, retained as evidence of what was issued. `subject_type` says what kind of records an export covers, and it is what decides how the request is authorised: there is no export permission of its own, so if you can see the records you can export them. name: Exports - description: > Scheduled delivery of a saved query's results, as a CSV attachment or a summary email. Every run is retained with the file it sent, so what a recipient received stays retrievable. A report runs as the person who created it, under their own access. name: Reports - description: > Performance standards the platform defines, such as the gas Guaranteed Standards of Performance 3 and 13, and how an organisation's forms answer them. An organisation maps its form fields to a standard's inputs, and the mapping generates a saved query that reads the answers. name: Standards - description: | Manage appointments for work to be carried out with your customers name: Customer Appointments - description: | Manage interactions you have with your customers name: Customer Interactions - description: | Manage accounts for your customers name: Customer Accounts and Contacts - description: > Competency: the assessments, training items, inductions and registrations an organisation requires, and the specifications that combine them. name: Qualifications - description: | Workflows allow you to automate your processes. name: Workflows - description: | Manage documents name: Documents - description: | Manage documents name: Folders - description: | Manage documents name: Document Reviews - description: | Manage feature configurations for an organisation. name: Feature Configurations - description: | Equipment are the physical assets that an organisation manages. name: Equipment - description: | The central cost register: time-versioned rate codes for material, labour, contractor and miscellaneous spend, used to cost work against the job hierarchy. name: Costs - description: > Locations are places an organisation manages, optionally classified by a location type. name: Locations - description: > Bulk loads of locations from an uploaded CSV. An import matches rows on the organisation's own `reference`, so re-importing a corrected file updates what is already there rather than doubling the population, and the import record is the audit trail for the whole load: the bulk write path deliberately emits no per-row events. name: Location Imports - description: | Manage your forms and their schemas name: Forms, Schemas and Categories - description: | Create and view form submissions name: Submissions - description: | View the roles available in the system. name: IAM Roles - description: > IAM role groups can be assigned to principals to manage authorisation centrally. name: IAM Role Groups - description: | Manage service accounts which can access the API programmatically. name: Service Accounts - description: | Manage bridges between organisations. name: Bridges - description: | Manage settings for an organisation. name: Settings - description: | Manage teams within an organisation. name: Teams - description: > Manage who manages whom within an organisation, and the manager roles that say what a manager may do for their people. name: Management - description: | Manage job roles within an organisation. name: Job Roles - description: | Manage users and accounts. name: Users - description: | Invite and manage invitations to organisations. name: Invitations - description: > IAM grants are the asignment of roles or permissions to principals to manage resource access. name: IAM Grants - description: | View the permissions available in the system. name: IAM Permissions - description: | SSO providers are the identity providers for an organisation. name: SSO Providers - description: | Whoami returns information about the currently authenticated principal. name: Whoami - description: | Your personal inbox. A notification is the thing you receive: an envelope that carries what happened to one or more channels. Email is one of those channels, the inbox is another, and this is where the ones delivered to your inbox are listed, read, saved and archived. name: Notifications - description: | Manage your images name: Images - description: > AI agent personas that synthesise data into role-specific intelligent briefings. name: Agents - description: | Briefings generated by AI agents, including reasoning traces. name: Agent Briefings - description: > Notices an organisation sends to its own people and its contractors' people, who acknowledge that they have read and understood them. Replaces v2's bulletins. name: Briefings - description: > Organisations are the center point for most resources in the platform. Most other endpoints are subresources of an organisation. name: Organisations - description: | Permits managements, integrated with street manager. name: Permits - description: | Projects manage your work and governance. name: Projects - description: > Import templates allow users to save and reuse their CSV importer configuration as named templates. name: Import Templates - description: | Properties are the physical locations. name: Properties - description: | Search across schemes, work orders, and operations. name: Search - description: | Provides the API specification in JSON and YAML formats name: Specifications - description: | Streets are the physical roads. name: Streets - description: | Integration with street manager name: Street Manager - description: | Vehicles are the physical vehicles that an organisation manages. name: Vehicles - description: > Scheme contracts (also known as regions) group schemes allocated from the network to a contractor. name: Scheme Contracts - description: > Scheme shares allow you to share your schemes with other organisations across bridges. name: Scheme Shares - description: | Schemes are large programmes of work name: Schemes - description: > A Construction Phase Plan is the Principal Contractor's plan for managing health and safety on a scheme, under CDM 2015. Its risks are control measures written against the hazards on the scheme's Pre-Construction Information. Each section is owned by one duty-holder role. name: Construction Phase Plans - description: > A Pre-Construction Information pack is the Client's information about a scheme under CDM 2015, with its site hazards. A scheme has at most one. Each section is owned by one duty-holder role, and only that role can write it. name: Pre-Construction Information - description: > Site attendances record who was on site and when, whether or not they hold an account. There is no daily register resource: a day's register and who is currently on site are both queries over the attendances themselves. name: Site Attendances - description: | Work orders the component parts of a scheme. name: Work Orders - description: | Operations are the work to be carried out within work orders. name: Operations externalDocs: description: More documentation and resources url: https://docs.ctrl-hub.com paths: /v3/briefing-recipients: get: tags: - Briefings description: > List the recipients the caller can see, with each one's status and times: every recipient of a briefing owned by an organisation where they hold `briefings:view`, that organisation's own members on briefings others sent, and the caller's own records. Filter by `briefing` for one briefing's gap view, by `user` for a member's history, or by `state` and `briefing_status` for the outstanding report. Each recipient carries `user_name`, so the list needs no access to the users themselves. This operation does not support `include`, so the response has no `included` member. operationId: ListBriefingRecipients parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/briefing_recipients_filter' - $ref: '#/components/parameters/briefing_recipients_sort' responses: '200': $ref: '#/components/responses/ListBriefingRecipients' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - OAuth2: [] - Cookie: [] components: parameters: limit: name: limit in: query description: Limit the number of resources returned by the API required: false schema: type: integer format: int64 minimum: 1 default: 100 offset: name: offset in: query description: Offset the resources returned by the API required: false schema: type: integer format: int64 minimum: 0 default: 0 page: name: page in: query description: > JSON:API pagination, as `page[limit]` and `page[offset]`. The same as the top-level `limit` and `offset` parameters; when both forms are sent, `page[...]` wins. required: false style: deepObject explode: true schema: type: object additionalProperties: false properties: limit: type: integer format: int64 minimum: 1 description: >- Limit the number of resources returned by the API. Defaults to the operation's `limit` default. offset: type: integer format: int64 minimum: 0 description: Offset the resources returned by the API. Defaults to 0. briefing_recipients_filter: name: filter in: query description: > Filters the response data based on the value provided. Available filters: - `briefing`: Filter by briefing ID, for one briefing's gap view. - `user`: Filter by the recipient's user ID, for a member's briefing history. - `organisation`: Filter by the recipient's organisation ID, e.g. one contractor. - `briefing_organisation`: Filter by the organisation that sent the briefing, e.g. `or(eq(briefing_organisation,X),eq(organisation,X))` for everything organisation X can see. - `job_role`: Filter by a job role that matched the recipient. - `state`: Filter by the recipient's progress: `sent`, `viewed` or `acknowledged`. `in(state,[sent,viewed])` is every recipient who has not acknowledged. - `briefing_status`: Filter by the briefing's status, `sent` or `archived`. `eq(briefing_status,sent)` leaves out archived briefings. - `acknowledge_by`: Filter by the briefing's acknowledge-by date, e.g. `lt(acknowledge_by,2026-11-09T00:00:00Z)` with `in(state,[sent,viewed])` for overdue recipients. For more information on using named filters, see [the docs](https://docs.ctrl-hub.com/api-reference/features#filtering) required: false schema: type: string default: '' briefing_recipients_sort: in: query name: sort description: >- A comma separated list of fields to sort by. A `-` prefix sorts descending. Any other field is refused. required: false style: form explode: false schema: type: array items: type: string enum: - sent_at - '-sent_at' - viewed_at - '-viewed_at' - acknowledged_at - '-acknowledged_at' - acknowledge_by - '-acknowledge_by' - state - '-state' - briefing_title - '-briefing_title' responses: ListBriefingRecipients: description: A list of briefing recipients headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: allOf: - type: object required: - data properties: data: title: A list of briefing recipients type: array items: $ref: '#/components/schemas/BriefingRecipient' - $ref: '#/components/schemas/DocumentMeta' - $ref: '#/components/schemas/JSONAPI' BadRequest: description: > There was an error with the request - this could be due to an invalid body, query parameters, or headers that were sent to the API. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 98ca4a78-b66f-4234-9719-aaf832ee6669 status: '400' title: A validation error was encountered source: parameter: include meta: resource: wrong_value Unauthorised: description: Authentication failed headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 05fc9c8d-73b9-4697-9337-57f7a567a48f status: '401' title: You are not authorised to access this resource detail: In order to access this resource, you need the 'admin' role. code: AUTH.001 InternalServerError: description: There was a problem handling the request on the server side headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: fe9d9a69-f0a7-4fdc-bb2c-176027f316c5 status: '500' title: Internal Server Error detail: An unexpected error occurred on the server. headers: content-type: description: The content type of the response schema: type: string example: application/vnd.api+json content-length: description: The length of the response body in bytes schema: type: integer format: int32 example: 1234 x-request-id: description: >- An ID that can be provided when reporting bugs to help identify the issue schema: type: string example: 8470f56af4cf25e22be08e72c70dbbdc schemas: BriefingRecipient: type: object description: One person a briefing was sent to, and how far they have got with it. required: - id - type - attributes - relationships properties: id: type: string format: uuid type: type: string const: briefing-recipients attributes: $ref: '#/components/schemas/BriefingRecipientAttributes' relationships: $ref: '#/components/schemas/BriefingRecipientRelationships' DocumentMeta: type: object description: Document level meta about the resources on the server in list endpoints. required: - meta properties: meta: type: object required: - pagination properties: features: $ref: '#/components/schemas/Features' pagination: $ref: '#/components/schemas/Pagination' JSONAPI: type: object description: JSON API response object required: - jsonapi properties: jsonapi: type: object required: - version properties: version: type: string description: The version of the JSON API specification examples: - '1.0' Error: type: object description: An error response properties: id: description: >- A unique identifier for this particular occurrence of the problem. If you encounter this, please provide us with the error ID and we can investigate it on our side. type: string format: uuid examples: - 05fc9c8d-73b9-4697-9337-57f7a567a48f status: description: >- The status code for the error. This might not match the HTTP status code if there are more that one errors to return with different status codes. type: string examples: - '401' - '500' title: description: A human readable title for the error. type: string examples: - You are not authorised to access this resource detail: description: >- Where there is more detail that we can provide outside of the title, we will provide it here. type: string examples: - In order to access this resource, you need the 'admin' role. code: description: >- A unique code for the error that may help us to diagnose the issue. Not all errors have codes, so this is usually empty. `CH.003.080` (403) means the organisation in `meta.organisation_id` requires two-factor authentication and the caller's session does not satisfy it. The caller must set up or use a second factor, or sign in through their organisation's SAML single sign-on. Other OIDC sign-ins do not count. type: string examples: - AUTH.001 - CH.003.080 source: description: A JSON object containing additional information about the error. type: object properties: pointer: description: >- A JSON Pointer to the value in the request that caused the error. type: string examples: - /data/attributes/email parameter: description: >- A string indicating which query parameter in the request caused the error. type: string examples: - include meta: description: >- A JSON object containing additional information about the error. When a parameter caused the error, there will be a `resource` property with the name of the resource that caused the error. When `code` is `CH.003.080`, `organisation_id` names the organisation that requires two-factor authentication, which the caller's session does not satisfy. type: object properties: resource: type: string description: >- The resource a parameter error relates to, such as an unsupported include. organisation_id: type: string format: uuid examples: - c000c344-8847-47da-a091-32e75902d3b1 additionalProperties: true required: - id - status - title BriefingRecipientAttributes: type: object description: Attributes of a briefing recipient required: - state - overdue - sent_at - viewed_at - acknowledged_at - last_reminded_at - briefing_title - briefing_status - acknowledge_by - user_name properties: state: type: string description: The furthest the recipient has got. `sent` means not yet opened. enum: - sent - viewed - acknowledged overdue: type: boolean description: >- True when the briefing is live, has an acknowledge-by date that has passed, and the recipient has not acknowledged it. sent_at: type: string format: date-time description: When the recipient was added to the briefing. viewed_at: type: - string - 'null' format: date-time description: When the recipient first opened the briefing. acknowledged_at: type: - string - 'null' format: date-time description: When the recipient pressed read and understood. last_reminded_at: type: - string - 'null' format: date-time briefing_title: type: string description: >- The briefing's title, so a list of recipients reads without fetching each briefing. briefing_status: type: string enum: - sent - archived acknowledge_by: type: - string - 'null' format: date-time description: The briefing's acknowledge-by date. user_name: type: string description: >- The recipient's display name, filled on the recipients list. It is empty elsewhere, such as on the caller's own record, and when the user no longer exists. BriefingRecipientRelationships: type: object description: Relationships for a briefing recipient required: - briefing - user - organisation - briefing_organisation - job_roles properties: briefing: type: object required: - data properties: data: $ref: '#/components/schemas/BriefingRelationship' user: type: object description: The recipient. required: - data properties: data: $ref: '#/components/schemas/UserRelationship' organisation: type: object description: >- The organisation the recipient was reached through, the sender's own or a contractor's. required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' briefing_organisation: type: object description: The organisation that sent the briefing. required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' job_roles: type: object description: >- The targeted job roles the recipient held when it was sent. Empty when they were reached another way. required: - data properties: data: type: array items: $ref: '#/components/schemas/JobRoleRelationship' Features: type: object description: Represents feature configurations of the API properties: include: type: object properties: options: type: array items: type: string examples: - related.resource Pagination: type: object description: Represents pagination details for API responses required: - counts - current_page - offsets - requested properties: counts: type: object required: - pages - resources properties: pages: type: integer examples: - 1 resources: type: integer examples: - 1 current_page: type: integer examples: - 1 offsets: type: object required: - next - previous properties: next: type: - integer - 'null' examples: - null previous: type: - integer - 'null' examples: - null requested: type: object required: - limit - offset properties: limit: type: integer examples: - 10 offset: type: integer examples: - 0 BriefingRelationship: type: object description: Represents a relationship to a briefing required: - id - type properties: id: type: string format: uuid description: The unique identifier of the briefing type: type: string const: briefings UserRelationship: type: object description: Represents a relationship to a user required: - id - type properties: id: type: string format: uuid description: The unique identifier of the user type: type: string const: users OrganisationRelationship: type: object description: Represents a relationship to an organisation required: - id - type properties: id: type: string format: uuid description: The unique identifier of the organisation type: type: string const: organisations JobRoleRelationship: type: object description: Represents a relationship to a job role required: - id - type properties: id: type: string format: uuid description: The unique identifier of the job role type: type: string const: job-roles securitySchemes: Session: description: | Session token for authentication. in: header name: X-Session-Token type: apiKey OAuth2: description: | OAuth2 token for authentication. flows: clientCredentials: scopes: {} tokenUrl: https://auth.ctrl-hub.com/oauth2/token type: oauth2 Cookie: description: | Cookie token for authentication. in: cookie name: ctrl_hub_session type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.