openapi: 3.0.3 info: title: Laravel description: '' version: 1.0.0 servers: - url: 'http://localhost:8000' tags: - name: 'Admin Dashboard' description: 'All other endpoints' - name: 'Crudy Endpoints' description: 'All Crudy endpoints' - name: 'Custom Endpoints' description: 'All other endpoints' - name: Endpoints description: 'All other endpoints' - name: 'Orion Endpoints' description: '' - name: 'Uncategorized Endpoints' description: 'All other endpoints' components: securitySchemes: default: type: http scheme: bearer description: '' security: - default: [] paths: /api/v1/dashboard: get: summary: 'Retrieve various metrics for the admin dashboard (Stability Score: 0.1)' operationId: retrieveVariousMetricsForTheAdminDashboardStabilityScore01 description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Admin Dashboard' /api/v1/external-employee-fields: get: summary: 'Fetch a list of External employee fields with pagination (Stability Score: 0.5)' operationId: fetchAListOfExternalEmployeeFieldsWithPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/external-employee-fields/search: post: summary: 'Fetch a list of External employee fields based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)' operationId: fetchAListOfExternalEmployeeFieldsBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: externalIntegrationId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false scopes: type: 'string[]' description: 'Scopes to apply' example: - name: unMapped parameters: [] - name: mapped parameters: [] nullable: false /api/v1/notification-preferences: post: summary: 'Create a new Notification preference' operationId: createANewNotificationPreference description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: preferences: type: array description: '' example: - - - sms items: type: array description: '' example: - - sms items: type: array description: '' example: - sms items: type: string organizationId: type: string description: '' example: sed nullable: true get: summary: 'Fetch a list of Notification preferences with pagination' operationId: fetchAListOfNotificationPreferencesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/notification-preferences/batch: post: summary: 'Batch create new Notification preferences' operationId: batchCreateNewNotificationPreferences description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: preferences: type: object description: '' example: [] nullable: false properties: { } organizationId: type: string description: '' example: quidem nullable: true required: - preferences patch: summary: 'Batch update Notification preferences' operationId: batchUpdateNotificationPreferences description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: preferences: type: object description: '' example: null nullable: false properties: { } organizationId: type: string description: '' example: null nullable: false delete: summary: 'Batch delete Notification preferences by their IDs' operationId: batchDeleteNotificationPreferencesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - inventore items: type: string '/api/v1/notification-preferences/{notificationPreferenceId}': get: summary: 'Fetch a Notification preference by its ID' operationId: fetchANotificationPreferenceByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'NotificationPreference [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'NotificationPreference [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Notification preference by its ID' operationId: updateANotificationPreferenceByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'NotificationPreference [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'NotificationPreference [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: preferences: type: array description: '' example: - - - email items: type: array description: '' example: - - email items: type: array description: '' example: - email items: type: string organizationId: type: string description: '' example: null nullable: false delete: summary: 'Delete a Notification preference by its ID' operationId: deleteANotificationPreferenceByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'NotificationPreference [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'NotificationPreference [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: notificationPreferenceId description: '' example: dolor required: true schema: type: string /api/v1/notification-preferences/search: post: summary: 'Fetch a list of Notification preferences based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfNotificationPreferencesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: organizationId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/behaviours: post: summary: 'Create a new Behaviour' operationId: createANewBehaviour description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: identifier: type: string description: '' example: omnis nullable: false name: type: string description: '' example: dolorem nullable: false description: type: string description: '' example: 'Accusantium possimus labore fugit modi.' nullable: false settings: type: object description: '' example: null nullable: false properties: { } required: - identifier - name - description get: summary: 'Fetch a list of Behaviours with pagination' operationId: fetchAListOfBehavioursWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/behaviours/batch: post: summary: 'Batch create new Behaviours' operationId: batchCreateNewBehaviours description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: identifier: type: string description: '' example: voluptas nullable: false name: type: string description: '' example: autem nullable: false description: type: string description: '' example: 'Perspiciatis omnis aperiam vitae eum eaque excepturi modi.' nullable: false settings: type: object description: '' example: null nullable: false properties: { } required: - identifier - name - description patch: summary: 'Batch update Behaviours' operationId: batchUpdateBehaviours description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: identifier: type: string description: '' example: null nullable: false name: type: string description: '' example: aliquam nullable: false description: type: string description: '' example: 'Consequatur blanditiis laborum doloremque et eos dignissimos itaque.' nullable: false settings: type: object description: '' example: null nullable: false properties: { } delete: summary: 'Batch delete Behaviours by their IDs' operationId: batchDeleteBehavioursByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - omnis items: type: string '/api/v1/behaviours/{behaviourId}': get: summary: 'Fetch a Behaviour by its ID' operationId: fetchABehaviourByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Behaviour [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Behaviour [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Behaviour by its ID' operationId: updateABehaviourByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Behaviour [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Behaviour [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: identifier: type: string description: '' example: null nullable: false name: type: string description: '' example: in nullable: false description: type: string description: '' example: 'Velit reprehenderit iste accusantium hic praesentium aut.' nullable: false settings: type: object description: '' example: null nullable: false properties: { } delete: summary: 'Delete a Behaviour by its ID' operationId: deleteABehaviourByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Behaviour [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Behaviour [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: behaviourId description: '' example: et required: true schema: type: string /api/v1/behaviours/search: post: summary: 'Fetch a list of Behaviours based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfBehavioursBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: [] nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/function-entities: post: summary: 'Create a new Function entity' operationId: createANewFunctionEntity description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: identifier: type: string description: '' example: cumque nullable: false name: type: string description: '' example: recusandae nullable: false description: type: string description: '' example: 'Sunt aliquid eum et ab ex.' nullable: false companyId: type: string description: '' example: vero nullable: false organizationId: type: string description: '' example: repellendus nullable: false customerTypeId: type: string description: '' example: dolorem nullable: false required: - identifier - name - description get: summary: 'Fetch a list of Function entities with pagination' operationId: fetchAListOfFunctionEntitiesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/function-entities/batch: post: summary: 'Batch create new Function entities' operationId: batchCreateNewFunctionEntities description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: identifier: type: string description: '' example: voluptas nullable: false name: type: string description: '' example: veritatis nullable: false description: type: string description: '' example: 'Nihil sint quasi eligendi facilis soluta dolor cumque.' nullable: false companyId: type: string description: '' example: repellendus nullable: false organizationId: type: string description: '' example: ea nullable: false customerTypeId: type: string description: '' example: molestiae nullable: false required: - identifier - name - description patch: summary: 'Batch update Function entities' operationId: batchUpdateFunctionEntities description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: identifier: type: string description: '' example: null nullable: false name: type: string description: '' example: voluptatem nullable: false description: type: string description: '' example: 'Suscipit impedit fugit nemo consequatur expedita sint consectetur.' nullable: false companyId: type: string description: '' example: voluptas nullable: false organizationId: type: string description: '' example: quia nullable: false customerTypeId: type: string description: '' example: blanditiis nullable: false delete: summary: 'Batch delete Function entities by their IDs' operationId: batchDeleteFunctionEntitiesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - sed items: type: string '/api/v1/function-entities/{functionEntityId}': get: summary: 'Fetch a Function entity by its ID' operationId: fetchAFunctionEntityByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'FunctionEntity [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'FunctionEntity [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Function entity by its ID' operationId: updateAFunctionEntityByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'FunctionEntity [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'FunctionEntity [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: identifier: type: string description: '' example: null nullable: false name: type: string description: '' example: unde nullable: false description: type: string description: '' example: 'Nam fugiat cum esse facilis debitis.' nullable: false companyId: type: string description: '' example: corrupti nullable: false organizationId: type: string description: '' example: magni nullable: false customerTypeId: type: string description: '' example: sit nullable: false delete: summary: 'Delete a Function entity by its ID' operationId: deleteAFunctionEntityByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'FunctionEntity [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'FunctionEntity [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: functionEntityId description: '' example: id required: true schema: type: string /api/v1/function-entities/search: post: summary: 'Fetch a list of Function entities based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfFunctionEntitiesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: organizationId operator: '=' value: value - field: identifier operator: '=' value: value - field: name operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/customer-types: post: summary: 'Create a new Customer type' operationId: createANewCustomerType description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: identifier: type: string description: '' example: omnis nullable: false name: type: string description: '' example: nobis nullable: false description: type: string description: '' example: 'Dolores dolorem natus possimus expedita.' nullable: false required: - identifier - name - description get: summary: 'Fetch a list of Customer types with pagination' operationId: fetchAListOfCustomerTypesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/customer-types/batch: post: summary: 'Batch create new Customer types' operationId: batchCreateNewCustomerTypes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: identifier: type: string description: '' example: animi nullable: false name: type: string description: '' example: et nullable: false description: type: string description: '' example: 'Ab inventore voluptatibus vero vitae enim earum.' nullable: false required: - identifier - name - description patch: summary: 'Batch update Customer types' operationId: batchUpdateCustomerTypes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: identifier: type: string description: '' example: null nullable: false name: type: string description: '' example: quos nullable: false description: type: string description: '' example: 'Voluptas ipsum quia temporibus id voluptatem rem magni.' nullable: false delete: summary: 'Batch delete Customer types by their IDs' operationId: batchDeleteCustomerTypesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - sequi items: type: string '/api/v1/customer-types/{customerTypeId}': get: summary: 'Fetch a Customer type by its ID' operationId: fetchACustomerTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CustomerType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CustomerType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Customer type by its ID' operationId: updateACustomerTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CustomerType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CustomerType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: identifier: type: string description: '' example: null nullable: false name: type: string description: '' example: nostrum nullable: false description: type: string description: '' example: 'Eaque beatae aut est dignissimos minus.' nullable: false delete: summary: 'Delete a Customer type by its ID' operationId: deleteACustomerTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CustomerType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CustomerType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: customerTypeId description: '' example: nam required: true schema: type: string /api/v1/customer-types/search: post: summary: 'Fetch a list of Customer types based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfCustomerTypesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: [] nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/team-positions: post: summary: 'Create a new Team position' operationId: createANewTeamPosition description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: id nullable: false description: type: string description: '' example: 'Vel sed eveniet quia quos incidunt aut.' nullable: false organizationId: type: string description: '' example: omnis nullable: true roles: type: array description: '' example: null items: type: object properties: roleIds: type: object description: '' example: null nullable: false properties: { } required: - name - description get: summary: 'Fetch a list of Team positions with pagination' operationId: fetchAListOfTeamPositionsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/team-positions/batch: post: summary: 'Batch create new Team positions' operationId: batchCreateNewTeamPositions description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: '' example: error nullable: false description: type: string description: '' example: 'Cumque nostrum et et dolor.' nullable: false organizationId: type: string description: '' example: magni nullable: true roles: type: object description: '' example: null nullable: false properties: { } required: - name - description patch: summary: 'Batch update Team positions' operationId: batchUpdateTeamPositions description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: '' example: exercitationem nullable: false description: type: string description: '' example: 'Veniam molestias deleniti natus nihil repudiandae quisquam nihil.' nullable: false organizationId: type: string description: '' example: ducimus nullable: true roles: type: object description: '' example: null nullable: false properties: { } delete: summary: 'Batch delete Team positions by their IDs' operationId: batchDeleteTeamPositionsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - accusantium items: type: string '/api/v1/team-positions/{teamPositionId}': get: summary: 'Fetch a Team position by its ID' operationId: fetchATeamPositionByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'TeamPosition [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'TeamPosition [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Team position by its ID' operationId: updateATeamPositionByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'TeamPosition [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'TeamPosition [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: '' example: ea nullable: false description: type: string description: '' example: 'Quis consequatur in ea.' nullable: false organizationId: type: string description: '' example: porro nullable: true roles: type: array description: '' example: null items: type: object properties: roleIds: type: object description: '' example: null nullable: false properties: { } delete: summary: 'Delete a Team position by its ID' operationId: deleteATeamPositionByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'TeamPosition [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'TeamPosition [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: teamPositionId description: '' example: qui required: true schema: type: string /api/v1/team-positions/search: post: summary: 'Fetch a list of Team positions based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfTeamPositionsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: name operator: '=' value: value - field: organizationId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false '/api/v1/persons/{personId}': get: summary: 'Fetch a Person by its ID' operationId: fetchAPersonByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,employees' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,employees' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Person [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Person [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: personId description: '' example: voluptatum required: true schema: type: string /api/v1/persons: get: summary: 'Fetch a list of People with pagination' operationId: fetchAListOfPeopleWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,employees' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,employees' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/persons/search: post: summary: 'Fetch a list of People based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPeopleBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,employees' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,employees' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyIds operator: '=' value: value - field: identities operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false scopes: type: 'string[]' description: 'Scopes to apply' example: - name: findBySsn parameters: [] nullable: false /api/v1/countries: post: summary: 'Create a new Country' operationId: createANewCountry description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: veniam nullable: false required: - name get: summary: 'Fetch a list of Countries with pagination' operationId: fetchAListOfCountriesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/countries/batch: post: summary: 'Batch create new Countries' operationId: batchCreateNewCountries description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: '' example: minima nullable: false required: - name patch: summary: 'Batch update Countries' operationId: batchUpdateCountries description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: '' example: null nullable: false delete: summary: 'Batch delete Countries by their IDs' operationId: batchDeleteCountriesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - neque items: type: string '/api/v1/countries/{countryId}': get: summary: 'Fetch a Country by its ID' operationId: fetchACountryByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Country [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Country [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Country by its ID' operationId: updateACountryByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Country [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Country [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: '' example: null nullable: false delete: summary: 'Delete a Country by its ID' operationId: deleteACountryByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Country [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Country [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: countryId description: '' example: officia required: true schema: type: string /api/v1/countries/search: post: summary: 'Fetch a list of Countries based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfCountriesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: [] nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/exports: get: summary: 'Fetch a list of Exports with pagination' operationId: fetchAListOfExportsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/exports/search: post: summary: 'Fetch a list of Exports based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfExportsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/ext-role-mappings: post: summary: 'Create a new Ext role mapping (Stability Score: 0.1)' operationId: createANewExtRoleMappingStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: quas nullable: false roleId: type: number description: '' example: 21.7 nullable: false externalIntegrationRoleId: type: string description: '' example: ad nullable: false required: - companyId - roleId - externalIntegrationRoleId '/api/v1/ext-role-mappings/{extRoleMappingId}': patch: summary: 'Update a Ext role mapping by its ID (Stability Score: 0.1)' operationId: updateAExtRoleMappingByItsIDStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'ExtRoleMapping [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'ExtRoleMapping [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false roleId: type: number description: '' example: 412058.2998902 nullable: false externalIntegrationRoleId: type: string description: '' example: debitis nullable: false delete: summary: 'Delete a Ext role mapping by its ID (Stability Score: 0.1)' operationId: deleteAExtRoleMappingByItsIDStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'ExtRoleMapping [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'ExtRoleMapping [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: extRoleMappingId description: '' example: ut required: true schema: type: string /api/v1/ext-role-mappings/search: post: summary: 'Fetch a list of Ext role mappings based on the provided filters, scopes, sorting and pagination (Stability Score: 0.1)' operationId: fetchAListOfExtRoleMappingsBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore01 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: roleId operator: '=' value: value - field: externalIntegrationRoleId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false '/api/v1/external-integration-roles/{externalIntegrationRoleId}': get: summary: 'Fetch a Ext integration role by its ID (Stability Score: 0.1)' operationId: fetchAExtIntegrationRoleByItsIDStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'ExtIntegrationRole [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'ExtIntegrationRole [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: externalIntegrationRoleId description: '' example: quibusdam required: true schema: type: string /api/v1/external-integration-roles: get: summary: 'Fetch a list of Ext integration roles with pagination (Stability Score: 0.1)' operationId: fetchAListOfExtIntegrationRolesWithPaginationStabilityScore01 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/external-integration-roles/search: post: summary: 'Fetch a list of Ext integration roles based on the provided filters, scopes, sorting and pagination (Stability Score: 0.1)' operationId: fetchAListOfExtIntegrationRolesBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore01 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: externalIntegrationId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/teams: post: summary: 'Create a new Team' operationId: createANewTeam description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must be at least 1 character. Must not be greater than 255 characters.' example: ykxcqmrpwopdequdn nullable: false organizationId: type: string description: 'This field is required when teamType is organization.' example: et nullable: false description: type: string description: '' example: 'Dolores qui pariatur omnis sunt at.' nullable: false teamType: type: string description: '' example: organization nullable: false enum: - organization - company companyId: type: string description: 'This field is required when teamType is company.' example: voluptatibus nullable: false companyIds: type: array description: '' example: - cumque items: type: string memberIds: type: array description: '' example: - sit items: type: string members: type: object description: '' example: null nullable: false properties: { } required: - name - companyIds - memberIds get: summary: 'Fetch a list of Teams with pagination' operationId: fetchAListOfTeamsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/teams/batch: post: summary: 'Batch create new Teams' operationId: batchCreateNewTeams description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: 'Must be at least 1 character. Must not be greater than 255 characters.' example: rzxadeeulgaylx nullable: false organizationId: type: string description: 'This field is required when teamType is organization.' example: error nullable: false description: type: string description: '' example: 'Quibusdam et qui consequatur vitae.' nullable: false teamType: type: string description: '' example: company nullable: false enum: - organization - company companyId: type: string description: 'This field is required when teamType is company.' example: ut nullable: false companyIds: type: object description: '' example: null nullable: false properties: { } memberIds: type: object description: '' example: null nullable: false properties: { } members: type: object description: '' example: null nullable: false properties: { } required: - name patch: summary: 'Batch update Teams' operationId: batchUpdateTeams description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: 'Must be at least 1 character. Must not be greater than 255 characters.' example: vydyhi nullable: false description: type: string description: '' example: 'Exercitationem sit non qui.' nullable: false companyIds: type: object description: '' example: null nullable: false properties: { } memberIds: type: object description: '' example: null nullable: false properties: { } companyId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false teamType: type: string description: '' example: null nullable: false members: type: object description: '' example: null nullable: false properties: { } delete: summary: 'Batch delete Teams by their IDs' operationId: batchDeleteTeamsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - consequatur items: type: string '/api/v1/teams/{teamId}': get: summary: 'Fetch a Team by its ID' operationId: fetchATeamByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Team [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Team [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Team by its ID' operationId: updateATeamByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Team [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Team [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must be at least 1 character. Must not be greater than 255 characters.' example: tpzjpliymrepidlgbqmfemc nullable: false description: type: string description: '' example: 'Esse vero ut perferendis alias tenetur et inventore.' nullable: false companyIds: type: array description: '' example: - nihil items: type: string memberIds: type: array description: '' example: - dolor items: type: string companyId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false teamType: type: string description: '' example: null nullable: false members: type: object description: '' example: null nullable: false properties: { } required: - companyIds - memberIds delete: summary: 'Delete a Team by its ID' operationId: deleteATeamByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Team [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Team [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: teamId description: '' example: a required: true schema: type: string /api/v1/teams/search: post: summary: 'Fetch a list of Teams based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfTeamsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'manager,companies,participants,organization' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: name operator: '=' value: value - field: description operator: '=' value: value - field: managerId operator: '=' value: value - field: companyIds operator: '=' value: value - field: organizationId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/company-change-history: get: summary: 'Fetch a list of Company change histories with pagination' operationId: fetchAListOfCompanyChangeHistoriesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' '/api/v1/company-field-changes/{recordId}': get: summary: 'Fetch a Company field change by its ID' operationId: fetchACompanyFieldChangeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyFieldChange [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyFieldChange [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: recordId description: '' example: est required: true schema: type: string /api/v1/company-field-changes: get: summary: 'Fetch a list of Company field changes with pagination' operationId: fetchAListOfCompanyFieldChangesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/company-field-changes/search: post: summary: 'Fetch a list of Company field changes based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfCompanyFieldChangesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: changeId operator: '=' value: value - field: approved operator: '=' value: value - field: status operator: '=' value: value - field: comment operator: '=' value: value - field: deniedNote operator: '=' value: value - field: companyFieldId operator: '=' value: value - field: changeType operator: '=' value: value - field: changedBy operator: '=' value: value - field: changedDate operator: '=' value: value - field: effectiveDate operator: '=' value: value - field: fieldName operator: '=' value: value - field: newValue operator: '=' value: value - field: oldValue operator: '=' value: value - field: exported operator: '=' value: value - field: companyId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/grid-views: post: summary: 'Create a new Grid view' operationId: createANewGridView description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: gridId: type: string description: '' example: neque nullable: false viewName: type: string description: '' example: dolorem nullable: false viewDescription: type: string description: '' example: quo nullable: false viewSettings: type: object description: '' example: [] nullable: false properties: { } userId: type: integer description: '' example: 6 nullable: true required: - gridId - viewName - viewDescription - viewSettings get: summary: 'Fetch a list of Grid views with pagination' operationId: fetchAListOfGridViewsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' '/api/v1/grid-views/{gridViewId}': get: summary: 'Fetch a Grid view by its ID' operationId: fetchAGridViewByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'GridView [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'GridView [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Grid view by its ID' operationId: updateAGridViewByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'GridView [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'GridView [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: gridId: type: string description: '' example: optio nullable: false viewName: type: string description: '' example: magnam nullable: false viewDescription: type: string description: '' example: ducimus nullable: false viewSettings: type: object description: '' example: null nullable: false properties: { } userId: type: integer description: '' example: 15 nullable: true delete: summary: 'Delete a Grid view by its ID' operationId: deleteAGridViewByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'GridView [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'GridView [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: gridViewId description: '' example: quo required: true schema: type: string /api/v1/grid-views/search: post: summary: 'Fetch a list of Grid views based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfGridViewsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: viewName operator: '=' value: value - field: gridId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/grid-configurations: post: summary: 'Create a new Grid configuration' operationId: createANewGridConfiguration description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: gridId: type: string description: '' example: consectetur nullable: false userId: type: string description: '' example: et nullable: false gridTitle: type: string description: '' example: et nullable: false gridDescription: type: string description: '' example: reiciendis nullable: false gridSettings: type: object description: '' example: [] nullable: false properties: { } required: - gridId - userId - gridTitle - gridDescription - gridSettings get: summary: 'Fetch a list of Grid configurations with pagination' operationId: fetchAListOfGridConfigurationsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/grid-configurations/batch: post: summary: 'Batch create new Grid configurations' operationId: batchCreateNewGridConfigurations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: gridId: type: string description: '' example: aut nullable: false userId: type: string description: '' example: unde nullable: false gridTitle: type: string description: '' example: nesciunt nullable: false gridDescription: type: string description: '' example: corrupti nullable: false gridSettings: type: object description: '' example: [] nullable: false properties: { } required: - gridId - userId - gridTitle - gridDescription - gridSettings patch: summary: 'Batch update Grid configurations' operationId: batchUpdateGridConfigurations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: gridId: type: string description: '' example: null nullable: false userId: type: string description: '' example: null nullable: false gridTitle: type: string description: '' example: et nullable: false gridDescription: type: string description: '' example: odio nullable: false gridSettings: type: object description: '' example: null nullable: false properties: { } delete: summary: 'Batch delete Grid configurations by their IDs' operationId: batchDeleteGridConfigurationsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - ut items: type: string '/api/v1/grid-configurations/{gridConfigurationId}': get: summary: 'Fetch a Grid configuration by its ID' operationId: fetchAGridConfigurationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'GridConfiguration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'GridConfiguration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Grid configuration by its ID' operationId: updateAGridConfigurationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'GridConfiguration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'GridConfiguration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: gridId: type: string description: '' example: null nullable: false userId: type: string description: '' example: null nullable: false gridTitle: type: string description: '' example: ipsam nullable: false gridDescription: type: string description: '' example: impedit nullable: false gridSettings: type: object description: '' example: null nullable: false properties: { } delete: summary: 'Delete a Grid configuration by its ID' operationId: deleteAGridConfigurationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'GridConfiguration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'GridConfiguration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: gridConfigurationId description: '' example: et required: true schema: type: string /api/v1/grid-configurations/search: post: summary: 'Fetch a list of Grid configurations based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfGridConfigurationsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,user' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: [] nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/ui-grids/batch: post: summary: 'Batch create new Ui grids' operationId: batchCreateNewUiGrids description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: gridTitle: type: string description: '' example: dolorem nullable: false gridDescription: type: string description: '' example: perspiciatis nullable: false gridSettings: type: object description: '' example: [] nullable: false properties: gridFor: type: string description: '' example: numquam nullable: true companyId: type: string description: '' example: ipsam nullable: true required: - gridTitle - gridDescription - gridSettings patch: summary: 'Batch update Ui grids' operationId: batchUpdateUiGrids description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: gridTitle: type: string description: '' example: ut nullable: false gridDescription: type: string description: '' example: ut nullable: false gridSettings: type: object description: '' example: null nullable: false properties: gridFor: type: string description: '' example: consectetur nullable: true companyId: type: string description: '' example: optio nullable: true delete: summary: 'Batch delete Ui grids by their IDs' operationId: batchDeleteUiGridsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - voluptatem items: type: string '/api/v1/ui-grids/{uiGridId}': get: summary: 'Fetch a Ui grid by its ID' operationId: fetchAUiGridByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'UiGrid [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'UiGrid [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Ui grid by its ID' operationId: updateAUiGridByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'UiGrid [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'UiGrid [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: gridTitle: type: string description: '' example: itaque nullable: false gridDescription: type: string description: '' example: aut nullable: false gridSettings: type: object description: '' example: null nullable: false properties: gridFor: type: string description: '' example: nesciunt nullable: true companyId: type: string description: '' example: corrupti nullable: true delete: summary: 'Delete a Ui grid by its ID' operationId: deleteAUiGridByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'UiGrid [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'UiGrid [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: uiGridId description: '' example: ab required: true schema: type: string /api/v1/ui-grids: get: summary: 'Fetch a list of Ui grids with pagination' operationId: fetchAListOfUiGridsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' post: summary: 'Create a new Ui grid' operationId: createANewUiGrid description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: gridTitle: type: string description: '' example: ea nullable: false gridDescription: type: string description: '' example: eum nullable: false gridSettings: type: object description: '' example: [] nullable: false properties: gridFor: type: string description: '' example: placeat nullable: true companyId: type: string description: '' example: ea nullable: true required: - gridTitle - gridDescription - gridSettings /api/v1/ui-grids/search: post: summary: 'Fetch a list of Ui grids based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfUiGridsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: gridTitle operator: '=' value: value - field: companyId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false '/api/v1/salary-warnings/{salaryWarningId}': get: summary: 'Fetch a Salary warning by its ID' operationId: fetchASalaryWarningByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'SalaryWarning [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'SalaryWarning [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: salaryWarningId description: '' example: ipsam required: true schema: type: string /api/v1/salary-warnings: get: summary: 'Fetch a list of Salary warnings with pagination' operationId: fetchAListOfSalaryWarningsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/salary-warnings/search: post: summary: 'Fetch a list of Salary warnings based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)' operationId: fetchAListOfSalaryWarningsBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: confirmedBy operator: '=' value: value - field: salaryRuleId operator: '=' value: value - field: employeeId operator: '=' value: value - field: salaryPeriod operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/company-integrations: post: summary: 'Create a new Company integration' operationId: createANewCompanyIntegration description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalIntegrationId: type: string description: '' example: fugit nullable: false companyId: type: string description: '' example: vero nullable: false settings: type: object description: '' example: null nullable: false properties: { } required: - externalIntegrationId - companyId get: summary: 'Fetch a list of Company integrations with pagination (Stability Score: 0.5)' operationId: fetchAListOfCompanyIntegrationsWithPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/company-integrations/batch: post: summary: 'Batch create new Company integrations' operationId: batchCreateNewCompanyIntegrations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalIntegrationId: type: string description: '' example: aperiam nullable: false companyId: type: string description: '' example: non nullable: false settings: type: object description: '' example: null nullable: false properties: { } required: - externalIntegrationId - companyId patch: summary: 'Batch update Company integrations' operationId: batchUpdateCompanyIntegrations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalIntegrationId: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false settings: type: object description: '' example: null nullable: false properties: { } delete: summary: 'Batch delete Company integrations by their IDs' operationId: batchDeleteCompanyIntegrationsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - cum items: type: string '/api/v1/company-integrations/{companyIntegrationId}': get: summary: 'Fetch a Company integration by its ID' operationId: fetchACompanyIntegrationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyIntegration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyIntegration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Company integration by its ID (Stability Score: 0.5)' operationId: updateACompanyIntegrationByItsIDStabilityScore05 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyIntegration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyIntegration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: externalIntegrationId: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false settings: type: object description: '' example: null nullable: false properties: { } delete: summary: 'Delete a Company integration by its ID (Stability Score: 0.5)' operationId: deleteACompanyIntegrationByItsIDStabilityScore05 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyIntegration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyIntegration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: companyIntegrationId description: '' example: saepe required: true schema: type: string /api/v1/company-integrations/search: post: summary: 'Fetch a list of Company integrations based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)' operationId: fetchAListOfCompanyIntegrationsBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: externalIntegration nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: externalIntegrationId operator: '=' value: value - field: companyId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/integration-types: get: summary: 'Fetch a list of Integration types with pagination (Stability Score: 0.5)' operationId: fetchAListOfIntegrationTypesWithPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/integration-types/search: post: summary: 'Fetch a list of Integration types based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)' operationId: fetchAListOfIntegrationTypesBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: name operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false '/api/v1/users/{userId}': get: summary: 'Fetch a User by its ID' operationId: fetchAUserByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: teams required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: teams nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'User [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'User [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: userId description: '' example: 1 required: true schema: type: integer /api/v1/users: get: summary: 'Fetch a list of Users with pagination' operationId: fetchAListOfUsersWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: teams required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: teams nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' post: summary: 'Create a user. (Stability Score: 0.5)' operationId: createAUserStabilityScore05 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: quo nullable: false email: type: string description: 'Must be a valid email address.' example: carroll.peter@example.com nullable: false preferred_username: type: string description: '' example: omnis nullable: false user_id: type: number description: '' example: 1800457.0922873 nullable: false notificationPreferences: type: array description: '' example: - - - inapp items: type: array description: '' example: - - inapp items: type: array description: '' example: - inapp items: type: string required: - name - email patch: summary: 'Update a user. (Stability Score: 0.5)' operationId: updateAUserStabilityScore05 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: notificationPreferences: type: array description: '' example: - - - broadcast items: type: array description: '' example: - - broadcast items: type: array description: '' example: - broadcast items: type: string id: type: number description: 'This field is required when userId is not present. The id of an existing record in the users table.' example: 367.21 nullable: false userId: type: string description: 'This field is required when id is not present. Must be 20 characters.' example: exblqhdpoblqrunhcxxv nullable: false user_id: type: number description: '' example: 10.504062448 nullable: false name: type: string description: '' example: ea nullable: false email: type: string description: 'Must be a valid email address.' example: dach.shaylee@example.org nullable: false family_name: type: string description: '' example: aut nullable: false given_name: type: string description: '' example: sunt nullable: false preferred_username: type: string description: '' example: provident nullable: false /api/v1/users/search: post: summary: 'Fetch a list of Users based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfUsersBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: teams required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: teams nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: name operator: '=' value: value - field: email operator: '=' value: value - field: userId operator: '=' value: value - field: pgUserId operator: '=' value: value - field: user_id operator: '=' value: value - field: organizationIds operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/notifications: get: summary: 'Fetch a list of Notifications with pagination' operationId: fetchAListOfNotificationsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/notifications/search: post: summary: 'Fetch a list of Notifications based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfNotificationsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: readAt operator: '=' value: value - field: createdAt operator: '=' value: value - field: data operator: '=' value: value - field: data.settings.type operator: '=' value: value - field: data.settings.level operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/employee-fields: post: summary: 'Create a new Employee field' operationId: createANewEmployeeField description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: true nullable: false isMandatory: type: boolean description: '' example: false nullable: true salarySensitive: type: boolean description: '' example: false nullable: true sensitive: type: boolean description: '' example: false nullable: true allowNewValue: type: boolean description: '' example: true nullable: true observe: type: boolean description: '' example: false nullable: true importExcluded: type: boolean description: '' example: true nullable: true manualInput: type: boolean description: '' example: true nullable: true fieldType: type: string description: '' example: textarea nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: date nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: 'This field is required when dataType is string.' example: 77929.9 nullable: false minInput: type: number description: 'This field is required when dataType is string.' example: 38.0 nullable: false maxLength: type: number description: '' example: 3948279.0496 nullable: false minLength: type: number description: '' example: 0.0 nullable: false fieldName: type: string description: 'Must not be greater than 255 characters.' example: ouzmfexms nullable: false combinedFieldIds: type: array description: '' example: - dolor items: type: string required: - isShow - fieldType - dataType - fieldName - combinedFieldIds get: summary: 'Fetch a list of Employee fields with pagination' operationId: fetchAListOfEmployeeFieldsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' '/api/v1/employee-fields/{fieldId}': get: summary: 'Fetch a Employee field by its ID' operationId: fetchAEmployeeFieldByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmployeeField [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmployeeField [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Employee field by its ID' operationId: updateAEmployeeFieldByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmployeeField [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmployeeField [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: false nullable: false isMandatory: type: boolean description: '' example: false nullable: true salarySensitive: type: boolean description: '' example: true nullable: true sensitive: type: boolean description: '' example: false nullable: true allowNewValue: type: boolean description: '' example: false nullable: true observe: type: boolean description: '' example: true nullable: true importExcluded: type: boolean description: '' example: false nullable: true manualInput: type: boolean description: '' example: true nullable: true fieldType: type: string description: '' example: number nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: decimal nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: 'This field is required when dataType is string.' example: 3136.39758984 nullable: false minInput: type: number description: 'This field is required when dataType is string.' example: 6.49888436 nullable: false maxLength: type: number description: '' example: 5082.070454 nullable: false minLength: type: number description: '' example: 3.319063 nullable: false fieldName: type: string description: '' example: null nullable: false combinedFieldIds: type: array description: '' example: - blanditiis items: type: string required: - combinedFieldIds delete: summary: 'Delete a Employee field by its ID' operationId: deleteAEmployeeFieldByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmployeeField [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmployeeField [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: fieldId description: '' example: aperiam required: true schema: type: string /api/v1/company-fields: post: summary: 'Create a new Company field' operationId: createANewCompanyField description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: fieldName: type: string description: '' example: ex nullable: false autoApproveOnImport: type: boolean description: '' example: false nullable: false required: - fieldName get: summary: 'Fetch a list of Company fields with pagination' operationId: fetchAListOfCompanyFieldsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/company-fields/batch: post: summary: 'Batch create new Company fields' operationId: batchCreateNewCompanyFields description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: fieldName: type: string description: '' example: et nullable: false autoApproveOnImport: type: boolean description: '' example: false nullable: false required: - fieldName patch: summary: 'Batch update Company fields' operationId: batchUpdateCompanyFields description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: fieldName: type: string description: '' example: null nullable: false autoApproveOnImport: type: boolean description: '' example: true nullable: false delete: summary: 'Batch delete Company fields by their IDs' operationId: batchDeleteCompanyFieldsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - sapiente items: type: string '/api/v1/company-fields/{id}': get: summary: 'Fetch a Company field by its ID' operationId: fetchACompanyFieldByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyField [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyField [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Company field by its ID' operationId: updateACompanyFieldByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyField [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyField [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: fieldName: type: string description: '' example: null nullable: false autoApproveOnImport: type: boolean description: '' example: true nullable: false delete: summary: 'Delete a Company field by its ID' operationId: deleteACompanyFieldByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyField [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyField [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: id description: 'The ID of the company field.' example: quam required: true schema: type: string /api/v1/company-fields/search: post: summary: 'Fetch a list of Company fields based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfCompanyFieldsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: fieldName operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/log-entities: get: summary: 'Fetch a list of Log entities with pagination' operationId: fetchAListOfLogEntitiesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/log-entities/search: post: summary: 'Fetch a list of Log entities based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfLogEntitiesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: entity operator: '=' value: value - field: entityId operator: '=' value: value - field: action operator: '=' value: value - field: createdBy operator: '=' value: value - field: createdAt operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/variable-types: post: summary: 'Create a new Variable type' operationId: createANewVariableType description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } description: type: string description: '' example: 'Fugiat animi alias officiis.' nullable: false required: - description get: summary: 'Fetch a list of Variable types with pagination' operationId: fetchAListOfVariableTypesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/variable-types/batch: post: summary: 'Batch create new Variable types' operationId: batchCreateNewVariableTypes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } description: type: string description: '' example: 'Officia quis qui sint sed rerum facere.' nullable: false required: - description patch: summary: 'Batch update Variable types' operationId: batchUpdateVariableTypes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } description: type: string description: '' example: 'Rem quae et sapiente ex saepe.' nullable: false delete: summary: 'Batch delete Variable types by their IDs' operationId: batchDeleteVariableTypesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - autem items: type: string '/api/v1/variable-types/{variableTypeId}': get: summary: 'Fetch a Variable type by its ID' operationId: fetchAVariableTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'VariableType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'VariableType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Variable type by its ID' operationId: updateAVariableTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'VariableType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'VariableType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } description: type: string description: '' example: 'Nesciunt pariatur quod vero fuga.' nullable: false delete: summary: 'Delete a Variable type by its ID' operationId: deleteAVariableTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'VariableType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'VariableType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: variableTypeId description: '' example: repellendus required: true schema: type: string /api/v1/variable-types/search: post: summary: 'Fetch a list of Variable types based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfVariableTypesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: description operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/salary-rules: post: summary: 'Create a new Salary rule' operationId: createANewSalaryRule description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: necessitatibus nullable: true selections: type: array description: '' example: null items: type: object properties: employeeFieldId: type: string description: '' example: tenetur nullable: false operator: type: string description: '' example: '!=' nullable: false enum: - '=' - '!=' value: type: string description: '' example: quo nullable: false required: - employeeFieldId - operator - value warning: type: string description: '' example: ad nullable: false solutionDescription: type: string description: '' example: qui nullable: false ruleExpression: type: array description: 'Must have at least 1 items.' example: - [] items: type: object properties: type: type: string description: '' example: logical nullable: false enum: - comparison_operator - logical_operator - logical - logical_missing - logical_diff payCodeIds: type: array description: '' example: - 4 items: type: integer previous_periods: type: integer description: 'This field is required when ruleExpression.*.type is logical_diff. Must be between 1 and 12.' example: 1 nullable: false diff_type: type: string description: 'This field is required when ruleExpression.*.type is logical_diff.' example: real nullable: false enum: - real - percentage conditions: type: object description: 'This field is required when ruleExpression.*.type is logical or logical_diff. Must have at least 1 items.' example: null nullable: false properties: { } required: - type required: - warning - solutionDescription - ruleExpression get: summary: 'Fetch a list of Salary rules with pagination' operationId: fetchAListOfSalaryRulesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' '/api/v1/salary-rules/{salaryRuleId}': get: summary: 'Fetch a Salary rule by its ID' operationId: fetchASalaryRuleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'SalaryRule [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'SalaryRule [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Salary rule by its ID' operationId: updateASalaryRuleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'SalaryRule [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'SalaryRule [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false warning: type: string description: '' example: illo nullable: false selections: type: object description: '' example: null nullable: false properties: { } solutionDescription: type: string description: '' example: cumque nullable: false ruleExpression: type: array description: 'Must have at least 1 items.' example: - [] items: type: object properties: type: type: string description: '' example: logical_missing nullable: false enum: - comparison_operator - logical_operator - logical - logical_missing - logical_diff payCodeIds: type: array description: '' example: - sapiente items: type: string previous_periods: type: integer description: 'This field is required when ruleExpression.*.type is logical_diff. Must be between 1 and 12.' example: 1 nullable: false diff_type: type: string description: 'This field is required when ruleExpression.*.type is logical_diff.' example: real nullable: false enum: - real - percentage conditions: type: object description: 'This field is required when ruleExpression.*.type is logical or logical_diff. Must have at least 1 items.' example: null nullable: false properties: { } required: - type required: - ruleExpression delete: summary: 'Delete a Salary rule by its ID' operationId: deleteASalaryRuleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'SalaryRule [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'SalaryRule [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: salaryRuleId description: '' example: sit required: true schema: type: string /api/v1/salary-rules/search: post: summary: 'Fetch a list of Salary rules based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfSalaryRulesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: [] nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/org-integrations-mappings: post: summary: 'Create a new Org integrations mapping' operationId: createANewOrgIntegrationsMapping description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalIntegrationId: type: string description: '' example: suscipit nullable: false organizationId: type: string description: '' example: sed nullable: false notes: type: string description: '' example: autem nullable: false status: type: string description: '' example: active nullable: false enum: - active - inactive required: - externalIntegrationId - organizationId - notes - status get: summary: 'Fetch a list of Org integrations mappings with pagination' operationId: fetchAListOfOrgIntegrationsMappingsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/org-integrations-mappings/batch: post: summary: 'Batch create new Org integrations mappings' operationId: batchCreateNewOrgIntegrationsMappings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalIntegrationId: type: string description: '' example: eos nullable: false organizationId: type: string description: '' example: hic nullable: false notes: type: string description: '' example: cumque nullable: false status: type: string description: '' example: active nullable: false enum: - active - inactive required: - externalIntegrationId - organizationId - notes - status patch: summary: 'Batch update Org integrations mappings' operationId: batchUpdateOrgIntegrationsMappings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false notes: type: string description: '' example: occaecati nullable: false status: type: string description: '' example: inactive nullable: false enum: - active - inactive delete: summary: 'Batch delete Org integrations mappings by their IDs' operationId: batchDeleteOrgIntegrationsMappingsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - voluptatem items: type: string '/api/v1/org-integrations-mappings/{orgIntegrationsMappingId}': get: summary: 'Fetch a Org integrations mapping by its ID' operationId: fetchAOrgIntegrationsMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' patch: summary: 'Update a Org integrations mapping by its ID' operationId: updateAOrgIntegrationsMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false notes: type: string description: '' example: sed nullable: false status: type: string description: '' example: active nullable: false enum: - active - inactive delete: summary: 'Delete a Org integrations mapping by its ID' operationId: deleteAOrgIntegrationsMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' nullable: false responses: { } tags: - 'Crudy Endpoints' parameters: - in: path name: orgIntegrationsMappingId description: '' example: qui required: true schema: type: string /api/v1/org-integrations-mappings/search: post: summary: 'Fetch a list of Org integrations mappings based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfOrgIntegrationsMappingsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: externalIntegrationId operator: '=' value: value - field: organizationId operator: '=' value: value - field: status operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/field-value-matrices: post: summary: 'Create a new Field value matrix' operationId: createANewFieldValueMatrix description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: quibusdam nullable: false description: type: string description: '' example: 'Est sit libero quia veritatis.' nullable: false keyFieldId: type: string description: '' example: recusandae nullable: false fieldIds: type: array description: '' example: - at items: type: string matrixFields: type: array description: '' example: null items: type: object properties: keyFieldValue: type: string description: '' example: non nullable: false fields: type: array description: '' example: - [] items: type: object properties: fieldValue: type: string description: '' example: animi nullable: false fieldId: type: string description: '' example: molestiae nullable: false required: - fieldValue - fieldId required: - keyFieldValue companyId: type: string description: '' example: iusto nullable: false required: - name - description - keyFieldId - fieldIds - companyId get: summary: 'Fetch a list of Field value matrices with pagination' operationId: fetchAListOfFieldValueMatricesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' '/api/v1/field-value-matrices/{fieldValueMatrixId}': get: summary: 'Fetch a Field value matrix by its ID' operationId: fetchAFieldValueMatrixByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'FieldValueMatrix [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'FieldValueMatrix [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Field value matrix by its ID' operationId: updateAFieldValueMatrixByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'FieldValueMatrix [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'FieldValueMatrix [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false name: type: string description: '' example: blanditiis nullable: false description: type: string description: '' example: 'Et et amet ut dolores.' nullable: false keyFieldId: type: string description: '' example: sed nullable: false fieldIds: type: array description: '' example: - quisquam items: type: string matrixFields: type: array description: '' example: null items: type: object properties: keyFieldValue: type: string description: '' example: est nullable: false fields: type: array description: '' example: - [] items: type: object properties: fieldValue: type: string description: '' example: nisi nullable: false fieldId: type: string description: '' example: suscipit nullable: false required: - fieldValue - fieldId required: - keyFieldValue required: - fieldIds delete: summary: 'Delete a Field value matrix by its ID' operationId: deleteAFieldValueMatrixByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'FieldValueMatrix [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'FieldValueMatrix [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: fieldValueMatrixId description: '' example: quibusdam required: true schema: type: string /api/v1/field-value-matrices/search: post: summary: 'Fetch a list of Field value matrices based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfFieldValueMatricesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: name operator: '=' value: value - field: description operator: '=' value: value - field: keyFieldValue operator: '=' value: value - field: keyFieldId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/organizations: post: summary: 'Create a new Organization' operationId: createANewOrganization description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: mollitia nullable: false orgNumber: type: string description: '' example: quibusdam nullable: false required: - name - orgNumber get: summary: 'Fetch a list of Organizations with pagination' operationId: fetchAListOfOrganizationsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/organizations/batch: post: summary: 'Batch create new Organizations' operationId: batchCreateNewOrganizations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: '' example: vel nullable: false orgNumber: type: string description: '' example: qui nullable: false required: - name - orgNumber patch: summary: 'Batch update Organizations' operationId: batchUpdateOrganizations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: '' example: error nullable: false orgNumber: type: string description: '' example: aliquid nullable: false delete: summary: 'Batch delete Organizations by their IDs' operationId: batchDeleteOrganizationsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - consequatur items: type: string '/api/v1/organizations/{organizationId}': get: summary: 'Fetch a Organization by its ID' operationId: fetchAOrganizationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Organization [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Organization [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Organization by its ID' operationId: updateAOrganizationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Organization [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Organization [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: '' example: fugit nullable: false orgNumber: type: string description: '' example: ipsum nullable: false delete: summary: 'Delete a Organization by its ID' operationId: deleteAOrganizationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Organization [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Organization [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: organizationId description: '' example: totam required: true schema: type: string /api/v1/organizations/search: post: summary: 'Fetch a list of Organizations based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfOrganizationsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: name operator: '=' value: value - field: orgNumber operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/menus: post: summary: 'Create a new Menu' operationId: createANewMenu description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: xbhnmunam nullable: false icon: type: string description: 'Must not be greater than 255 characters.' example: yn nullable: false url: type: string description: 'Must not be greater than 255 characters.' example: 'http://www.kuhlman.biz/repudiandae-consectetur-voluptas-quia-nostrum-vero-ut-ut.html' nullable: false parentId: type: string description: '' example: commodi nullable: true required: - name - icon - url get: summary: 'Fetch a list of Menus with pagination' operationId: fetchAListOfMenusWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/menus/batch: post: summary: 'Batch create new Menus' operationId: batchCreateNewMenus description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: bfqgjjhd nullable: false icon: type: string description: 'Must not be greater than 255 characters.' example: mg nullable: false url: type: string description: 'Must not be greater than 255 characters.' example: 'https://www.terry.org/aut-voluptas-pariatur-non-nihil-et-esse-voluptas' nullable: false parentId: type: string description: '' example: labore nullable: true required: - name - icon - url patch: summary: 'Batch update Menus' operationId: batchUpdateMenus description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: vylgbrbvbxgxswfzkugglx nullable: false icon: type: string description: 'Must not be greater than 255 characters.' example: jetuofnyy nullable: false url: type: string description: 'Must not be greater than 255 characters.' example: 'http://tremblay.info/debitis-dolores-provident-expedita-earum-debitis-quae.html' nullable: false parentId: type: string description: '' example: eveniet nullable: true delete: summary: 'Batch delete Menus by their IDs' operationId: batchDeleteMenusByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - illo items: type: string '/api/v1/menus/{menuId}': get: summary: 'Fetch a Menu by its ID' operationId: fetchAMenuByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Menu [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Menu [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Menu by its ID' operationId: updateAMenuByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Menu [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Menu [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: ycyoo nullable: false icon: type: string description: 'Must not be greater than 255 characters.' example: oszdbbgabkzeitjque nullable: false url: type: string description: 'Must not be greater than 255 characters.' example: 'http://hilpert.info/nisi-animi-aperiam-ipsum-explicabo-sint.html' nullable: false parentId: type: string description: '' example: ad nullable: true delete: summary: 'Delete a Menu by its ID' operationId: deleteAMenuByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Menu [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Menu [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: menuId description: '' example: quae required: true schema: type: string /api/v1/menus/search: post: summary: 'Fetch a list of Menus based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfMenusBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'parent,children' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: name operator: '=' value: value - field: icon operator: '=' value: value - field: url operator: '=' value: value - field: parentId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/company-field-maps: post: summary: 'Create a new Company field map' operationId: createANewCompanyFieldMap description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalCompanyFieldId: type: string description: '' example: suscipit nullable: false companyFieldId: type: string description: '' example: impedit nullable: false companyId: type: string description: '' example: aut nullable: true externalIntegrationId: type: string description: '' example: quia nullable: false required: - externalCompanyFieldId - companyFieldId - externalIntegrationId get: summary: 'Fetch a list of Company field maps with pagination' operationId: fetchAListOfCompanyFieldMapsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/company-field-maps/batch: post: summary: 'Batch create new Company field maps' operationId: batchCreateNewCompanyFieldMaps description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalCompanyFieldId: type: string description: '' example: illum nullable: false companyFieldId: type: string description: '' example: quis nullable: false companyId: type: string description: '' example: voluptate nullable: true externalIntegrationId: type: string description: '' example: omnis nullable: false required: - externalCompanyFieldId - companyFieldId - externalIntegrationId patch: summary: 'Batch update Company field maps' operationId: batchUpdateCompanyFieldMaps description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalCompanyFieldId: type: string description: '' example: similique nullable: false companyFieldId: type: string description: '' example: optio nullable: false companyId: type: string description: '' example: voluptatem nullable: true externalIntegrationId: type: string description: '' example: dicta nullable: true required: - externalCompanyFieldId - companyFieldId delete: summary: 'Batch delete Company field maps by their IDs' operationId: batchDeleteCompanyFieldMapsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - illo items: type: string '/api/v1/company-field-maps/{companyFieldMapId}': get: summary: 'Fetch a Company field map by its ID' operationId: fetchACompanyFieldMapByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyFieldMap [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyFieldMap [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Company field map by its ID' operationId: updateACompanyFieldMapByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyFieldMap [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyFieldMap [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalCompanyFieldId: type: string description: '' example: ut nullable: false companyFieldId: type: string description: '' example: quos nullable: false companyId: type: string description: '' example: saepe nullable: true externalIntegrationId: type: string description: '' example: molestias nullable: true required: - externalCompanyFieldId - companyFieldId delete: summary: 'Delete a Company field map by its ID' operationId: deleteACompanyFieldMapByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyFieldMap [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyFieldMap [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: companyFieldMapId description: '' example: assumenda required: true schema: type: string /api/v1/company-field-maps/search: post: summary: 'Fetch a list of Company field maps based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfCompanyFieldMapsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/pay-code-variables: post: summary: 'Create a new Pay code variable' operationId: createANewPayCodeVariable description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } variableTypeId: type: string description: '' example: quis nullable: false required: - variableTypeId get: summary: 'Fetch a list of Pay code variables with pagination' operationId: fetchAListOfPayCodeVariablesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/pay-code-variables/batch: post: summary: 'Batch create new Pay code variables' operationId: batchCreateNewPayCodeVariables description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } variableTypeId: type: string description: '' example: iusto nullable: false required: - variableTypeId patch: summary: 'Batch update Pay code variables' operationId: batchUpdatePayCodeVariables description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } variableTypeId: type: string description: '' example: null nullable: false delete: summary: 'Batch delete Pay code variables by their IDs' operationId: batchDeletePayCodeVariablesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - eius items: type: string '/api/v1/pay-code-variables/{payCodeVariableId}': get: summary: 'Fetch a Pay code variable by its ID' operationId: fetchAPayCodeVariableByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeVariable [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeVariable [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Pay code variable by its ID' operationId: updateAPayCodeVariableByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeVariable [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeVariable [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } variableTypeId: type: string description: '' example: null nullable: false delete: summary: 'Delete a Pay code variable by its ID' operationId: deleteAPayCodeVariableByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeVariable [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeVariable [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: payCodeVariableId description: '' example: cumque required: true schema: type: string /api/v1/pay-code-variables/search: post: summary: 'Fetch a list of Pay code variables based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPayCodeVariablesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: variableTypeId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/pay-code-types: post: summary: 'Create a new Pay code type' operationId: createANewPayCodeType description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: payCodeTypeNumber: type: number description: '' example: 0.1 nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } required: - payCodeTypeNumber get: summary: 'Fetch a list of Pay code types with pagination' operationId: fetchAListOfPayCodeTypesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/pay-code-types/batch: post: summary: 'Batch create new Pay code types' operationId: batchCreateNewPayCodeTypes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: payCodeTypeNumber: type: number description: '' example: 68821533.0 nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } required: - payCodeTypeNumber patch: summary: 'Batch update Pay code types' operationId: batchUpdatePayCodeTypes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: payCodeTypeNumber: type: number description: '' example: 17.4 nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } delete: summary: 'Batch delete Pay code types by their IDs' operationId: batchDeletePayCodeTypesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - perferendis items: type: string '/api/v1/pay-code-types/{payCodeTypeId}': get: summary: 'Fetch a Pay code type by its ID' operationId: fetchAPayCodeTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Pay code type by its ID' operationId: updateAPayCodeTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: payCodeTypeNumber: type: number description: '' example: 1143.849294312 nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } delete: summary: 'Delete a Pay code type by its ID' operationId: deleteAPayCodeTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: payCodeTypeId description: '' example: deserunt required: true schema: type: string /api/v1/pay-code-types/search: post: summary: 'Fetch a list of Pay code types based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPayCodeTypesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: payCodeTypeNumber operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/pay-code-mappings: post: summary: 'Create a new Pay code mapping' operationId: createANewPayCodeMapping description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: whiteListedPayCodeIds: type: object description: '' example: null nullable: false properties: { } companyId: type: string description: 'This field is required when organizationId is not present.' example: omnis nullable: false organizationId: type: string description: 'This field is required when companyId is not present.' example: temporibus nullable: false isGlobal: type: boolean description: '' example: true nullable: false isGroup: type: boolean description: '' example: false nullable: false mappings: type: array description: '' example: null items: type: string notes: type: string description: '' example: sint nullable: false required: - isGlobal - isGroup get: summary: 'Fetch a list of Pay code mappings with pagination' operationId: fetchAListOfPayCodeMappingsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/pay-code-mappings/batch: post: summary: 'Batch create new Pay code mappings' operationId: batchCreateNewPayCodeMappings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: whiteListedPayCodeIds: type: object description: '' example: null nullable: false properties: { } companyId: type: string description: 'This field is required when resources.*.organizationId is not present.' example: est nullable: false organizationId: type: string description: 'This field is required when resources.*.companyId is not present.' example: nesciunt nullable: false isGlobal: type: boolean description: '' example: true nullable: false isGroup: type: boolean description: '' example: true nullable: false mappings: type: object description: '' example: [] nullable: false properties: { } notes: type: string description: '' example: et nullable: false required: - isGlobal - isGroup - mappings patch: summary: 'Batch update Pay code mappings' operationId: batchUpdatePayCodeMappings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: whiteListedPayCodeIds: type: object description: '' example: null nullable: false properties: { } companyId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false isGlobal: type: boolean description: '' example: false nullable: false isGroup: type: boolean description: '' example: false nullable: false mappings: type: object description: '' example: null nullable: false properties: { } notes: type: string description: '' example: cumque nullable: false status: type: string description: '' example: active nullable: false enum: - active - inactive delete: summary: 'Batch delete Pay code mappings by their IDs' operationId: batchDeletePayCodeMappingsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - animi items: type: string '/api/v1/pay-code-mappings/{mappingId}': get: summary: 'Fetch a Pay code mapping by its ID' operationId: fetchAPayCodeMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeMapping [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeMapping [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Pay code mapping by its ID' operationId: updateAPayCodeMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeMapping [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeMapping [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: whiteListedPayCodeIds: type: object description: '' example: null nullable: false properties: { } companyId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false isGlobal: type: boolean description: '' example: false nullable: false isGroup: type: boolean description: '' example: true nullable: false mappings: type: array description: '' example: null items: type: string notes: type: string description: '' example: qui nullable: false status: type: string description: '' example: inactive nullable: false enum: - active - inactive delete: summary: 'Delete a Pay code mapping by its ID' operationId: deleteAPayCodeMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeMapping [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeMapping [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: mappingId description: '' example: a required: true schema: type: string /api/v1/pay-code-mappings/search: post: summary: 'Fetch a list of Pay code mappings based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPayCodeMappingsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: isGlobal operator: '=' value: value - field: isGroup operator: '=' value: value - field: status operator: '=' value: value - field: whiteListedPayCodeIds operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/companies: post: summary: 'Create a new Company' operationId: createANewCompany description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: fields: type: array description: '' example: null items: type: string companyId: type: string description: '' example: null nullable: false importedAt: type: string description: '' example: null nullable: false parentCompanyId: type: string description: '' example: null nullable: true organizationId: type: string description: '' example: null nullable: false countryId: type: string description: '' example: null nullable: true customerTypeIds: type: array description: '' example: - deserunt items: type: string autoApproveOnImport: type: boolean description: '' example: false nullable: false required: - customerTypeIds get: summary: 'Fetch a list of Companies with pagination' operationId: fetchAListOfCompaniesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/companies/batch: post: summary: 'Batch create new Companies' operationId: batchCreateNewCompanies description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: fields: type: object description: '' example: null nullable: false properties: { } companyId: type: string description: '' example: null nullable: false importedAt: type: string description: '' example: null nullable: false parentCompanyId: type: string description: '' example: null nullable: true organizationId: type: string description: '' example: null nullable: false countryId: type: string description: '' example: null nullable: true customerTypeIds: type: object description: '' example: null nullable: false properties: { } autoApproveOnImport: type: boolean description: '' example: false nullable: false patch: summary: 'Batch update Companies' operationId: batchUpdateCompanies description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: fields: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false importedAt: type: string description: '' example: null nullable: false parentCompanyId: type: string description: '' example: null nullable: true organizationId: type: string description: '' example: null nullable: false countryId: type: string description: '' example: null nullable: false customerTypeIds: type: object description: '' example: null nullable: false properties: { } autoApproveOnImport: type: boolean description: '' example: false nullable: false delete: summary: 'Batch delete Companies by their IDs' operationId: batchDeleteCompaniesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - sit items: type: string '/api/v1/companies/{companyId}': get: summary: 'Fetch a Company by its ID' operationId: fetchACompanyByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Company [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Company [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Company by its ID' operationId: updateACompanyByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Company [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Company [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: fields: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false importedAt: type: string description: '' example: null nullable: false parentCompanyId: type: string description: '' example: null nullable: true organizationId: type: string description: '' example: null nullable: false countryId: type: string description: '' example: null nullable: false customerTypeIds: type: array description: '' example: - expedita items: type: string autoApproveOnImport: type: boolean description: '' example: true nullable: false delete: summary: 'Delete a Company by its ID' operationId: deleteACompanyByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Company [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Company [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: companyId description: '' example: quidem required: true schema: type: string /api/v1/companies/search: post: summary: 'Fetch a list of Companies based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfCompaniesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: importedAt operator: '=' value: value - field: parentCompanyId operator: '=' value: value - field: organizationId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `externalId`.' example: - field: externalId direction: asc - field: companyId direction: asc nullable: false /api/v1/company-integrations-mappings: post: summary: 'Create a new Company integrations mapping' operationId: createANewCompanyIntegrationsMapping description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalIntegrationId: type: string description: '' example: tempora nullable: false companyId: type: string description: '' example: ipsa nullable: false notes: type: string description: '' example: labore nullable: false status: type: string description: '' example: inactive nullable: false enum: - active - inactive required: - externalIntegrationId - companyId - notes - status get: summary: 'Fetch a list of Company integrations mappings with pagination' operationId: fetchAListOfCompanyIntegrationsMappingsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/company-integrations-mappings/batch: post: summary: 'Batch create new Company integrations mappings' operationId: batchCreateNewCompanyIntegrationsMappings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalIntegrationId: type: string description: '' example: tenetur nullable: false companyId: type: string description: '' example: porro nullable: false notes: type: string description: '' example: voluptatem nullable: false status: type: string description: '' example: inactive nullable: false enum: - active - inactive required: - externalIntegrationId - companyId - notes - status patch: summary: 'Batch update Company integrations mappings' operationId: batchUpdateCompanyIntegrationsMappings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalIntegrationId: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false notes: type: string description: '' example: aliquam nullable: false status: type: string description: '' example: inactive nullable: false enum: - active - inactive delete: summary: 'Batch delete Company integrations mappings by their IDs' operationId: batchDeleteCompanyIntegrationsMappingsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - fuga items: type: string '/api/v1/company-integrations-mappings/{companyIntegrationsMappingId}': get: summary: 'Fetch a Company integrations mapping by its ID' operationId: fetchACompanyIntegrationsMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' patch: summary: 'Update a Company integrations mapping by its ID' operationId: updateACompanyIntegrationsMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: externalIntegrationId: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false notes: type: string description: '' example: quidem nullable: false status: type: string description: '' example: active nullable: false enum: - active - inactive delete: summary: 'Delete a Company integrations mapping by its ID' operationId: deleteACompanyIntegrationsMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' parameters: - in: path name: companyIntegrationsMappingId description: '' example: voluptatum required: true schema: type: string /api/v1/company-integrations-mappings/search: post: summary: 'Fetch a list of Company integrations mappings based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfCompanyIntegrationsMappingsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: [] nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/company-settings: post: summary: 'Create a new Company settings' operationId: createANewCompanySettings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: defaultLocale: type: string description: '' example: ha_SD nullable: false defaultProfile: type: string description: '' example: aperiam nullable: false activeProfile: type: string description: '' example: provident nullable: false companyId: type: string description: 'This field is required when organizationId is not present.' example: qui nullable: false organizationId: type: string description: 'This field is required when companyId is not present.' example: aliquid nullable: false organisationNumber: type: string description: '' example: magnam nullable: false get: summary: 'Fetch a list of Company settings with pagination' operationId: fetchAListOfCompanySettingsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/company-settings/batch: post: summary: 'Batch create new Company settings' operationId: batchCreateNewCompanySettings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: defaultLocale: type: string description: '' example: de_DE nullable: false defaultProfile: type: string description: '' example: nostrum nullable: false activeProfile: type: string description: '' example: vel nullable: false companyId: type: string description: 'This field is required when resources.*.organizationId is not present.' example: impedit nullable: false organizationId: type: string description: 'This field is required when resources.*.companyId is not present.' example: eum nullable: false organisationNumber: type: string description: '' example: blanditiis nullable: false patch: summary: 'Batch update Company settings' operationId: batchUpdateCompanySettings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: defaultLocale: type: string description: '' example: ja_JP nullable: false defaultProfile: type: string description: '' example: architecto nullable: false activeProfile: type: string description: '' example: rerum nullable: false companyId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false organisationNumber: type: string description: '' example: hic nullable: false delete: summary: 'Batch delete Company settings by their IDs' operationId: batchDeleteCompanySettingsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - mollitia items: type: string '/api/v1/company-settings/{companySettingsId}': get: summary: 'Fetch a Company settings by its ID' operationId: fetchACompanySettingsByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanySettings [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanySettings [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Company settings by its ID' operationId: updateACompanySettingsByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanySettings [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanySettings [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: defaultLocale: type: string description: '' example: es_UY nullable: false defaultProfile: type: string description: '' example: maiores nullable: false activeProfile: type: string description: '' example: reprehenderit nullable: false companyId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false organisationNumber: type: string description: '' example: libero nullable: false delete: summary: 'Delete a Company settings by its ID' operationId: deleteACompanySettingsByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanySettings [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanySettings [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: sit nullable: false required: - companyId parameters: - in: path name: companySettingsId description: '' example: nulla required: true schema: type: string /api/v1/company-settings/search: post: summary: 'Fetch a list of Company settings based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfCompanySettingsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: organisationId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/pay-code-groups: post: summary: 'Create a new Pay code group' operationId: createANewPayCodeGroup description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } payCodeGroupNumber: type: number description: '' example: 78210.03829 nullable: false payCodeGroupId: type: string description: '' example: null nullable: false payCodeVariableIds: type: array description: '' example: - vitae items: type: string required: - payCodeGroupNumber - payCodeVariableIds get: summary: 'Fetch a list of Pay code groups with pagination' operationId: fetchAListOfPayCodeGroupsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/pay-code-groups/batch: post: summary: 'Batch create new Pay code groups' operationId: batchCreateNewPayCodeGroups description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } payCodeGroupNumber: type: number description: '' example: 641600792.1 nullable: false payCodeGroupId: type: string description: '' example: null nullable: false payCodeVariableIds: type: object description: '' example: [] nullable: false properties: { } required: - payCodeGroupNumber - payCodeVariableIds patch: summary: 'Batch update Pay code groups' operationId: batchUpdatePayCodeGroups description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } payCodeGroupNumber: type: number description: '' example: 0.5529983 nullable: false payCodeGroupId: type: string description: '' example: null nullable: false payCodeVariableIds: type: object description: '' example: null nullable: false properties: { } delete: summary: 'Batch delete Pay code groups by their IDs' operationId: batchDeletePayCodeGroupsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - reprehenderit items: type: string '/api/v1/pay-code-groups/{payCodeGroupId}': get: summary: 'Fetch a Pay code group by its ID' operationId: fetchAPayCodeGroupByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeGroup [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeGroup [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Pay code group by its ID' operationId: updateAPayCodeGroupByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeGroup [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeGroup [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } payCodeGroupNumber: type: number description: '' example: 104907.39221824 nullable: false payCodeGroupId: type: string description: '' example: null nullable: false payCodeVariableIds: type: array description: '' example: - minima items: type: string delete: summary: 'Delete a Pay code group by its ID' operationId: deleteAPayCodeGroupByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeGroup [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeGroup [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: payCodeGroupId description: '' example: nesciunt required: true schema: type: string /api/v1/pay-code-groups/search: post: summary: 'Fetch a list of Pay code groups based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPayCodeGroupsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: payCodeGroupNumber operator: '=' value: value - field: payCodeVariableIds operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/external-integrations/batch: post: summary: 'Batch create new External integrations' operationId: batchCreateNewExternalIntegrations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object patch: summary: 'Batch update External integrations' operationId: batchUpdateExternalIntegrations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: integrationName: type: string description: '' example: null nullable: false description: type: string description: '' example: 'Eos aut a asperiores rerum voluptas.' nullable: false status: type: string description: '' example: active nullable: false enum: - active - inactive integrationTypeId: type: string description: '' example: temporibus nullable: false delete: summary: 'Batch delete External integrations by their IDs' operationId: batchDeleteExternalIntegrationsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - quibusdam items: type: string '/api/v1/external-integrations/{externalIntegrationId}': get: summary: 'Fetch a External integration by its ID' operationId: fetchAExternalIntegrationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'ExternalIntegration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'ExternalIntegration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a External integration by its ID' operationId: updateAExternalIntegrationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'ExternalIntegration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'ExternalIntegration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: integrationName: type: string description: '' example: null nullable: false description: type: string description: '' example: 'Incidunt impedit non unde a qui.' nullable: false status: type: string description: '' example: active nullable: false enum: - active - inactive integrationTypeId: type: string description: '' example: nostrum nullable: false delete: summary: 'Delete a External integration by its ID' operationId: deleteAExternalIntegrationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'ExternalIntegration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'ExternalIntegration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: externalIntegrationId description: '' example: eos required: true schema: type: string /api/v1/external-integrations: get: summary: 'Fetch a list of External integrations with pagination' operationId: fetchAListOfExternalIntegrationsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/external-integrations/search: post: summary: 'Fetch a list of External integrations based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfExternalIntegrationsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: integrationName operator: '=' value: value - field: description operator: '=' value: value - field: status operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/pay-codes: post: summary: 'Create a new Pay code' operationId: createANewPayCode description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: et nullable: true integrationId: type: string description: '' example: error nullable: true organizationId: type: string description: '' example: qui nullable: true translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } payCodeNumber: type: number description: '' example: 450277.6422224 nullable: false payCodeId: type: string description: '' example: null nullable: false payCodeGroupId: type: string description: '' example: nobis nullable: false payCodeTypeId: type: string description: '' example: sapiente nullable: false payCodeVariableIds: type: array description: '' example: - et items: type: string required: - payCodeNumber - payCodeGroupId - payCodeTypeId - payCodeVariableIds get: summary: 'Fetch a list of Pay codes with pagination' operationId: fetchAListOfPayCodesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/pay-codes/batch: post: summary: 'Batch create new Pay codes' operationId: batchCreateNewPayCodes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: companyId: type: string description: '' example: nihil nullable: true integrationId: type: string description: '' example: dolor nullable: true organizationId: type: string description: '' example: quod nullable: true translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } payCodeNumber: type: number description: '' example: 81.8501 nullable: false payCodeId: type: string description: '' example: null nullable: false payCodeGroupId: type: string description: '' example: quia nullable: false payCodeTypeId: type: string description: '' example: saepe nullable: false payCodeVariableIds: type: object description: '' example: [] nullable: false properties: { } required: - payCodeNumber - payCodeGroupId - payCodeTypeId - payCodeVariableIds patch: summary: 'Batch update Pay codes' operationId: batchUpdatePayCodes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } payCodeNumber: type: number description: '' example: 82.0 nullable: false payCodeId: type: string description: '' example: null nullable: false payCodeGroupId: type: string description: '' example: voluptatibus nullable: false payCodeTypeId: type: string description: '' example: quia nullable: false payCodeVariableIds: type: object description: '' example: null nullable: false properties: { } delete: summary: 'Batch delete Pay codes by their IDs' operationId: batchDeletePayCodesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - et items: type: string '/api/v1/pay-codes/{payCodeId}': get: summary: 'Fetch a Pay code by its ID' operationId: fetchAPayCodeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCode [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCode [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Pay code by its ID' operationId: updateAPayCodeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCode [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCode [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } payCodeNumber: type: number description: '' example: 5895.620492145 nullable: false payCodeId: type: string description: '' example: null nullable: false payCodeGroupId: type: string description: '' example: nesciunt nullable: false payCodeTypeId: type: string description: '' example: maiores nullable: false payCodeVariableIds: type: array description: '' example: - harum items: type: string delete: summary: 'Delete a Pay code by its ID' operationId: deleteAPayCodeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCode [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCode [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: payCodeId description: '' example: odio required: true schema: type: string /api/v1/pay-codes/search: post: summary: 'Fetch a list of Pay codes based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPayCodesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: organizationId operator: '=' value: value - field: integrationId operator: '=' value: value - field: companyId operator: '=' value: value - field: payCodeNumber operator: '=' value: value - field: payCodeGroupId operator: '=' value: value - field: payCodeTypeId operator: '=' value: value - field: payCodeVariableIds operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: payCodeNumber direction: asc nullable: false /api/v1/personal-card-profiles: post: summary: 'Create a new Personal card profile' operationId: createANewPersonalCardProfile description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: praesentium nullable: false tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 5729070.7 nullable: false personalCardProfileTabId: type: string description: '' example: quibusdam nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 2097959.334 nullable: false personalCardProfileTabGridId: type: string description: '' example: vel nullable: false fieldGroupId: type: string description: 'This field is required when tabs.*.grids.*.fields is not present.' example: ipsum nullable: false fields: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 330554.6 nullable: false fieldId: type: string description: '' example: optio nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId - fields required: - order - personalCardProfileTabId - grids translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } description: type: string description: '' example: 'Saepe eum totam qui quo temporibus.' nullable: false isGlobal: type: string description: '' example: iste nullable: false roleIds: type: array description: 'The id of an existing record in the roles table.' example: - 12 items: type: integer companyId: type: string description: '' example: sapiente nullable: true required: - name - tabs - description - isGlobal get: summary: 'Fetch a list of Personal card profiles with pagination' operationId: fetchAListOfPersonalCardProfilesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: et nullable: false required: - isGlobal /api/v1/personal-card-profiles/batch: post: summary: 'Batch create new Personal card profiles' operationId: batchCreateNewPersonalCardProfiles description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: '' example: aliquam nullable: false tabs: type: object description: '' example: null nullable: false properties: { } translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } description: type: string description: '' example: 'Libero optio enim quia aut iusto.' nullable: false isGlobal: type: string description: '' example: sed nullable: false roleIds: type: object description: '' example: null nullable: false properties: { } companyId: type: string description: '' example: culpa nullable: true required: - name - description - isGlobal patch: summary: 'Batch update Personal card profiles' operationId: batchUpdatePersonalCardProfiles description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: et nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } description: type: string description: '' example: 'Vel nulla repellendus asperiores voluptatem expedita molestias mollitia repudiandae.' nullable: false tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 1720.91 nullable: false personalCardProfileTabId: type: string description: '' example: exercitationem nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 502505092.7 nullable: false personalCardProfileTabGridId: type: string description: '' example: cum nullable: false fieldGroupId: type: string description: '' example: magni nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 17.49 nullable: false fieldId: type: string description: '' example: provident nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids isGlobal: type: string description: '' example: illum nullable: false companyId: type: string description: '' example: qui nullable: true roleIds: type: array description: 'The id of an existing record in the roles table.' example: - 1 items: type: integer required: - tabs - isGlobal delete: summary: 'Batch delete Personal card profiles by their IDs' operationId: batchDeletePersonalCardProfilesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: doloribus nullable: false required: - isGlobal '/api/v1/personal-card-profiles/{personalCardProfileId}': get: summary: 'Fetch a Personal card profile by its ID' operationId: fetchAPersonalCardProfileByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfile [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfile [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: expedita nullable: false required: - isGlobal patch: summary: 'Update a Personal card profile by its ID' operationId: updateAPersonalCardProfileByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfile [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfile [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: id nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } description: type: string description: '' example: 'Ipsa quod quis voluptatem vel quam quis.' nullable: false tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 204322.5 nullable: false personalCardProfileTabId: type: string description: '' example: expedita nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 363330.24731 nullable: false personalCardProfileTabGridId: type: string description: '' example: quae nullable: false fieldGroupId: type: string description: '' example: nobis nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 18632478.92044 nullable: false fieldId: type: string description: '' example: cupiditate nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids isGlobal: type: string description: '' example: iusto nullable: false companyId: type: string description: '' example: unde nullable: true roleIds: type: array description: 'The id of an existing record in the roles table.' example: - 9 items: type: integer required: - tabs - isGlobal delete: summary: 'Delete a Personal card profile by its ID' operationId: deleteAPersonalCardProfileByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfile [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfile [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: laboriosam nullable: false required: - isGlobal parameters: - in: path name: personalCardProfileId description: '' example: ex required: true schema: type: string /api/v1/personal-card-profiles/search: post: summary: 'Fetch a list of Personal card profiles based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPersonalCardProfilesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: isGlobal operator: '=' value: value - field: name operator: '=' value: value - field: description operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/personal-card-profile-tab-grids: post: summary: 'Create a new Personal card profile tab grid' operationId: createANewPersonalCardProfileTabGrid description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: tabId: type: string description: '' example: eos nullable: true isGlobal: type: boolean description: '' example: false nullable: false description: type: string description: '' example: 'Aliquam repudiandae quia id nihil libero.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: 'no': type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false dk: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false se: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false en: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false fi: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false fieldGroupId: type: string description: '' example: repellendus nullable: true fields: type: array description: '' example: null items: type: object properties: globalFieldId: type: string description: '' example: tenetur nullable: false required: - globalFieldId originPersonalCardProfileId: type: string description: '' example: corrupti nullable: false required: - description get: summary: 'Fetch a list of Personal card profile tab grids with pagination' operationId: fetchAListOfPersonalCardProfileTabGridsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/personal-card-profile-tab-grids/batch: post: summary: 'Batch create new Personal card profile tab grids' operationId: batchCreateNewPersonalCardProfileTabGrids description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: tabId: type: string description: '' example: sint nullable: true isGlobal: type: boolean description: '' example: false nullable: false description: type: string description: '' example: 'Iure voluptatem commodi facere sit facilis qui quibusdam provident.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: 'no': type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false dk: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false se: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false en: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false fi: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false fieldGroupId: type: string description: '' example: veniam nullable: true fields: type: object description: '' example: null nullable: false properties: { } originPersonalCardProfileId: type: string description: '' example: voluptate nullable: false required: - description patch: summary: 'Batch update Personal card profile tab grids' operationId: batchUpdatePersonalCardProfileTabGrids description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: tabId: type: string description: '' example: null nullable: false isGlobal: type: boolean description: '' example: true nullable: false description: type: string description: '' example: 'Et unde illo accusantium recusandae perferendis tempore ad.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: 'no': type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false dk: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false se: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false en: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false fi: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false fields: type: string description: '' example: null nullable: false originPersonalCardProfileId: type: string description: '' example: null nullable: false delete: summary: 'Batch delete Personal card profile tab grids by their IDs' operationId: batchDeletePersonalCardProfileTabGridsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - quis items: type: string '/api/v1/personal-card-profile-tab-grids/{personalCardProfileTabGridId}': get: summary: 'Fetch a Personal card profile tab grid by its ID' operationId: fetchAPersonalCardProfileTabGridByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfileTabGrid [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfileTabGrid [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Personal card profile tab grid by its ID' operationId: updateAPersonalCardProfileTabGridByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfileTabGrid [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfileTabGrid [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: tabId: type: string description: '' example: null nullable: false isGlobal: type: boolean description: '' example: false nullable: false description: type: string description: '' example: 'Consequatur enim molestiae accusamus tempore.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: 'no': type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false dk: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false se: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false en: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false fi: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false fields: type: string description: '' example: null nullable: false originPersonalCardProfileId: type: string description: '' example: null nullable: false delete: summary: 'Delete a Personal card profile tab grid by its ID' operationId: deleteAPersonalCardProfileTabGridByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfileTabGrid [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfileTabGrid [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: personalCardProfileTabGridId description: '' example: sed required: true schema: type: string /api/v1/personal-card-profile-tab-grids/search: post: summary: 'Fetch a list of Personal card profile tab grids based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPersonalCardProfileTabGridsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: isGlobal operator: '=' value: value - field: description operator: '=' value: value - field: originPersonalCardProfileId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/personal-card-profile-tabs: post: summary: 'Create a new Personal card profile tab' operationId: createANewPersonalCardProfileTab description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: boolean description: '' example: true nullable: false description: type: string description: '' example: 'Minima illum voluptatem et modi magni amet.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: 'no': type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false dk: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false se: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false en: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false fi: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false originPersonalCardProfileId: type: string description: '' example: non nullable: false required: - description get: summary: 'Fetch a list of Personal card profile tabs with pagination' operationId: fetchAListOfPersonalCardProfileTabsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/personal-card-profile-tabs/batch: post: summary: 'Batch create new Personal card profile tabs' operationId: batchCreateNewPersonalCardProfileTabs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: isGlobal: type: boolean description: '' example: false nullable: false description: type: string description: '' example: 'Sed hic sit sunt perspiciatis.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: 'no': type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false dk: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false se: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false en: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false fi: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false originPersonalCardProfileId: type: string description: '' example: dicta nullable: false required: - description patch: summary: 'Batch update Personal card profile tabs' operationId: batchUpdatePersonalCardProfileTabs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: isGlobal: type: boolean description: '' example: false nullable: false description: type: string description: '' example: 'Ea non natus omnis est praesentium perferendis et.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: 'no': type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false dk: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false se: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false en: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false fi: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false originPersonalCardProfileId: type: string description: '' example: null nullable: false delete: summary: 'Batch delete Personal card profile tabs by their IDs' operationId: batchDeletePersonalCardProfileTabsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - ipsum items: type: string '/api/v1/personal-card-profile-tabs/{personalCardProfileTabId}': get: summary: 'Fetch a Personal card profile tab by its ID' operationId: fetchAPersonalCardProfileTabByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfileTab [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfileTab [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Personal card profile tab by its ID' operationId: updateAPersonalCardProfileTabByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfileTab [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfileTab [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: isGlobal: type: boolean description: '' example: false nullable: false description: type: string description: '' example: 'Voluptas facilis provident perspiciatis voluptate minus.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: 'no': type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false dk: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false se: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false en: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false fi: type: object description: '' example: [] nullable: false properties: long: type: string description: '' example: null nullable: false short: type: string description: '' example: null nullable: false originPersonalCardProfileId: type: string description: '' example: null nullable: false delete: summary: 'Delete a Personal card profile tab by its ID' operationId: deleteAPersonalCardProfileTabByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfileTab [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfileTab [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: personalCardProfileTabId description: '' example: et required: true schema: type: string /api/v1/personal-card-profile-tabs/search: post: summary: 'Fetch a list of Personal card profile tabs based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPersonalCardProfileTabsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: isGlobal operator: '=' value: value - field: description operator: '=' value: value - field: originPersonalCardProfileId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/locales: post: summary: 'Create a new Locale' operationId: createANewLocale description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false title: type: string description: '' example: culpa nullable: false code: type: string description: '' example: consectetur nullable: false enabled: type: boolean description: '' example: true nullable: false required: - title - code - enabled get: summary: 'Fetch a list of Locales with pagination' operationId: fetchAListOfLocalesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/locales/batch: post: summary: 'Batch create new Locales' operationId: batchCreateNewLocales description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: isGlobal: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false title: type: string description: '' example: corporis nullable: false code: type: string description: '' example: voluptatem nullable: false enabled: type: boolean description: '' example: false nullable: false required: - title - code - enabled patch: summary: 'Batch update Locales' operationId: batchUpdateLocales description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: title: type: string description: '' example: atque nullable: false code: type: string description: '' example: sint nullable: false enabled: type: boolean description: '' example: false nullable: false delete: summary: 'Batch delete Locales by their IDs' operationId: batchDeleteLocalesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - qui items: type: string '/api/v1/locales/{localeId}': get: summary: 'Fetch a Locale by its ID' operationId: fetchALocaleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Locale [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Locale [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Locale by its ID' operationId: updateALocaleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Locale [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Locale [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: '' example: sed nullable: false code: type: string description: '' example: temporibus nullable: false enabled: type: boolean description: '' example: false nullable: false delete: summary: 'Delete a Locale by its ID' operationId: deleteALocaleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Locale [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Locale [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: localeId description: '' example: officia required: true schema: type: string /api/v1/locales/search: post: summary: 'Fetch a list of Locales based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfLocalesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: code operator: '=' value: value - field: title operator: '=' value: value - field: enabled operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `code`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false '/api/v1/external-salary-types/{salaryTypeId}': get: summary: 'Fetch a External salary type by its ID' operationId: fetchAExternalSalaryTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,externalIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,externalIntegration' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'ExternalSalaryType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'ExternalSalaryType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: salaryTypeId description: '' example: fugit required: true schema: type: string /api/v1/external-salary-types: get: summary: 'Fetch a list of External salary types with pagination' operationId: fetchAListOfExternalSalaryTypesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,externalIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,externalIntegration' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/personnel-permissions: post: summary: 'Create a new Emp permission (Stability Score: 0.1)' operationId: createANewEmpPermissionStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: excepturi nullable: false glue: type: string description: '' example: AND nullable: false enum: - AND - OR translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } rules: type: array description: '' example: - rem items: type: string required: - companyId - glue '/api/v1/personnel-permissions/{empPermissionId}': patch: summary: 'Update a Emp permission by its ID (Stability Score: 0.1)' operationId: updateAEmpPermissionByItsIDStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmpPermission [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmpPermission [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: eos nullable: false glue: type: string description: '' example: OR nullable: false enum: - AND - OR translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } rules: type: array description: '' example: - quo items: type: string required: - companyId delete: summary: 'Delete a Emp permission by its ID (Stability Score: 0.1)' operationId: deleteAEmpPermissionByItsIDStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmpPermission [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmpPermission [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: empPermissionId description: '' example: provident required: true schema: type: string /api/v1/personnel-permissions/search: post: summary: 'Fetch a list of Emp permissions based on the provided filters, scopes, sorting and pagination (Stability Score: 0.1)' operationId: fetchAListOfEmpPermissionsBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore01 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: empPermissionId operator: '=' value: value - field: companyId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/personnel-permission-rules: post: summary: 'Create a new Emp permission rule' operationId: createANewEmpPermissionRule description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: employeeFieldId: type: string description: '' example: enim nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } operator: type: string description: '' example: '=' nullable: false enum: - '=' value: type: string description: '' example: sed nullable: false required: - employeeFieldId - operator - value get: summary: 'Fetch a list of Emp permission rules with pagination (Stability Score: 0.1)' operationId: fetchAListOfEmpPermissionRulesWithPaginationStabilityScore01 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/personnel-permission-rules/batch: post: summary: 'Batch create new Emp permission rules' operationId: batchCreateNewEmpPermissionRules description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: employeeFieldId: type: string description: '' example: rerum nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } operator: type: string description: '' example: '=' nullable: false enum: - '=' value: type: string description: '' example: dolorem nullable: false required: - employeeFieldId - operator - value patch: summary: 'Batch update Emp permission rules' operationId: batchUpdateEmpPermissionRules description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: employeeFieldId: type: string description: '' example: nemo nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } operator: type: string description: '' example: '=' nullable: false enum: - '=' value: type: string description: '' example: sapiente nullable: false delete: summary: 'Batch delete Emp permission rules by their IDs' operationId: batchDeleteEmpPermissionRulesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - non items: type: string '/api/v1/personnel-permission-rules/{empPermissionRuleId}': get: summary: 'Fetch a Emp permission rule by its ID' operationId: fetchAEmpPermissionRuleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmpPermissionRule [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmpPermissionRule [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Emp permission rule by its ID (Stability Score: 0.1)' operationId: updateAEmpPermissionRuleByItsIDStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmpPermissionRule [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmpPermissionRule [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: employeeFieldId: type: string description: '' example: illum nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } operator: type: string description: '' example: '=' nullable: false enum: - '=' value: type: string description: '' example: deserunt nullable: false delete: summary: 'Delete a Emp permission rule by its ID (Stability Score: 0.1)' operationId: deleteAEmpPermissionRuleByItsIDStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmpPermissionRule [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmpPermissionRule [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: empPermissionRuleId description: '' example: est required: true schema: type: string /api/v1/personnel-permission-rules/search: post: summary: 'Fetch a list of Emp permission rules based on the provided filters, scopes, sorting and pagination (Stability Score: 0.1)' operationId: fetchAListOfEmpPermissionRulesBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore01 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: empPermissionRuleId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/transactions: get: summary: 'Fetch a list of Transactions with pagination' operationId: fetchAListOfTransactionsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,employee,payCode' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,employee,payCode' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: ad nullable: false required: - companyId /api/v1/transactions/search: post: summary: 'Fetch a list of Transactions based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfTransactionsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,employee,payCode' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,employee,payCode' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: employeeId operator: '=' value: value - field: payCodeId operator: '=' value: value - field: salaryPeriod operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: externalId direction: asc nullable: false companyId: type: string description: '' example: cupiditate nullable: false required: - companyId '/api/v1/companies/{companyId}/ui-grids': get: summary: 'Fetch a list of Ui grids with pagination' operationId: fetchAListOfUiGridsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' parameters: - in: path name: companyId description: '' example: atque required: true schema: type: string '/api/v1/companies/{companyId}/ui-grids/{uiGridId}': get: summary: 'Fetch a Ui grid by its ID' operationId: fetchAUiGridByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'UiGrid [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'UiGrid [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Ui grid by its ID' operationId: updateAUiGridByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'UiGrid [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'UiGrid [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: gridTitle: type: string description: '' example: quis nullable: false gridDescription: type: string description: '' example: tempore nullable: false gridSettings: type: object description: '' example: null nullable: false properties: gridFor: type: string description: '' example: dolores nullable: true companyId: type: string description: '' example: molestiae nullable: true delete: summary: 'Delete a Ui grid by its ID' operationId: deleteAUiGridByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'views,company,actors' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'UiGrid [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'UiGrid [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: companyId description: '' example: earum required: true schema: type: string - in: path name: uiGridId description: '' example: odio required: true schema: type: string '/api/v1/companies/{companyId}/employees': get: summary: 'Fetch a list of Employees with pagination' operationId: fetchAListOfEmployeesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' post: summary: 'Create a new Employee' operationId: createANewEmployee description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' parameters: - in: path name: companyId description: '' example: soluta required: true schema: type: string '/api/v1/companies/{companyId}/employees/search': post: summary: 'Fetch a list of Employees based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfEmployeesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: personId operator: '=' value: value - field: isDraft operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false scopes: type: 'string[]' description: 'Scopes to apply' example: - name: fieldNameFilter parameters: [] nullable: false parameters: - in: path name: companyId description: '' example: dolorum required: true schema: type: string '/api/v1/companies/{companyId}/field-changes/search-custom': post: summary: 'Fetch a list of App\ http\ resources\ api\ v1\ company field change resources based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfAppHttpResourcesApiV1CompanyFieldChangeResourcesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: fieldName operator: '=' value: value - field: changeId operator: '=' value: value - field: effectiveDate operator: '=' value: value - field: status operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false parameters: - in: path name: companyId description: '' example: praesentium required: true schema: type: string /api/v1/field-changes/search: post: summary: 'Fetch a list of Employee field changes based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfEmployeeFieldChangesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: effectiveDate operator: '=' value: value - field: employeeId operator: '=' value: value - field: companyId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false '/api/v1/employees/{employeeId}/field-changes/search-custom': post: summary: 'Fetch a list of App\ http\ resources\ api\ v1\ employee field change resources based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfAppHttpResourcesApiV1EmployeeFieldChangeResourcesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: fieldName operator: '=' value: value - field: changeId operator: '=' value: value - field: effectiveDate operator: '=' value: value - field: status operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false parameters: - in: path name: employeeId description: '' example: sapiente required: true schema: type: string /api/v1/field-mappings/search: post: summary: 'Fetch a list of Employee field maps based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)' operationId: fetchAListOfEmployeeFieldMapsBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 nullable: false - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 nullable: false - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true nullable: false - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,externalEmployeeField,employeeField,externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,externalEmployeeField,employeeField,externalIntegration,organization' nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: employeeFieldId operator: '=' value: value - field: externalIntegrationId operator: '=' value: value - field: organizationId operator: '=' value: value nullable: false sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc nullable: false /api/v1/authenticate: get: summary: 'Authenticate (Stability Score: 0.1)' operationId: authenticateStabilityScore01 description: 'This endpoint lets you authenticate.' parameters: [] responses: 422: description: '' content: application/json: schema: type: object example: message: 'Company molestiae does not exist. (and 1 more error)' errors: companyId: - 'Company molestiae does not exist.' roleId: - 'The selected role id is invalid.' status: 422 properties: message: type: string example: 'Company molestiae does not exist. (and 1 more error)' errors: type: object properties: companyId: type: array example: - 'Company molestiae does not exist.' items: type: string roleId: type: array example: - 'The selected role id is invalid.' items: type: string status: type: integer example: 422 tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: url: type: string description: '' example: 'http://www.ebert.biz/enim-et-quia-dolores-ratione-modi-rerum.html' nullable: true companyId: type: string description: '' example: molestiae nullable: true roleId: type: integer description: 'The id of an existing record in the roles table.' example: 7 nullable: true access_token: type: string description: '' example: molestias nullable: false sensitive: type: boolean description: '' example: false nullable: false useLatest: type: boolean description: '' example: false nullable: false security: [] /api/v1/logout: get: summary: Logout operationId: logout description: 'This endpoint lets you logout.' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' /api/v1/user: get: summary: 'User (Stability Score: 0.1)' operationId: userStabilityScore01 description: 'This endpoint lets you get the authenticated user.' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' patch: summary: '' operationId: patchApiV1User description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' /api/v1/user/roles: get: summary: 'Receive the roles that the authenticated user has access to. (Stability Score: 0.1)' operationId: receiveTheRolesThatTheAuthenticatedUserHasAccessToStabilityScore01 description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' '/api/v1/function-entities/{functionEntityId}/duplicate': post: summary: 'Duplicate a function entity.' operationId: duplicateAFunctionEntity description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: functionEntityId description: '' example: accusantium required: true schema: type: string '/api/v1/grid-views/{gridViewId}/duplicate': post: summary: 'Duplicate a grid view.' operationId: duplicateAGridView description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'grid,actors' nullable: false responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: gridViewId description: '' example: vero required: true schema: type: string '/api/v1/salary-warnings/{salaryWarningId}/confirm': post: summary: 'Confirm a salary rule warning (Stability Score: 0.1)' operationId: confirmASalaryRuleWarningStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' nullable: false responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: salaryWarningId description: '' example: natus required: true schema: type: string '/api/v1/salary-warnings/{salaryWarningId}/unconfirm': post: summary: 'Remove confirmation from a salary rule warning (Stability Score: 0.1)' operationId: removeConfirmationFromASalaryRuleWarningStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' nullable: false responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: salaryWarningId description: '' example: magnam required: true schema: type: string /api/v1/notifications/read-all: post: summary: 'Mark all notifications as read' operationId: markAllNotificationsAsRead description: 'This endpoint lets you mark all notifications as read.' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Custom Endpoints' '/api/v1/notifications/{notificationId}/read': post: summary: 'Mark a notification as read by its ID (Stability Score: 0.1)' operationId: markANotificationAsReadByItsIDStabilityScore01 description: 'This endpoint lets you mark a notification as read.' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: notificationId description: '' example: sequi required: true schema: type: string '/api/v1/notifications/{notificationId}/unread': post: summary: 'Mark a notification as not read by its ID (Stability Score: 0.1)' operationId: markANotificationAsNotReadByItsIDStabilityScore01 description: 'This endpoint lets you mark a notification as not read.' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: notificationId description: '' example: dolore required: true schema: type: string /api/v1/execute-salary-rules: post: summary: 'Evaluate salary rules for a given period (Stability Score: 0.1)' operationId: evaluateSalaryRulesForAGivenPeriodStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Custom Endpoints' '/api/v1/pay-code-mappings/{mappingId}/duplicate': post: summary: 'Duplicate a payCode mapping' operationId: duplicateAPayCodeMapping description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: ut nullable: false required: - companyId parameters: - in: path name: mappingId description: '' example: iusto required: true schema: type: string /api/v1/transactions/statistics: post: summary: 'Transaction Statistics' operationId: transactionStatistics description: 'This endpoint lets you get transaction statistics.' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: includeChildren: type: boolean description: '' example: true nullable: false organizationId: type: string description: 'This field is required when companyId is not present.' example: et nullable: false companyId: type: string description: 'This field is required when organizationId is not present.' example: molestias nullable: false '/api/v1/personal-card-profiles/{personalCardProfileId}/duplicate': post: summary: 'Duplicate a personal card profile' operationId: duplicateAPersonalCardProfile description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: odit nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } description: type: string description: '' example: 'Fugiat voluptatem similique perspiciatis.' nullable: false isGlobal: type: string description: '' example: velit nullable: false companyId: type: string description: '' example: non nullable: true required: - isGlobal parameters: - in: path name: personalCardProfileId description: '' example: rerum required: true schema: type: string '/api/v1/team-positions/{teamPositionId}/duplicate': post: summary: 'Duplicate a Team Position' operationId: duplicateATeamPosition description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: teamPositionId description: '' example: neque required: true schema: type: string '/api/v1/companies/{companyId}/duplicate': post: summary: 'Duplicate a company' operationId: duplicateACompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: parentCompanyId: type: string description: '' example: labore nullable: false required: - parentCompanyId parameters: - in: path name: companyId description: '' example: unde required: true schema: type: string '/api/v1/companies/{companyId}/field-changes/unique-effective-dates': get: summary: 'Get all unique effective dates for a company.' operationId: getAllUniqueEffectiveDatesForACompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' parameters: - in: path name: companyId description: '' example: animi required: true schema: type: string '/api/v1/companies/{companyId}/field-changes/approve-field-change': post: summary: 'Approve a field change for a particular company.' operationId: approveAFieldChangeForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: et nullable: false recordId: type: string description: '' example: provident nullable: false required: - changeId - recordId parameters: - in: path name: companyId description: '' example: cupiditate required: true schema: type: string '/api/v1/companies/{companyId}/field-changes/approve-field-change/batch': post: summary: 'Approve multiple field changes for a particular company.' operationId: approveMultipleFieldChangesForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: doloribus nullable: false recordId: type: string description: '' example: delectus nullable: false required: - changeId - recordId parameters: - in: path name: companyId description: '' example: ut required: true schema: type: string '/api/v1/companies/{companyId}/field-changes/deny-field-change': post: summary: 'Deny a field change for a particular company.' operationId: denyAFieldChangeForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: ut nullable: false recordId: type: string description: '' example: ipsum nullable: false required: - changeId - recordId parameters: - in: path name: companyId description: '' example: sequi required: true schema: type: string '/api/v1/companies/{companyId}/field-changes/deny-field-change/batch': post: summary: 'Deny multiple field changes for a particular company.' operationId: denyMultipleFieldChangesForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: unde nullable: false recordId: type: string description: '' example: eos nullable: false required: - changeId - recordId parameters: - in: path name: companyId description: '' example: fuga required: true schema: type: string /api/v1/storage-structure: post: summary: 'Create a new storage structure' operationId: createANewStorageStructure description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: directoryName: type: string description: '' example: enim nullable: false directoryParentId: type: string description: '' example: iste nullable: true required: - directoryName get: summary: 'Fetch a list of storage structures with pagination' operationId: fetchAListOfStorageStructuresWithPagination description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' '/api/v1/storage-structure/{storageStructureId}': get: summary: 'Fetch a storage structure by its ID' operationId: fetchAStorageStructureByItsID description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' patch: summary: 'Update a storage structure by its ID' operationId: updateAStorageStructureByItsID description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: directoryName: type: string description: 'This field is required when directoryParentId is not present.' example: laborum nullable: false directoryParentId: type: string description: '' example: est nullable: true delete: summary: 'Delete a storage structure by its ID' operationId: deleteAStorageStructureByItsID description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: storageStructureId description: '' example: consequatur required: true schema: type: string /api/v1/field-changes/approve/batch: post: summary: 'Approve multiple field changes for a particular employee.' operationId: approveMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: libero nullable: false recordId: type: string description: '' example: voluptatem nullable: false required: - changeId - recordId /api/v1/field-changes/deny/batch: post: summary: 'Deny multiple field changes for a particular employee.' operationId: denyMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: sed nullable: false recordId: type: string description: '' example: iusto nullable: false required: - changeId - recordId /api/v1/field-changes/revert/batch: post: summary: 'Revert multiple field changes for a particular employee.' operationId: revertMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: autem nullable: false recordId: type: string description: '' example: quia nullable: false required: - changeId - recordId /api/v1/field-changes/revert: post: summary: 'Revert field change for a particular employee.' operationId: revertFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: et nullable: false recordId: type: string description: '' example: cum nullable: false required: - changeId - recordId /api/v1/field-changes/revert/pay-code/batch: post: summary: 'Revert multiple pay code field changes for a particular employee.' operationId: revertMultiplePayCodeFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: illo nullable: false recordId: type: string description: '' example: eveniet nullable: false required: - changeId - recordId /api/v1/field-changes/revert/pay-code: post: summary: 'Revert pay code field change for a particular employee.' operationId: revertPayCodeFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: nam nullable: false recordId: type: string description: '' example: qui nullable: false required: - changeId - recordId /api/v1/field-changes/revert/employment/batch: post: summary: 'Revert multiple employment field changes for a particular employee.' operationId: revertMultipleEmploymentFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: itaque nullable: false recordId: type: string description: '' example: eveniet nullable: false required: - changeId - recordId /api/v1/field-changes/revert/employment: post: summary: 'Revert employment field change for a particular employee.' operationId: revertEmploymentFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: natus nullable: false recordId: type: string description: '' example: fugit nullable: false required: - changeId - recordId '/api/v1/employees/{employeeId}/employee-relatives': post: summary: 'Create a new relative' operationId: createANewRelative description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: firstName: type: string description: '' example: eos nullable: false lastName: type: string description: '' example: quis nullable: false emailAddress: type: string description: 'Must be a valid email address.' example: genoveva.pouros@example.net nullable: false telephone: type: string description: 'Must match the regex /^[\d\s\-\+]{5,}$/.' example: 'd{5,}' nullable: false mobilePhone: type: string description: 'Must match the regex /^[\d\s\-\+]{5,}$/.' example: 'd{5,}' nullable: false relationship: type: string description: '' example: voluptates nullable: false comment: type: string description: '' example: voluptate nullable: false required: - firstName - lastName - relationship parameters: - in: path name: employeeId description: '' example: culpa required: true schema: type: string '/api/v1/employees/{employeeId}/employee-relatives/{relativeId}/field-changes': get: summary: 'Get changes for a particular relative.' operationId: getChangesForAParticularRelative description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' parameters: - in: path name: employeeId description: '' example: ut required: true schema: type: string - in: path name: relativeId description: '' example: sed required: true schema: type: string '/api/v1/employees/{employeeId}/employee-relatives/{relativeId}/approve-field-change': post: summary: 'Approve a field change for a particular employee.' operationId: approveAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: dolores nullable: false recordId: type: string description: '' example: quia nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: ipsam required: true schema: type: string - in: path name: relativeId description: '' example: aut required: true schema: type: string '/api/v1/employees/{employeeId}/employee-relatives/{relativeId}/approve-field-change/batch': post: summary: 'Approve multiple field changes for a particular employee.' operationId: approveMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: consequuntur nullable: false recordId: type: string description: '' example: officiis nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: ipsam required: true schema: type: string - in: path name: relativeId description: '' example: quaerat required: true schema: type: string '/api/v1/employees/{employeeId}/employee-relatives/{relativeId}/deny-field-change': post: summary: 'Deny a field change for a particular employee.' operationId: denyAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: ratione nullable: false recordId: type: string description: '' example: aspernatur nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: aut required: true schema: type: string - in: path name: relativeId description: '' example: ut required: true schema: type: string '/api/v1/employees/{employeeId}/employee-relatives/{relativeId}/deny-field-change/batch': post: summary: 'Deny multiple field changes for a particular employee.' operationId: denyMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: deserunt nullable: false recordId: type: string description: '' example: sunt nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: sequi required: true schema: type: string - in: path name: relativeId description: '' example: ipsam required: true schema: type: string '/api/v1/employees/{employeeId}/future-changes': get: summary: 'List all changes for a particular employee.' operationId: listAllChangesForAParticularEmployee description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' parameters: - in: path name: employeeId description: '' example: sit required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/unique-effective-dates': get: summary: 'Get all unique effective dates for an employee.' operationId: getAllUniqueEffectiveDatesForAnEmployee description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' parameters: - in: path name: employeeId description: '' example: ratione required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes': post: summary: 'Create a new employee change' operationId: createANewEmployeeChange description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 0 nullable: false changeId: type: string description: '' example: quidem nullable: false changeType: type: string description: '' example: delete nullable: false enum: - delete fieldName: type: string description: '' example: cupiditate nullable: false newValue: type: string description: 'This field is required unless changeType is in delete.' example: null nullable: false oldValue: type: string description: '' example: qui nullable: true comment: type: string description: '' example: quia nullable: false changedBy: type: string description: '' example: null nullable: false changedDate: type: string description: '' example: null nullable: false approved: type: string description: '' example: null nullable: false employeeId: type: string description: '' example: null nullable: false status: type: string description: '' example: null nullable: false required: - fieldName parameters: - in: path name: employeeId description: '' example: facilis required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/batch': post: summary: 'Create multiple employee changes' operationId: createMultipleEmployeeChanges description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 0 nullable: false changeId: type: string description: '' example: voluptatibus nullable: false changeType: type: string description: '' example: delete nullable: false enum: - delete fieldName: type: string description: '' example: illum nullable: false newValue: type: string description: 'This field is required unless changeType is in delete.' example: null nullable: false oldValue: type: string description: '' example: voluptatem nullable: true comment: type: string description: '' example: quod nullable: false changedBy: type: string description: '' example: null nullable: false changedDate: type: string description: '' example: null nullable: false approved: type: string description: '' example: null nullable: false employeeId: type: string description: '' example: null nullable: false status: type: string description: '' example: null nullable: false required: - fieldName parameters: - in: path name: employeeId description: '' example: sed required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/employment': get: summary: 'List all changes for a particular employee.' operationId: listAllChangesForAParticularEmployee description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' post: summary: 'Create a new change request for a particular employee.' operationId: createANewChangeRequestForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 1 nullable: false changeId: type: string description: '' example: quisquam nullable: false changeType: type: string description: '' example: delete nullable: false enum: - delete fieldName: type: string description: '' example: assumenda nullable: false newValue: type: string description: 'This field is required unless changeType is in delete.' example: null nullable: false oldValue: type: string description: '' example: in nullable: true comment: type: string description: '' example: necessitatibus nullable: false changedBy: type: string description: '' example: null nullable: false changedDate: type: string description: '' example: null nullable: false approved: type: string description: '' example: null nullable: false employeeId: type: string description: '' example: null nullable: false status: type: string description: '' example: null nullable: false required: - fieldName parameters: - in: path name: employeeId description: '' example: sint required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/employment/batch': post: summary: 'Create multiple change requests for a particular employee.' operationId: createMultipleChangeRequestsForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 1 nullable: false changeId: type: string description: '' example: consequatur nullable: false changeType: type: string description: '' example: delete nullable: false enum: - delete fieldName: type: string description: '' example: itaque nullable: false newValue: type: string description: 'This field is required unless changeType is in delete.' example: null nullable: false oldValue: type: string description: '' example: qui nullable: true comment: type: string description: '' example: asperiores nullable: false changedBy: type: string description: '' example: null nullable: false changedDate: type: string description: '' example: null nullable: false approved: type: string description: '' example: null nullable: false employeeId: type: string description: '' example: null nullable: false status: type: string description: '' example: null nullable: false required: - fieldName parameters: - in: path name: employeeId description: '' example: est required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/employment/approve-field-change': post: summary: 'Approve a field change for a particular employee.' operationId: approveAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: occaecati nullable: false recordId: type: string description: '' example: accusantium nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: ipsam required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/employment/approve-field-change/batch': post: summary: 'Approve multiple field changes for a particular employee.' operationId: approveMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: explicabo nullable: false recordId: type: string description: '' example: illum nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: sequi required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/employment/deny-field-change': post: summary: 'Deny a field change for a particular employee.' operationId: denyAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: corporis nullable: false recordId: type: string description: '' example: aspernatur nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: suscipit required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/employment/deny-field-change/batch': post: summary: 'Deny multiple field changes for a particular employee.' operationId: denyMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: necessitatibus nullable: false recordId: type: string description: '' example: porro nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: nulla required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/pay-code': get: summary: 'Get all pay code changes.' operationId: getAllPayCodeChanges description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' post: summary: 'Create a new pay code change.' operationId: createANewPayCodeChange description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 0 nullable: false changeId: type: string description: '' example: sit nullable: false changeType: type: string description: '' example: delete nullable: false enum: - delete fieldName: type: string description: '' example: aut nullable: false newValue: type: object description: 'This field is required unless changeType is in delete.' example: null nullable: false properties: { } oldValue: type: object description: '' example: null nullable: true properties: { } comment: type: string description: '' example: et nullable: false changedBy: type: string description: '' example: null nullable: false changedDate: type: string description: '' example: null nullable: false approved: type: string description: '' example: null nullable: false employeeId: type: string description: '' example: null nullable: false status: type: string description: '' example: null nullable: false required: - fieldName parameters: - in: path name: employeeId description: '' example: ipsam required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/pay-code/batch': post: summary: 'Create multiple pay code changes.' operationId: createMultiplePayCodeChanges description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 1 nullable: false changeId: type: string description: '' example: sunt nullable: false changeType: type: string description: '' example: delete nullable: false enum: - delete fieldName: type: string description: '' example: et nullable: false newValue: type: object description: 'This field is required unless changeType is in delete.' example: null nullable: false properties: { } oldValue: type: object description: '' example: null nullable: true properties: { } comment: type: string description: '' example: distinctio nullable: false changedBy: type: string description: '' example: null nullable: false changedDate: type: string description: '' example: null nullable: false approved: type: string description: '' example: null nullable: false employeeId: type: string description: '' example: null nullable: false status: type: string description: '' example: null nullable: false required: - fieldName parameters: - in: path name: employeeId description: '' example: sint required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/pay-code/approve-field-change': post: summary: 'Approve a field change for a particular employee.' operationId: approveAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: molestiae nullable: false recordId: type: string description: '' example: ut nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: nam required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/pay-code/approve-field-change/batch': post: summary: 'Approve multiple field changes for a particular employee.' operationId: approveMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: dolores nullable: false recordId: type: string description: '' example: beatae nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: eveniet required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/pay-code/deny-field-change': post: summary: 'Deny a field change for a particular employee.' operationId: denyAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: officiis nullable: false recordId: type: string description: '' example: incidunt nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: fugiat required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/pay-code/deny-field-change/batch': post: summary: 'Deny multiple field changes for a particular employee.' operationId: denyMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: sit nullable: false recordId: type: string description: '' example: minus nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: alias required: true schema: type: string '/api/v1/employees/{employeeId}/approve-field-change': post: summary: 'Approve a field change for a particular employee.' operationId: approveAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: accusamus nullable: false recordId: type: string description: '' example: quae nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: pariatur required: true schema: type: string '/api/v1/employees/{employeeId}/approve-field-change/batch': post: summary: 'Approve multiple field changes for a particular employee.' operationId: approveMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: autem nullable: false recordId: type: string description: '' example: facere nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: et required: true schema: type: string '/api/v1/employees/{employeeId}/deny-field-change': post: summary: 'Deny a field change for a particular employee.' operationId: denyAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: consequatur nullable: false recordId: type: string description: '' example: explicabo nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: molestiae required: true schema: type: string '/api/v1/employees/{employeeId}/deny-field-change/batch': post: summary: 'Deny multiple field changes for a particular employee.' operationId: denyMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: nisi nullable: false recordId: type: string description: '' example: qui nullable: false required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: voluptates required: true schema: type: string /api/v1/field-mappings: post: summary: 'Create a new employee field mapping.' operationId: createANewEmployeeFieldMapping description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalEmployeeFieldId: type: string description: '' example: nostrum nullable: false employeeFieldId: type: string description: '' example: quod nullable: false companyId: type: string description: '' example: null nullable: true externalIntegrationId: type: string description: '' example: expedita nullable: true organizationId: type: string description: '' example: null nullable: true required: - externalEmployeeFieldId - employeeFieldId /api/v1/field-mappings/batch: post: summary: 'Create multiple employee field mappings.' operationId: createMultipleEmployeeFieldMappings description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalEmployeeFieldId: type: string description: '' example: eveniet nullable: false employeeFieldId: type: string description: '' example: sapiente nullable: false companyId: type: string description: '' example: null nullable: true externalIntegrationId: type: string description: '' example: sit nullable: true organizationId: type: string description: '' example: null nullable: true required: - externalEmployeeFieldId - employeeFieldId '/api/v1/field-mappings/{mappingId}': patch: summary: 'Update an employee field mapping.' operationId: updateAnEmployeeFieldMapping description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: externalEmployeeFieldId: type: string description: '' example: non nullable: false employeeFieldId: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: true externalIntegrationId: type: string description: '' example: ut nullable: true organizationId: type: string description: '' example: null nullable: true delete: summary: 'Delete an employee field mapping.' operationId: deleteAnEmployeeFieldMapping description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: mappingId description: '' example: doloribus required: true schema: type: string '/api/v1/external-integration/{integrationId}/employee-fields': get: summary: 'Get fields for a particular integration.' operationId: getFieldsForAParticularIntegration description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: true nullable: false isMandatory: type: boolean description: '' example: false nullable: false salarySensitive: type: boolean description: '' example: false nullable: false sensitive: type: boolean description: '' example: false nullable: false allowNewValue: type: boolean description: '' example: true nullable: false observe: type: boolean description: '' example: false nullable: false importExcluded: type: boolean description: '' example: false nullable: false manualInput: type: boolean description: '' example: true nullable: false fieldType: type: string description: '' example: select nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: decimal nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 7095.99 nullable: false minInput: type: number description: '' example: 6.1 nullable: false parameters: - in: path name: integrationId description: '' example: ut required: true schema: type: string '/api/v1/external-integration/{integrationId}/employee-fields/{fieldId}': put: summary: 'Customize an existing global employee field for a particular integration.' operationId: customizeAnExistingGlobalEmployeeFieldForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: false nullable: false isMandatory: type: boolean description: '' example: true nullable: false salarySensitive: type: boolean description: '' example: true nullable: false sensitive: type: boolean description: '' example: true nullable: false allowNewValue: type: boolean description: '' example: true nullable: false observe: type: boolean description: '' example: true nullable: false importExcluded: type: boolean description: '' example: false nullable: false manualInput: type: boolean description: '' example: false nullable: false fieldType: type: string description: '' example: password nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: decimal nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 1.82496819 nullable: false minInput: type: number description: '' example: 6003.176798309 nullable: false get: summary: 'Get an extended employee field for a particular integration.' operationId: getAnExtendedEmployeeFieldForAParticularIntegration description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: true nullable: false isMandatory: type: boolean description: '' example: true nullable: false salarySensitive: type: boolean description: '' example: false nullable: false sensitive: type: boolean description: '' example: true nullable: false allowNewValue: type: boolean description: '' example: false nullable: false observe: type: boolean description: '' example: false nullable: false importExcluded: type: boolean description: '' example: true nullable: false manualInput: type: boolean description: '' example: true nullable: false fieldType: type: string description: '' example: email nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: number nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 152135863.68 nullable: false minInput: type: number description: '' example: 2.92601 nullable: false delete: summary: 'Revert an extended employee field for a particular integration.' operationId: revertAnExtendedEmployeeFieldForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: false nullable: false isMandatory: type: boolean description: '' example: true nullable: false salarySensitive: type: boolean description: '' example: false nullable: false sensitive: type: boolean description: '' example: true nullable: false allowNewValue: type: boolean description: '' example: true nullable: false observe: type: boolean description: '' example: false nullable: false importExcluded: type: boolean description: '' example: false nullable: false manualInput: type: boolean description: '' example: false nullable: false fieldType: type: string description: '' example: select nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: number nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 1324.4 nullable: false minInput: type: number description: '' example: 63250.8812539 nullable: false parameters: - in: path name: integrationId description: '' example: pariatur required: true schema: type: string - in: path name: fieldId description: '' example: facilis required: true schema: type: string '/api/v1/organization/{organizationId}/employee-fields': get: summary: 'Get fields for a particular organization.' operationId: getFieldsForAParticularOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: false nullable: false isMandatory: type: boolean description: '' example: false nullable: false salarySensitive: type: boolean description: '' example: false nullable: false sensitive: type: boolean description: '' example: false nullable: false allowNewValue: type: boolean description: '' example: false nullable: false observe: type: boolean description: '' example: false nullable: false importExcluded: type: boolean description: '' example: true nullable: false manualInput: type: boolean description: '' example: true nullable: false fieldType: type: string description: '' example: date nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: boolean nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 5332.328655 nullable: false minInput: type: number description: '' example: 0.894885 nullable: false parameters: - in: path name: organizationId description: '' example: qui required: true schema: type: string '/api/v1/organization/{organizationId}/employee-fields/{fieldId}': put: summary: 'Customize an existing global employee field for a particular organization.' operationId: customizeAnExistingGlobalEmployeeFieldForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: true nullable: false isMandatory: type: boolean description: '' example: true nullable: false salarySensitive: type: boolean description: '' example: false nullable: false sensitive: type: boolean description: '' example: true nullable: false allowNewValue: type: boolean description: '' example: true nullable: false observe: type: boolean description: '' example: true nullable: false importExcluded: type: boolean description: '' example: true nullable: false manualInput: type: boolean description: '' example: false nullable: false fieldType: type: string description: '' example: select nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: number nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 319582.6881 nullable: false minInput: type: number description: '' example: 12329039.3 nullable: false get: summary: 'Show an extended employee field for a particular organization.' operationId: showAnExtendedEmployeeFieldForAParticularOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: true nullable: false isMandatory: type: boolean description: '' example: false nullable: false salarySensitive: type: boolean description: '' example: true nullable: false sensitive: type: boolean description: '' example: true nullable: false allowNewValue: type: boolean description: '' example: true nullable: false observe: type: boolean description: '' example: true nullable: false importExcluded: type: boolean description: '' example: true nullable: false manualInput: type: boolean description: '' example: true nullable: false fieldType: type: string description: '' example: password nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: boolean nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 66979.9 nullable: false minInput: type: number description: '' example: 1.93536709 nullable: false delete: summary: 'Revert an extended employee field for a particular organization.' operationId: revertAnExtendedEmployeeFieldForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: false nullable: false isMandatory: type: boolean description: '' example: true nullable: false salarySensitive: type: boolean description: '' example: true nullable: false sensitive: type: boolean description: '' example: false nullable: false allowNewValue: type: boolean description: '' example: true nullable: false observe: type: boolean description: '' example: true nullable: false importExcluded: type: boolean description: '' example: true nullable: false manualInput: type: boolean description: '' example: false nullable: false fieldType: type: string description: '' example: radio nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: boolean nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 35746495.069463 nullable: false minInput: type: number description: '' example: 269060.9 nullable: false parameters: - in: path name: organizationId description: '' example: ab required: true schema: type: string - in: path name: fieldId description: '' example: veritatis required: true schema: type: string '/api/v1/company/{companyId}/employee-fields/{fieldId}': put: summary: 'Customize an existing global employee field for a particular company.' operationId: customizeAnExistingGlobalEmployeeFieldForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: true nullable: false isMandatory: type: boolean description: '' example: true nullable: false salarySensitive: type: boolean description: '' example: false nullable: false sensitive: type: boolean description: '' example: true nullable: false allowNewValue: type: boolean description: '' example: true nullable: false observe: type: boolean description: '' example: true nullable: false importExcluded: type: boolean description: '' example: false nullable: false manualInput: type: boolean description: '' example: false nullable: false fieldType: type: string description: '' example: password nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: decimal nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 740.39596 nullable: false minInput: type: number description: '' example: 2.90087906 nullable: false get: summary: 'Get an extended employee field for a particular company.' operationId: getAnExtendedEmployeeFieldForAParticularCompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: true nullable: false isMandatory: type: boolean description: '' example: true nullable: false salarySensitive: type: boolean description: '' example: true nullable: false sensitive: type: boolean description: '' example: false nullable: false allowNewValue: type: boolean description: '' example: true nullable: false observe: type: boolean description: '' example: false nullable: false importExcluded: type: boolean description: '' example: false nullable: false manualInput: type: boolean description: '' example: true nullable: false fieldType: type: string description: '' example: email nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: decimal nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 284.36900544 nullable: false minInput: type: number description: '' example: 428.3 nullable: false patch: summary: 'Update an employee field for a particular company.' operationId: updateAnEmployeeFieldForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: true nullable: false isMandatory: type: boolean description: '' example: false nullable: true salarySensitive: type: boolean description: '' example: false nullable: true sensitive: type: boolean description: '' example: true nullable: true allowNewValue: type: boolean description: '' example: true nullable: true observe: type: boolean description: '' example: true nullable: true importExcluded: type: boolean description: '' example: false nullable: true manualInput: type: boolean description: '' example: true nullable: true fieldName: type: string description: '' example: null nullable: false fieldType: type: string description: '' example: number nullable: true enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: string nullable: true enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 554.0 nullable: false minInput: type: number description: '' example: 459.487200469 nullable: false maxLength: type: number description: '' example: 93259.59359 nullable: false minLength: type: number description: '' example: 353463724.3 nullable: false combinedFieldIds: type: array description: '' example: - sint items: type: string required: - combinedFieldIds delete: summary: 'Delete an employee field for a particular company.' operationId: deleteAnEmployeeFieldForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: companyId description: '' example: cupiditate required: true schema: type: string - in: path name: fieldId description: '' example: quo required: true schema: type: string '/api/v1/company/{companyId}/employee-fields/{fieldId}/revert': post: summary: 'Revert an extended employee field for a particular company.' operationId: revertAnExtendedEmployeeFieldForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: true nullable: false isMandatory: type: boolean description: '' example: false nullable: false salarySensitive: type: boolean description: '' example: true nullable: false sensitive: type: boolean description: '' example: true nullable: false allowNewValue: type: boolean description: '' example: true nullable: false observe: type: boolean description: '' example: false nullable: false importExcluded: type: boolean description: '' example: true nullable: false manualInput: type: boolean description: '' example: false nullable: false fieldType: type: string description: '' example: number nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: date nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 250222434.87367 nullable: false minInput: type: number description: '' example: 4.4 nullable: false parameters: - in: path name: companyId description: '' example: minus required: true schema: type: string - in: path name: fieldId description: '' example: accusamus required: true schema: type: string '/api/v1/company/{companyId}/employee-fields/revert-all': post: summary: 'Revert extended employee fields and custom fields for a particular company.' operationId: revertExtendedEmployeeFieldsAndCustomFieldsForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: false nullable: false isMandatory: type: boolean description: '' example: true nullable: false salarySensitive: type: boolean description: '' example: true nullable: false sensitive: type: boolean description: '' example: true nullable: false allowNewValue: type: boolean description: '' example: false nullable: false observe: type: boolean description: '' example: true nullable: false importExcluded: type: boolean description: '' example: false nullable: false manualInput: type: boolean description: '' example: true nullable: false fieldType: type: string description: '' example: textarea nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: date nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 0.1 nullable: false minInput: type: number description: '' example: 3752067.7897 nullable: false parameters: - in: path name: companyId description: '' example: minima required: true schema: type: string '/api/v1/company/{companyId}/employee-fields': get: summary: 'Get employee fields for a particular company.' operationId: getEmployeeFieldsForAParticularCompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: false nullable: false isMandatory: type: boolean description: '' example: true nullable: false salarySensitive: type: boolean description: '' example: true nullable: false sensitive: type: boolean description: '' example: false nullable: false allowNewValue: type: boolean description: '' example: false nullable: false observe: type: boolean description: '' example: true nullable: false importExcluded: type: boolean description: '' example: false nullable: false manualInput: type: boolean description: '' example: false nullable: false fieldType: type: string description: '' example: checkbox nullable: false enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: boolean nullable: false enum: - string - number - decimal - date - boolean maxInput: type: number description: '' example: 23.576897644 nullable: false minInput: type: number description: '' example: 70.65 nullable: false post: summary: 'Get employee fields for a particular company.' operationId: getEmployeeFieldsForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } isShow: type: boolean description: '' example: false nullable: false isMandatory: type: boolean description: '' example: false nullable: true salarySensitive: type: boolean description: '' example: false nullable: true sensitive: type: boolean description: '' example: false nullable: true allowNewValue: type: boolean description: '' example: false nullable: true observe: type: boolean description: '' example: true nullable: true importExcluded: type: boolean description: '' example: false nullable: true manualInput: type: boolean description: '' example: true nullable: true fieldType: type: string description: '' example: checkbox nullable: true enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: date nullable: true enum: - string - number - decimal - date - boolean maxInput: type: number description: 'This field is required when dataType is string.' example: 548165.41 nullable: false minInput: type: number description: 'This field is required when dataType is string.' example: 84.0 nullable: false maxLength: type: number description: '' example: 257.10683 nullable: false minLength: type: number description: '' example: 20.64036 nullable: false fieldName: type: string description: 'Must not be greater than 255 characters.' example: tdkedobytsh nullable: false combinedFieldIds: type: array description: '' example: - nihil items: type: string required: - isShow - fieldName - combinedFieldIds parameters: - in: path name: companyId description: '' example: fugit required: true schema: type: string /api/v1/field-groups: post: summary: 'Create a global field group' operationId: createAGlobalFieldGroup description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupName: type: string description: '' example: minus nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false required: - groupName get: summary: 'Fetch all global field groups' operationId: fetchAllGlobalFieldGroups description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' '/api/v1/field-groups/{groupId}': get: summary: 'Fetch a global field group by its ID' operationId: fetchAGlobalFieldGroupByItsID description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' patch: summary: 'Update a global field group' operationId: updateAGlobalFieldGroup description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: eos nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false delete: summary: 'Delete a global field group' operationId: deleteAGlobalFieldGroup description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: groupId description: '' example: omnis required: true schema: type: string '/api/v1/field-groups/{employeeFieldId}/add-field': post: summary: 'Add a field to a global field group' operationId: addAFieldToAGlobalFieldGroup description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: voluptas nullable: false required: - groupId parameters: - in: path name: employeeFieldId description: '' example: earum required: true schema: type: string '/api/v1/field-groups/{employeeFieldId}/move-field': patch: summary: 'Move a field from one global field group to another' operationId: moveAFieldFromOneGlobalFieldGroupToAnother description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: oldGroupId: type: string description: '' example: impedit nullable: false newGroupId: type: string description: '' example: mollitia nullable: false required: - oldGroupId - newGroupId parameters: - in: path name: employeeFieldId description: '' example: perspiciatis required: true schema: type: string '/api/v1/field-groups/{employeeFieldId}/remove-field': post: summary: 'Remove a field from a global field group' operationId: removeAFieldFromAGlobalFieldGroup description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: quaerat nullable: false required: - groupId parameters: - in: path name: employeeFieldId description: '' example: velit required: true schema: type: string '/api/v1/external-integration/{integrationId}/field-groups': get: summary: 'Get fields groups for a particular integration.' operationId: getFieldsGroupsForAParticularIntegration description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: et nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false parameters: - in: path name: integrationId description: '' example: sed required: true schema: type: string '/api/v1/external-integration/{integrationId}/field-groups/{groupId}': put: summary: 'Customize an existing global field group for a particular integration.' operationId: customizeAnExistingGlobalFieldGroupForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: optio nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false get: summary: 'Get a particular field group for a particular integration.' operationId: getAParticularFieldGroupForAParticularIntegration description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: omnis nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false delete: summary: 'Revert a customized global field group for a particular integration.' operationId: revertACustomizedGlobalFieldGroupForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: recusandae nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false parameters: - in: path name: integrationId description: '' example: aliquam required: true schema: type: string - in: path name: groupId description: '' example: et required: true schema: type: string '/api/v1/external-integration/{integrationId}/field-groups/{employeeFieldId}/add-field': post: summary: 'Add a field to a particular field group for a particular integration.' operationId: addAFieldToAParticularFieldGroupForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: sed nullable: false required: - groupId parameters: - in: path name: integrationId description: '' example: unde required: true schema: type: string - in: path name: employeeFieldId description: '' example: laudantium required: true schema: type: string '/api/v1/external-integration/{integrationId}/field-groups/{employeeFieldId}/move-field': patch: summary: 'Move a field from a field group for a particular integration.' operationId: moveAFieldFromAFieldGroupForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: oldGroupId: type: string description: '' example: ut nullable: false newGroupId: type: string description: '' example: rerum nullable: false required: - oldGroupId - newGroupId parameters: - in: path name: integrationId description: '' example: eum required: true schema: type: string - in: path name: employeeFieldId description: '' example: dignissimos required: true schema: type: string '/api/v1/external-integration/{integrationId}/field-groups/{employeeFieldId}/remove-field': post: summary: 'Remove a field from a field group for a particular integration.' operationId: removeAFieldFromAFieldGroupForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: voluptates nullable: false required: - groupId parameters: - in: path name: integrationId description: '' example: ad required: true schema: type: string - in: path name: employeeFieldId description: '' example: ab required: true schema: type: string '/api/v1/organization/{organizationId}/field-groups': get: summary: 'Get fields groups for a particular organization.' operationId: getFieldsGroupsForAParticularOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: animi nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false parameters: - in: path name: organizationId description: '' example: eum required: true schema: type: string '/api/v1/organization/{organizationId}/field-groups/{groupId}': put: summary: 'Customize an existing global field group for a particular organization.' operationId: customizeAnExistingGlobalFieldGroupForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: veritatis nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false get: summary: 'Get a particular field group for a particular organization.' operationId: getAParticularFieldGroupForAParticularOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: natus nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false delete: summary: 'Revert a customized field group for a particular organization.' operationId: revertACustomizedFieldGroupForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: nihil nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false parameters: - in: path name: organizationId description: '' example: fugit required: true schema: type: string - in: path name: groupId description: '' example: sunt required: true schema: type: string '/api/v1/organization/{organizationId}/field-groups/{employeeFieldId}/add-field': post: summary: 'Add a field to a particular field group for a particular organization.' operationId: addAFieldToAParticularFieldGroupForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: consequatur nullable: false required: - groupId parameters: - in: path name: organizationId description: '' example: similique required: true schema: type: string - in: path name: employeeFieldId description: '' example: et required: true schema: type: string '/api/v1/organization/{organizationId}/field-groups/{employeeFieldId}/move-field': patch: summary: 'Move a field from one field group to another for a particular organization.' operationId: moveAFieldFromOneFieldGroupToAnotherForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: oldGroupId: type: string description: '' example: reiciendis nullable: false newGroupId: type: string description: '' example: aut nullable: false required: - oldGroupId - newGroupId parameters: - in: path name: organizationId description: '' example: hic required: true schema: type: string - in: path name: employeeFieldId description: '' example: voluptate required: true schema: type: string '/api/v1/organization/{organizationId}/field-groups/{employeeFieldId}/remove-field': post: summary: 'Remove a field from a particular field group for a particular organization.' operationId: removeAFieldFromAParticularFieldGroupForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: perspiciatis nullable: false required: - groupId parameters: - in: path name: organizationId description: '' example: voluptatum required: true schema: type: string - in: path name: employeeFieldId description: '' example: earum required: true schema: type: string '/api/v1/company/{companyId}/field-groups': get: summary: 'Get fields groups for a particular company.' operationId: getFieldsGroupsForAParticularCompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' parameters: - in: path name: companyId description: '' example: autem required: true schema: type: string '/api/v1/company/{companyId}/field-groups/{groupId}': put: summary: 'Customize an existing global field group for a particular company.' operationId: customizeAnExistingGlobalFieldGroupForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: beatae nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false get: summary: 'Show a customized global field group for a particular company.' operationId: showACustomizedGlobalFieldGroupForAParticularCompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: non nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false delete: summary: 'Revert a customized global field group for a particular company.' operationId: revertACustomizedGlobalFieldGroupForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: ad nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } fields: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false companyId: type: string description: '' example: null nullable: false integrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false parameters: - in: path name: companyId description: '' example: quia required: true schema: type: string - in: path name: groupId description: '' example: molestias required: true schema: type: string '/api/v1/company/{companyId}/field-groups/{employeeFieldId}/add-field': post: summary: 'Add a field to a field group for a particular company.' operationId: addAFieldToAFieldGroupForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: ut nullable: false required: - groupId parameters: - in: path name: companyId description: '' example: est required: true schema: type: string - in: path name: employeeFieldId description: '' example: est required: true schema: type: string '/api/v1/company/{companyId}/field-groups/{employeeFieldId}/move-field': patch: summary: 'Move a field from one field group to another for a particular company.' operationId: moveAFieldFromOneFieldGroupToAnotherForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: oldGroupId: type: string description: '' example: quis nullable: false newGroupId: type: string description: '' example: rerum nullable: false required: - oldGroupId - newGroupId parameters: - in: path name: companyId description: '' example: ea required: true schema: type: string - in: path name: employeeFieldId description: '' example: ipsa required: true schema: type: string '/api/v1/company/{companyId}/field-groups/{employeeFieldId}/remove-field': post: summary: 'Remove a field from a field group for a particular company.' operationId: removeAFieldFromAFieldGroupForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: corrupti nullable: false required: - groupId parameters: - in: path name: companyId description: '' example: voluptatem required: true schema: type: string - in: path name: employeeFieldId description: '' example: reprehenderit required: true schema: type: string '/api/v1/organization/{organizationId}/locales': get: summary: 'Get locales for a particular organization.' operationId: getLocalesForAParticularOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false title: type: string description: '' example: vero nullable: false code: type: string description: '' example: omnis nullable: false enabled: type: boolean description: '' example: false nullable: false parameters: - in: path name: organizationId description: '' example: rem required: true schema: type: string '/api/v1/organization/{organizationId}/locales/{localeId}': put: summary: 'Customize an existing global locale for a particular organization.' operationId: customizeAnExistingGlobalLocaleForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false title: type: string description: '' example: sapiente nullable: false code: type: string description: '' example: eos nullable: false enabled: type: boolean description: '' example: true nullable: false get: summary: 'Show an extended locale for a particular organization.' operationId: showAnExtendedLocaleForAParticularOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false title: type: string description: '' example: labore nullable: false code: type: string description: '' example: omnis nullable: false enabled: type: boolean description: '' example: false nullable: false delete: summary: 'Revert an extended employee field for a particular organization.' operationId: revertAnExtendedEmployeeFieldForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false title: type: string description: '' example: dolores nullable: false code: type: string description: '' example: ratione nullable: false enabled: type: boolean description: '' example: true nullable: false parameters: - in: path name: organizationId description: '' example: ut required: true schema: type: string - in: path name: localeId description: '' example: enim required: true schema: type: string '/api/v1/company/{companyId}/locales/{localeId}': put: summary: 'Customize an existing global locale for a particular company.' operationId: customizeAnExistingGlobalLocaleForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false title: type: string description: '' example: tenetur nullable: false code: type: string description: '' example: sed nullable: false enabled: type: boolean description: '' example: true nullable: false get: summary: 'Show an extended locale for a particular company.' operationId: showAnExtendedLocaleForAParticularCompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false title: type: string description: '' example: adipisci nullable: false code: type: string description: '' example: dignissimos nullable: false enabled: type: boolean description: '' example: false nullable: false parameters: - in: path name: companyId description: '' example: dolores required: true schema: type: string - in: path name: localeId description: '' example: fugit required: true schema: type: string '/api/v1/company/{companyId}/locales/{localeId}/revert': post: summary: 'Revert an extended employee field for a particular company.' operationId: revertAnExtendedEmployeeFieldForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false title: type: string description: '' example: dolor nullable: false code: type: string description: '' example: qui nullable: false enabled: type: boolean description: '' example: true nullable: false parameters: - in: path name: companyId description: '' example: et required: true schema: type: string - in: path name: localeId description: '' example: et required: true schema: type: string '/api/v1/company/{companyId}/locales': get: summary: 'Get locales for a particular company.' operationId: getLocalesForAParticularCompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false fieldName: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false title: type: string description: '' example: veniam nullable: false code: type: string description: '' example: et nullable: false enabled: type: boolean description: '' example: true nullable: false parameters: - in: path name: companyId description: '' example: id required: true schema: type: string '/api/v1/organization/{organizationId}/employee-field-maps': get: summary: 'Get employee field maps for a particular organization.' operationId: getEmployeeFieldMapsForAParticularOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false externalEmployeeFieldId: type: string description: '' example: repellat nullable: false employeeFieldId: type: string description: '' example: quaerat nullable: false parameters: - in: path name: organizationId description: '' example: accusamus required: true schema: type: string '/api/v1/organization/{organizationId}/employee-field-maps/{employeeFieldMapId}': put: summary: 'Customize an existing global employee field map for a particular organization.' operationId: customizeAnExistingGlobalEmployeeFieldMapForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false externalEmployeeFieldId: type: string description: '' example: non nullable: false employeeFieldId: type: string description: '' example: mollitia nullable: false get: summary: 'Show an extended employee field map for a particular organization.' operationId: showAnExtendedEmployeeFieldMapForAParticularOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false externalEmployeeFieldId: type: string description: '' example: sunt nullable: false employeeFieldId: type: string description: '' example: culpa nullable: false delete: summary: 'Revert an extended employee field map for a particular organization.' operationId: revertAnExtendedEmployeeFieldMapForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false externalEmployeeFieldId: type: string description: '' example: aut nullable: false employeeFieldId: type: string description: '' example: et nullable: false parameters: - in: path name: organizationId description: '' example: in required: true schema: type: string - in: path name: employeeFieldMapId description: '' example: reiciendis required: true schema: type: string '/api/v1/company/{companyId}/employee-field-maps/{employeeFieldMapId}': put: summary: 'Customize an existing global employee field map for a particular company.' operationId: customizeAnExistingGlobalEmployeeFieldMapForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false externalEmployeeFieldId: type: string description: '' example: ducimus nullable: false employeeFieldId: type: string description: '' example: consequatur nullable: false get: summary: 'Show an extended employee field map for a particular company.' operationId: showAnExtendedEmployeeFieldMapForAParticularCompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false externalEmployeeFieldId: type: string description: '' example: omnis nullable: false employeeFieldId: type: string description: '' example: cupiditate nullable: false parameters: - in: path name: companyId description: '' example: voluptas required: true schema: type: string - in: path name: employeeFieldMapId description: '' example: aliquam required: true schema: type: string '/api/v1/company/{companyId}/employee-field-maps/{employeeFieldMapId}/revert': post: summary: 'Revert an extended employee field map for a particular company.' operationId: revertAnExtendedEmployeeFieldMapForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false externalEmployeeFieldId: type: string description: '' example: esse nullable: false employeeFieldId: type: string description: '' example: dolor nullable: false parameters: - in: path name: companyId description: '' example: unde required: true schema: type: string - in: path name: employeeFieldMapId description: '' example: asperiores required: true schema: type: string '/api/v1/company/{companyId}/employee-field-maps': get: summary: 'Get employee field maps for a particular company.' operationId: getEmployeeFieldMapsForAParticularCompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false externalEmployeeFieldId: type: string description: '' example: tenetur nullable: false employeeFieldId: type: string description: '' example: reiciendis nullable: false parameters: - in: path name: companyId description: '' example: et required: true schema: type: string '/api/v1/external-integration/{externalIntegrationId}/personal-card-profiles/{personalCardProfileId}': put: summary: 'Customize an existing global personal card profile for an integration.' operationId: customizeAnExistingGlobalPersonalCardProfileForAnIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false name: type: string description: '' example: ut nullable: false description: type: string description: '' example: 'Sapiente sit qui laudantium voluptas omnis architecto excepturi.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 40577.202534807 nullable: false personalCardProfileTabId: type: string description: '' example: nihil nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 105937.16556 nullable: false personalCardProfileTabGridId: type: string description: '' example: itaque nullable: false fieldGroupId: type: string description: '' example: nihil nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 464910.04717 nullable: false fieldId: type: string description: '' example: possimus nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids required: - tabs get: summary: 'Show an extended personal card profile for an integration.' operationId: showAnExtendedPersonalCardProfileForAnIntegration description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false name: type: string description: '' example: deleniti nullable: false description: type: string description: '' example: 'Inventore molestiae voluptatum veniam deleniti.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 4310926.585052 nullable: false personalCardProfileTabId: type: string description: '' example: optio nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 0.0 nullable: false personalCardProfileTabGridId: type: string description: '' example: ipsam nullable: false fieldGroupId: type: string description: '' example: sed nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 383316.2 nullable: false fieldId: type: string description: '' example: est nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids required: - tabs parameters: - in: path name: externalIntegrationId description: '' example: fugiat required: true schema: type: string - in: path name: personalCardProfileId description: '' example: quas required: true schema: type: string '/api/v1/external-integration/{externalIntegrationId}/personal-card-profiles/{personalCardProfileId}/revert': post: summary: 'Revert an extended personal card profile for an integration.' operationId: revertAnExtendedPersonalCardProfileForAnIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false name: type: string description: '' example: et nullable: false description: type: string description: '' example: 'Dolorem qui praesentium quia dolorem maiores expedita.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 1.0 nullable: false personalCardProfileTabId: type: string description: '' example: omnis nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 23.26744221 nullable: false personalCardProfileTabGridId: type: string description: '' example: ab nullable: false fieldGroupId: type: string description: '' example: dolor nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 15858.0 nullable: false fieldId: type: string description: '' example: non nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids required: - tabs parameters: - in: path name: externalIntegrationId description: '' example: iure required: true schema: type: string - in: path name: personalCardProfileId description: '' example: aliquid required: true schema: type: string '/api/v1/external-integration/{externalIntegrationId}/personal-card-profiles': get: summary: 'Get extended personal card profiles for an integration.' operationId: getExtendedPersonalCardProfilesForAnIntegration description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false name: type: string description: '' example: quisquam nullable: false description: type: string description: '' example: 'Doloribus aut et aliquid iure et.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 5394446.8197175 nullable: false personalCardProfileTabId: type: string description: '' example: voluptatum nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 236237.04926 nullable: false personalCardProfileTabGridId: type: string description: '' example: accusantium nullable: false fieldGroupId: type: string description: '' example: explicabo nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 3471358.53 nullable: false fieldId: type: string description: '' example: earum nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids required: - tabs parameters: - in: path name: externalIntegrationId description: '' example: necessitatibus required: true schema: type: string '/api/v1/organization/{organizationId}/personal-card-profiles/{personalCardProfileId}': put: summary: 'Customize an existing global personal card profile for an organization.' operationId: customizeAnExistingGlobalPersonalCardProfileForAnOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false name: type: string description: '' example: voluptatem nullable: false description: type: string description: '' example: 'Vel iure deserunt neque deserunt veniam doloribus labore molestiae.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 18693.1599 nullable: false personalCardProfileTabId: type: string description: '' example: occaecati nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 45448.6 nullable: false personalCardProfileTabGridId: type: string description: '' example: vitae nullable: false fieldGroupId: type: string description: '' example: possimus nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 5737645.3001905 nullable: false fieldId: type: string description: '' example: libero nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids required: - tabs get: summary: 'Show an extended personal card profile for an organization.' operationId: showAnExtendedPersonalCardProfileForAnOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false name: type: string description: '' example: voluptatem nullable: false description: type: string description: '' example: 'Error ut illo laboriosam nihil aut enim delectus aut.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 35.756475 nullable: false personalCardProfileTabId: type: string description: '' example: nobis nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 198041.188 nullable: false personalCardProfileTabGridId: type: string description: '' example: non nullable: false fieldGroupId: type: string description: '' example: dolorem nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 16804421.023724 nullable: false fieldId: type: string description: '' example: culpa nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids required: - tabs parameters: - in: path name: organizationId description: '' example: omnis required: true schema: type: string - in: path name: personalCardProfileId description: '' example: eum required: true schema: type: string '/api/v1/organization/{organizationId}/personal-card-profiles/{personalCardProfileId}/revert': post: summary: 'Revert an extended personal card profile for an organization.' operationId: revertAnExtendedPersonalCardProfileForAnOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false name: type: string description: '' example: id nullable: false description: type: string description: '' example: 'Veniam aut quisquam delectus quo voluptas dolorum.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 99267.0 nullable: false personalCardProfileTabId: type: string description: '' example: dicta nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 130258.5963 nullable: false personalCardProfileTabGridId: type: string description: '' example: occaecati nullable: false fieldGroupId: type: string description: '' example: ducimus nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 0.8516 nullable: false fieldId: type: string description: '' example: sit nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids required: - tabs parameters: - in: path name: organizationId description: '' example: quos required: true schema: type: string - in: path name: personalCardProfileId description: '' example: in required: true schema: type: string '/api/v1/organization/{organizationId}/personal-card-profiles': get: summary: 'Get extended personal card profiles for an organization.' operationId: getExtendedPersonalCardProfilesForAnOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false name: type: string description: '' example: hic nullable: false description: type: string description: '' example: 'Dolores minima laborum veritatis sit quae.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 98.44 nullable: false personalCardProfileTabId: type: string description: '' example: sunt nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 5147.358 nullable: false personalCardProfileTabGridId: type: string description: '' example: rerum nullable: false fieldGroupId: type: string description: '' example: eveniet nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 18827.137 nullable: false fieldId: type: string description: '' example: sit nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids required: - tabs parameters: - in: path name: organizationId description: '' example: incidunt required: true schema: type: string '/api/v1/company/{companyId}/personal-card-profiles/{personalCardProfileId}': put: summary: 'Customize an existing global personal card profile for a company.' operationId: customizeAnExistingGlobalPersonalCardProfileForACompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false name: type: string description: '' example: numquam nullable: false description: type: string description: '' example: 'Tenetur et commodi at aut.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 37668.618 nullable: false personalCardProfileTabId: type: string description: '' example: dolorem nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 2808415.268 nullable: false personalCardProfileTabGridId: type: string description: '' example: quasi nullable: false fieldGroupId: type: string description: '' example: ut nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 54.6 nullable: false fieldId: type: string description: '' example: incidunt nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids required: - tabs get: summary: 'Show an extended personal card profile for a company.' operationId: showAnExtendedPersonalCardProfileForACompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false name: type: string description: '' example: libero nullable: false description: type: string description: '' example: 'Id autem cupiditate provident dolorem accusamus recusandae.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 14743102.56 nullable: false personalCardProfileTabId: type: string description: '' example: dicta nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 676317093.7505 nullable: false personalCardProfileTabGridId: type: string description: '' example: consequatur nullable: false fieldGroupId: type: string description: '' example: molestiae nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 586.15483761 nullable: false fieldId: type: string description: '' example: distinctio nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids required: - tabs parameters: - in: path name: companyId description: '' example: quod required: true schema: type: string - in: path name: personalCardProfileId description: '' example: non required: true schema: type: string '/api/v1/company/{companyId}/personal-card-profiles/{personalCardProfileId}/revert': post: summary: 'Revert an extended personal card profile for a company.' operationId: revertAnExtendedPersonalCardProfileForACompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false name: type: string description: '' example: qui nullable: false description: type: string description: '' example: 'Deleniti aut id eum rem accusantium possimus voluptatem.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 115.0 nullable: false personalCardProfileTabId: type: string description: '' example: laboriosam nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 389373159.40347 nullable: false personalCardProfileTabGridId: type: string description: '' example: vel nullable: false fieldGroupId: type: string description: '' example: voluptatem nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 0.0 nullable: false fieldId: type: string description: '' example: facilis nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids required: - tabs parameters: - in: path name: companyId description: '' example: eveniet required: true schema: type: string - in: path name: personalCardProfileId description: '' example: expedita required: true schema: type: string '/api/v1/company/{companyId}/personal-card-profiles': get: summary: 'Get extended personal card profiles for a company.' operationId: getExtendedPersonalCardProfilesForACompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null nullable: false parentId: type: string description: '' example: null nullable: false isGlobal: type: string description: '' example: null nullable: false externalIntegrationId: type: string description: '' example: null nullable: false organizationId: type: string description: '' example: null nullable: false name: type: string description: '' example: dolor nullable: false description: type: string description: '' example: 'Alias rem officiis porro corrupti delectus error qui esse.' nullable: false translations: type: object description: 'The data must be a valid translation object.' example: null nullable: false properties: { } tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 29526.81 nullable: false personalCardProfileTabId: type: string description: '' example: rerum nullable: false grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 4476.059749 nullable: false personalCardProfileTabGridId: type: string description: '' example: explicabo nullable: false fieldGroupId: type: string description: '' example: error nullable: false fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 71218781.4178 nullable: false fieldId: type: string description: '' example: odio nullable: false required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids required: - tabs parameters: - in: path name: companyId description: '' example: beatae required: true schema: type: string '/api/v1/organizations/{organizationId}/available-parents': get: summary: 'List companies that can be used as parent companies in an organization (Stability Score: 0.5)' operationId: listCompaniesThatCanBeUsedAsParentCompaniesInAnOrganizationStabilityScore05 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies nullable: false responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' parameters: - in: path name: organizationId description: '' example: illo required: true schema: type: string '/api/v1/import/agda-company-list/{agdaConnectionId}': get: summary: 'List companies for an Agda connection (Stability Score: 0.3)' operationId: listCompaniesForAnAgdaConnectionStabilityScore03 description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' parameters: - in: path name: agdaConnectionId description: '' example: sit required: true schema: type: string /api/v1/import/company: post: summary: 'Import company details (Stability Score: 0.1)' operationId: importCompanyDetailsStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: quasi nullable: false companyIntegrationId: type: string description: '' example: omnis nullable: false async: type: boolean description: '' example: false nullable: true required: - companyId - companyIntegrationId /api/v1/import/employees: post: summary: 'Import employees (Stability Score: 0.1)' operationId: importEmployeesStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: dicta nullable: false companyIntegrationId: type: string description: '' example: at nullable: false async: type: boolean description: '' example: false nullable: false required: - companyId - companyIntegrationId /api/v1/import/roles: post: summary: 'Import roles (Stability Score: 0.1)' operationId: importRolesStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: eaque nullable: false companyIntegrationId: type: string description: '' example: voluptatem nullable: false async: type: boolean description: '' example: true nullable: true required: - companyId - companyIntegrationId /api/v1/import/transactions: post: summary: 'Import transactions. (Stability Score: 0.1)' operationId: importTransactionsStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: veritatis nullable: false companyIntegrationId: type: string description: '' example: possimus nullable: false period: type: string description: 'Must match the regex /^[1-9][0-9]{3}(0[1-9]|1[0-2])[0-9]$/.' example: '1652106' nullable: false required: - companyId - companyIntegrationId - period /api/v1/import/salary-types: post: summary: 'Import salary types.' operationId: importSalaryTypes description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: architecto nullable: false required: - companyId /api/v1/import/cloud/transactions: post: summary: 'Import transactions to the cloud.' operationId: importTransactionsToTheCloud description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' /api/v1/employees/transfer-changes: post: summary: 'Transfer Changes' operationId: transferChanges description: 'This endpoint lets you transfer changes to the employee document' parameters: [] responses: { } tags: - 'Custom Endpoints' /api/v1/export/employees: post: summary: 'Export employees (Stability Score: 0.1)' operationId: exportEmployeesStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: aperiam nullable: false companyIntegrationId: type: string description: '' example: quaerat nullable: false recordIds: type: array description: '' example: - doloremque items: type: string required: - recordIds /api/v1/cache/refresh: post: summary: 'Refresh the cache.' operationId: refreshTheCache description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' /api/v1/cache/warm: post: summary: 'Warm the cache.' operationId: warmTheCache description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' /api/v1/cache/clear: post: summary: 'Clear the cache.' operationId: clearTheCache description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' /api/v1/real-time/connection-token: get: summary: 'Generate connection token for Centrifugo.' operationId: generateConnectionTokenForCentrifugo description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' /api/v1/real-time/subscription-token: get: summary: 'Generate subscription token for Centrifugo.' operationId: generateSubscriptionTokenForCentrifugo description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: channel: type: string description: '' example: fuga nullable: false required: - channel '/api/v1/permissions/endpoint-permission-groups/{endpointPermissionGroupId}/assign': post: summary: 'Add/update an endpoint permission to/in an endpoint permission group. (Stability Score: 0.1)' operationId: addupdateAnEndpointPermissionToinAnEndpointPermissionGroupStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: endpoint_id: type: integer description: 'The id of an existing record in the endpoints table.' example: 12 nullable: false permission: type: number description: 'Must match the regex /^[0-1]{3}$/.' example: '100' nullable: false required: - endpoint_id - permission parameters: - in: path name: endpointPermissionGroupId description: '' example: distinctio required: true schema: type: string '/api/v1/permissions/endpoint-permission-groups/{endpointPermissionGroupId}/remove': post: summary: 'Remove and endpoint permission from an endpoint permission group. (Stability Score: 0.1)' operationId: removeAndEndpointPermissionFromAnEndpointPermissionGroupStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: endpoint_id: type: integer description: 'The endpoint_id of an existing record in the endpoint_permission_group_permissions table.' example: 19 nullable: false required: - endpoint_id parameters: - in: path name: endpointPermissionGroupId description: '' example: sint required: true schema: type: string /api/v1/permissions/endpoints: get: summary: 'Get all available endpoints. (Stability Score: 0.1)' operationId: getAllAvailableEndpointsStabilityScore01 description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' /api/v1/role-profiles/attach: post: summary: 'Attach a personal card profile to a role.' operationId: attachAPersonalCardProfileToARole description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: role_id: type: number description: 'The id of an existing record in the roles table.' example: 473693617.28223 nullable: false personal_card_profile_id: type: string description: '' example: quia nullable: false company_id: type: string description: '' example: quia nullable: false required: - role_id - personal_card_profile_id /api/v1/role-profiles/detach: post: summary: 'Detach a personal card profile from a role.' operationId: detachAPersonalCardProfileFromARole description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: role_id: type: number description: 'The id of an existing record in the roles table.' example: 6.567503709 nullable: false personal_card_profile_id: type: string description: '' example: et nullable: false company_id: type: string description: '' example: nam nullable: false required: - role_id - personal_card_profile_id '/api/v1/abilities/roles/{roleId}/assign': post: summary: 'Assign a role to a user. (Stability Score: 0.1)' operationId: assignARoleToAUserStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: roleId description: '' example: 1 required: true schema: type: integer '/api/v1/abilities/roles/{roleId}/retract': post: summary: 'Retract a role from a user. (Stability Score: 0.1)' operationId: retractARoleFromAUserStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: roleId description: '' example: 1 required: true schema: type: integer /api/v1/refresh-endpoints: post: summary: 'Refresh endpoints list. (Stability Score: 0.5)' operationId: refreshEndpointsListStabilityScore05 description: 'This endpoint lets you refresh the endpoints list.' parameters: [] responses: { } tags: - 'Custom Endpoints' /api/v1/permissions/endpoint-permission-groups/search: post: summary: 'Filters, sorts, and fetches the list of resources.' operationId: filtersSortsAndFetchesTheListOfResources description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/permissions/endpoint-permission-groups/batch: post: summary: 'Creates a batch of new resources in a transaction-safe way.' operationId: createsABatchOfNewResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] nullable: false properties: { } required: - resources patch: summary: 'Update a batch of resources in a transaction-safe way.' operationId: updateABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] nullable: false properties: { } required: - resources delete: summary: 'Deletes a batch of resources in a transaction-safe way.' operationId: deletesABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/permissions/endpoint-permission-groups: get: summary: 'Fetches the list of resources.' operationId: fetchesTheListOfResources description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints post: summary: 'Creates new resource in a transaction-safe way.' operationId: createsNewResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints '/api/v1/permissions/endpoint-permission-groups/{id}': get: summary: 'Fetches resource.' operationId: fetchesResource description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints put: summary: 'Update a resource in a transaction-safe way.' operationId: updateAResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints delete: summary: 'Deletes a resource.' operationId: deletesAResource description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the endpoint permission group.' example: natus required: true schema: type: string /api/v1/permissions/endpoint-permissions/search: post: summary: 'Filters, sorts, and fetches the list of resources.' operationId: filtersSortsAndFetchesTheListOfResources description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/permissions/endpoint-permissions/batch: post: summary: 'Creates a batch of new resources in a transaction-safe way.' operationId: createsABatchOfNewResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] nullable: false properties: { } required: - resources patch: summary: 'Update a batch of resources in a transaction-safe way.' operationId: updateABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] nullable: false properties: { } required: - resources delete: summary: 'Deletes a batch of resources in a transaction-safe way.' operationId: deletesABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/permissions/endpoint-permissions: get: summary: 'Fetches the list of resources.' operationId: fetchesTheListOfResources description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints post: summary: 'Creates new resource in a transaction-safe way.' operationId: createsNewResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints '/api/v1/permissions/endpoint-permissions/{id}': get: summary: 'Fetches resource.' operationId: fetchesResource description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints put: summary: 'Update a resource in a transaction-safe way.' operationId: updateAResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints delete: summary: 'Deletes a resource.' operationId: deletesAResource description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the endpoint permission.' example: nostrum required: true schema: type: string /api/v1/pg-users/batch: post: summary: 'Creates a batch of new resources in a transaction-safe way.' operationId: createsABatchOfNewResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] nullable: false properties: { } required: - resources patch: summary: 'Update a batch of resources in a transaction-safe way.' operationId: updateABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] nullable: false properties: { } required: - resources delete: summary: 'Deletes a batch of resources in a transaction-safe way.' operationId: deletesABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/pg-users/batch/restore: post: summary: 'Restores a batch of resources in a transaction-safe way.' operationId: restoresABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/abilities/roles/search: post: summary: 'Filters, sorts, and fetches the list of resources.' operationId: filtersSortsAndFetchesTheListOfResources description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/abilities/roles/batch: post: summary: 'Creates a batch of new resources in a transaction-safe way.' operationId: createsABatchOfNewResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] nullable: false properties: { } required: - resources patch: summary: 'Update a batch of resources in a transaction-safe way.' operationId: updateABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] nullable: false properties: { } required: - resources delete: summary: 'Deletes a batch of resources in a transaction-safe way.' operationId: deletesABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/abilities/roles: get: summary: 'Fetches the list of resources.' operationId: fetchesTheListOfResources description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints post: summary: 'Creates new resource in a transaction-safe way.' operationId: createsNewResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints '/api/v1/abilities/roles/{id}': get: summary: 'Fetches resource.' operationId: fetchesResource description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints put: summary: 'Update a resource in a transaction-safe way.' operationId: updateAResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints delete: summary: 'Deletes a resource.' operationId: deletesAResource description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the role.' example: 1 required: true schema: type: integer /api/v1/orion/transactions/search: post: summary: 'Filters, sorts, and fetches the list of resources.' operationId: filtersSortsAndFetchesTheListOfResources description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' /api/v1/orion/transactions/batch: post: summary: 'Creates a batch of new resources in a transaction-safe way.' operationId: createsABatchOfNewResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] nullable: false properties: { } required: - resources patch: summary: 'Update a batch of resources in a transaction-safe way.' operationId: updateABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] nullable: false properties: { } required: - resources delete: summary: 'Deletes a batch of resources in a transaction-safe way.' operationId: deletesABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' /api/v1/orion/transactions: get: summary: 'Fetches the list of resources.' operationId: fetchesTheListOfResources description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Orion Endpoints' post: summary: 'Creates new resource in a transaction-safe way.' operationId: createsNewResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' '/api/v1/orion/transactions/{id}': get: summary: 'Fetches resource.' operationId: fetchesResource description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Orion Endpoints' put: summary: 'Update a resource in a transaction-safe way.' operationId: updateAResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' delete: summary: 'Deletes a resource.' operationId: deletesAResource description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' parameters: - in: path name: id description: 'The ID of the transaction.' example: maxime required: true schema: type: string /api/octane-firebase-concurrently: get: summary: '' operationId: getApiOctaneFirebaseConcurrently description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Uncategorized Endpoints' /api/v1/admin/createToken: post: summary: '' operationId: postApiV1AdminCreateToken description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' /api/v1/websocket: post: summary: '' operationId: postApiV1Websocket description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' /api/v1/queue/jobs: get: summary: '' operationId: getApiV1QueueJobs description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Uncategorized Endpoints' /api/v1/queue/jobs/trigger-failing: get: summary: '' operationId: getApiV1QueueJobsTriggerFailing description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Uncategorized Endpoints' '/api/v1/queue/jobs/{jobId}': get: summary: '' operationId: getApiV1QueueJobsJobId description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Uncategorized Endpoints' parameters: - in: path name: jobId description: '' example: voluptatem required: true schema: type: string '/api/v1/queue/jobs_uuid/{jobId}': get: summary: '' operationId: getApiV1QueueJobs_uuidJobId description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Uncategorized Endpoints' parameters: - in: path name: jobId description: '' example: sint required: true schema: type: string '/api/v1/queue/jobs/{jobId}/retry': post: summary: '' operationId: postApiV1QueueJobsJobIdRetry description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' parameters: - in: path name: jobId description: '' example: cum required: true schema: type: string /api/v1/behaviour/dispatch: post: summary: '' operationId: postApiV1BehaviourDispatch description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' '/api/v1/persons/{personId}/merge': post: summary: '' operationId: postApiV1PersonsPersonIdMerge description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,employees' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,employees' nullable: false responses: { } tags: - 'Uncategorized Endpoints' parameters: - in: path name: personId description: '' example: a required: true schema: type: string '/api/v1/exports/{exportId}/revert': post: summary: '' operationId: postApiV1ExportsExportIdRevert description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' nullable: false responses: { } tags: - 'Uncategorized Endpoints' parameters: - in: path name: exportId description: '' example: corrupti required: true schema: type: string '/api/v1/companies/{companyId}/employees/apply-changes': post: summary: '' operationId: postApiV1CompaniesCompanyIdEmployeesApplyChanges description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' parameters: - in: path name: companyId description: '' example: modi required: true schema: type: string '/api/v1/companies/{companyId}/recalculate-is-draft': post: summary: '' operationId: postApiV1CompaniesCompanyIdRecalculateIsDraft description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes' nullable: false responses: { } tags: - 'Uncategorized Endpoints' parameters: - in: path name: companyId description: '' example: quia required: true schema: type: string '/api/v1/companies/{companyId}/field-changes': post: summary: '' operationId: postApiV1CompaniesCompanyIdFieldChanges description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 1 nullable: false changeId: type: string description: '' example: eos nullable: false changeType: type: string description: '' example: delete nullable: false enum: - delete fieldName: type: string description: '' example: similique nullable: false newValue: type: string description: 'This field is required unless changeType is in delete.' example: null nullable: false oldValue: type: string description: '' example: vero nullable: true comment: type: string description: '' example: eius nullable: false changedBy: type: string description: '' example: null nullable: false changedDate: type: string description: '' example: null nullable: false approved: type: string description: '' example: null nullable: false status: type: string description: '' example: null nullable: false required: - fieldName parameters: - in: path name: companyId description: '' example: inventore required: true schema: type: string '/api/v1/companies/{companyId}/field-changes/batch': post: summary: '' operationId: postApiV1CompaniesCompanyIdFieldChangesBatch description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 1 nullable: false changeId: type: string description: '' example: enim nullable: false changeType: type: string description: '' example: delete nullable: false enum: - delete fieldName: type: string description: '' example: neque nullable: false newValue: type: string description: 'This field is required unless changeType is in delete.' example: null nullable: false oldValue: type: string description: '' example: ea nullable: true comment: type: string description: '' example: et nullable: false changedBy: type: string description: '' example: null nullable: false changedDate: type: string description: '' example: null nullable: false approved: type: string description: '' example: null nullable: false status: type: string description: '' example: null nullable: false required: - fieldName parameters: - in: path name: companyId description: '' example: amet required: true schema: type: string /api/v1/company-transfer: post: summary: '' operationId: postApiV1CompanyTransfer description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' /api/v1/pg-users/search: post: summary: '' operationId: postApiV1PgUsersSearch description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' /api/v1/pg-users: get: summary: '' operationId: getApiV1PgUsers description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Uncategorized Endpoints' post: summary: '' operationId: postApiV1PgUsers description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' '/api/v1/pg-users/{id}': get: summary: '' operationId: getApiV1PgUsersId description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Uncategorized Endpoints' put: summary: '' operationId: putApiV1PgUsersId description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' delete: summary: '' operationId: deleteApiV1PgUsersId description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' parameters: - in: path name: id description: 'The ID of the pg user.' example: eum required: true schema: type: string '/api/v1/pg-users/{pg_user}/restore': post: summary: '' operationId: postApiV1PgUsersPg_userRestore description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' parameters: - in: path name: pg_user description: '' example: voluptatem required: true schema: type: string /api/v1/role-profiles/search: post: summary: '' operationId: postApiV1RoleProfilesSearch description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' '/api/v1/role-profiles/{roleProfileId}': patch: summary: '' operationId: patchApiV1RoleProfilesRoleProfileId description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' parameters: - in: path name: roleProfileId description: '' example: error required: true schema: type: string