> ## 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. # Create a query > Create a new query definition. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v3/queries 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: | 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: > Locations are places an organisation manages, optionally classified by a location type. name: Locations - 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: > 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: | 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/queries: post: tags: - Queries summary: Create a new query description: Create a new query definition. operationId: CreateQuery requestBody: $ref: '#/components/requestBodies/CreateQuery' responses: '201': $ref: '#/components/responses/GetQuery' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - Cookie: [] - OAuth2: [] components: requestBodies: CreateQuery: required: true description: The query to create. content: application/vnd.api+json: schema: type: object required: - data properties: data: type: object required: - type - attributes - relationships properties: type: type: string const: queries attributes: type: object required: - name - dataset - mode properties: name: type: string description: type: string dataset: type: string enum: - form-submissions mode: type: string enum: - detail - aggregate fields: type: array items: type: object required: - key properties: key: type: string label: type: string type: type: string group_by: type: array items: type: object required: - key properties: key: type: string label: type: string measures: type: array items: type: object required: - func properties: key: type: string func: type: string enum: - count - sum - avg - min - max label: type: string allOf: - if: required: - func properties: func: enum: - sum - avg - min - max then: required: - key filters: type: array items: type: object required: - key - op properties: key: type: string op: type: string values: type: array items: type: string sort: type: array items: type: object required: - key properties: key: type: string direction: type: string enum: - asc - desc relationships: type: object required: - organisation properties: organisation: type: object required: - data properties: data: type: object required: - type - id properties: type: type: string const: organisations id: type: string description: The ID of the organisation. form: type: object properties: data: oneOf: - type: object required: - type - id properties: type: type: string const: forms id: type: string format: uuid - type: 'null' responses: GetQuery: description: An individual query. 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/Query' included: $ref: '#/components/schemas/QueryIncludes' - $ref: '#/components/schemas/JSONAPI' BadRequest: description: > There was an error with the request - this could be due to an invalid body, query parameters, or headers that were sent to the API. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 98ca4a78-b66f-4234-9719-aaf832ee6669 status: '400' title: A validation error was encountered source: parameter: include meta: resource: wrong_value Unauthorised: description: Authentication failed headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 05fc9c8d-73b9-4697-9337-57f7a567a48f status: '401' title: You are not authorised to access this resource detail: In order to access this resource, you need the 'admin' role. code: AUTH.001 InternalServerError: description: There was a problem handling the request on the server side headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: fe9d9a69-f0a7-4fdc-bb2c-176027f316c5 status: '500' title: Internal Server Error detail: An unexpected error occurred on the server. headers: content-type: description: The content type of the response schema: type: string example: application/vnd.api+json content-length: description: The length of the response body in bytes schema: type: integer format: int32 example: 1234 x-request-id: description: >- An ID that can be provided when reporting bugs to help identify the issue schema: type: string example: 8470f56af4cf25e22be08e72c70dbbdc schemas: Query: type: object description: A saved query definition required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the query. type: type: string const: queries attributes: $ref: '#/components/schemas/QueryAttributes' meta: $ref: '#/components/schemas/QueryMeta' relationships: $ref: '#/components/schemas/QueryRelationships' QueryIncludes: type: array description: Related resources that can be included when a query is returned. items: discriminator: propertyName: type mapping: organisations: $ref: '#/components/schemas/Organisation' forms: $ref: '#/components/schemas/Form' oneOf: - $ref: '#/components/schemas/Organisation' - $ref: '#/components/schemas/Form' 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 QueryAttributes: type: object description: Attributes of a query definition required: - name - dataset - mode properties: name: type: string description: The display name of the query. description: type: string description: A description of the query. dataset: type: string enum: - form-submissions description: The dataset the query runs against. v1 supports "form-submissions". mode: type: string enum: - detail - aggregate description: >- detail returns one row per submission; aggregate groups by dimensions and computes measures. fields: type: array description: >- Selected columns (detail mode). Key is a stable schema field id or a spine column. items: type: object required: - key properties: key: type: string label: type: string type: type: string description: >- Drives the safe cast applied when extracting the value from the JSON payload. group_by: type: array description: >- Dimension fields (aggregate mode). Key is a stable schema field id or a spine column; label is the human-readable column heading. items: type: object required: - key properties: key: type: string label: type: string measures: type: array description: Aggregated values (aggregate mode). items: type: object required: - func properties: key: type: string description: The field aggregated over. Optional for count. func: type: string enum: - count - sum - avg - min - max label: type: string filters: type: array description: Constraints applied to the rows the query executes over. items: type: object required: - key - op properties: key: type: string op: type: string values: type: array items: type: string sort: type: array description: Ordering applied to query results. items: type: object required: - key properties: key: type: string direction: type: string enum: - asc - desc QueryMeta: type: object description: Metadata for a query required: - created_at - updated_at properties: created_at: type: string format: date-time description: The date and time the query was created. updated_at: type: string format: date-time description: The date and time the query was last updated. QueryRelationships: type: object description: Relationships for a query required: - organisation properties: organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' form: type: object properties: data: oneOf: - type: object required: - type - id properties: type: type: string const: forms id: type: string format: uuid - type: 'null' description: >- The form this query targets (for the form-submissions dataset). Null for dataset-level queries. 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' Form: type: object description: A form required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the form. type: type: string const: forms attributes: $ref: '#/components/schemas/FormAttributes' meta: $ref: '#/components/schemas/FormMeta' relationships: $ref: '#/components/schemas/FormRelationships' 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 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 properties: teams: type: object description: Team-related settings for the organisation. properties: customer_representatives: type: array description: > IDs of teams within this organisation whose members act as customer service representatives. Each entry must reference a team that belongs to this organisation. items: type: string format: uuid uniqueItems: true examples: - - b234c567-8901-2345-6789-abcdef012345 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' FormAttributes: type: object description: Attributes for a form required: - name - description - status properties: name: type: string description: The name of the form description: type: string description: The description of the form status: type: string enum: - draft - active - archived default: draft description: The current status of the form FormMeta: type: object description: Metadata for a form required: - created_at - updated_at - modified_at - counts properties: created_at: type: string format: date-time description: The date and time when the form was created updated_at: type: string format: date-time description: The date and time when the form was last updated modified_at: type: string format: date-time description: The date and time when the form was last modified counts: type: object properties: schemas: type: integer description: The number of schemas this form has. format: int64 minimum: 0 default: 0 categories: type: integer description: The number of categories this form has. format: int64 minimum: 0 default: 0 submissions: type: integer description: The number of submissions this form has. format: int64 minimum: 0 default: 0 submission_versions: type: integer description: The number of submission versions this form has. format: int64 minimum: 0 default: 0 FormRelationships: type: object description: Relationships for a form required: - organisation - categories - schemas properties: author: type: object required: - data properties: data: $ref: '#/components/schemas/UserRelationship' organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' categories: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/FormCategoryRelationship' workflow: type: object required: - data properties: data: oneOf: - $ref: '#/components/schemas/WorkflowDefinitionRelationship' - type: 'null' latest_schema: type: object required: - data properties: data: $ref: '#/components/schemas/FormSchemaRelationship' schemas: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/FormSchemaRelationship' submissions: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/FormSubmissionRelationship' 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 FormCategoryRelationship: type: object description: Represents a relationship to a form category required: - id - type properties: id: type: string format: uuid description: The unique identifier of the form category type: type: string const: form-categories WorkflowDefinitionRelationship: type: object description: Represents a relationship to a workflow definition required: - id - type properties: id: type: string format: uuid description: The unique identifier of the workflow definition type: type: string const: workflow-definitions FormSchemaRelationship: type: object description: Represents a relationship to a form schema required: - id - type properties: id: type: string format: uuid description: The unique identifier of the form schema type: type: string const: form-schemas FormSubmissionRelationship: type: object description: Represents a relationship to a form submission required: - id - type properties: id: type: string format: uuid description: The unique identifier of the form submission type: type: string const: form-submissions 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 ````