> ## 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.

# Get a form reminder

> Get one of the organisation's form reminders.

Requires `forms:create` on the reminder's form, held across the organisation or on that form.

This operation does not support `include`, so the response has no `included` member.




## OpenAPI

````yaml /api-reference/openapi.yaml get /v3/orgs/{org_id}/form-reminders/{form_reminder_id}
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: >
      Exposure limits: an organisation's thresholds for each exposure type,
      stricter than the HSE

      values, and the limit in force for a person on a date.
    name: Exposure Limits
  - 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: >
      Recurring reminders to fill in a form, for the people, teams and job roles
      each names. A form can have several. Only the organisation that owns a
      form sets its reminders.
    name: Form Reminders
  - 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: >
      Feedback a console user sends to Ctrl Hub from any page. Only Ctrl Hub
      staff read it, on the

      Management API.
    name: User Feedback
  - 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: >
      Things an organisation has that expire or renew, such as insurance,
      accreditations, domains,

      certificates and contracts, in the organisation's own categories. Their
      recipients are told

      ahead of time, and evidence is attached to each period.
    name: Reminders
  - description: >
      What falls due in an organisation between two dates, drawn from reminders,
      documents,

      competency records and work permits.
    name: Calendar
  - description: >
      The UK bank holidays of each nation, as gov.uk publishes them. Form
      reminders skip the

      bank holidays of the nation an organisation keeps.
    name: Bank Holidays
  - 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/orgs/{org_id}/form-reminders/{form_reminder_id}:
    get:
      tags:
        - Form Reminders
      summary: Get a form reminder
      description: >
        Get one of the organisation's form reminders.


        Requires `forms:create` on the reminder's form, held across the
        organisation or on that form.


        This operation does not support `include`, so the response has no
        `included` member.
      operationId: GetFormReminder
      parameters:
        - $ref: '#/components/parameters/org_id'
        - $ref: '#/components/parameters/form_reminder_id'
      responses:
        '200':
          $ref: '#/components/responses/GetFormReminder'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - Session: []
        - OAuth2: []
        - Cookie: []
