> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt > Use this file to discover all available pages before exploring further. # Get an equipment item > Retrieve a specific equipment item by its unique identifier. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v3/equipment-items/{equipment_item_id} openapi: 3.1.0 info: contact: email: support@ctrl-hub.com name: Ctrl Hub url: https://www.ctrl-hub.com description: > Ctrl Hub is the all-in-one platform for high-risk industries like utilities, construction, infrastructure, and renewables. We help teams manage everything from risk assessments and HAVS exposure to vehicle and equipment checks, with a guaranteed minimum of 200% ROI. license: name: MIT License url: https://opensource.org/licenses/MIT summary: An API for managing your compliance and risk posture termsOfService: https://www.ctrl-hub.com/terms-conditions title: Ctrl Hub version: 1.0.0 servers: - description: Production url: https://api.ctrl-hub.com - description: Staging url: https://api.ctrl-hub.dev - description: Development url: https://api.ctrl-hub.run security: [] tags: - description: | 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: | 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: | Qualifications are the skills and knowledge that an organisation requires. 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: | 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: | Manage your images name: Images - 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: | 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/equipment-items/{equipment_item_id}: get: tags: - Equipment description: Retrieve a specific equipment item by its unique identifier. operationId: GetEquipmentItem parameters: - $ref: '#/components/parameters/equipment_item_id' - $ref: '#/components/parameters/equipment_items_include' responses: '200': $ref: '#/components/responses/GetEquipmentItem' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - Cookie: [] - OAuth2: [] components: parameters: equipment_item_id: name: equipment_item_id in: path required: true description: The unique identifier for the equipment item. schema: type: string format: uuid example: b000316c-c731-41ba-9f0a-2091611b73f0 equipment_items_include: name: include in: query description: A comma separated list of related resources to include. required: false style: form explode: false schema: type: array items: type: string enum: - model - organisation - vehicle responses: GetEquipmentItem: description: Get a list of equipment in the organisation. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: allOf: - type: object required: - data properties: data: $ref: '#/components/schemas/EquipmentItem' included: $ref: '#/components/schemas/EquipmentItemIncludes' - $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: EquipmentItem: type: object description: An equipment item required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the equipment item. type: type: string const: equipment-items attributes: $ref: '#/components/schemas/EquipmentItemAttributes' meta: $ref: '#/components/schemas/EquipmentItemMeta' relationships: $ref: '#/components/schemas/EquipmentItemRelationships' EquipmentItemIncludes: type: array description: >- Related resources that can be included when an equipment item is returned. items: discriminator: propertyName: type mapping: equipment-models: $ref: '#/components/schemas/EquipmentModel' organisations: $ref: '#/components/schemas/Organisation' vehicles: $ref: '#/components/schemas/Vehicle' oneOf: - $ref: '#/components/schemas/EquipmentModel' - $ref: '#/components/schemas/Organisation' - $ref: '#/components/schemas/Vehicle' 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. type: string examples: - AUTH.001 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 required: - id - status - title EquipmentItemAttributes: type: object description: Attributes for an equipment item required: - serial properties: serial: type: string description: The serial number of the equipment item. examples: - CH-001 status: type: - string - 'null' description: The equipment item's status (e.g. active, retired, in-service). EquipmentItemMeta: type: object description: Metadata for an equipment item required: - created_at - updated_at properties: created_at: type: string format: date-time description: The date and time when the equipment item was created updated_at: type: string format: date-time description: The date and time when the equipment item was last updated EquipmentItemRelationships: type: object description: Relationships for an equipment item required: - organisation - model properties: organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' model: type: object required: - data properties: data: $ref: '#/components/schemas/EquipmentModelRelationship' vehicle: type: object required: - data properties: data: $ref: '#/components/schemas/VehicleRelationship' EquipmentModel: type: object description: An equipment model required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the equipment model. type: type: string const: equipment-models attributes: $ref: '#/components/schemas/EquipmentModelAttributes' meta: $ref: '#/components/schemas/EquipmentModelMeta' relationships: $ref: '#/components/schemas/EquipmentModelRelationships' Organisation: type: object description: An organisation required: - id - type - attributes - meta properties: id: type: string format: uuid description: The unique identifier of the organisation. type: type: string const: organisations attributes: $ref: '#/components/schemas/OrganisationAttributes' meta: $ref: '#/components/schemas/OrganisationMeta' relationships: $ref: '#/components/schemas/OrganisationRelationships' Vehicle: type: object description: A vehicle required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the vehicle. type: type: string const: vehicles attributes: $ref: '#/components/schemas/VehicleAttributes' meta: $ref: '#/components/schemas/VehicleMeta' relationships: $ref: '#/components/schemas/VehicleRelationships' OrganisationRelationship: type: object description: Represents a relationship to an organisation required: - id - type properties: id: type: string format: uuid description: The unique identifier of the organisation type: type: string const: organisations EquipmentModelRelationship: type: object description: Represents a relationship to an equipment model required: - id - type properties: id: type: string format: uuid description: The unique identifier for the equipment model type: type: string const: equipment-models VehicleRelationship: type: object description: Represents a relationship to a vehicle required: - id - type properties: id: type: string format: uuid description: The unique identifier of the vehicle type: type: string const: vehicles EquipmentModelAttributes: type: object description: Attributes for an equipment model required: - name properties: name: type: string description: The model name. examples: - TS 55 REQ-Plus description: type: - string - 'null' description: A short description of the model. specification: type: - object - 'null' description: >- Specification data, including HAVS-related vibration magnitude used by exposure calculations. properties: vibration: type: object description: Vibration magnitude exposed by the manufacturer for this model. properties: magnitude: type: number description: >- Vibration magnitude in m/s². Used as the source value for HAVS exposure calculations against this model. examples: - 2.7 documentation: type: array description: Documentation links for this model. items: type: object required: - name - link properties: name: type: string description: type: string link: type: string format: uri EquipmentModelMeta: type: object description: Metadata for an equipment model required: - created_at - updated_at properties: created_at: type: string format: date-time updated_at: type: string format: date-time EquipmentModelRelationships: type: object description: Relationships for an equipment model required: - manufacturer properties: manufacturer: type: object required: - data properties: data: $ref: '#/components/schemas/EquipmentManufacturerRelationship' categories: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/EquipmentCategoryRelationship' OrganisationAttributes: type: object description: Attributes for an organisation required: - name - slug - sandbox properties: name: type: string description: The name of the organisation. examples: - Acme Construction Ltd slug: type: string description: The URL-friendly identifier for the organisation. examples: - acme-construction description: type: string description: A short description of the organisation. examples: - >- Leading construction company specializing in infrastructure projects sandbox: type: boolean description: Whether the organisation is a sandbox (i.e. a test organisation) examples: - false settings: type: object OrganisationMeta: type: object description: Meta information for an organisation required: - v3 - status properties: created_at: type: string format: date-time description: The creation time of the organisation. examples: - '2023-01-15T10:30:00.000Z' updated_at: type: string format: date-time description: The last update time of the organisation. examples: - '2023-02-20T14:45:00.000Z' v3: type: boolean description: Whether the organisation is using version 3 exclusively. examples: - true status: type: string enum: - active - inactive default: active description: The current status of the organisation. examples: - active features: type: array description: Available features and their limits for the organisation. items: type: object properties: name: type: string description: The name of the feature. examples: - advanced_reporting enabled: type: boolean description: Whether the feature is enabled. examples: - true limit: type: integer description: The usage limit for this feature (if applicable). examples: - 1000 OrganisationRelationships: type: object description: Relationships for an organisation properties: users: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/UserRelationship' service_accounts: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/ServiceAccountRelationship' groups: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/UserGroupRelationship' teams: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/TeamRelationship' nomenclature: type: object required: - data properties: data: oneOf: - $ref: '#/components/schemas/NomenclatureRelationship' - type: 'null' VehicleAttributes: type: object description: Attributes for a vehicle required: - registration properties: vin: type: - string - 'null' description: The vehicle identification number. registration: type: string description: >- The vehicle's registration number (VRM). Stored uppercase with spaces stripped. examples: - BX10GKJ description: type: - string - 'null' description: A free-text description of the vehicle. colour: type: - string - 'null' description: The vehicle's colour. status: type: - string - 'null' description: >- The vehicle's status. A free-form string (e.g. active, off-road, retired, sorn). When the vehicle is SORN according to DVLA the status is automatically set to `sorn`. VehicleMeta: type: object description: > Metadata for a vehicle. Includes timestamps, derived counts, the rolled-up MOT/tax/SORN status from DVLA, the most recent inspection and inventory check references, and the full DVLA payload. required: - created_at - updated_at properties: created_at: type: string format: date-time updated_at: type: string format: date-time sorn: type: boolean description: Whether the vehicle is SORN according to DVLA. has_recall: type: boolean description: Whether DVLA reports an outstanding recall. last_odometer_reading: type: - integer - 'null' description: The most recent odometer reading taken from MOT records. counts: type: object properties: equipment: type: integer description: Number of equipment items currently assigned. mot: type: object description: Rolled-up MOT status. properties: is_valid: type: - boolean - 'null' records: type: integer description: Number of MOT records on file. last: type: object properties: at: type: - string - 'null' format: date-time id: type: - string - 'null' format: uuid tax: type: object description: Rolled-up tax status. properties: is_valid: type: - boolean - 'null' due: type: - string - 'null' checks: type: object description: Rolled-up inspection and inventory check references. properties: inventory: type: object properties: count: type: integer last: type: object properties: at: type: - string - 'null' format: date-time id: type: - string - 'null' format: uuid inspection: type: object properties: count: type: integer last: type: object properties: at: type: - string - 'null' format: date-time id: type: - string - 'null' format: uuid dvla: type: - object - 'null' description: The full DVLA VES + MOT payload as last seen. properties: mot: type: - object - 'null' properties: exists: type: boolean last_sync: type: - string - 'null' format: date-time data: type: - object - 'null' ves: type: - object - 'null' properties: exists: type: boolean last_sync: type: - string - 'null' format: date-time data: type: - object - 'null' VehicleRelationships: type: object description: Relationships for a vehicle required: - organisation properties: organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' specification: type: object required: - data properties: data: $ref: '#/components/schemas/VehicleSpecificationRelationship' equipment: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/EquipmentItemRelationship' team: type: object required: - data properties: data: $ref: '#/components/schemas/TeamRelationship' assignee: type: object required: - data properties: data: $ref: '#/components/schemas/UserRelationship' EquipmentManufacturerRelationship: type: object description: Represents a relationship to an equipment manufacturer required: - id - type properties: id: type: string format: uuid description: The unique identifier for the equipment manufacturer type: type: string const: equipment-manufacturers EquipmentCategoryRelationship: type: object description: Represents a relationship to an equipment category required: - id - type properties: id: type: string format: uuid description: The unique identifier of the equipment category type: type: string const: equipment-categories UserRelationship: type: object description: Represents a relationship to a user required: - id - type properties: id: type: string format: uuid description: The unique identifier of the user type: type: string const: users ServiceAccountRelationship: type: object description: Represents a relationship to a service account required: - id - type properties: id: type: string format: uuid description: The unique identifier of the service account type: type: string const: service-accounts UserGroupRelationship: type: object description: Represents a relationship to a group required: - id - type properties: id: type: string format: uuid description: The unique identifier of the group type: type: string const: groups TeamRelationship: type: object description: Represents a relationship to a team required: - id - type properties: id: type: string format: uuid description: The unique identifier of the team type: type: string const: teams NomenclatureRelationship: type: object description: Represents a relationship to a nomenclature resource required: - id - type properties: id: type: string format: uuid description: The unique identifier of the nomenclature resource type: type: string const: nomenclature VehicleSpecificationRelationship: type: object description: Represents a relationship to a vehicle specification required: - id - type properties: id: type: string format: uuid description: The unique identifier for the vehicle specification type: type: string const: vehicle-specifications EquipmentItemRelationship: type: object description: Represents a relationship to an equipment item required: - id - type properties: id: type: string format: uuid description: The unique identifier for the equipment item type: type: string const: equipment-items securitySchemes: Session: description: | Session token for authentication. in: header name: X-Session-Token type: apiKey Cookie: description: | Cookie token for authentication. in: cookie name: ctrl_hub_session type: apiKey OAuth2: description: | OAuth2 token for authentication. flows: clientCredentials: scopes: {} tokenUrl: https://auth.ctrl-hub.com/oauth2/token type: oauth2 ````