email of an existing record in the users table.'
example: gbailey@example.net
nullable: false
required:
- email
security: []
/api/reset-password:
post:
summary: ''
operationId: postApiResetPassword
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Must be a valid email address. The email of an existing record in the users table.'
example: gbailey@example.net
nullable: false
token:
type: string
description: ''
example: architecto
nullable: false
password:
type: string
description: 'Must be at least 6 characters.'
example: ']|{+-0pBNvYg'
nullable: false
required:
- email
- token
- password
security: []
/api/refresh-token:
post:
summary: ''
operationId: postApiRefreshToken
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
/api/send-verification-email:
post:
summary: ''
operationId: postApiSendVerificationEmail
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Must be a valid email address.'
example: gbailey@example.net
nullable: false
required:
- email
security: []
/api/verify-email-token:
post:
summary: ''
operationId: postApiVerifyEmailToken
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: ''
example: architecto
nullable: false
required:
- token
security: []
/api/send-otp:
post:
summary: ''
operationId: postApiSendOtp
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Must be a valid email address.'
example: gbailey@example.net
nullable: false
required:
- email
security: []
/api/verify-otp:
post:
summary: ''
operationId: postApiVerifyOtp
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Must be a valid email address.'
example: gbailey@example.net
nullable: false
otp:
type: string
description: 'Must be 6 digits.'
example: '569775'
nullable: false
required:
- email
- otp
security: []
/api/blogs:
get:
summary: ''
operationId: getApiBlogs
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: array
items:
type: object
example:
-
id: 1
title: Angular
slug: angular
department_id: 1
image: 'https://qgenesisapi.dilonline.in/uploads/blogs/1750069204_5.PNG'
summary: null
content: 'Angular
Test
' meta_title: 'M Title' tags: '' meta_description: '' author_name: '' desired_modules: '' status: Published allow_comments: 1 is_featured: 0 is_pinned: 0 publish_date: '2025-06-17' scheduled_publish_date: '2025-06-17' created_at: '2025-06-17T10:43:08.000000Z' updated_at: '2025-06-17T10:43:39.000000Z' tags: - Endpoints security: [] post: summary: '' operationId: postApiBlogs description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: multipart/form-data: schema: type: object properties: title: type: string description: 'Blog Content Section. Must not be greater than 255 characters.' example: b nullable: false slug: type: string description: 'Must not be greater than 255 characters.' example: 'n' nullable: false department: type: string description: 'Theid of an existing record in the department_categories table.'
example: null
nullable: true
image:
type: string
format: binary
description: 'Must be an image. Must not be greater than 2048 kilobytes.'
nullable: true
summary:
type: string
description: ''
example: architecto
nullable: true
content:
type: string
description: ''
example: architecto
nullable: true
metaTitle:
type: string
description: 'Must not be greater than 255 characters.'
example: 'n'
nullable: true
tags:
type: string
description: 'Must not be greater than 255 characters.'
example: g
nullable: true
metaDescription:
type: string
description: ''
example: architecto
nullable: true
authorName:
type: string
description: 'Must not be greater than 255 characters.'
example: 'n'
nullable: true
desiredModules:
type: string
description: 'Must not be greater than 255 characters.'
example: g
nullable: true
status:
type: string
description: ''
example: Scheduled
nullable: true
enum:
- Published
- Draft
- Scheduled
- Pending
publishDate:
type: string
description: 'Must be a valid date.'
example: '2025-06-18T08:59:18'
nullable: true
scheduledPublishDate:
type: string
description: 'Must be a valid date.'
example: '2025-06-18T08:59:18'
nullable: true
allowComments:
type: boolean
description: ''
example: true
nullable: false
isFeatured:
type: boolean
description: ''
example: true
nullable: false
isPinned:
type: boolean
description: ''
example: false
nullable: false
required:
- title
- slug
security: []
/api/plans:
get:
summary: ''
operationId: getApiPlans
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: array
items:
type: object
example:
-
id: 2
name: Basic
price: '2000.00'
domain: null
bandwidth: null
storage: null
email_support: 0
hourly_support: 0
users: '2'
days: 66
created_at: '2025-06-16T10:19:51.000000Z'
updated_at: '2025-06-16T10:19:51.000000Z'
-
id: 3
name: Test
price: '1.00'
domain: null
bandwidth: null
storage: null
email_support: 0
hourly_support: 0
users: '2'
days: 6
created_at: '2025-06-17T10:45:06.000000Z'
updated_at: '2025-06-17T10:45:06.000000Z'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiPlans
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: architecto
nullable: false
price:
type: string
description: ''
example: architecto
nullable: false
domain:
type: string
description: ''
example: null
nullable: true
bandwidth:
type: string
description: ''
example: null
nullable: true
storage:
type: string
description: ''
example: null
nullable: true
users:
type: number
description: 'Must be at least 1.'
example: 22
nullable: false
days:
type: number
description: 'Must be at least 1.'
example: 67
nullable: false
email_support:
type: string
description: ''
example: null
nullable: true
hourly_support:
type: string
description: ''
example: null
nullable: true
required:
- name
- price
- users
- days
security: []
'/api/plans/{id}':
get:
summary: ''
operationId: getApiPlansId
description: ''
parameters: []
responses:
404:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'No query results for model [App\Models\SubscriptionPlan] architecto'
properties:
message:
type: string
example: 'No query results for model [App\Models\SubscriptionPlan] architecto'
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the plan.'
example: architecto
required: true
schema:
type: string
/api/industry-categories:
get:
summary: ''
operationId: getApiIndustryCategories
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: array
items:
type: object
example:
-
id: 5
name: Research
created_at: '2025-06-17T09:17:19.000000Z'
updated_at: '2025-06-17T09:17:19.000000Z'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiIndustryCategories
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
required:
- name
security: []
'/api/industry-sub-categories/{industry_id}/sub-industries':
get:
summary: ''
operationId: getApiIndustrySubCategoriesIndustry_idSubIndustries
description: ''
parameters: []
responses:
404:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'No sub-domains found for this domain.'
properties:
message:
type: string
example: 'No sub-domains found for this domain.'
tags:
- Endpoints
security: []
parameters:
-
in: path
name: industry_id
description: 'The ID of the industry.'
example: architecto
required: true
schema:
type: string
/api/register-business:
post:
summary: ''
operationId: postApiRegisterBusiness
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
/api/register-domain:
post:
summary: ''
operationId: postApiRegisterDomain
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
domain_name:
type: string
description: 'Must match the regex /^[a-zA-Z0-9-]+$/.'
example: VJR
nullable: false
full_name:
type: string
description: 'Must not be greater than 255 characters.'
example: 'y'
nullable: false
country:
type: string
description: ''
example: architecto
nullable: false
email:
type: string
description: 'Must be a valid email address.'
example: zbailey@example.net
nullable: false
required:
- domain_name
- full_name
- country
- email
security: []
'/api/verify-email/{token}':
get:
summary: ''
operationId: getApiVerifyEmailToken
description: ''
parameters: []
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Verification failed.'
properties:
message:
type: string
example: 'Verification failed.'
tags:
- Endpoints
security: []
parameters:
-
in: path
name: token
description: ''
example: architecto
required: true
schema:
type: string
/api/resend-verification-email:
post:
summary: ''
operationId: postApiResendVerificationEmail
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Must be a valid email address. The email of an existing record in the users table.'
example: gbailey@example.net
nullable: false
required:
- email
security: []
/api/business-workflows:
get:
summary: ''
operationId: getApiBusinessWorkflows
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiBusinessWorkflows
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
version:
type: string
description: 'Must not be greater than 50 characters.'
example: 'n'
nullable: false
dynamic_form_id:
type: string
description: 'The id of an existing record in the dynamic_forms table.'
example: architecto
nullable: false
workflow_level_forms:
type: array
description: 'Must have at least 1 items.'
example:
- []
items:
type: object
properties:
title:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
business_workflow_id:
type: string
description: 'The id of an existing record in the business_workflows table.'
example: null
nullable: true
department_category_id:
type: string
description: 'The id of an existing record in the department_categories table.'
example: architecto
nullable: false
department_team_member_id:
type: string
description: ''
example: architecto
nullable: false
form_structure_json:
type: string
description: ''
example: architecto
nullable: false
required:
- title
- department_category_id
- department_team_member_id
- form_structure_json
required:
- title
- version
- dynamic_form_id
- workflow_level_forms
security: []
'/api/business-workflows/{id}':
get:
summary: ''
operationId: getApiBusinessWorkflowsId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiBusinessWorkflowsId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
version:
type: string
description: 'Must not be greater than 50 characters.'
example: 'n'
nullable: false
dynamic_form_id:
type: string
description: 'The id of an existing record in the dynamic_forms table.'
example: architecto
nullable: false
workflow_level_forms:
type: array
description: 'Must have at least 1 items.'
example:
- []
items:
type: object
properties:
title:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
business_workflow_id:
type: string
description: 'The id of an existing record in the business_workflows table.'
example: null
nullable: true
department_category_id:
type: string
description: 'The id of an existing record in the department_categories table.'
example: architecto
nullable: false
department_team_member_id:
type: string
description: ''
example: architecto
nullable: false
form_structure_json:
type: string
description: ''
example: architecto
nullable: false
required:
- title
- department_category_id
- department_team_member_id
- form_structure_json
required:
- title
- version
- dynamic_form_id
- workflow_level_forms
security: []
delete:
summary: ''
operationId: deleteApiBusinessWorkflowsId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the business workflow.'
example: architecto
required: true
schema:
type: string
/api/profile/change-password:
post:
summary: ''
operationId: postApiProfileChangePassword
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
currentPassword:
type: string
description: ''
example: architecto
nullable: false
password:
type: string
description: 'Must be at least 8 characters.'
example: ']|{+-0pBNvYg'
nullable: false
required:
- currentPassword
- password
security: []
/api/profile/update:
post:
summary: ''
operationId: postApiProfileUpdate
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
profile_image:
type: string
format: binary
description: 'Must be an image. Must not be greater than 8000 kilobytes.'
nullable: false
signature:
type: string
format: binary
description: 'Must be an image. Must not be greater than 8000 kilobytes.'
nullable: false
first_name:
type: string
description: ''
example: architecto
nullable: false
last_name:
type: string
description: ''
example: architecto
nullable: false
organization:
type: string
description: ''
example: architecto
nullable: true
required:
- first_name
- last_name
security: []
/api/profile/update-billing:
post:
summary: ''
operationId: postApiProfileUpdateBilling
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
company_name:
type: string
description: ''
example: architecto
nullable: true
billing_email:
type: string
description: 'Must be a valid email address.'
example: zbailey@example.net
nullable: true
tax_id:
type: string
description: ''
example: architecto
nullable: true
vat_number:
type: string
description: ''
example: architecto
nullable: true
mobile_no:
type: string
description: ''
example: architecto
nullable: true
billing_address:
type: string
description: ''
example: architecto
nullable: true
billing_country:
type: string
description: ''
example: architecto
nullable: true
billing_state:
type: string
description: ''
example: architecto
nullable: true
billing_zip:
type: string
description: ''
example: architecto
nullable: true
security: []
/api/profile/get-profile:
get:
summary: ''
operationId: getApiProfileGetProfile
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
/api/users:
get:
summary: ''
operationId: getApiUsers
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiUsers
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Must be a valid email address.'
example: gbailey@example.net
nullable: false
password:
type: string
description: 'Must be at least 8 characters.'
example: '+-0pBNvYgxwmi/#iw'
nullable: false
name:
type: string
description: ''
example: architecto
nullable: false
phone:
type: string
description: ''
example: architecto
nullable: true
employee_id:
type: string
description: ''
example: architecto
nullable: true
designation:
type: string
description: ''
example: architecto
nullable: true
location:
type: string
description: ''
example: architecto
nullable: true
timezone:
type: string
description: ''
example: Asia/Yekaterinburg
nullable: true
role_id:
type: string
description: 'The id of an existing record in the roles table.'
example: architecto
nullable: false
department_id:
type: string
description: 'The id of an existing record in the department_categories table.'
example: architecto
nullable: false
status:
type: string
description: ''
example: inactive
nullable: true
enum:
- active
- inactive
required:
- email
- password
- name
- role_id
- department_id
security: []
'/api/users/{id}':
get:
summary: ''
operationId: getApiUsersId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiUsersId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: ''
example: null
nullable: false
name:
type: string
description: ''
example: architecto
nullable: false
phone:
type: string
description: ''
example: architecto
nullable: true
employee_id:
type: string
description: ''
example: architecto
nullable: true
designation:
type: string
description: ''
example: architecto
nullable: true
location:
type: string
description: ''
example: architecto
nullable: true
timezone:
type: string
description: ''
example: Asia/Yekaterinburg
nullable: true
role_id:
type: string
description: 'The id of an existing record in the roles table.'
example: architecto
nullable: false
department_id:
type: string
description: 'The id of an existing record in the department_categories table.'
example: architecto
nullable: false
status:
type: string
description: ''
example: inactive
nullable: true
enum:
- active
- inactive
required:
- name
- role_id
- department_id
security: []
delete:
summary: ''
operationId: deleteApiUsersId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the user.'
example: architecto
required: true
schema:
type: string
'/api/department-users/{department_id}':
get:
summary: ''
operationId: getApiDepartmentUsersDepartment_id
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
parameters:
-
in: path
name: department_id
description: 'The ID of the department.'
example: architecto
required: true
schema:
type: string
'/api/roles/{role_id}/permissions':
post:
summary: ''
operationId: postApiRolesRole_idPermissions
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
permissions:
type: object
description: ''
example: []
nullable: false
properties: { }
required:
- permissions
security: []
get:
summary: ''
operationId: getApiRolesRole_idPermissions
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
parameters:
-
in: path
name: role_id
description: 'The ID of the role.'
example: 11
required: true
schema:
type: integer
/api/roles:
get:
summary: ''
operationId: getApiRoles
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiRoles
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: architecto
nullable: false
description:
type: string
description: ''
example: null
nullable: true
permissions:
type: object
description: ''
example: null
nullable: false
properties: { }
required:
- name
security: []
'/api/roles/{id}':
get:
summary: ''
operationId: getApiRolesId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiRolesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
description:
type: string
description: ''
example: null
nullable: true
permissions:
type: object
description: ''
example: null
nullable: true
properties: { }
required:
- name
security: []
delete:
summary: ''
operationId: deleteApiRolesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the role.'
example: 11
required: true
schema:
type: integer
/api/permissions:
get:
summary: ''
operationId: getApiPermissions
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiPermissions
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: architecto
nullable: false
required:
- name
security: []
'/api/permissions/{id}':
put:
summary: ''
operationId: putApiPermissionsId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: null
nullable: false
security: []
delete:
summary: ''
operationId: deleteApiPermissionsId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the permission.'
example: 1
required: true
schema:
type: integer
'/api/users/{user}/permissions':
get:
summary: ''
operationId: getApiUsersUserPermissions
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
parameters:
-
in: path
name: user
description: 'The user.'
example: architecto
required: true
schema:
type: string
/api/businesses/all:
get:
summary: ''
operationId: getApiBusinessesAll
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
/api/businesses:
get:
summary: ''
operationId: getApiBusinesses
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
'/api/businesses/{id}':
delete:
summary: ''
operationId: deleteApiBusinessesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
get:
summary: ''
operationId: getApiBusinessesId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiBusinessesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the business.'
example: architecto
required: true
schema:
type: string
/api/businesses/upload-temp-image:
post:
summary: ''
operationId: postApiBusinessesUploadTempImage
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
image:
type: string
format: binary
description: 'Must be an image. Must not be greater than 2048 kilobytes.'
nullable: false
required:
- image
security: []
/api/businesses/delete-temp-image:
delete:
summary: ''
operationId: deleteApiBusinessesDeleteTempImage
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
'/api/businesses/restore/{id}':
put:
summary: ''
operationId: putApiBusinessesRestoreId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the restore.'
example: architecto
required: true
schema:
type: string
'/api/company/{id}':
get:
summary: ''
operationId: getApiCompanyId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiCompanyId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the company.'
example: architecto
required: true
schema:
type: string
/api/industries:
get:
summary: ''
operationId: getApiIndustries
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiIndustries
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
'/api/industries/{id}':
get:
summary: ''
operationId: getApiIndustriesId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiIndustriesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
delete:
summary: ''
operationId: deleteApiIndustriesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the industry.'
example: architecto
required: true
schema:
type: string
'/api/industry-categories/{id}':
put:
summary: ''
operationId: putApiIndustryCategoriesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
required:
- name
security: []
delete:
summary: ''
operationId: deleteApiIndustryCategoriesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the industry category.'
example: 5
required: true
schema:
type: integer
/api/industry-sub-categories:
get:
summary: ''
operationId: getApiIndustrySubCategories
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiIndustrySubCategories
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
subCategoryName:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
categoryName:
type: string
description: 'The id of an existing record in the industry_categories table.'
example: null
nullable: true
required:
- subCategoryName
security: []
'/api/industry-sub-categories/{id}':
get:
summary: ''
operationId: getApiIndustrySubCategoriesId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiIndustrySubCategoriesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
subCategoryName:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
categoryName:
type: string
description: 'The id of an existing record in the industry_categories table.'
example: null
nullable: true
required:
- subCategoryName
security: []
delete:
summary: ''
operationId: deleteApiIndustrySubCategoriesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the industry sub category.'
example: 2
required: true
schema:
type: integer
/api/industry-third-level-categories:
get:
summary: ''
operationId: getApiIndustryThirdLevelCategories
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiIndustryThirdLevelCategories
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
thirdLevelCategoryName:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
categoryName:
type: string
description: 'The id of an existing record in the industry_categories table.'
example: null
nullable: true
subCategoryName:
type: string
description: 'The id of an existing record in the industry_sub_categories table.'
example: null
nullable: true
required:
- thirdLevelCategoryName
security: []
'/api/industry-third-level-categories/{id}':
get:
summary: ''
operationId: getApiIndustryThirdLevelCategoriesId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiIndustryThirdLevelCategoriesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
thirdLevelCategoryName:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
categoryName:
type: string
description: 'The id of an existing record in the industry_categories table.'
example: null
nullable: true
subCategoryName:
type: string
description: 'The id of an existing record in the industry_sub_categories table.'
example: null
nullable: true
required:
- thirdLevelCategoryName
security: []
delete:
summary: ''
operationId: deleteApiIndustryThirdLevelCategoriesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the industry third level category.'
example: architecto
required: true
schema:
type: string
'/api/industry-third-level-categories/{industry_id}/third-level-sub-industries':
get:
summary: ''
operationId: getApiIndustryThirdLevelCategoriesIndustry_idThirdLevelSubIndustries
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
parameters:
-
in: path
name: industry_id
description: 'The ID of the industry.'
example: architecto
required: true
schema:
type: string
/api/companies:
get:
summary: ''
operationId: getApiCompanies
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiCompanies
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
company_name:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
primary_industry_id:
type: string
description: 'The id of an existing record in the industry_categories table.'
example: architecto
nullable: false
sub_industry_id:
type: string
description: 'The id of an existing record in the industry_sub_categories table.'
example: null
nullable: true
email:
type: string
description: 'Must be a valid email address.'
example: zbailey@example.net
nullable: false
password:
type: string
description: 'Must be at least 6 characters.'
example: '-0pBNvYgxw'
nullable: false
required:
- company_name
- primary_industry_id
- email
- password
security: []
'/api/companies/{id}':
get:
summary: ''
operationId: getApiCompaniesId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiCompaniesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
delete:
summary: ''
operationId: deleteApiCompaniesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the company.'
example: architecto
required: true
schema:
type: string
/api/tickets:
get:
summary: ''
operationId: getApiTickets
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiTickets
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
contact:
type: string
description: 'Must be a valid email address.'
example: gbailey@example.net
nullable: false
subject:
type: string
description: ''
example: architecto
nullable: false
type:
type: string
description: ''
example: other
nullable: false
enum:
- question
- issue
- feature_request
- other
status:
type: string
description: ''
example: in_progress
nullable: false
enum:
- open
- in_progress
- closed
priority:
type: string
description: ''
example: urgent
nullable: false
enum:
- low
- medium
- high
- urgent
assigned_to:
type: string
description: 'The id of an existing record in the users table.'
example: null
nullable: true
description:
type: string
description: 'Must be at least 10 characters.'
example: 'Et animi quos velit et fugiat.'
nullable: false
tags:
type: object
description: ''
example: null
nullable: true
properties: { }
required:
- contact
- subject
- type
- status
- priority
- description
security: []
'/api/tickets/{id}':
get:
summary: ''
operationId: getApiTicketsId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiTicketsId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
delete:
summary: ''
operationId: deleteApiTicketsId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the ticket.'
example: architecto
required: true
schema:
type: string
/api/surveys:
get:
summary: ''
operationId: getApiSurveys
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiSurveys
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
survey_title:
type: string
description: ''
example: architecto
nullable: false
survey_description:
type: string
description: ''
example: architecto
nullable: false
department_category_id:
type: string
description: 'The id of an existing record in the department_categories table.'
example: architecto
nullable: false
target_audience:
type: string
description: ''
example: architecto
nullable: false
survey_type:
type: string
description: ''
example: architecto
nullable: false
anonymous_responses:
type: boolean
description: ''
example: false
nullable: false
start_date:
type: string
description: 'Must be a valid date.'
example: '2025-06-18T08:59:18'
nullable: false
end_date:
type: string
description: 'Must be a valid date.'
example: '2025-06-18T08:59:18'
nullable: false
email_copy_to_respondent:
type: string
description: 'Must be a valid email address.'
example: zbailey@example.net
nullable: false
redirect_url:
type: string
description: 'Must be a valid URL.'
example: 'https://www.gulgowski.com/nihil-accusantium-harum-mollitia-modi-deserunt'
nullable: false
comment_box:
type: string
description: ''
example: architecto
nullable: true
thank_you_message:
type: string
description: ''
example: architecto
nullable: true
fields:
type: string
description: 'Must be a valid JSON string.'
example: '["architecto","architecto"]'
nullable: true
required:
- survey_title
- survey_description
- department_category_id
- target_audience
- survey_type
- anonymous_responses
- start_date
- end_date
- email_copy_to_respondent
- redirect_url
security: []
'/api/surveys/{id}':
get:
summary: ''
operationId: getApiSurveysId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiSurveysId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
survey_title:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
survey_description:
type: string
description: ''
example: architecto
nullable: false
department_category_id:
type: string
description: 'The id of an existing record in the department_categories table.'
example: architecto
nullable: false
target_audience:
type: string
description: ''
example: architecto
nullable: false
survey_type:
type: string
description: ''
example: architecto
nullable: false
anonymous_responses:
type: boolean
description: ''
example: false
nullable: false
start_date:
type: string
description: 'Must be a valid date.'
example: '2025-06-18T08:59:18'
nullable: true
end_date:
type: string
description: 'Must be a valid date.'
example: '2025-06-18T08:59:18'
nullable: true
email_copy_to_respondent:
type: string
description: 'Must be a valid email address.'
example: zbailey@example.net
nullable: false
redirect_url:
type: string
description: ''
example: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html'
nullable: true
comment_box:
type: string
description: ''
example: architecto
nullable: true
thank_you_message:
type: string
description: ''
example: architecto
nullable: true
fields:
type: string
description: 'Must be a valid JSON string.'
example: '["architecto","architecto"]'
nullable: true
required:
- survey_title
- survey_description
- department_category_id
- target_audience
- survey_type
- anonymous_responses
- email_copy_to_respondent
security: []
delete:
summary: ''
operationId: deleteApiSurveysId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the survey.'
example: architecto
required: true
schema:
type: string
/api/department-categories:
get:
summary: ''
operationId: getApiDepartmentCategories
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiDepartmentCategories
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: architecto
nullable: false
parent_id:
type: string
description: 'The id of an existing record in the department_categories table.'
example: null
nullable: true
required:
- name
security: []
'/api/department-categories/{id}':
put:
summary: ''
operationId: putApiDepartmentCategoriesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: architecto
nullable: false
parent_id:
type: string
description: 'The id of an existing record in the department_categories table.'
example: null
nullable: true
required:
- name
security: []
delete:
summary: ''
operationId: deleteApiDepartmentCategoriesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the department category.'
example: architecto
required: true
schema:
type: string
/api/categories:
get:
summary: ''
operationId: getApiCategories
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
post:
summary: ''
operationId: postApiCategories
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: architecto
nullable: false
type:
type: string
description: ''
example: architecto
nullable: false
parent_id:
type: string
description: 'The id of an existing record in the categories table.'
example: null
nullable: true
required:
- name
- type
security: []
'/api/categories/{id}':
put:
summary: ''
operationId: putApiCategoriesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: architecto
nullable: false
type:
type: string
description: ''
example: architecto
nullable: false
parent_id:
type: string
description: 'The id of an existing record in the categories table.'
example: null
nullable: true
required:
- name
- type
security: []
delete:
summary: ''
operationId: deleteApiCategoriesId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the category.'
example: architecto
required: true
schema:
type: string
/api/save-form:
post:
summary: ''
operationId: postApiSaveForm
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
formName:
type: string
description: "'serialNumber' => 'required|numeric|max:255',. Must not be greater than 255 characters."
example: b
nullable: false
formCode:
type: string
description: 'Must not be greater than 255 characters.'
example: 'n'
nullable: false
formDescription:
type: string
description: ''
example: architecto
nullable: false
ownerDepartment:
type: number
description: 'The id of an existing record in the department_categories table.'
example: 4326.41688
nullable: false
firstLevelCategory:
type: number
description: 'Must not be greater than 255.'
example: 17
nullable: false
secondLevelCategory:
type: number
description: 'Must not be greater than 255.'
example: 15
nullable: false
thirdLevelCategory:
type: number
description: 'Must not be greater than 255.'
example: 8
nullable: false
fields:
type: object
description: "'version' => 'required|string|max:50',."
example: []
nullable: false
properties: { }
formStatus:
type: string
description: ''
example: architecto
nullable: false
targetAudience:
type: string
description: ''
example: architecto
nullable: false
required:
- formName
- formCode
- formDescription
- ownerDepartment
- firstLevelCategory
- secondLevelCategory
- thirdLevelCategory
- fields
- formStatus
- targetAudience
security: []
/api/forms:
get:
summary: ''
operationId: getApiForms
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
'/api/forms/{id}':
get:
summary: ''
operationId: getApiFormsId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiFormsId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
formName:
type: string
description: 'Must not be greater than 255 characters.'
example: b
nullable: false
formCode:
type: string
description: 'Must not be greater than 255 characters.'
example: 'n'
nullable: false
formDescription:
type: string
description: ''
example: architecto
nullable: false
ownerDepartment:
type: number
description: 'The id of an existing record in the department_categories table.'
example: 4326.41688
nullable: false
firstLevelCategory:
type: number
description: 'Must not be greater than 255.'
example: 17
nullable: false
secondLevelCategory:
type: number
description: 'Must not be greater than 255.'
example: 15
nullable: false
thirdLevelCategory:
type: number
description: 'Must not be greater than 255.'
example: 8
nullable: false
fields:
type: object
description: ''
example: []
nullable: false
properties: { }
formStatus:
type: string
description: ''
example: architecto
nullable: false
targetAudience:
type: string
description: ''
example: architecto
nullable: false
required:
- formName
- formCode
- formDescription
- ownerDepartment
- firstLevelCategory
- secondLevelCategory
- thirdLevelCategory
- fields
- formStatus
- targetAudience
security: []
parameters:
-
in: path
name: id
description: 'The ID of the form.'
example: architecto
required: true
schema:
type: string
'/api/forms/{id}/delete':
delete:
summary: ''
operationId: deleteApiFormsIdDelete
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the form.'
example: architecto
required: true
schema:
type: string
'/api/forms/{id}/recover':
get:
summary: ''
operationId: getApiFormsIdRecover
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the form.'
example: architecto
required: true
schema:
type: string
'/api/forms/{id}/duplicate':
post:
summary: ''
operationId: postApiFormsIdDuplicate
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the form.'
example: architecto
required: true
schema:
type: string
'/api/forms/{id}/toggle':
get:
summary: ''
operationId: getApiFormsIdToggle
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the form.'
example: architecto
required: true
schema:
type: string
/api/save-workflow:
post:
summary: ''
operationId: postApiSaveWorkflow
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
serialNumber:
type: number
description: 'Must not be greater than 255.'
example: 1
nullable: false
workflowName:
type: string
description: 'Must not be greater than 255 characters.'
example: 'n'
nullable: false
formID:
type: number
description: "'workflowIndustry' => 'required|string|max:255',. Must not be greater than 255."
example: 7
nullable: false
version:
type: string
description: 'Must not be greater than 50 characters.'
example: z
nullable: false
workflowLevel:
type: string
description: 'Must not be greater than 50 characters.'
example: m
nullable: false
workflowTrigger:
type: number
description: 'Must not be greater than 50.'
example: 15
nullable: false
fields:
type: object
description: "'department' => 'required|string|max:50',\n'teamMember' => 'required|string|max:50',."
example: []
nullable: false
properties: { }
required:
- serialNumber
- workflowName
- formID
- version
- workflowLevel
- workflowTrigger
- fields
security: []
/api/workflows:
get:
summary: ''
operationId: getApiWorkflows
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
'/api/workflows/{id}':
get:
summary: ''
operationId: getApiWorkflowsId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiWorkflowsId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
serialNumber:
type: number
description: 'Must not be greater than 255.'
example: 1
nullable: false
workflowName:
type: string
description: 'Must not be greater than 255 characters.'
example: 'n'
nullable: false
formID:
type: number
description: "'workflowIndustry' => 'required|string|max:255',. Must not be greater than 255."
example: 7
nullable: false
version:
type: string
description: 'Must not be greater than 50 characters.'
example: z
nullable: false
workflowLevel:
type: string
description: 'Must not be greater than 50 characters.'
example: m
nullable: false
workflowTrigger:
type: number
description: 'Must not be greater than 50.'
example: 15
nullable: false
fields:
type: object
description: "'department' => 'required|string|max:50',\n'teamMember' => 'required|string|max:50',."
example: []
nullable: false
properties: { }
required:
- serialNumber
- workflowName
- formID
- version
- workflowLevel
- workflowTrigger
- fields
security: []
parameters:
-
in: path
name: id
description: 'The ID of the workflow.'
example: architecto
required: true
schema:
type: string
'/api/recover/{module}/{id}':
get:
summary: ''
operationId: getApiRecoverModuleId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
parameters:
-
in: path
name: module
description: ''
example: architecto
required: true
schema:
type: string
-
in: path
name: id
description: 'The ID of the {module}.'
example: architecto
required: true
schema:
type: string
'/api/blogs/{id}':
get:
summary: ''
operationId: getApiBlogsId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiBlogsId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
title:
type: string
description: 'Blog Content Section. Must not be greater than 255 characters.'
example: b
nullable: false
slug:
type: string
description: ''
example: null
nullable: false
department:
type: string
description: 'The id of an existing record in the department_categories table.'
example: null
nullable: true
image:
type: string
format: binary
description: 'Must be an image. Must not be greater than 2048 kilobytes.'
nullable: true
summary:
type: string
description: ''
example: architecto
nullable: true
content:
type: string
description: ''
example: architecto
nullable: true
metaTitle:
type: string
description: 'Must not be greater than 255 characters.'
example: 'n'
nullable: true
tags:
type: string
description: 'Must not be greater than 255 characters.'
example: g
nullable: true
metaDescription:
type: string
description: ''
example: architecto
nullable: true
authorName:
type: string
description: 'Must not be greater than 255 characters.'
example: 'n'
nullable: true
desiredModules:
type: string
description: 'Must not be greater than 255 characters.'
example: g
nullable: true
status:
type: string
description: ''
example: Pending
nullable: true
enum:
- Published
- Draft
- Scheduled
- Pending
publishDate:
type: string
description: 'Must be a valid date.'
example: '2025-06-18T08:59:18'
nullable: true
scheduledPublishDate:
type: string
description: 'Must be a valid date.'
example: '2025-06-18T08:59:18'
nullable: true
allowComments:
type: boolean
description: ''
example: true
nullable: false
isFeatured:
type: boolean
description: ''
example: false
nullable: false
isPinned:
type: boolean
description: ''
example: true
nullable: false
required:
- title
security: []
delete:
summary: ''
operationId: deleteApiBlogsId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: id
description: 'The ID of the blog.'
example: 1
required: true
schema:
type: integer
/api/terms:
get:
summary: ''
operationId: getApiTerms
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Token not found'
properties:
error:
type: string
example: 'Token not found'
tags:
- Endpoints
security: []
put:
summary: ''
operationId: putApiTerms
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
content:
type: string
description: ''
example: architecto
nullable: false
required:
- content
security: []
'/api/plans/{id}/update':
put:
summary: ''
operationId: putApiPlansIdUpdate
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: architecto
nullable: false
price:
type: string
description: ''
example: architecto
nullable: false
domain:
type: string
description: ''
example: null
nullable: true
bandwidth:
type: string
description: ''
example: null
nullable: true
storage:
type: string
description: ''
example: null
nullable: true
users:
type: number
description: 'Must be at least 1.'
example: 22
nullable: false
days:
type: number
description: 'Must be at least 1.'
example: 67
nullable: false
email_support:
type: string
description: ''
example: null
nullable: true
hourly_support:
type: string
description: ''
example: null
nullable: true
required:
- name
- price
- users
- days
security: []
parameters:
-
in: path
name: id
description: 'The ID of the plan.'
example: architecto
required: true
schema:
type: string
'/api/plans/{plan_id}':
delete:
summary: ''
operationId: deleteApiPlansPlan_id
description: ''
parameters: []
responses: { }
tags:
- Endpoints
security: []
parameters:
-
in: path
name: plan_id
description: 'The ID of the plan.'
example: 2
required: true
schema:
type: integer