> ## 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 form > Create a new form with no schema. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v3/forms 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/forms: post: tags: - Forms, Schemas and Categories summary: Create a new form description: Create a new form with no schema. operationId: CreateForm requestBody: $ref: '#/components/requestBodies/CreateForm' responses: '201': $ref: '#/components/responses/GetForm' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - OAuth2: [] - Cookie: [] components: requestBodies: CreateForm: required: true description: The form 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: forms attributes: type: object required: - name - status properties: name: type: string minLength: 1 description: The name of the form examples: - Customer Registration Form description: type: string description: Description of the form examples: - Form to collect customer registration information status: type: string enum: - draft - active - archived default: draft description: The status of the form examples: - draft relationships: type: object required: - organisation properties: organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' categories: type: object properties: data: type: array items: $ref: '#/components/schemas/FormCategoryRelationship' workflow: type: object properties: data: oneOf: - $ref: >- #/components/schemas/WorkflowDefinitionRelationship - type: 'null' responses: GetForm: description: Get a form. 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/Form' included: $ref: '#/components/schemas/FormIncludes' - $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 Conflict: description: The request conflicts with the current state of the resource 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: 8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g status: '409' title: Conflict detail: The request conflicts with the current state of the resource. code: CONFLICT.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. schemas: 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 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 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' FormIncludes: type: array description: Related resources that can be included when a form is returned items: discriminator: propertyName: type mapping: form-categories: $ref: '#/components/schemas/FormCategory' form-schemas: $ref: '#/components/schemas/FormSchema' organisations: $ref: '#/components/schemas/Organisation' users: $ref: '#/components/schemas/User' oneOf: - $ref: '#/components/schemas/FormCategory' - $ref: '#/components/schemas/FormSchema' - $ref: '#/components/schemas/Organisation' - $ref: '#/components/schemas/User' 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 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' FormCategory: type: object description: A form category required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the form category. type: type: string const: form-categories attributes: $ref: '#/components/schemas/FormCategoryAttributes' meta: $ref: '#/components/schemas/FormCategoryMeta' relationships: $ref: '#/components/schemas/FormCategoryRelationships' FormSchema: type: object description: A form schema required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the form schema. type: type: string const: form-schemas attributes: $ref: '#/components/schemas/FormSchemaAttributes' meta: $ref: '#/components/schemas/FormSchemaMeta' relationships: $ref: '#/components/schemas/FormSchemaRelationships' 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' User: type: object description: A user required: - id - type - attributes properties: id: type: string format: uuid description: The unique identifier of the user. examples: - 123e4567-e89b-12d3-a456-426614174000 type: type: string const: users attributes: $ref: '#/components/schemas/UserAttributes' meta: $ref: '#/components/schemas/UserMeta' relationships: $ref: '#/components/schemas/UserRelationships' 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 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 FormCategoryAttributes: type: object description: Attributes for a form category required: - name properties: name: type: string description: The name of the form category FormCategoryMeta: type: object description: Metadata for a form category required: - created_at - updated_at - counts properties: created_at: type: string format: date-time description: The date and time when the form category was created updated_at: type: string format: date-time description: The date and time when the form category was last updated counts: type: object properties: forms: type: integer description: The number of forms in this category. format: int64 minimum: 0 default: 0 FormCategoryRelationships: type: object description: Relationships for a form category properties: forms: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/FormRelationship' FormSchemaAttributes: type: object description: Attributes for a form schema required: - model - view - version properties: model: type: object description: >- The model schema for your data. This follows the JSON Schema specification, so the value here must be a valid JSON Schema. additionalProperties: true view: type: object required: - title - sections properties: title: type: string description: The title of the form view sections: type: array items: type: object required: - title - description - rows properties: title: type: string description: The title of the section description: type: string description: The description of the section order: type: integer minimum: 0 conditions: type: object description: Conditional logic for showing this section rows: type: array items: type: object required: - span - columns - title - description properties: title: type: string description: The title of the row description: type: string description: The description of the row order: type: integer minimum: 0 span: type: integer minimum: 1 maximum: 12 columns: type: array items: type: object required: - span - blocks - title - description - order properties: span: type: integer minimum: 1 maximum: 12 order: type: integer minimum: 0 blocks: type: array description: The form blocks in this column items: type: object title: type: string description: The title of the column description: type: string description: The description of the column version: type: string pattern: ^\d+\.\d+\.\d+$ description: Semantic version of the form schema FormSchemaMeta: type: object description: Metadata for a form schema required: - created_at - updated_at - latest properties: created_at: type: string format: date-time description: The date and time when the form schema was created updated_at: type: string format: date-time description: The date and time when the form schema was last updated latest: type: object properties: id: type: string format: uuid description: The ID of the latest version version: type: string description: The last version's semantic version pattern: ^\d+\.\d+\.\d+$ FormSchemaRelationships: type: object description: Relationships for a form schema properties: form: type: object required: - data properties: data: $ref: '#/components/schemas/FormRelationship' 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' UserAttributes: type: object description: Attributes for a user properties: email: type: string format: email description: The email address of the user. examples: - john.doe@example.com status: type: string enum: - active - inactive - pending - unknown description: > The membership status of this user in the organisation in the request URL. Only populated on org-scoped member endpoints; absent on global user endpoints. examples: - active identities: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier for the identity. examples: - 39ce13b8-1116-416a-ad5f-3c5edfd44f53 platform: type: string description: The platform of the identity. examples: - multi_tenant meta: type: - object - 'null' additionalProperties: true description: Additional metadata for the identity. profile: type: object properties: work: type: object properties: occupation: type: string description: The occupation of the user. examples: - Site Manager cscs: type: string description: The CSCS card number of the user. examples: - CSC123456 eusr: type: string description: The EUSR card number of the user. examples: - EUR789123 start_date: type: string format: date description: The start date of the user's employment. examples: - '2020-03-01T00:00:00.000Z' personal: type: object properties: first_name: type: string description: The first name of the user. examples: - John last_name: type: string description: The last name of the user. examples: - Doe dob: type: string format: date description: The date of birth of the user. examples: - '1985-06-15T00:00:00.000Z' username: type: string description: The username of the user. examples: - johndoe contact: type: object properties: mobile: type: string description: The mobile number of the user. examples: - +44 7700 900123 landline: type: string description: The landline of the user. examples: - +44 20 7946 0958 address: type: object properties: number: type: string description: The house number of the user's address. default: '' examples: - '42' street: type: string description: The street of the user's address. examples: - High Street area: type: string description: The area of the user's address. examples: - Westminster town: type: string description: The town of the user's address. examples: - London county: type: string description: The county of the user's address. examples: - Greater London postcode: type: string description: The postcode of the user's address. examples: - SW1A 1AA country_code: type: string description: The country code of the user's address. examples: - GB what3words: type: string description: The what3words location of the user's address. examples: - filled.count.soap settings: type: object properties: preferred_language: type: string description: The preferred language of the user. default: en-GB examples: - en-GB timezone: type: string description: The timezone of the user. examples: - Europe/London UserMeta: type: object description: Metadata for a user properties: grants: type: array items: type: string description: >- This data is only returned on the whoami endpoint - it contains all of the user's granted permissions. UserRelationships: type: object description: Relationships for a user properties: organisations: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/OrganisationRelationship' teams: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/TeamRelationship' managing_organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' FormRelationship: type: object description: Represents a relationship to a form required: - id - type properties: id: type: string format: uuid description: The unique identifier of the form type: type: string const: forms 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 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 securitySchemes: Session: description: | Session token for authentication. in: header name: X-Session-Token type: apiKey OAuth2: description: | OAuth2 token for authentication. flows: clientCredentials: scopes: {} tokenUrl: https://auth.ctrl-hub.com/oauth2/token type: oauth2 Cookie: description: | Cookie token for authentication. in: cookie name: ctrl_hub_session type: apiKey ````