# Ctrl Hub ## Docs - [List audit events](https://docs.ctrl-hub.com/api-reference/audit-events/get-v3audit-events.md): Retrieve a list of audit events for the given organisation. - [Get an audit event](https://docs.ctrl-hub.com/api-reference/audit-events/get-v3audit-events-1.md): Retrieve a specific audit event by its unique identifier. - [Auth](https://docs.ctrl-hub.com/api-reference/auth.md): How to perform authenticated requests to the API - [Create a bridge request](https://docs.ctrl-hub.com/api-reference/bridges/generate-a-code-that-will-allow-another-organisation-to-request-a-bridge-to-your-organisation.md): Create code to initiate organisation connection bridge. - [List bridge requests](https://docs.ctrl-hub.com/api-reference/bridges/get-v3orgs-organisation-bridge-requests.md): List the organisation bridge requests. - [Get a bridge request](https://docs.ctrl-hub.com/api-reference/bridges/get-v3orgs-organisation-bridge-requests-1.md): Get an organisation bridge request. - [List bridges](https://docs.ctrl-hub.com/api-reference/bridges/get-v3orgs-organisation-bridges.md): List the organisation bridges. - [Get a bridge](https://docs.ctrl-hub.com/api-reference/bridges/get-v3orgs-organisation-bridges-1.md): Get an organisation bridge. - [Update a bridge request](https://docs.ctrl-hub.com/api-reference/bridges/update-an-existing-organisation-bridge-request.md): Updating organisation bridge requests allows you to approve or reject them. - [Remove contacts from an account](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/delete-v3orgs-customersaccounts-relationshipscontacts.md): Delete relationships from the customer account to contact(s) - [Remove properties from an account](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/delete-v3orgs-customersaccounts-relationshipsproperties.md): Delete relationships from the customer account to property(s) - [List accounts](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/get-v3orgs-customersaccounts.md): List all of the customer accounts in an organisation. - [Get an account](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/get-v3orgs-customersaccounts-1.md): Get an individual customer account by its ID. - [List contacts](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/get-v3orgs-customerscontacts.md): List all of the contacts in an organisation. - [Get a contact](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/get-v3orgs-customerscontacts-1.md): Get an individual contact by its ID. - [Update the contacts for an account](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/patch-v3orgs-customersaccounts-relationshipscontacts.md): Replace existing relationships from the customer account to the contact - [Update the properties for an account](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/patch-v3orgs-customersaccounts-relationshipsproperties.md): Replace existing relationships from the customer account to the property - [Create an account](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/post-v3orgs-customersaccounts.md): Create a new customer account. - [Associate a contact to an account](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/post-v3orgs-customersaccounts-relationshipscontacts.md): Create new relationships from the customer account to the contact - [Associate a property to an account](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/post-v3orgs-customersaccounts-relationshipsproperties.md): Create new relationships from the customer account to the property - [Create a contact](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/post-v3orgs-customerscontacts.md): Create a new contact. - [Update an account](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/put-v3orgs-customersaccounts.md): Update an existing customer account - [Update a contact](https://docs.ctrl-hub.com/api-reference/customer-accounts-and-contacts/put-v3orgs-customerscontacts.md): Update an existing contact - [List appointments](https://docs.ctrl-hub.com/api-reference/customer-appointments/get-v3orgs-customersappointments.md): List all of the appointments in an organisation. - [Get an appointment](https://docs.ctrl-hub.com/api-reference/customer-appointments/get-v3orgs-customersappointments-1.md): Get an individual appointment by its ID. - [Update appointment interactions](https://docs.ctrl-hub.com/api-reference/customer-appointments/patch-v3orgs-customersappointments-relationshipsinteraction.md): Replace existing relationship from the appointment to the interaction - [Update appointment operations](https://docs.ctrl-hub.com/api-reference/customer-appointments/patch-v3orgs-customersappointments-relationshipsoperation.md): Replace existing relationship from the appointment to the operation - [Update an appointment time band](https://docs.ctrl-hub.com/api-reference/customer-appointments/patch-v3orgs-customersappointments-relationshipstime-band.md): Replace existing relationship from the appointment to the time band - [Create an appointment](https://docs.ctrl-hub.com/api-reference/customer-appointments/post-v3orgs-customersappointments.md): Create a new appointment. - [Update an appointment](https://docs.ctrl-hub.com/api-reference/customer-appointments/put-v3orgs-customersappointments.md): Update an existing appointment - [List interactions](https://docs.ctrl-hub.com/api-reference/customer-interactions/get-v3orgs-customersinteractions.md): List all of the customer interactions in an organisation. - [Get an interaction](https://docs.ctrl-hub.com/api-reference/customer-interactions/get-v3orgs-customersinteractions-1.md): Get an individual customer interaction by its ID. - [Update the account for an interaction](https://docs.ctrl-hub.com/api-reference/customer-interactions/patch-v3orgs-customersinteractions-relationshipsaccount.md): Replace existing relationship from the customer interaction to the account - [Update the contact for an interaction](https://docs.ctrl-hub.com/api-reference/customer-interactions/patch-v3orgs-customersinteractions-relationshipscontact.md): Replace existing relationship from the customer interaction to the contact - [Update the property for an interaction](https://docs.ctrl-hub.com/api-reference/customer-interactions/patch-v3orgs-customersinteractions-relationshipsproperty.md): Replace existing relationship from the customer interaction to the property - [Update the prepresentative for an interaction](https://docs.ctrl-hub.com/api-reference/customer-interactions/patch-v3orgs-customersinteractions-relationshipsrepresentative.md): Replace existing relationship from the customer interaction to the representative - [Create an interaction](https://docs.ctrl-hub.com/api-reference/customer-interactions/post-v3orgs-customersinteractions.md): Create a new customer interaction. - [Update an interaction](https://docs.ctrl-hub.com/api-reference/customer-interactions/put-v3orgs-customersinteractions.md): Update an existing customer interaction - [Request a document review](https://docs.ctrl-hub.com/api-reference/document-reviews/create-a-document-review-request.md): Create a document review request - [Delete a request for a document review](https://docs.ctrl-hub.com/api-reference/document-reviews/delete-v3document-review-requests.md): Delete a document review request - [List request for document reviews](https://docs.ctrl-hub.com/api-reference/document-reviews/get-v3document-review-requests.md): List all document review requests accessible to the user - [Get a request for a document review](https://docs.ctrl-hub.com/api-reference/document-reviews/get-v3document-review-requests-1.md): Get a specific document review request by ID - [Update a request for a document review](https://docs.ctrl-hub.com/api-reference/document-reviews/put-v3document-review-requests.md): Update a document review request (reviewers or due date) - [Make a decision for a review](https://docs.ctrl-hub.com/api-reference/document-reviews/submit-a-review-decision.md): Submit an approval or rejection decision for a document review - [Create a document](https://docs.ctrl-hub.com/api-reference/documents/create-a-document.md): Create a document from an upload - [Add content to a document](https://docs.ctrl-hub.com/api-reference/documents/create-document-content.md): Create document content from an upload - [Delete a document](https://docs.ctrl-hub.com/api-reference/documents/delete-a-document.md): Delete a document - [Download the content of a document](https://docs.ctrl-hub.com/api-reference/documents/download-document-content.md): Download document content - [List downloads for all documents](https://docs.ctrl-hub.com/api-reference/documents/get-v3document-downloads.md): Retrieve all downloads - [List documents](https://docs.ctrl-hub.com/api-reference/documents/get-v3documents.md): Retrieve a list of documents you have access to - [Get a document](https://docs.ctrl-hub.com/api-reference/documents/get-v3documents-1.md): Get a document - [List document contents](https://docs.ctrl-hub.com/api-reference/documents/get-v3documents-contents.md): Retrieve a list of documents you have access to - [Create the content of a document](https://docs.ctrl-hub.com/api-reference/documents/get-v3documents-contents-1.md): Get a document content - [List downloads of a document](https://docs.ctrl-hub.com/api-reference/documents/get-v3documents-downloads.md): Retrieve a list downloads of documents. - [Update a document](https://docs.ctrl-hub.com/api-reference/documents/update-an-existing-document.md): Update an existing document - [Change a documents folder](https://docs.ctrl-hub.com/api-reference/documents/update-the-folder-that-a-document-is-in.md): Update the folder that a document is in. When data is set to null, the document will be moved to the root. - [Upload a document](https://docs.ctrl-hub.com/api-reference/documents/upload-a-document.md): Upload a document to the server. - [List equipment categories](https://docs.ctrl-hub.com/api-reference/equipment/get-v3assetsequipmentcategories.md): Retrieve a list of equipment categories. - [Get an equipment category](https://docs.ctrl-hub.com/api-reference/equipment/get-v3assetsequipmentcategories-1.md): Retrieve a specific equipment category by its unique identifier. - [List equipment](https://docs.ctrl-hub.com/api-reference/equipment/get-v3orgs-assetsequipment.md): Retrieve a list of equipment items for the given organisation. - [Get a piece of equipment](https://docs.ctrl-hub.com/api-reference/equipment/get-v3orgs-assetsequipment-1.md): Retrieve a specific piece of equipment. - [Create a feature configuration](https://docs.ctrl-hub.com/api-reference/feature-configurations/create-a-new-feature-configuration.md): Create a new feature configuration. - [Delete a feature configuration](https://docs.ctrl-hub.com/api-reference/feature-configurations/delete-a-feature-configuration.md): Delete a feature configuration. - [List feature configurations](https://docs.ctrl-hub.com/api-reference/feature-configurations/get-v3feature-configurations.md): List all feature configurations. - [Get a feature configuration](https://docs.ctrl-hub.com/api-reference/feature-configurations/get-v3feature-configurations-1.md): Get an individual feature configuration by id. - [Update a feature configuration](https://docs.ctrl-hub.com/api-reference/feature-configurations/update-an-existing-feature-configuration.md): Update an existing feature configuration. - [List features](https://docs.ctrl-hub.com/api-reference/feature-registry/get-v3features.md): Retrieve a list of registered features - [API Features](https://docs.ctrl-hub.com/api-reference/features.md): When we talk about API features, we are referring to the capabilities of the API rather than the resources themselves. This includes the ability to include, filter, sort, and page through data. - [Create a folder](https://docs.ctrl-hub.com/api-reference/folders/create-a-folder.md): Create a folder - [Delete a folder](https://docs.ctrl-hub.com/api-reference/folders/delete-a-folder.md): Delete a folder. Will only be successful if the folder is empty. - [List folders](https://docs.ctrl-hub.com/api-reference/folders/get-v3folders.md): Retrieve a list of folders you have access to - [Get a folder](https://docs.ctrl-hub.com/api-reference/folders/get-v3folders-1.md): Get a folder - [Update a folder](https://docs.ctrl-hub.com/api-reference/folders/update-an-existing-folder.md): Update an existing folder - [Change a folders parent](https://docs.ctrl-hub.com/api-reference/folders/update-the-parent-of-an-existing-folder.md): Update the parent of an existing folder. When data is set to null, the folder will be moved to the root. - [Create a form](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/create-a-new-form.md): Create a new form with no schema. - [Create a form category](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/create-a-new-form-category.md): Create a new form category. - [Create a schema for a form](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/create-a-new-form-schema.md): Create a new form schema. - [Remove a form from a category](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/delete-v3form-categories-relationshipsforms.md): Delete relationships from the form category to form(s) - [List form categories](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/get-v3form-categories.md): List all of the form categories in an organisation. - [Get a form category](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/get-v3form-categories-1.md): Get an individual form category by id. - [List form schemas](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/get-v3form-schemas.md): List all of the form schemas for a specific form. - [Get a form schema](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/get-v3form-schemas-1.md): Get an individual form schema by version. - [List forms](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/get-v3forms.md): List all of the forms in an organisation. - [Get a form](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/get-v3forms-1.md): Get an individual form by id. - [Update the category for a form](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/patch-v3form-categories-relationshipsforms.md): Replace existing relationships from the form category to the form - [Add a form to a category](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/post-v3form-categories-relationshipsforms.md): Create new relationships from the form category to the form - [Update a form](https://docs.ctrl-hub.com/api-reference/forms-schemas-and-categories/update-an-existing-form.md): Update an existing form - [Create a grant](https://docs.ctrl-hub.com/api-reference/iam-grants/create-a-grant.md): Create a new grant - [Delete a grant](https://docs.ctrl-hub.com/api-reference/iam-grants/delete-a-grant.md): Delete a grant - [List grants](https://docs.ctrl-hub.com/api-reference/iam-grants/get-v3grants.md): Retrieve a list of grants for the given organisation. - [Get a grant](https://docs.ctrl-hub.com/api-reference/iam-grants/get-v3grants-1.md): Retrieve a specific grant by its unique identifier. - [Update a grant](https://docs.ctrl-hub.com/api-reference/iam-grants/update-an-existing-grant.md): Update an existing grant - [List permissions](https://docs.ctrl-hub.com/api-reference/iam-permissions/get-v3permissions.md): Retrieve a list of permissions - [Get a permission](https://docs.ctrl-hub.com/api-reference/iam-permissions/get-v3permissions-1.md): Get an individual permission by its ID. - [Create a role group](https://docs.ctrl-hub.com/api-reference/iam-role-groups/create-a-role-group.md): Create a new role group. - [List role groups](https://docs.ctrl-hub.com/api-reference/iam-role-groups/get-v3orgs-iamgroups.md): List all of the groups in an organisation. - [Get a role group](https://docs.ctrl-hub.com/api-reference/iam-role-groups/get-v3orgs-iamgroups-1.md): Get an individual role group account by its ID. - [Replace group members](https://docs.ctrl-hub.com/api-reference/iam-role-groups/patch-v3orgs-iamgroups-relationshipsmembers.md): Replace existing relationship from the group to the member - [Update a role group](https://docs.ctrl-hub.com/api-reference/iam-role-groups/update-a-role-group.md): Update an existing role group. - [List roles](https://docs.ctrl-hub.com/api-reference/iam-roles/get-v3roles.md): Retrieve a list of roles - [Get a role](https://docs.ctrl-hub.com/api-reference/iam-roles/get-v3roles-1.md): Get an individual role by its ID. - [Create an image](https://docs.ctrl-hub.com/api-reference/images/creates-a-new-image.md): Uploads a new image and returns the ID. Images are processed in the background, so after uploading, you can poll the image resource URL to get additional information post processing - [List images](https://docs.ctrl-hub.com/api-reference/images/get-v3images.md): List all of the images in an organisation. - [Get an image at a specified size](https://docs.ctrl-hub.com/api-reference/images/get-v3images-.md): Images stored in Ctrl Hub are not accessible directly. This endpoint proxies the image binary to you. It is intended to be used in client requests and therefore it does not conform to the JSON:API standard. - [Get an image](https://docs.ctrl-hub.com/api-reference/images/get-v3images-1.md): Get an individual image by its ID. - [Create an import template](https://docs.ctrl-hub.com/api-reference/import-templates/create-an-import-template.md): Create an import template - [Delete import template](https://docs.ctrl-hub.com/api-reference/import-templates/delete-v3import-templates.md): Delete an import template. - [List import templates](https://docs.ctrl-hub.com/api-reference/import-templates/get-v3import-templates.md): Retrieve a list of import templates. - [Get import template](https://docs.ctrl-hub.com/api-reference/import-templates/get-v3import-templates-1.md): Retrieve a single import template. - [Update an import template](https://docs.ctrl-hub.com/api-reference/import-templates/update-an-import-template.md): Update an import template - [Introduction](https://docs.ctrl-hub.com/api-reference/introduction.md): Integrating with our API - [Invite a user](https://docs.ctrl-hub.com/api-reference/invitations/creates-a-user-invitation-to-join-the-organisation.md): Sends an invitation to the users email address if they exist in Ctrl Hub for them to join the organisation. - [Delete an invitation](https://docs.ctrl-hub.com/api-reference/invitations/delete-a-user-invitation.md): Delete a user invitation - [List invitations](https://docs.ctrl-hub.com/api-reference/invitations/get-v3user-invitations.md): List all of the user invitations in an organisation. - [Get an invitation](https://docs.ctrl-hub.com/api-reference/invitations/get-v3user-invitations-1.md): Get an individual user invitation by its ID. - [Update an invitation](https://docs.ctrl-hub.com/api-reference/invitations/update-an-existing-user-invitation.md): Update an existing user invitation. This can only be updated by the recipient of the email and can only be updated to change the status to accepted or rejected. When accepted, the user becomes a member of the organisation that sent the invitation. - [Create a job role](https://docs.ctrl-hub.com/api-reference/job-roles/create-a-new-job-role.md): Create a new job role. - [Assign a job role](https://docs.ctrl-hub.com/api-reference/job-roles/create-a-new-job-role-assignment.md): Create a new job role assignment linking a user to a job role. - [Delete a job role](https://docs.ctrl-hub.com/api-reference/job-roles/delete-a-job-role.md): Delete a job role - [Unassign a job role](https://docs.ctrl-hub.com/api-reference/job-roles/delete-a-job-role-assignment.md): Delete a job role assignment - [Get a job role](https://docs.ctrl-hub.com/api-reference/job-roles/retrieve-a-job-role.md): Retrieve a specific job role by its unique identifier. - [Get a job role assignment](https://docs.ctrl-hub.com/api-reference/job-roles/retrieve-a-job-role-assignment.md): Retrieve a specific job role assignment by its unique identifier. - [List job role assignments](https://docs.ctrl-hub.com/api-reference/job-roles/retrieve-job-role-assignments.md): Retrieve a list of job role assignments. - [List job roles](https://docs.ctrl-hub.com/api-reference/job-roles/retrieve-job-roles.md): Retrieve a list of job roles for the given organisation. - [Update a job role](https://docs.ctrl-hub.com/api-reference/job-roles/update-an-existing-job-role.md): Update an existing job role - [Create an operation](https://docs.ctrl-hub.com/api-reference/operations/create-a-new-operation.md): Create a new operation. - [Create an operation template](https://docs.ctrl-hub.com/api-reference/operations/create-a-new-operation-template.md): Create a new operation template. - [Remove assignees from an operation](https://docs.ctrl-hub.com/api-reference/operations/delete-v3operations-relationshipsassignees.md): Remove assignees from the operation - [Remove permits from an operation](https://docs.ctrl-hub.com/api-reference/operations/delete-v3operations-relationshipspermits.md): Remove permits from the operation - [Remove properties from an operation](https://docs.ctrl-hub.com/api-reference/operations/delete-v3operations-relationshipsproperties.md): Remove properties from the operation - [Remove streets from an operation](https://docs.ctrl-hub.com/api-reference/operations/delete-v3operations-relationshipsstreets.md): Remove streets from the operation - [Remove teams from an operation](https://docs.ctrl-hub.com/api-reference/operations/delete-v3operations-relationshipsteams.md): Remove teams from the operation - [List operations](https://docs.ctrl-hub.com/api-reference/operations/get-v3operations.md): List all of the operations in an organisation. - [Get an operation](https://docs.ctrl-hub.com/api-reference/operations/get-v3operations-1.md): Get an individual operation by its ID. - [List operation templates](https://docs.ctrl-hub.com/api-reference/operations/get-v3orgs-projectsoperation-templates.md): List all of the operation templates in an organisation. - [Get an operation template](https://docs.ctrl-hub.com/api-reference/operations/get-v3orgs-projectsoperation-templates-1.md): Get an individual operation template by its ID. - [Patch an operation](https://docs.ctrl-hub.com/api-reference/operations/partially-update-an-existing-operation.md): Partially update an existing operation. Only provided fields are modified. - [Replace the appointment on an operation](https://docs.ctrl-hub.com/api-reference/operations/patch-v3operations-relationshipsappointment.md): Replace existing appointment to the operation - [Replace assignees to an operation](https://docs.ctrl-hub.com/api-reference/operations/patch-v3operations-relationshipsassignees.md): Replace existing assignees to the operation - [Replace the permits on an operation](https://docs.ctrl-hub.com/api-reference/operations/patch-v3operations-relationshipspermits.md): Replace existing permits to the operation - [Replace properties on an operation](https://docs.ctrl-hub.com/api-reference/operations/patch-v3operations-relationshipsproperties.md): Replace existing properties to the operation - [Replace the streets on an operation](https://docs.ctrl-hub.com/api-reference/operations/patch-v3operations-relationshipsstreets.md): Replace existing streets to the operation - [Replace the teams on an operation](https://docs.ctrl-hub.com/api-reference/operations/patch-v3operations-relationshipsteams.md): Replace existing teams to the operation - [Assign users to an operation](https://docs.ctrl-hub.com/api-reference/operations/post-v3operations-relationshipsassignees.md): Add new assignees to an operation - [Assign permits to an operation](https://docs.ctrl-hub.com/api-reference/operations/post-v3operations-relationshipspermits.md): Add new permits to an operation - [Assign properties to an operation](https://docs.ctrl-hub.com/api-reference/operations/post-v3operations-relationshipsproperties.md): Add new properties to an operation - [Assign streets to an operation](https://docs.ctrl-hub.com/api-reference/operations/post-v3operations-relationshipsstreets.md): Add new streets to an operation - [Assign teams to an operation](https://docs.ctrl-hub.com/api-reference/operations/post-v3operations-relationshipsteams.md): Add new teams to an operation - [Update an operation](https://docs.ctrl-hub.com/api-reference/operations/update-an-existing-operation.md): Update an existing operation - [Update an operation template](https://docs.ctrl-hub.com/api-reference/operations/update-an-existing-operation-template.md): Update an existing operation template - [Create an organisation](https://docs.ctrl-hub.com/api-reference/organisations/create-an-organisation.md): Create an organisation - [List reviewers](https://docs.ctrl-hub.com/api-reference/organisations/get-v3document-reviewers.md): List users eligible to review documents for an organisation. Includes the organisation's members plus all members from SchemeShare-connected organisations (both directions), i.e., the union of members from connected schemes. - [List organisations](https://docs.ctrl-hub.com/api-reference/organisations/get-v3orgs.md): List all of the organisations that the principal has access to. - [Get an organisation](https://docs.ctrl-hub.com/api-reference/organisations/get-v3orgs-1.md): Get an individual organisation by its ID. - [Get member stats](https://docs.ctrl-hub.com/api-reference/organisations/get-v3orgs-iammember-stats.md): Get stats of members in an organisation. - [List members](https://docs.ctrl-hub.com/api-reference/organisations/get-v3orgs-iammembers.md): List all of the members in an organisation. - [Get a member](https://docs.ctrl-hub.com/api-reference/organisations/get-v3orgs-iammembers-1.md): Get an individual member by its ID. - [Create a permit](https://docs.ctrl-hub.com/api-reference/permits/create-a-new-permit.md): Create a new permit. - [List permits](https://docs.ctrl-hub.com/api-reference/permits/get-v3orgs-projectspermits.md): List all of the permits in an organisation. - [Get a permit](https://docs.ctrl-hub.com/api-reference/permits/get-v3orgs-projectspermits-1.md): Get an individual permit by its ID. - [Create a meter](https://docs.ctrl-hub.com/api-reference/properties/create-a-meter.md): Create a meter - [Create a PSR record](https://docs.ctrl-hub.com/api-reference/properties/create-a-psr-record.md): Create a PSR record - [Delete a meter](https://docs.ctrl-hub.com/api-reference/properties/delete-a-meter.md): Delete a meter - [Delete a PSR record](https://docs.ctrl-hub.com/api-reference/properties/delete-a-psr-record.md): Delete a PSR record - [List meters](https://docs.ctrl-hub.com/api-reference/properties/get-v3meters.md): Retrieve a list of meters. - [Get a meter](https://docs.ctrl-hub.com/api-reference/properties/get-v3meters-1.md): Retrieve an individual meter by its ID. - [Search by postcode](https://docs.ctrl-hub.com/api-reference/properties/get-v3postcode-lookups.md): Search for addresses at a given postcode. - [List properties](https://docs.ctrl-hub.com/api-reference/properties/get-v3properties.md): Retrieve a list of properties. - [Get a property](https://docs.ctrl-hub.com/api-reference/properties/get-v3properties-1.md): Retrieve an individual property by its ID or UPRN. - [Search for properties](https://docs.ctrl-hub.com/api-reference/properties/get-v3property-search-results.md): Search for properties. - [List PSR records](https://docs.ctrl-hub.com/api-reference/properties/get-v3psrs.md): Retrieve a list of PSR records. - [Get a PSR record](https://docs.ctrl-hub.com/api-reference/properties/get-v3psrs-1.md): Retrieve an individual PSR record by its ID. - [Resolve addresses](https://docs.ctrl-hub.com/api-reference/properties/resolve-addresses.md): Resolve one or more free-text address strings to canonical UPRNs. - [Update a meter](https://docs.ctrl-hub.com/api-reference/properties/update-an-existing-meter.md): Update an existing meter - [Update a PSR record](https://docs.ctrl-hub.com/api-reference/properties/update-an-existing-psr-record.md): Update an existing PSR record - [Create an assessment](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-assessment.md): Record an assessment for a user against an assessment definition. - [Create an assessment definition](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-assessment-definition.md): Create a new assessment definition. - [Award a qualification](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-award-for-a-qualification.md): Create a new award for a qualification. - [Create a competency requirement specification](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-competency-requirement-specification.md): Create a new competency requirement specification. - [Create an induction](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-induction.md): Create a new induction. - [Create an induction completion](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-induction-completion.md): Record an induction completion for a user. - [Assess a qualification](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-qualification-award-assessment.md): Create a new qualification award assessment. - [Verify a qualification](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-qualification-award-verification.md): Create a new qualification award verification. - [Create a registration](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-registration.md): Create a new registration on a skills register for a user. - [Create a skills register](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-skills-register.md): Create a new skills register. - [Create a skills register scheme](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-skills-register-scheme.md): Create a new skills register scheme. - [Create a skills register scheme category](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-skills-register-scheme-category.md): Create a new skills register scheme category. - [Create a training item](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-training-item.md): Create a new training item. - [Create a training standard completion](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-new-training-standard-completion.md): Record a training standard completion for a user. - [Create a training standard category](https://docs.ctrl-hub.com/api-reference/qualifications/create-a-training-standard-category.md): Create a new training standard category. - [Delete a competency requirement specification](https://docs.ctrl-hub.com/api-reference/qualifications/delete-a-competency-requirement-specification.md): Delete a competency requirement specification. - [Delete a registration](https://docs.ctrl-hub.com/api-reference/qualifications/delete-a-registration.md): Soft delete a registration. - [Delete a training item](https://docs.ctrl-hub.com/api-reference/qualifications/delete-a-training-item.md): Delete a training item. - [Delete an assessment definition](https://docs.ctrl-hub.com/api-reference/qualifications/delete-an-assessment-definition.md): Delete an assessment definition. - [Delete an induction](https://docs.ctrl-hub.com/api-reference/qualifications/delete-an-induction.md): Delete an induction. - [Delete an induction completion](https://docs.ctrl-hub.com/api-reference/qualifications/delete-an-induction-completion.md): Soft delete an induction completion. - [List assessment definitions](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3assessment-definitions.md): List all assessment definitions. - [Get an assessment definition](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3assessment-definitions-1.md): Get an individual assessment definition by its ID. - [List assessments](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3assessments.md): List all assessments. - [Get an assessment](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3assessments-1.md): Get an individual assessment by its ID. - [List competency requirement specifications](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3competency-requirement-specifications.md): List all competency requirement specifications. - [Get a competency requirement specification](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3competency-requirement-specifications-1.md): Get an individual competency requirement specification by its ID. - [List induction completions](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3induction-completions.md): List all induction completions. - [Get an induction completion](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3induction-completions-1.md): Get an individual induction completion by its ID. - [List inductions](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3inductions.md): List all inductions. - [Get an induction](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3inductions-1.md): Get an individual induction by its ID. - [List assessments](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3qualification-award-assessments.md): Retrieve a list of qualification award assessments for the given organisation. - [Get an assessment](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3qualification-award-assessments-1.md): Retrieve a specific qualification award assessment by its unique identifier. - [List verifications](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3qualification-award-verifications.md): Retrieve a list of qualification award verifications for the given organisation. - [Get a verification](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3qualification-award-verifications-1.md): Retrieve a specific qualification award verification by its unique identifier. - [List qualification awards](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3qualification-awards.md): Retrieve a list of qualification awards. - [Get a qualification award](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3qualification-awards-1.md): Retrieve a specific award by its unique identifier. - [List registrations](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3registrations.md): List all registrations. - [Get a registration](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3registrations-1.md): Get an individual registration by its ID. - [List skills register scheme categories](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3skills-register-scheme-categories.md): List all skills register scheme categories. - [Get a skills register scheme category](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3skills-register-scheme-categories-1.md): Get an individual skills register scheme category by its ID. - [List skills register schemes](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3skills-register-schemes.md): List all skills register schemes. - [Get a skills register scheme](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3skills-register-schemes-1.md): Get an individual skills register scheme by its ID. - [List skills registers](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3skills-registers.md): List all skills registers. - [Get a skills register](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3skills-registers-1.md): Get an individual skills register by its ID. - [List training items](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3training-items.md): List all training items. - [Get a training item](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3training-items-1.md): Get an individual training item by its ID. - [List training standard completions](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3training-standard-completions.md): List all training standard completions. - [Get a training standard completion](https://docs.ctrl-hub.com/api-reference/qualifications/get-v3training-standard-completions-1.md): Get an individual training standard completion by its ID. - [Evaluate group compliance for a CRS](https://docs.ctrl-hub.com/api-reference/qualifications/post-v3competency-requirement-specifications-compliance.md): Evaluate compliance for a collection of users against a competency requirement specification. Returns the overall `satisfied` outcome and a hierarchical compliance report. - [Update a verification](https://docs.ctrl-hub.com/api-reference/qualifications/put-v3qualification-award-verifications.md): Update a qualification award verification - [Get a qualification](https://docs.ctrl-hub.com/api-reference/qualifications/retrieve-a-qualification.md): Retrieve a specific qualification by its unique identifier. - [Get a qualification unit](https://docs.ctrl-hub.com/api-reference/qualifications/retrieve-a-qualification-unit.md): Retrieve a specific qualification unit by its unique identifier. - [Get a standards body](https://docs.ctrl-hub.com/api-reference/qualifications/retrieve-a-standards-body.md): Retrieve a specific standards body by its unique identifier. - [Get a training standard](https://docs.ctrl-hub.com/api-reference/qualifications/retrieve-a-training-standard.md): Retrieve a specific training standard by its unique identifier. - [Get a training standard category](https://docs.ctrl-hub.com/api-reference/qualifications/retrieve-a-training-standard-category.md): Retrieve a specific training standard category by its unique identifier. - [Get an awarding body](https://docs.ctrl-hub.com/api-reference/qualifications/retrieve-an-awarding-body.md): Retrieve a specific awarding body by its unique identifier. - [List awarding bodies](https://docs.ctrl-hub.com/api-reference/qualifications/retrieve-awarding-bodies.md): Retrieve a list of awarding bodies from the qualification library. - [List qualification units](https://docs.ctrl-hub.com/api-reference/qualifications/retrieve-qualification-units.md): Retrieve a list of qualification units from the qualification library. - [List qualifications](https://docs.ctrl-hub.com/api-reference/qualifications/retrieve-qualifications.md): Retrieve a list of qualifications from the qualification library. - [List standards bodies](https://docs.ctrl-hub.com/api-reference/qualifications/retrieve-standards-bodies.md): Retrieve a list of standards bodies from the training standards library. - [List training standard categories](https://docs.ctrl-hub.com/api-reference/qualifications/retrieve-training-standard-categories.md): Retrieve a list of training standard categories. - [List training standards](https://docs.ctrl-hub.com/api-reference/qualifications/retrieve-training-standards.md): Retrieve a list of training standards from the training standards library. - [Update a qualification](https://docs.ctrl-hub.com/api-reference/qualifications/update-a-qualification.md): Update admin-managed fields on a qualification (status). Fields sourced from Ofqual are managed by the sync pipeline. - [Update a training standard](https://docs.ctrl-hub.com/api-reference/qualifications/update-a-training-standard.md): Update admin-managed fields on a training standard (status, renewal period, categories). Fields sourced from the standards body (title, code, etc.) are managed by the sync pipeline. - [Update a training standard category](https://docs.ctrl-hub.com/api-reference/qualifications/update-a-training-standard-category.md): Update an existing training standard category. - [Update an assessment](https://docs.ctrl-hub.com/api-reference/qualifications/update-an-existing-assessment.md): Update an existing assessment. - [Update an assessment definition](https://docs.ctrl-hub.com/api-reference/qualifications/update-an-existing-assessment-definition.md): Update an existing assessment definition. - [Update a competency requirement specification](https://docs.ctrl-hub.com/api-reference/qualifications/update-an-existing-competency-requirement-specification.md): Update an existing competency requirement specification. - [Update an induction](https://docs.ctrl-hub.com/api-reference/qualifications/update-an-existing-induction.md): Update an existing induction. - [Update an induction completion](https://docs.ctrl-hub.com/api-reference/qualifications/update-an-existing-induction-completion.md): Update an existing induction completion. - [Update an award](https://docs.ctrl-hub.com/api-reference/qualifications/update-an-existing-qualification-award.md): Update an existing qualification award - [Update a registration](https://docs.ctrl-hub.com/api-reference/qualifications/update-an-existing-registration.md): Update an existing registration. - [Update a skills register](https://docs.ctrl-hub.com/api-reference/qualifications/update-an-existing-skills-register.md): Update an existing skills register. - [Update a skills register scheme](https://docs.ctrl-hub.com/api-reference/qualifications/update-an-existing-skills-register-scheme.md): Update an existing skills register scheme. - [Update a skills register scheme category](https://docs.ctrl-hub.com/api-reference/qualifications/update-an-existing-skills-register-scheme-category.md): Update an existing skills register scheme category. - [Update a training item](https://docs.ctrl-hub.com/api-reference/qualifications/update-an-existing-training-item.md): Update an existing training item. - [Update a training standard completion](https://docs.ctrl-hub.com/api-reference/qualifications/update-an-existing-training-standard-completion.md): Update an existing training standard completion. - [Create a scheme contract](https://docs.ctrl-hub.com/api-reference/scheme-contracts/create-a-new-scheme-contract.md): Create a new scheme contract. - [Delete a scheme contract](https://docs.ctrl-hub.com/api-reference/scheme-contracts/delete-a-scheme-contract.md): Soft-delete a scheme contract. - [Get a scheme contract](https://docs.ctrl-hub.com/api-reference/scheme-contracts/get-a-scheme-contract.md): Get an individual scheme contract by its ID. - [List scheme contracts](https://docs.ctrl-hub.com/api-reference/scheme-contracts/list-scheme-contracts.md): List scheme contracts allocated to the caller's organisation. - [Update a scheme contract](https://docs.ctrl-hub.com/api-reference/scheme-contracts/update-an-existing-scheme-contract.md): Update an existing scheme contract. - [Create a scheme share](https://docs.ctrl-hub.com/api-reference/scheme-shares/create-a-new-resource-share-between-2-organisations.md): Create a new share. - [Get a scheme share](https://docs.ctrl-hub.com/api-reference/scheme-shares/get-a-scheme-share-resource.md): Get a scheme share. - [List scheme shares](https://docs.ctrl-hub.com/api-reference/scheme-shares/list-scheme-share-resources.md): List scheme shares. - [Update a scheme share](https://docs.ctrl-hub.com/api-reference/scheme-shares/update-an-existing-scheme-share.md): Update an existing scheme share - [Create a scheme](https://docs.ctrl-hub.com/api-reference/schemes/create-a-new-scheme.md): Create a new scheme. - [Get a scheme template](https://docs.ctrl-hub.com/api-reference/schemes/create-a-new-scheme-template.md): Create a new scheme template. - [List scheme templates](https://docs.ctrl-hub.com/api-reference/schemes/get-v3orgs-projectsscheme-templates.md): List all of the scheme templates in an organisation. - [Get a scheme template](https://docs.ctrl-hub.com/api-reference/schemes/get-v3orgs-projectsscheme-templates-1.md): Get an individual scheme template by its ID. - [List schemes](https://docs.ctrl-hub.com/api-reference/schemes/get-v3orgs-projectsschemes.md): List all of the schemes in an organisation. - [Get a scheme](https://docs.ctrl-hub.com/api-reference/schemes/get-v3orgs-projectsschemes-1.md): Get an individual scheme by its ID. - [List schemes](https://docs.ctrl-hub.com/api-reference/schemes/get-v3schemes.md): List all of the schemes in an organisation. - [Get a scheme](https://docs.ctrl-hub.com/api-reference/schemes/get-v3schemes-1.md): Get an individual scheme by its ID. - [Update a scheme](https://docs.ctrl-hub.com/api-reference/schemes/update-an-existing-scheme.md): Update an existing scheme - [Update a scheme template](https://docs.ctrl-hub.com/api-reference/schemes/update-an-existing-scheme-template.md): Update an existing scheme template - [Perform a search](https://docs.ctrl-hub.com/api-reference/search/get-v3search.md): Search for schemes, work orders, and operations by name, code, or description. - [Create a service account](https://docs.ctrl-hub.com/api-reference/service-accounts/create-a-service-account.md): Create a new service account. - [Create a key for a service account](https://docs.ctrl-hub.com/api-reference/service-accounts/create-a-service-account-key.md): Create a new service account key. - [List service accounts](https://docs.ctrl-hub.com/api-reference/service-accounts/get-v3orgs-iamservice-accounts.md): List all of the service accounts in an organisation. - [Get a service account](https://docs.ctrl-hub.com/api-reference/service-accounts/get-v3orgs-iamservice-accounts-1.md): Get an individual service account by its ID. - [List logs for a service account](https://docs.ctrl-hub.com/api-reference/service-accounts/get-v3orgs-iamservice-accounts-logs.md): List the logs for a service account. - [Get a log for a service account](https://docs.ctrl-hub.com/api-reference/service-accounts/get-v3orgs-iamservice-accounts-logs-1.md): Get an individual service account log by its ID. - [Create a time band](https://docs.ctrl-hub.com/api-reference/settings/create-a-new-time-band.md): Create a new time band. - [Create nomenclature](https://docs.ctrl-hub.com/api-reference/settings/create-nomenclature-settings.md): Create nomenclature settings for an organisation. - [List time bands](https://docs.ctrl-hub.com/api-reference/settings/get-v3orgs-settingstime-bands.md): List all of the time bands in an organisation. - [Get a time band](https://docs.ctrl-hub.com/api-reference/settings/get-v3orgs-settingstime-bands-1.md): Get an individual time band by its ID. - [Update a time band](https://docs.ctrl-hub.com/api-reference/settings/update-an-existing-time-band.md): Update an existing time band - [Update nomenclature](https://docs.ctrl-hub.com/api-reference/settings/update-nomenclature-settings.md): Update the nomenclature settings for an organisation. - [Get this spec (JSON)](https://docs.ctrl-hub.com/api-reference/specifications/get-specjson.md): Returns the full API spec in JSON format. - [Get this spec (YAML)](https://docs.ctrl-hub.com/api-reference/specifications/get-specyaml.md): Returns the full API spec in YAML format. - [Create an SSO provider](https://docs.ctrl-hub.com/api-reference/sso-providers/create-an-sso-provider.md): Create an SSO provider - [Delete an SSO provider](https://docs.ctrl-hub.com/api-reference/sso-providers/delete-an-sso-provider.md): Delete an SSO provider. - [Match an SSO provider](https://docs.ctrl-hub.com/api-reference/sso-providers/get-v3sso-provider-matches.md): Matches an SSO provider by a supplied email address to compare against the domain - [List SSO providers](https://docs.ctrl-hub.com/api-reference/sso-providers/get-v3sso-providers.md): Retrieve a list of SSO providers you have access to - [Get an SSO provider](https://docs.ctrl-hub.com/api-reference/sso-providers/get-v3sso-providers-1.md): Get an SSO provider - [Update an SSO provider](https://docs.ctrl-hub.com/api-reference/sso-providers/update-an-existing-sso-provider.md): Update an existing SSO provider - [Status](https://docs.ctrl-hub.com/api-reference/status/get-v3status.md): View the platform status. - [List permits](https://docs.ctrl-hub.com/api-reference/street-manager/get-v3street-managerpermits.md): List all of the street manager permits with optional filtering and pagination. - [Get a permit](https://docs.ctrl-hub.com/api-reference/street-manager/get-v3street-managerpermits-1.md): Retrieve a single street manager permit by its ID. - [List versions of a permit](https://docs.ctrl-hub.com/api-reference/street-manager/get-v3street-managerpermits-versions.md): List all of the street manager permit versions for a specific permit. - [Get a permit version](https://docs.ctrl-hub.com/api-reference/street-manager/get-v3street-managerpermits-versions-1.md): Retrieve a single street manager permit version by its ID. - [Create a new activity](https://docs.ctrl-hub.com/api-reference/street-manager/post-street-manageractivities.md): This is used by street manager to create a new activity. - [Create a new permit](https://docs.ctrl-hub.com/api-reference/street-manager/post-street-managerpermits.md): This is used by street manager to create a new permit. - [Create a new protection](https://docs.ctrl-hub.com/api-reference/street-manager/post-street-managerprotections.md): This is used by street manager to create a new protection. - [List streets](https://docs.ctrl-hub.com/api-reference/streets/get-v3geostreets.md): Retrieve a list of streets. - [Get a street](https://docs.ctrl-hub.com/api-reference/streets/get-v3geostreets-1.md): Retrieve an individual street by its ID or USRN. - [Create a submission for a form](https://docs.ctrl-hub.com/api-reference/submissions/create-a-form-submission.md): Create a form submission - [Get all versions of form submissions](https://docs.ctrl-hub.com/api-reference/submissions/get-v3form-submission-versions.md): List all of the submission versions. - [Get a version of a form submission](https://docs.ctrl-hub.com/api-reference/submissions/get-v3form-submission-versions-1.md): Get an individual form submission version. - [List all submissions for a form](https://docs.ctrl-hub.com/api-reference/submissions/get-v3form-submissions.md): List all of the submissions in an organisation. - [Get a form submission](https://docs.ctrl-hub.com/api-reference/submissions/get-v3form-submissions-1.md): Get an individual submission by ID. - [Create a team](https://docs.ctrl-hub.com/api-reference/teams/create-a-team.md): Create a new team. - [List teams](https://docs.ctrl-hub.com/api-reference/teams/get-v3orgs-peopleteams.md): List all of the teams in an organisation. - [Get a team](https://docs.ctrl-hub.com/api-reference/teams/get-v3orgs-peopleteams-1.md): Get an individual team by its ID. - [Replace team members](https://docs.ctrl-hub.com/api-reference/teams/patch-v3orgs-peopleteams-relationshipsmembers.md): Replace existing relationship from the team to the member - [Update a team](https://docs.ctrl-hub.com/api-reference/teams/update-a-team.md): Update an existing team. - [Useful Reading](https://docs.ctrl-hub.com/api-reference/useful-reading.md): Useful information to read before attempting to integrate with the API - [Create a managed user](https://docs.ctrl-hub.com/api-reference/users/create-a-new-managed-user.md): Create a user managed by an organisation. - [Update a user](https://docs.ctrl-hub.com/api-reference/users/update-a-user.md): Update an existing user. - [List vehicle categories](https://docs.ctrl-hub.com/api-reference/vehicles/get-v3assetsvehiclescategories.md): Retrieve a list of vehicle categories. - [Get a vehicle category](https://docs.ctrl-hub.com/api-reference/vehicles/get-v3assetsvehiclescategories-1.md): Retrieve a specific vehicle category by its unique identifier. - [List vehicles](https://docs.ctrl-hub.com/api-reference/vehicles/get-v3orgs-assetsvehicles.md): Retrieve a list of vehicles for the given organisation. - [Get a vehicle](https://docs.ctrl-hub.com/api-reference/vehicles/get-v3orgs-assetsvehicles-1.md): Retrieve a specific vehicle by its unique identifier. - [Get information about the currently authenticated principal](https://docs.ctrl-hub.com/api-reference/whoami/get-v3iamwhoami.md): Get the currently authorised principal. - [Get information about the currently authenticated principal](https://docs.ctrl-hub.com/api-reference/whoami/get-v3whoami.md): Get the currently authorised principal. - [Create a work order](https://docs.ctrl-hub.com/api-reference/work-orders/create-a-new-work-order.md): Create a new work order. - [Create a work order template](https://docs.ctrl-hub.com/api-reference/work-orders/create-a-new-work-order-template.md): Create a new work order template. - [Remove permits from a work order](https://docs.ctrl-hub.com/api-reference/work-orders/delete-v3work-orders-relationshipspermits.md): Remove permits from the work order - [Remove site managers from a work order](https://docs.ctrl-hub.com/api-reference/work-orders/delete-v3work-orders-relationshipssite-managers.md): Remove site managers from the work order - [List work order templates](https://docs.ctrl-hub.com/api-reference/work-orders/get-v3orgs-projectswork-order-templates.md): List all of the work order templates in an organisation. - [Get a work order template](https://docs.ctrl-hub.com/api-reference/work-orders/get-v3orgs-projectswork-order-templates-1.md): Get an individual work order template by its ID. - [List work orders](https://docs.ctrl-hub.com/api-reference/work-orders/get-v3work-orders.md): List all of the users work orders. - [Get a work order](https://docs.ctrl-hub.com/api-reference/work-orders/get-v3work-orders-1.md): Get an individual work order by its ID. - [Replace permits on a work order](https://docs.ctrl-hub.com/api-reference/work-orders/patch-v3work-orders-relationshipspermits.md): Replace existing permits to the work order - [Replace site managers on a work order](https://docs.ctrl-hub.com/api-reference/work-orders/patch-v3work-orders-relationshipssite-managers.md): Replace existing site managers to the work order - [Assign permits to a work order](https://docs.ctrl-hub.com/api-reference/work-orders/post-v3work-orders-relationshipspermits.md): Add new permits to a work order - [Assign site managers to a work order](https://docs.ctrl-hub.com/api-reference/work-orders/post-v3work-orders-relationshipssite-managers.md): Add new site managers to a work order - [Update a work order](https://docs.ctrl-hub.com/api-reference/work-orders/update-an-existing-work-order.md): Update an existing work order - [Update a work order template](https://docs.ctrl-hub.com/api-reference/work-orders/update-an-existing-work-order-template.md): Update an existing work order template - [Create a workflow](https://docs.ctrl-hub.com/api-reference/workflows/creates-a-new-workflow-definition.md): Creates a new workflow definition that can be applied to forms - [Create a workflow version](https://docs.ctrl-hub.com/api-reference/workflows/creates-a-new-workflow-definition-version.md): Creates a new workflow definition version - [List workflow versions](https://docs.ctrl-hub.com/api-reference/workflows/get-v3workflow-definition-versions.md): List all of the workflow definition versions. - [Get a workflow version](https://docs.ctrl-hub.com/api-reference/workflows/get-v3workflow-definition-versions-1.md): Get an individual workflow definition version by its ID. - [List workflows](https://docs.ctrl-hub.com/api-reference/workflows/get-v3workflow-definitions.md): List all of the workflow definitions. - [Get a workflow](https://docs.ctrl-hub.com/api-reference/workflows/get-v3workflow-definitions-1.md): Get an individual workflow definition by its ID. - [List workflow transition records](https://docs.ctrl-hub.com/api-reference/workflows/get-v3workflow-transition-records.md): List workflow transition records - [Get a workflow transition record](https://docs.ctrl-hub.com/api-reference/workflows/get-v3workflow-transition-records-1.md): Get an individual workflow transition record by its ID. - [Create a workflow transition record](https://docs.ctrl-hub.com/api-reference/workflows/post-v3workflow-transition-records.md): Create a new workflow transition record. - [Update a workflow](https://docs.ctrl-hub.com/api-reference/workflows/update-an-existing-workflow-definition.md): Update an existing workflow definition. - [Create an assessment record](https://docs.ctrl-hub.com/api-reference/workforce/create-a-new-assessment-record.md): Create a new assessment record. - [Create a category registration](https://docs.ctrl-hub.com/api-reference/workforce/create-a-new-category-registration.md): Create a new category registration. - [Create a scheme registration](https://docs.ctrl-hub.com/api-reference/workforce/create-a-new-scheme-registration.md): Create a new scheme registration. - [Create a training completion](https://docs.ctrl-hub.com/api-reference/workforce/create-a-new-training-completion.md): Create a new training completion. - [Create a verification](https://docs.ctrl-hub.com/api-reference/workforce/create-a-verification.md): Record that the authenticated principal has verified a specific record. The supported record types are: induction completions, training completions, assessment records, registrations, category registrations, and scheme registrations. - [Delete a category registration](https://docs.ctrl-hub.com/api-reference/workforce/delete-a-category-registration.md): Soft delete a category registration. - [Delete a scheme registration](https://docs.ctrl-hub.com/api-reference/workforce/delete-a-scheme-registration.md): Soft delete a scheme registration. - [Delete a training completion](https://docs.ctrl-hub.com/api-reference/workforce/delete-a-training-completion.md): Soft delete a training completion. - [Delete an assessment record](https://docs.ctrl-hub.com/api-reference/workforce/delete-an-assessment-record.md): Soft delete an assessment record. - [List assessment records](https://docs.ctrl-hub.com/api-reference/workforce/get-v3assessment-records.md): List all assessment records. - [Get an assessment record](https://docs.ctrl-hub.com/api-reference/workforce/get-v3assessment-records-1.md): Get an individual assessment record by its ID. - [List category registrations](https://docs.ctrl-hub.com/api-reference/workforce/get-v3category-registrations.md): List all category registrations. - [Get a category registration](https://docs.ctrl-hub.com/api-reference/workforce/get-v3category-registrations-1.md): Get an individual category registration by its ID. - [List scheme registrations](https://docs.ctrl-hub.com/api-reference/workforce/get-v3scheme-registrations.md): List all scheme registrations. - [Get a scheme registration](https://docs.ctrl-hub.com/api-reference/workforce/get-v3scheme-registrations-1.md): Get an individual scheme registration by its ID. - [List training completions](https://docs.ctrl-hub.com/api-reference/workforce/get-v3training-completions.md): List all training completions. - [Get a training completion](https://docs.ctrl-hub.com/api-reference/workforce/get-v3training-completions-1.md): Get an individual training completion by its ID. - [List verifications](https://docs.ctrl-hub.com/api-reference/workforce/list-verifications.md): Retrieve a list of verifications. Filter by `ref_type` and `ref_id` to list verifications for a single record (e.g. a particular induction completion). - [Get a verification](https://docs.ctrl-hub.com/api-reference/workforce/retrieve-a-verification.md): Retrieve an individual verification by its unique identifier. - [Update an assessment record](https://docs.ctrl-hub.com/api-reference/workforce/update-an-existing-assessment-record.md): Update an existing assessment record. - [Update a category registration](https://docs.ctrl-hub.com/api-reference/workforce/update-an-existing-category-registration.md): Update an existing category registration. - [Update a scheme registration](https://docs.ctrl-hub.com/api-reference/workforce/update-an-existing-scheme-registration.md): Update an existing scheme registration. - [Update a training completion](https://docs.ctrl-hub.com/api-reference/workforce/update-an-existing-training-completion.md): Update an existing training completion. - [Field Engineer Guide](https://docs.ctrl-hub.com/guides/data-capture/field-engineer-guide.md): A step-by-step guide for field engineers using the Ctrl Hub mobile app, covering installation, operations, form submissions, offline working, and document access. - [Finding my operations](https://docs.ctrl-hub.com/guides/data-capture/finding-my-operations.md): Learn how to find your assigned operations using the Ctrl Hub mobile app. - [Starting a submission](https://docs.ctrl-hub.com/guides/data-capture/starting-a-submission.md): Learn how to create submissions using the Ctrl Hub mobile app, and save drafts until your are ready to submit. - [Submitting your completed form](https://docs.ctrl-hub.com/guides/data-capture/submitting-your-completed-form.md): Learn how to complete a submission in the Ctrl Hub mobile app, including working offline. - [Updating published submissions](https://docs.ctrl-hub.com/guides/data-capture/updating-published-submissions.md): Learn how to find published submissions in the Ctrl Hub we console. - [Working offline](https://docs.ctrl-hub.com/guides/data-capture/working-offline.md): Learn how to use the Ctrl Hub mobile app while offline or in areas with poor network connectivity. - [Document expiry](https://docs.ctrl-hub.com/guides/document-management/document-expiry.md): Learn how to set document expiry dates. - [Document review and approval](https://docs.ctrl-hub.com/guides/document-management/document-review-and-approval.md): Learn how to request review, and view and approve documents. - [Document versioning](https://docs.ctrl-hub.com/guides/document-management/document-versioning.md): Learn how document versions are created and accessed. - [Managing files and folders](https://docs.ctrl-hub.com/guides/document-management/managing-files-and-folders.md): Learn how to create, organise, rename, and manage document files and folders in your Ctrl Hub schemes. - [Accepting an enrolment invitation](https://docs.ctrl-hub.com/guides/getting-started/accepting-an-enrolment-invitation.md): Learn how to accept an invitation to join an organisation within the Ctrl Hub platform. - [Accessing Ctrl Hub](https://docs.ctrl-hub.com/guides/getting-started/accessing-ctrl-hub.md): Learn how to access the Ctrl Hub web console and mobile apps. - [Managing your password](https://docs.ctrl-hub.com/guides/getting-started/managing-your-password.md): Learn how to manage your account password, and recover forgotten credentials. - [Assigning operations](https://docs.ctrl-hub.com/guides/project-governance/assigning-operations.md): Learn how to assign operations to your field staff. - [Creating projects](https://docs.ctrl-hub.com/guides/project-governance/creating-projects.md): Learn how to create a new scheme (project) in Ctrl Hub, add work orders, and set up operations for contractor access. - [Finding projects](https://docs.ctrl-hub.com/guides/project-governance/finding-projects.md): Learn how to find projects (schemes), work order and operations. - [Importing property meter and PSR data](https://docs.ctrl-hub.com/guides/project-governance/importing-property-data.md): Learn how to import property meter and PSR information, using CSV files, through the Geo Importer tool. - [Managing progress](https://docs.ctrl-hub.com/guides/project-governance/managing-progress.md): Learn how to update the progress status of your work. - [Sharing projects](https://docs.ctrl-hub.com/guides/project-governance/sharing-projects.md): Learn how to share a scheme (project) in Ctrl Hub with your contractor organisations. - [Welcome to Ctrl Hub](https://docs.ctrl-hub.com/guides/what-is-ctrl-hub.md): Your complete platform for construction and utilities project governance, compliance, and field data capture ## OpenAPI Specs - [openapi](https://docs.ctrl-hub.com/api-reference/openapi.yaml)