> ## 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 a construction phase plan's revisions > List the document's revisions, newest first. Every party that can read the document can. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v3/construction-phase-plans/{construction_phase_plan_id}/revisions 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: | 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 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: 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/construction-phase-plans/{construction_phase_plan_id}/revisions: get: tags: - Construction Phase Plans summary: List a construction phase plan's revisions description: > List the document's revisions, newest first. Every party that can read the document can. operationId: ListConstructionPhasePlanRevisions parameters: - $ref: '#/components/parameters/construction_phase_plan_id' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/page' responses: '200': $ref: '#/components/responses/ListConstructionPhasePlanRevisions' '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: construction_phase_plan_id: name: construction_phase_plan_id in: path required: true description: The unique identifier for the construction phase plan resource. schema: type: string format: uuid example: 8d2f4a6c-1b3e-4c5d-9e7f-0a1b2c3d4e52 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. responses: ListConstructionPhasePlanRevisions: description: A list of a construction phase plan's revisions. 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: type: array items: $ref: '#/components/schemas/ConstructionPhasePlanRevision' - $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 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: ConstructionPhasePlanRevision: type: object description: > An immutable revision of a construction phase plan: the document as it stood when the revision was minted. Nothing can change or delete it. required: - id - type - attributes - relationships properties: id: type: string format: uuid type: type: string const: construction-phase-plan-revisions attributes: $ref: '#/components/schemas/ConstructionPhasePlanRevisionAttributes' relationships: $ref: '#/components/schemas/ConstructionPhasePlanRevisionRelationships' 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 ConstructionPhasePlanRevisionAttributes: type: object description: > Attributes for a construction phase plan revision. `attestations` holds every sign-off made up to and including this revision, each naming the revision it attested. required: - number - cause - proposer - recipient - minted_at - document - risks - attestations properties: number: type: integer minimum: 1 description: The revision's number. Revision 1 is the handover. cause: $ref: '#/components/schemas/CDMRevisionCause' proposer: $ref: '#/components/schemas/CDMActor' recipient: $ref: '#/components/schemas/CDMActor' minted_at: type: string format: date-time document: $ref: '#/components/schemas/CPPRevisionDocument' risks: type: array items: $ref: '#/components/schemas/CDMRevisionRisk' attestations: $ref: '#/components/schemas/CDMAttestations' ConstructionPhasePlanRevisionRelationships: type: object description: Relationships for a construction phase plan revision required: - construction_phase_plan properties: construction_phase_plan: type: object description: The document this is a revision of. required: - data properties: data: $ref: '#/components/schemas/ConstructionPhasePlanRelationship' proposed_change: type: object description: >- The accepted proposed change to this plan that minted this revision. Absent for the handover and for a hazard_change revision. properties: data: $ref: >- #/components/schemas/ConstructionPhasePlanProposedChangeRelationship pre_construction_information_proposed_change: type: object description: >- For a hazard_change revision, the accepted hazard change on the pre-construction information that refreshed the plan's risks. properties: data: $ref: >- #/components/schemas/PreConstructionInformationProposedChangeRelationship 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 CDMRevisionCause: type: string description: > What minted a revision. Revision 1 comes from the handover, and every later one from an accepted proposed change. A construction phase plan's revision can also come from an accepted change to a hazard on the pre-construction information, which refreshed the plan's risks. enum: - handover - proposed_change - hazard_change CDMActor: type: object description: > A party acting on a CDM document: who acted, in which duty-holder role, for which organisation, and when. Every field is taken from the authenticated request. A handover's recipient names an organisation and role but no principal, because the recipient does not act. required: - acting_role - organisation_id - at properties: principal_type: type: - string - 'null' enum: - users - service-accounts - null description: >- Whether a user or a service account acted. Null for a handover's recipient. principal_id: type: - string - 'null' format: uuid acting_role: $ref: '#/components/schemas/CDMRole' organisation_id: type: string format: uuid at: type: string format: date-time CPPRevisionDocument: type: object description: >- A construction phase plan's sections as they stood when a revision was minted. required: - health_and_safety_aims - site_rules - induction - welfare - emergency_arrangements - monitoring_and_review - key_operatives - client_checklist properties: health_and_safety_aims: $ref: '#/components/schemas/CPPHealthAndSafetyAims' site_rules: $ref: '#/components/schemas/CPPSiteRules' induction: $ref: '#/components/schemas/CPPInduction' welfare: $ref: '#/components/schemas/CPPWelfare' emergency_arrangements: $ref: '#/components/schemas/CPPEmergencyArrangements' monitoring_and_review: $ref: '#/components/schemas/CPPMonitoringAndReview' key_operatives: $ref: '#/components/schemas/CPPKeyOperatives' client_checklist: $ref: '#/components/schemas/CPPClientChecklist' CDMRevisionRisk: type: object description: A risk as it stood when a revision was minted. required: - id - hazard_id - hazard_ref - hazard_version - hazard_snapshot - control_measure - responsible_party properties: id: type: string format: uuid hazard_id: type: string format: uuid hazard_ref: type: string hazard_version: type: integer hazard_snapshot: $ref: '#/components/schemas/CDMHazardSnapshot' control_measure: type: string responsible_party: type: string responsible_party_user_id: type: - string - 'null' format: uuid description: >- The user who is responsible, when they have an account. The name is kept as written either way. responsible_party_organisation_id: type: - string - 'null' format: uuid description: >- The organisation that is responsible, when it is a party to the scheme. The name is kept as written either way. implemented_on: type: - string - 'null' format: date CDMAttestations: type: array readOnly: true description: Every sign-off of the document's sections, oldest first. items: $ref: '#/components/schemas/CDMAttestation' ConstructionPhasePlanRelationship: type: object description: Represents a relationship to a construction phase plan required: - id - type properties: id: type: string format: uuid description: The unique identifier of the construction phase plan type: type: string const: construction-phase-plans ConstructionPhasePlanProposedChangeRelationship: type: object description: >- Represents a relationship to a proposed change to a construction phase plan required: - id - type properties: id: type: string format: uuid type: type: string const: construction-phase-plan-proposed-changes PreConstructionInformationProposedChangeRelationship: type: object description: >- Represents a relationship to a proposed change to a pre-construction information required: - id - type properties: id: type: string format: uuid type: type: string const: pre-construction-information-proposed-changes CDMRole: type: string description: > A CDM 2015 duty-holder role on a scheme. The scheme owner is the Client and Principal Designer. The organisation nominated on the Pre-Construction Information is the Principal Contractor. Any other organisation the scheme is shared with is a reader. enum: - client_and_principal_designer - principal_contractor - reader CPPHealthAndSafetyAims: type: object description: Health and safety aims. Owned by the Principal Contractor. x-cdm-owner: principal_contractor additionalProperties: false properties: aims: type: - string - 'null' CPPSiteRules: type: object description: Mandatory site rules. Owned by the Principal Contractor. x-cdm-owner: principal_contractor additionalProperties: false properties: rules: type: array items: type: string CPPInduction: type: object description: >- What is put to every person signed in on site, in order. Owned by the Principal Contractor and versioned by the plan's revisions. A site attendance records the revision whose points were put to the attendee. x-cdm-owner: principal_contractor additionalProperties: false properties: points: type: array description: The induction points, in the order they are put to the attendee. items: type: string declarations: type: array description: The personal declarations the attendee is asked to make, in order. items: type: string CPPWelfare: type: object description: Welfare arrangements, by facility. Owned by the Principal Contractor. x-cdm-owner: principal_contractor additionalProperties: false properties: toilets: type: - string - 'null' washing: type: - string - 'null' drinking_water: type: - string - 'null' rest_and_eating: type: - string - 'null' changing_and_drying: type: - string - 'null' location: type: - string - 'null' CPPEmergencyArrangements: type: object description: Emergency and first-aid arrangements. Owned by the Principal Contractor. x-cdm-owner: principal_contractor additionalProperties: false properties: emergency_procedures: type: - string - 'null' fire_arrangements: type: - string - 'null' first_aid_arrangements: type: - string - 'null' first_aiders: type: array items: $ref: '#/components/schemas/CDMPerson' nearest_hospital: type: - string - 'null' CPPMonitoringAndReview: type: object description: Monitoring and review arrangements. Owned by the Principal Contractor. x-cdm-owner: principal_contractor additionalProperties: false properties: arrangements: type: - string - 'null' review_frequency: type: - string - 'null' CPPKeyOperatives: type: array description: Key operatives on site. Owned by the Principal Contractor. x-cdm-owner: principal_contractor items: type: object additionalProperties: false required: - name properties: name: type: string description: >- The name as written. May be blank when a user is linked, whose name is then used; an unlinked operative needs a name. role: type: - string - 'null' description: >- The role as written. May be blank when a job role is linked, whose alias or name is then used. phone: type: - string - 'null' user_id: type: - string - 'null' format: uuid description: >- The user this operative is, when they have an account. When a job role is linked too, the user must hold it. The name is kept as written either way. job_role_id: type: - string - 'null' format: uuid description: >- The job role this operative holds, when it is one the platform records. It must apply to schemes and belong to the scheme owner, because only those can be posted on the scheme's Roles tab. When a revision is issued, an operative with both a user and a job role is posted in it. The role is kept as written either way. CPPClientChecklist: type: object description: > The Client's checks on the arrangements, one field per item. Owned by the Client and Principal Designer, because satisfying itself that the plan is adequate is a Client duty. x-cdm-owner: client_and_principal_designer additionalProperties: false properties: management_arrangements: $ref: '#/components/schemas/CPPChecklistItem' time_and_resources: $ref: '#/components/schemas/CPPChecklistItem' pre_construction_information: $ref: '#/components/schemas/CPPChecklistItem' principal_designer_appointed: $ref: '#/components/schemas/CPPChecklistItem' principal_contractor_appointed: $ref: '#/components/schemas/CPPChecklistItem' construction_phase_plan_in_place: $ref: '#/components/schemas/CPPChecklistItem' welfare_provided: $ref: '#/components/schemas/CPPChecklistItem' health_and_safety_file_arranged: $ref: '#/components/schemas/CPPChecklistItem' notification_made: $ref: '#/components/schemas/CPPChecklistItem' competence_checked: $ref: '#/components/schemas/CPPChecklistItem' CDMHazardSnapshot: type: object readOnly: true description: The hazard text as it stood when the risk was written against it. required: - description properties: description: type: string associated_activity: type: - string - 'null' CDMAttestation: type: object description: > A sign-off of one section. Every field is derived on the server from the authenticated request, and none is accepted from a client. required: - section - acting_role - attested_at - attested_by_type - attested_by_id - revision properties: section: type: string description: The section that was signed off. acting_role: $ref: '#/components/schemas/CDMRole' organisation_id: type: string format: uuid description: The organisation the principal acted for. attested_at: type: string format: date-time attested_by_type: type: string enum: - users - service-accounts description: >- Whether a user or a service account signed it off. A client shows the two differently. attested_by_id: type: string format: uuid revision: type: integer description: >- The document's revision when the section was signed off. 0 means before handover. CDMPerson: type: object description: A person named on a document, linked to their user when they have one. additionalProperties: false required: - name properties: name: type: string description: >- The name as written. Kept even when the person is linked. May be blank when a user is linked, whose name is then used; an unlinked person needs a name. user_id: type: - string - 'null' format: uuid description: The user this person is, when they have an account. CPPChecklistItem: type: object description: One client checklist item. additionalProperties: false properties: answer: type: - string - 'null' enum: - 'yes' - 'no' - not_applicable - null description: Null until answered. Not applicable is a distinct answer. comments: type: - string - 'null' 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.