components:
  parameters:
    org_id:
      name: org_id
      in: path
      required: true
      description: The unique identifier for the organisation.
      schema:
        type: string
        format: uuid
      example: c000c344-8847-47da-a091-32e75902d3b1
    form_reminder_id:
      name: form_reminder_id
      in: path
      required: true
      description: The unique identifier for the form reminder.
      schema:
        type: string
        format: uuid
      example: 3f6a1c2e-8d4b-4e7a-9b1c-5d2e3f4a6b7c
  responses:
    GetFormReminder:
      description: A form reminder.
      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:
                    $ref: '#/components/schemas/FormReminder'
              - $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
    NotFound:
      description: The requested resource could not be found
      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: 7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f
            status: '404'
            title: Resource not found
            detail: The requested resource could not be found or does not exist.
            code: NOT_FOUND.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:
    FormReminder:
      type: object
      description: >-
        A recurring reminder to fill in a form, for the people, teams and job
        roles it names.
      required:
        - id
        - type
        - attributes
        - relationships
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the form reminder.
        type:
          type: string
          const: form-reminders
        attributes:
          $ref: '#/components/schemas/FormReminderAttributes'
        relationships:
          $ref: '#/components/schemas/FormReminderRelationships'
        meta:
          $ref: '#/components/schemas/FormReminderMeta'
    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.

            When `code` is `CH.029.016`, `retry_after` is the number of seconds
            to wait before sending feedback again. It matches the `Retry-After`
            header, which a browser on another origin cannot read.
          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
            retry_after:
              type: integer
              minimum: 1
              description: Seconds to wait before trying the request again.
              examples:
                - 1200
          additionalProperties: true
      required:
        - id
        - status
        - title
    FormReminderAttributes:
      type: object
      required:
        - name
        - schedule
        - grace_period_minutes
        - bank_holiday_nation
        - audience
        - next_due_on
      properties:
        name:
          type: string
          maxLength: 200
          examples:
            - Morning check
        schedule:
          $ref: '#/components/schemas/FormReminderSchedule'
        grace_period_minutes:
          type: integer
          minimum: 0
          maximum: 10080
          description: How long after the due time an open reminder counts as missed.
        bank_holiday_nation:
          type:
            - string
            - 'null'
          description: >-
            The nation whose bank holidays the reminder skips. Null follows the
            organisation's nation.
          enum:
            - england-and-wales
            - scotland
            - northern-ireland
            - null
        audience:
          $ref: '#/components/schemas/FormReminderAudience'
        next_due_on:
          type:
            - string
            - 'null'
          format: date
          readOnly: true
          description: >-
            The next date the reminder falls due, skipping bank holidays,
            counted from now in Europe/London. Today counts only until its time
            of day has passed. Null when it falls on no date in the next two
            years, and also when the bank holidays or the organisation's
            settings could not be read, so null does not by itself mean it will
            never fall due.
    FormReminderRelationships:
      type: object
      description: Relationships for a form reminder
      required:
        - organisation
        - form
      properties:
        organisation:
          type: object
          description: The organisation that owns the form and its reminder.
          required:
            - data
          properties:
            data:
              $ref: '#/components/schemas/OrganisationRelationship'
        form:
          type: object
          description: The form the reminder asks people to fill in.
          required:
            - data
          properties:
            data:
              $ref: '#/components/schemas/FormRelationship'
    FormReminderMeta:
      type: object
      description: Meta information for a form reminder
      properties:
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    FormReminderSchedule:
      type: object
      description: >
        When a form reminder falls due. There is no daily frequency: every day
        is `weekly` with all seven `weekdays`. Every N weeks counts from the
        Monday-to-Sunday week holding `starts_on`, and every N months from its
        month. Quarterly falls every third month and yearly every twelfth, both
        counted from the month of `starts_on`.
      required:
        - frequency
        - interval
        - weekdays
        - monthly
        - starts_on
        - time_of_day
      properties:
        frequency:
          type: string
          enum:
            - weekly
            - monthly
            - quarterly
            - yearly
        interval:
          type: integer
          minimum: 1
          maximum: 52
          description: >-
            Weeks between dates for `weekly`, from 1 to 52, and months for
            `monthly`, from 1 to 12. Always 1 for `quarterly` and `yearly`.
        weekdays:
          type: array
          description: >-
            The days a `weekly` schedule falls on, returned Monday first. Must
            be empty for every other frequency.
          uniqueItems: true
          items:
            type: string
            enum:
              - mon
              - tue
              - wed
              - thu
              - fri
              - sat
              - sun
        monthly:
          type:
            - object
            - 'null'
          description: >-
            The day a `monthly`, `quarterly` or `yearly` schedule falls on in
            its month. Must be null for `weekly`. `day` mode takes only `day`,
            and `weekday` mode only `week` and `weekday`.
          required:
            - mode
          properties:
            mode:
              type: string
              description: >-
                `day` picks a date in the month. `weekday` picks a numbered or
                last weekday, such as the last Friday.
              enum:
                - day
                - weekday
            day:
              type: integer
              minimum: 1
              maximum: 31
              description: >-
                For `day`, the date in the month. A day past a shorter month's
                end falls on its last day.
            week:
              type: string
              description: For `weekday`, which of the month's weekdays.
              enum:
                - first
                - second
                - third
                - fourth
                - last
            weekday:
              type: string
              description: For `weekday`, the day of the week.
              enum:
                - mon
                - tue
                - wed
                - thu
                - fri
                - sat
                - sun
        starts_on:
          type: string
          format: date
          description: The first date the schedule can fall on.
        time_of_day:
          type: string
          pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$
          description: >-
            The time it falls due, HH:MM in each person's own timezone, or
            Europe/London for a person with none.
          examples:
            - '07:30'
    FormReminderAudience:
      type: object
      description: >-
        Who a form reminder is for. Teams and job roles are resolved to people
        each time it falls due, and a person named more than once is reminded
        once. At most 500 ids in all, each a member, team or job role of the
        organisation. Each list is returned sorted.
      required:
        - user_ids
        - team_ids
        - job_role_ids
      properties:
        user_ids:
          type: array
          uniqueItems: true
          items:
            type: string
            format: uuid
        team_ids:
          type: array
          uniqueItems: true
          items:
            type: string
            format: uuid
        job_role_ids:
          type: array
          uniqueItems: true
          items:
            type: string
            format: uuid
    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
    FormRelationship:
      type: object
      description: Represents a relationship to a form
      required:
        - id
        - type
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the form
        type:
          type: string
          const: forms
  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.