# Caraer API Documentation This documentation provides an overview of the Caraer API, including authentication methods, endpoint details, data models, and integration guidelines for building on the Caraer platform. Version: 1.8 ## Servers Production ``` https://v2.api.caraer.com ``` ## Security ### BearerAuthentication Type: http Scheme: bearer Bearer Format: Opaque ## Download OpenAPI description [Caraer API Documentation](https://developer.caraer.com/_bundle/apis/index.yaml) ## Sync Sync configurations define automated data synchronization mappings between CaraerObjects. A Sync specifies how property values from source Records should be mapped to target Records, enabling automated data flow between different object types. Syncs use Mappings that define source and target properties, allowing data to be copied, transformed, or synchronized when source Records are created or updated. Syncs are used for data integration, automation workflows, and keeping related data in sync across the platform. They enable scenarios like automatically creating a Company Record when a User Record is created, or syncing Candidate data to an external system. Syncs support complex mapping rules and can trigger on various Record events. ### Get a sync - [GET /api/v2/sync/{uuid}](https://developer.caraer.com/apis/sync/getsync.md): Retrieves a sync by its UUID. Returns a SyncDTO containing the sync details. ### Update a sync - [PUT /api/v2/sync/{uuid}](https://developer.caraer.com/apis/sync/updatesync.md): Updates an existing sync. Returns a UpdateResponse containing the updated sync details. ### Delete a sync - [DELETE /api/v2/sync/{uuid}](https://developer.caraer.com/apis/sync/deletesync.md): Deletes an existing sync. Returns a DeleteResponse containing the deleted sync details. ### Restore a deleted sync - [POST /api/v2/sync/{uuid}/restore](https://developer.caraer.com/apis/sync/restoresync.md): Restores a previously deleted sync by its UUID. Returns a RestoreResponse containing the restored sync details. ### Fetch paginated syncs - [POST /api/v2/sync/index](https://developer.caraer.com/apis/sync/getsyncs.md): Retrieves a paginated list of syncs. Returns a PaginationResponse containing SyncDTO objects based on the provided pagination criteria. ### Create a sync - [POST /api/v2/sync](https://developer.caraer.com/apis/sync/createsync.md): Creates a new sync. Returns a CreateResponse containing the created sync details. ## Relations Relations define typed connections between CaraerObjects, enabling graph-like data modeling. A Relation specifies how Records of one Object can connect to Records of another Object (e.g., "Candidate applies to Vacancy", "Company has Employees"). Relations create directed or bidirectional relationships between Records, allowing navigation and querying of related data. Relations support cardinality, directionality, and can be used in filtering, sorting, and querying Records. They enable complex data structures where Records reference each other, creating a graph database model on top of the object-oriented schema. Relations are essential for modeling real-world relationships between entities and enable powerful querying capabilities across connected Records. ### Add a connection to a relation - [PUT /api/v2/relations/{relationUuid}/connection/{from}/{to}](https://developer.caraer.com/apis/relations/addconnection.md): Creates a connection between two objects for a given relation. The 'from' and 'to' UUIDs identify the objects to connect. ### Delete a connection from a relation - [DELETE /api/v2/relations/{relationUuid}/connection/{from}/{to}](https://developer.caraer.com/apis/relations/deleteconnection.md): Deletes a connection between two objects for a given relation using the specified UUIDs. ### Update relation indices - [PUT /api/v2/relations/updateIndices](https://developer.caraer.com/apis/relations/updateindices.md): Updates the indices for relations. The request body should contain a mapping of relation UUIDs to their new index values. Returns a SuccessResponse containing the updated relation objects. ### Restore a deleted relation - [POST /api/v2/relations/{relationUuid}/restore](https://developer.caraer.com/apis/relations/restorerelation.md): Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details. ### Create or update a relation - [POST /api/v2/relations/{objectUuid}](https://developer.caraer.com/apis/relations/createrelationorupdate.md): Creates a new relation or updates an existing one for the specified object. If a relation with the same name exists, it is updated; otherwise, a new relation is created. Returns an UpdateResponse if updated or a CreateResponse if created. ### Fetch paginated relations - [POST /api/v2/relations/index](https://developer.caraer.com/apis/relations/getrelations.md): Retrieves a paginated list of relations. Returns a PaginationResponse containing RelationDTO objects based on the provided pagination criteria. ### Fetch relations for a specific object - [POST /api/v2/relations/index/{objectUuid}](https://developer.caraer.com/apis/relations/getrelationsbyobject.md): Retrieves a paginated list of relations associated with the specified object UUID. The relations are filtered using a custom Cypher query based on the object's name. ### Get all relations between two objects - [POST /api/v2/relations/index/{fromObjectUuid}/{toObjectUuid}](https://developer.caraer.com/apis/relations/getrelationsbetweenobjects.md): Retrieves all relations between two objects based on the provided object UUIDs. ### Get relation details - [GET /api/v2/relations/{relationUuid}](https://developer.caraer.com/apis/relations/getrelation.md): Retrieves the details of a relation by its UUID. Returns a ShowResponse containing a RelationDTO. ### Delete a relation - [DELETE /api/v2/relations/{relationUuid}](https://developer.caraer.com/apis/relations/deleterelation_1.md): Deletes a relation specified by its UUID. Returns a DeleteResponse with the deleted relation details. ### Get relation details for a specific object - [GET /api/v2/relations/{relationUuid}/{objectUuid}](https://developer.caraer.com/apis/relations/getrelationforobject.md): Retrieves a relation by its UUID and associates it with the specified object, returning a RelationDTO that includes details from the related object. ## WebMenus WebMenus define navigation structures for public-facing websites. They specify menu items with labels and URLs, locations (header, footer, sidebar), environments (production, preview), and can include custom URLs or links to Records and Webpages. WebMenus enable dynamic navigation that adapts based on published content, allowing websites to automatically reflect changes in the data model. Menus can be activated/deactivated, organized hierarchically, and support multiple environments for preview/testing before production deployment. WebMenus are essential for building dynamic, content-driven navigation in career sites and public-facing applications. ### Show web menu - [GET /api/v2/webmenus/{uuid}](https://developer.caraer.com/apis/webmenus/getwebmenu.md): Show web menu ### Update web menu - [PUT /api/v2/webmenus/{uuid}](https://developer.caraer.com/apis/webmenus/updatewebmenu.md): Update web menu ### Delete web menu - [DELETE /api/v2/webmenus/{uuid}](https://developer.caraer.com/apis/webmenus/deletewebmenu.md): Delete web menu ### Create web menu - [POST /api/v2/webmenus](https://developer.caraer.com/apis/webmenus/createwebmenu.md): Create web menu ### Restore deleted web menu - [POST /api/v2/webmenus/{uuid}/restore](https://developer.caraer.com/apis/webmenus/restorewebmenu.md): Restore a deleted web menu by its UUID ### Index web menus - [POST /api/v2/webmenus/index](https://developer.caraer.com/apis/webmenus/indexwebmenus.md): Index web menus ## Forms Forms are dynamic data collection interfaces associated with CaraerObjects. They use a grid-based layout system with FormItems (GridItems) arranged in rows and columns that can render various field types based on Property definitions. Forms support multi-step wizards, lead scoring configurations, styling options (standard, underline, plain), and form submissions that create Records. Forms enable public-facing data collection (e.g., job applications, contact forms, candidate registrations) and can be embedded in Webpages. Forms validate input against Property validation rules and can include nested forms (inner forms) for complex data structures. Form submissions trigger FormSubmissionEvents and can create Relations between Records. Forms are essential for converting external user input into structured Records in the platform. ### Get form by UUID - [GET /api/v2/forms/{formUuid}](https://developer.caraer.com/apis/forms/getform.md): Retrieves a specific form by its UUID. Returns the details of the form in a FormDTO object wrapped in a ShowResponse. ### Update an existing form - [PUT /api/v2/forms/{formUuid}](https://developer.caraer.com/apis/forms/updateform.md): Updates an existing form identified by its UUID with the provided data. The request body should include the updated fields in a FormDTO. Returns the updated form wrapped in an UpdateResponse. Validation: Form fields are validated according to the Form validation rules. Required fields and format constraints are enforced. ### Delete a form - [DELETE /api/v2/forms/{formUuid}](https://developer.caraer.com/apis/forms/deleteform.md): Deletes a form identified by its UUID. On success, returns the deleted form's data wrapped in a DeleteResponse. ### Get forms by object UUID - [POST /api/v2/forms/{objectUuid}/index](https://developer.caraer.com/apis/forms/getformsbyobject.md): Retrieves a paginated list of forms associated with a specific object UUID. The endpoint uses a custom Cypher query to match forms linked to the object. ### Restore a deleted form - [POST /api/v2/forms/{formUuid}/restore](https://developer.caraer.com/apis/forms/restoreform.md): Restores a previously deleted form identified by its UUID. Returns the restored form wrapped in a RestoreResponse. ### Submit a file - [POST /api/v2/forms/public/{companyUuid}/{formUuid}/upload](https://developer.caraer.com/apis/forms/uploadfiles.md): Submits a file with the provided data. Returns a SuccessResponse upon successful submission. ### Submit a form - [POST /api/v2/forms/public/{companyUuid}/{formUuid}/submit](https://developer.caraer.com/apis/forms/submit.md): Submits a form with the provided data. Returns a SuccessResponse upon successful submission. ### Get all forms for a company - [POST /api/v2/forms/public/{companyUuid}/index](https://developer.caraer.com/apis/forms/getformspublic.md) ### Get paginated list of forms - [POST /api/v2/forms/index](https://developer.caraer.com/apis/forms/getforms.md): Retrieves a paginated list of forms based on the provided filters, sorting, and search query. This endpoint returns a list of FormDTO objects wrapped in a PaginationResponse containing the current page, limit, total count, and the forms data. ### Create a new form - [POST /api/v2/forms](https://developer.caraer.com/apis/forms/createform.md): Creates a new form with the provided data. The request body should contain a valid FormDTO object. On success, returns the created form as a FormDTO wrapped in a CreateResponse. Validation: Form fields are validated according to the Form validation rules. Required fields and format constraints are enforced. ### Get form by UUID - [GET /api/v2/forms/public/{companyUuid}/{formUuid}](https://developer.caraer.com/apis/forms/getformpublic.md): Retrieves a specific form by its UUID. Returns the details of the form in a FormDTO object wrapped in a ShowResponse. ## File Management File endpoints manage file uploads and downloads using S3-compatible storage. Files are used for attachments, images, documents, and media in Records and Webpages. Files support property format constraints (when used with file-type Properties) and access control through scopes. The file system provides pre-signed URLs for secure, time-limited access to files, supports bulk uploads, and can list files associated with specific Records. Files are stored with unique keys and can be deleted when no longer needed. The file system enables rich content management, allowing Records and Webpages to include images, documents, and other media assets. ### Download file - [GET /api/v2/files](https://developer.caraer.com/apis/file-management/downloadfile.md): Generates a pre-signed URL to download a file stored in S3-compatible storage. The URL expiry time and download behavior can be specified using the query parameters. ### Upload files - [POST /api/v2/files](https://developer.caraer.com/apis/file-management/uploadfile_2.md): Uploads multiple files to an S3-compatible storage and returns their unique keys. The request must contain one or more files in multipart/form-data format. ### Delete file - [DELETE /api/v2/files](https://developer.caraer.com/apis/file-management/deletefile.md): Deletes a file from the S3-compatible storage identified by its unique key. ### List files - [GET /api/v2/files/list](https://developer.caraer.com/apis/file-management/listfiles.md): Lists all files stored in the system or, if a record UUID is provided, lists the files related to that record. ## Filter SavedFilters are reusable filter configurations that users can save and share. They encapsulate complex filter criteria for Records, enabling quick access to filtered data views without re-entering filter conditions. SavedFilters improve UX by allowing users to bookmark common queries (e.g., "Active Candidates", "Open Vacancies", "My Applications") and share them with team members. Filters can be soft-deleted and restored, and they support the same filter capabilities as Views but are stored separately for quick access. SavedFilters enable consistent data access patterns across teams and reduce the time needed to access frequently-used filtered views. ### Fetch a specific saved filter - [GET /api/v2/filters/{filterUuid}](https://developer.caraer.com/apis/filter/getfilter.md): Retrieves details of a saved filter by its UUID. ### Update an existing saved filter - [PUT /api/v2/filters/{filterUuid}](https://developer.caraer.com/apis/filter/updatefilter.md): Updates an existing saved filter identified by its UUID. ### Delete a saved filter - [DELETE /api/v2/filters/{filterUuid}](https://developer.caraer.com/apis/filter/deletefilter.md): Soft deletes a saved filter identified by its UUID. ### Create a new saved filter - [POST /api/v2/filters](https://developer.caraer.com/apis/filter/createfilter.md): Creates a new saved filter with the provided configuration. ### Fetch paginated saved filters - [POST /api/v2/filters/index/{objectUuid}](https://developer.caraer.com/apis/filter/getfilters.md): Fetches a paginated list of saved filters. The request body should contain pagination details such as limit, page, filters, and sort. ## Serverless Functions Serverless functions are runtime+code units attached to Apps, used in Webhooks and other extensibility points. ### Get a serverless function - [GET /api/v2/apps/{appUuid}/serverless-functions/{uuid}](https://developer.caraer.com/apis/serverless-functions/show.md): Retrieves a serverless function by its UUID, ensuring it belongs to the specified app. ### Update a serverless function - [PUT /api/v2/apps/{appUuid}/serverless-functions/{uuid}](https://developer.caraer.com/apis/serverless-functions/update_1.md): Updates an existing serverless function's runtime and code, keeping it attached to the same app. ### Create a serverless function - [POST /api/v2/apps/{appUuid}/serverless-functions](https://developer.caraer.com/apis/serverless-functions/create_1.md): Creates a new serverless function attached to the specified app. ### Test a serverless function - [POST /api/v2/apps/{appUuid}/serverless-functions/{uuid}/test](https://developer.caraer.com/apis/serverless-functions/testserverlessfunction.md): Provisions (if needed) and invokes a serverless function for a given record and event type, using the same payload shape as webhooks. ### List serverless functions for an app - [POST /api/v2/apps/{appUuid}/serverless-functions/index](https://developer.caraer.com/apis/serverless-functions/index_1.md): Retrieves a paginated list of serverless functions that belong to the specified app. ## Module API endpoints for managing modules ### Fetch a specific module - [GET /api/v2/modules/{moduleId}](https://developer.caraer.com/apis/module/getmodule.md): Retrieves details of a module by its UUID. ### Update an existing module - [PUT /api/v2/modules/{moduleId}](https://developer.caraer.com/apis/module/updatemodule.md): Updates the details of an existing module. ### Delete a module - [DELETE /api/v2/modules/{moduleId}](https://developer.caraer.com/apis/module/deletemodule.md): Deletes a module by its UUID. ### Fetch paginated modules - [POST /api/v2/modules/index](https://developer.caraer.com/apis/module/getmodules.md): Retrieves a paginated list of modules. ### Create a new module - [POST /api/v2/modules](https://developer.caraer.com/apis/module/createmodule.md): Creates a new module. ## Views Views are saved configurations for displaying Records that define filters, sorting, visible properties (show), grouping, calculations, row heights, and display traits (table, flow). Views enable users to create custom perspectives on data (e.g., "My Active Candidates", "High Priority Vacancies", "Recent Applications"). Each View belongs to a CaraerObject and specifies how Records of that Object should be displayed. Views can be shared with other users, set as default views, and include query strings for search functionality. Views support different traits like Table (tabular display), Flow (kanban-style workflow), and can include calculations for aggregated data. Views improve UX by allowing users to bookmark common queries and share them with team members, ensuring consistent data presentation across the platform. ### Get view details - [GET /api/v2/objects/{objectUuid}/views/{viewUuid}](https://developer.caraer.com/apis/views/getview.md): Retrieves detailed information for a view identified by its UUID for the specified object. Returns a ShowResponse containing the ViewDTO. ### Update an existing view - [PUT /api/v2/objects/{objectUuid}/views/{viewUuid}](https://developer.caraer.com/apis/views/updateview.md): Updates the details of an existing view identified by its UUID for the specified object. The request body must contain the updated view details as a ViewDTO. Returns an UpdateResponse with the updated view data. ### Delete a view - [DELETE /api/v2/objects/{objectUuid}/views/{viewUuid}](https://developer.caraer.com/apis/views/deleteview.md): Deletes the view identified by its UUID from the specified object. Returns a DeleteResponse confirming the deletion. ### Toggle view favorite status - [PUT /api/v2/objects/{objectUuid}/views/{viewUuid}/favorite](https://developer.caraer.com/apis/views/favoriteview.md): Toggles the favorite status of the specified view. Returns an UpdateResponse containing the updated view details. ### Update view indices - [PUT /api/v2/objects/{objectUuid}/views/updateIndices](https://developer.caraer.com/apis/views/updateindices_1.md): Updates the indices for views associated with the specified object. The request body must include a mapping of view UUIDs to their new index values. Returns a SuccessResponse with the updated view DTOs. ### Fetch paginated views for an object - [POST /api/v2/objects/{objectUuid}/views/index](https://developer.caraer.com/apis/views/getviews.md): Retrieves a paginated list of views for the specified object. A custom Cypher query is used to filter views based on the object's UUID. Returns a PaginationResponse containing ViewDTO objects. ### Create a new view - [POST /api/v2/objects/{objectUuid}/views](https://developer.caraer.com/apis/views/createview.md): Creates a new view for the specified object. The request body must contain the view details as a ViewDTO. Returns a CreateResponse containing the newly created view as a ViewDTO. ## Records Records are actual data instances belonging to a CaraerObject. They contain property values that conform to the object's schema defined by Properties. Records support dynamic relationships via Relations, enabling graph-like data modeling where Records can reference and navigate to related Records. Records can be filtered, sorted, paginated, and displayed in various views (table, flow, page, preview). They support morphing (association with multiple objects), soft deletion with restore capability, and property parsing for formatted display. Records are the core data entities that users create, update, and manage. Each Record has a UUID, belongs to a primary Object, can have morph objects (making it visible in multiple object contexts), and maintains createdAt/updatedAt timestamps. Records enable the platform's dynamic, content-driven data management. ### Update a record - [PUT /api/v2/records/{objectName}/{uuid}](https://developer.caraer.com/apis/records/update.md): Updates a record's details identified by its UUID. The record data is provided as a RecordDTO. Returns an UpdateResponse with the updated record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. ### Restore a deleted record - [POST /api/v2/records/{uuid}/restore](https://developer.caraer.com/apis/records/restore.md): Restores a soft-deleted record identified by its UUID. Returns a SuccessResponse confirming that the record has been restored. ### Morph a record - [POST /api/v2/records/{uuid}/morph](https://developer.caraer.com/apis/records/morph.md): Morphs a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it'll be visible in the new object.Returns a SuccessResponse confirming that the record has been morphed. ### Create a new record - [POST /api/v2/records/{objectName}](https://developer.caraer.com/apis/records/create.md): Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. ### Create or update a record - [POST /api/v2/records/{objectName}/createOrUpdate](https://developer.caraer.com/apis/records/createorupdate.md): Creates a new record or updates an existing one based on uniqueness criteria for the given object. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc. ### Search records - [POST /api/v2/records/search](https://developer.caraer.com/apis/records/search.md): Performs a search for records based on the specified criteria in the request body. Returns a PaginationResponse containing matching records. ### Create a relation between records - [POST /api/v2/records/relations/{fromUuid}/{relationName}/{toUuid}](https://developer.caraer.com/apis/records/createrelation.md): Creates a relation between two records identified by their UUIDs using the provided relation name. ### Delete a relation between records - [DELETE /api/v2/records/relations/{fromUuid}/{relationName}/{toUuid}](https://developer.caraer.com/apis/records/deleterelation.md): Deletes a relation between two records identified by their UUIDs and the relation name. ### Fetch paginated records - [POST /api/v2/records/index](https://developer.caraer.com/apis/records/index.md): Retrieves a paginated list of records. If a preview type is specified in the request, returns records formatted for preview; otherwise, returns full record details. ### Fetch records for table view - [POST /api/v2/records/index/table](https://developer.caraer.com/apis/records/indextable.md): Retrieves records formatted for table display. Returns a PaginationResponse containing records formatted for table view. ### Fetch records for page view - [POST /api/v2/records/index/page](https://developer.caraer.com/apis/records/indexpage.md): Retrieves a paginated list of webpages for page view. The search query is temporarily removed from the pagination request and passed separately. Returns a PaginationResponse containing WebpageDTO objects. ### Fetch records for flow view - [POST /api/v2/records/index/flow](https://developer.caraer.com/apis/records/indexflow.md): Retrieves a list of records formatted for flow view based on a specific property. If the property is not provided in the request, defaults to the 'status' property of the main object. Returns a SuccessResponse containing the flow records. ### Get record details - [GET /api/v2/records/{uuid}](https://developer.caraer.com/apis/records/show_1.md): Retrieves detailed information about a record by its UUID. Returns a ShowResponse containing the record details. ### Delete a record - [DELETE /api/v2/records/{uuid}](https://developer.caraer.com/apis/records/delete.md): Deletes a record specified by its UUID. ### Get record preview - [GET /api/v2/records/{uuid}/previews/{name}](https://developer.caraer.com/apis/records/preview.md): Retrieves a preview for a record specified by its UUID and preview name. Returns a ShowResponse containing the preview data. ## Traits Traits are behavioral features that can be added to CaraerObjects to extend their functionality without modifying the core schema. Common traits include Flow (kanban-style workflow management), Table (tabular data display with sorting and filtering), Page (enables Records to have public-facing Webpages), and User (enables user authentication and user profile Records). Traits are composable - an Object can have multiple traits enabled simultaneously. Traits extend object functionality by adding specific behaviors, UI components, and capabilities. For example, the Flow trait adds workflow state management, the Table trait adds list view capabilities, and the Page trait enables CMS functionality. Traits enable flexible feature composition where objects can be customized with different capabilities based on business needs. ### Fetch a specific trait for an object - [GET /api/v2/traits/{objectUuid}/{traitName}](https://developer.caraer.com/apis/traits/gettrait.md): Retrieves details of a specific trait associated with the specified object, identified by the trait name. Returns a ShowResponse containing the TraitDTO. If the trait is not found, a NotFoundError is thrown. ### Create or update a trait for an object - [POST /api/v2/traits/{objectUuid}/{traitName}](https://developer.caraer.com/apis/traits/createtrait.md): Creates a new trait or updates an existing trait for the specified object. The trait name is provided in the URL, and trait details are supplied in the request body as a JSON map. If a trait with the specified name exists, it will be updated; otherwise, a new trait is created. Returns a CreateResponse containing the TraitDTO of the created or updated trait. ### Delete a trait from an object - [DELETE /api/v2/traits/{objectUuid}/{traitName}](https://developer.caraer.com/apis/traits/deletetrait.md): Removes a trait identified by its name from the specified object. Returns a DeleteResponse confirming that the trait has been removed. ### Fetch all traits for an object - [GET /api/v2/traits/{objectUuid}](https://developer.caraer.com/apis/traits/gettraits.md): Retrieves a list of traits associated with the specified object. Returns a paginated response containing TraitDTO objects. The page is set to 0 by default, with a maximum limit of 100. ## Webpages Webpages are CMS pages associated with Records that enable public-facing content. They support dynamic content layouts using PageContent structures, preview and production environments, scheduled publishing (publishAt/unpublishAt), SEO metadata (title, excerpt, slug, image), custom CSS and JavaScript, and sidebar previews. Webpages are used to create career sites, landing pages, job detail pages, and other public-facing content. They integrate with Forms for data collection and Previews for displaying related Records. Webpages can be published/unpublished, support environment-specific content (preview vs production), and maintain publication timestamps. The Webpage system enables dynamic, data-driven public websites where content is managed through Records and automatically rendered as HTML pages. ### Get webpage details - [GET /api/v2/webpages/{uuid}](https://developer.caraer.com/apis/webpages/getwebpage.md): Retrieves detailed information for a webpage identified by its UUID. Optionally, the webpage title is 'smartened' if the smartened parameter is true. ### Update a webpage - [PUT /api/v2/webpages/{uuid}](https://developer.caraer.com/apis/webpages/updatewebpage.md): Updates an existing webpage identified by its UUID using the provided webpage details. Returns an UpdateResponse containing the updated webpage as a WebpageDTO. Validation: Webpage fields are validated according to the Webpage validation rules. Required fields and format constraints are enforced. ### Unpublish a webpage - [PUT /api/v2/webpages/{uuid}/unpublish](https://developer.caraer.com/apis/webpages/unpublishwebpage.md): Unpublishes a webpage by its UUID. Optionally, an unpublishAt timestamp (in seconds) may be provided. Returns an UpdateResponse containing the unpublished webpage details. ### Publish a webpage - [PUT /api/v2/webpages/{uuid}/publish](https://developer.caraer.com/apis/webpages/publishwebpage.md): Publishes a webpage by its UUID. Optionally, a publishAt timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details. ### Upload a file for a webpage - [POST /api/v2/webpages/{uuid}/uploadFile](https://developer.caraer.com/apis/webpages/uploadfile.md): Uploads a file to S3 storage under the specified webpage's attachments folder, sets the file's ACL to public, and returns the public URL for the file in a SuccessResponse. ### Copy a webpage from one environment to another - [POST /api/v2/webpages/{uuid}/copy/{fromEnvironment}/{toEnvironment}](https://developer.caraer.com/apis/webpages/copywebpage.md): Copies a webpage by its UUID from one environment to another. Returns a CreateResponse containing the copied webpage as a WebpageDTO. ### Upload a file - [POST /api/v2/webpages/uploadFile](https://developer.caraer.com/apis/webpages/uploadfile_1.md): Uploads a file to S3 storage and returns the public URL for the file in a SuccessResponse. ### Get template webpage - [GET /api/v2/webpages/template/{objectName}/{environment}](https://developer.caraer.com/apis/webpages/gettemplatewebpage.md): Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data. ### Create or update template webpage - [POST /api/v2/webpages/template/{objectName}/{environment}](https://developer.caraer.com/apis/webpages/createorupdatetemplatewebpage.md): Creates a new or updates an existing template webpage for the specified object. An event is published after the template is changed. Returns an UpdateResponse or CreateResponse with the template webpage details. ### Get previews for a public webpage - [POST /api/v2/webpages/public/previews/{pageUuid}/{componentUuid}/{layout}](https://developer.caraer.com/apis/webpages/getpublicpreviews.md): Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects. ### Get all environments - [GET /api/v2/webpages/environments](https://developer.caraer.com/apis/webpages/getenvironments.md): Retrieves a list of all environments. ### Create an environment - [POST /api/v2/webpages/environments](https://developer.caraer.com/apis/webpages/createenvironments.md): Creates an environment. ### Create a new webpage - [POST /api/v2/webpages](https://developer.caraer.com/apis/webpages/createwebpage.md): Creates a new webpage using the provided webpage details. Returns a CreateResponse containing the newly created webpage as a WebpageDTO. Validation: Webpage fields are validated according to the Webpage validation rules. Required fields and format constraints are enforced. ### Get a public webpage by slug - [GET /api/v2/webpages/public/{rootSlug}/{slug}](https://developer.caraer.com/apis/webpages/getpublicwebpage.md): Retrieves a published webpage based on the provided root slug and slug. Returns a ShowResponse containing WebpageDTO data. ### Get all public webpage slugs - [GET /api/v2/webpages/public/getSlugs](https://developer.caraer.com/apis/webpages/getallslugs.md): Retrieves a list of all webpage slugs for the public site. Returns a PaginationResponse containing WebpageMapItemDTO objects. ### Fetch public web menus - [GET /api/v2/webpages/public/getMenus](https://developer.caraer.com/apis/webpages/getmenus.md): Retrieves a list of web menus for the public site. Returns a PaginationResponse containing WebMenuDTO objects. ### Fetch public company settings - [GET /api/v2/webpages/public/companySettings](https://developer.caraer.com/apis/webpages/getcompanysettings.md): Retrieves the public company configuration for the given subdomain. Returns a ShowResponse containing PublicCompanyDTO details. ## Property Properties define the schema and field definitions for CaraerObjects. A Property specifies the data type (string, number, date, boolean, etc.), format (text, email, select, multi-select, linked, file, etc.), validation rules (required, unique, character limits, etc.), and display options (label, description, icon, groups). Properties determine what data Records can store, how it's validated, how it's displayed in forms and views, and how it can be searched. Each Property belongs to a CaraerObject and defines one field in that object's schema. Properties support various formats including linked properties (relationships to other Records), file uploads, rich text, and custom option lists. Properties are immutable once created to maintain data integrity, and they can be organized into groups for better UX. The Property system enables dynamic, schema-on-read data modeling where object structures can be customized per company without code changes. ### Fetch a specific property - [GET /api/v2/objects/{objectUuid}/properties/{propertyUuid}](https://developer.caraer.com/apis/property/getproperty.md): Retrieves details of a property by its UUID and associates it with its parent object. Returns a ShowResponse containing a PropertyDTO object with complete property details. ### Update an existing property - [PUT /api/v2/objects/{objectUuid}/properties/{propertyUuid}](https://developer.caraer.com/apis/property/updateproperty.md): Updates the details of an existing property for a specific object. The property details are provided via SavePropertyDTO, and the property is identified by its UUID. Returns an UpdateResponse containing the updated property as a PropertyDTO. Validation rules: name (required, must be unique, must be lowercase, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), label (required), description (maximum 255 characters), type (required, must be one of valid PropertyTypes, cannot be changed after creation), format (required, must be one of valid PropertyFormats, cannot be changed after creation), rules (required, must be an array of string). ### Delete a property - [DELETE /api/v2/objects/{objectUuid}/properties/{propertyUuid}](https://developer.caraer.com/apis/property/deleteproperty.md): Deletes a property from the specified object, identified by the property UUID. Returns a DeleteResponse containing the deleted property's details. ### Update property indices - [PUT /api/v2/objects/{objectUuid}/properties/updateIndices](https://developer.caraer.com/apis/property/updateindices_2.md): Updates the indices for properties of a specific object. The request body should contain a mapping between property UUIDs and their new index values. Returns a SuccessResponse containing a list of updated PropertyDTO objects. ### Restore a soft-deleted property - [POST /api/v2/objects/{objectUuid}/properties/{propertyUuid}/restore](https://developer.caraer.com/apis/property/restoreproperty.md): Restores a previously deleted property by propertyUuid for the specified objectUuid. Returns a RestoreResponse containing the restored property details. ### Fetch paginated properties - [POST /api/v2/objects/{objectUuid}/properties/index](https://developer.caraer.com/apis/property/getproperties.md): Retrieves a paginated list of properties for a given object. Depending on the object UUID format, a Cypher query is constructed to filter properties belonging to that object. Returns a PaginationResponse containing PropertyDTO objects. ### Create a new property - [POST /api/v2/objects/{objectUuid}/properties](https://developer.caraer.com/apis/property/createproperty.md): Creates a new property for a specific object using the provided property details. The SavePropertyDTO must include necessary details, and the object association is determined by the objectUuid path variable. Returns a CreateResponse containing the newly created property as a PropertyDTO. Validation rules: name (required, must be unique, must be lowercase, must match name pattern (lowercase letters, numbers, underscores)), label (required), description (maximum 255 characters), type (required, must be one of valid PropertyTypes, cannot be changed after creation), format (required, must be one of valid PropertyFormats, cannot be changed after creation), rules (required, must be an array of string). ### Retrieve property formats - [GET /api/v2/objects/{objectUuid}/properties/formats](https://developer.caraer.com/apis/property/getformats.md): Fetches a sorted list of available property formats. The formats are retrieved from the PropertyFormats enum and converted to PropertyFormat instances. ## Automations Endpoints for Caraer Automations and Latenode integration. ### Get Latenode JWT token for current user - [GET /api/v2/automations/token](https://developer.caraer.com/apis/automations/gettoken.md): Generates a short-lived Latenode JWT token for the authenticated user, to be used with the Latenode embedded SDK. ## Applications Apps are third-party integrations and extensions that extend Caraer functionality. They can provide additional features, connect to external services, include Webhooks for event handling, and offer custom UI components through AppBars. Apps enable the platform ecosystem where companies can integrate with their existing tools and workflows. Apps can be public (available to all companies) or private (company-specific), have pricing models, descriptions, and settings schemas. Apps can include Webhooks with rate limiting and secret-based authentication. The App system enables extensibility and integration capabilities, allowing the platform to connect with external systems and provide additional functionality beyond the core platform features. ### Update a webhook for an app - [PUT /api/v2/apps/{appUuid}/webhooks/{webhookUuid}](https://developer.caraer.com/apis/applications/updateappwebhookforapp.md): Updates an existing webhook that belongs to the specified app and the authenticated user's selected company. ### Delete a webhook for an app - [DELETE /api/v2/apps/{appUuid}/webhooks/{webhookUuid}](https://developer.caraer.com/apis/applications/deleteappwebhook.md): Deletes a webhook that belongs to the specified app and the authenticated user's selected company. ### Get a public app (creator view) - [GET /api/v2/apps/public/{uuid}](https://developer.caraer.com/apis/applications/getpublicapp.md): Gets the full app for the creator, including appPublish, appBars, details, and pricing. Returns AppCreatorDTO with everything under App. ### Update a public app (creator edit) - [PUT /api/v2/apps/public/{uuid}](https://developer.caraer.com/apis/applications/updatepublicapp.md): Updates a public app with the full creator payload (label, description, details, pricing, settingsSchema, appBars). Send the entire AppCreatorDTO as returned by GET. Returns the updated app as AppCreatorDTO. ### Uninstall an application - [POST /api/v2/apps/{uuid}/uninstall](https://developer.caraer.com/apis/applications/uninstallapp.md): Removes the installed application specified by its UUID using the provided settings. The request body should contain an AppRequest with the uninstallation settings. Returns the updated application details as a ShowResponse wrapping an AppDTO. ### Rotate application configurations - [POST /api/v2/apps/{uuid}/rotate](https://developer.caraer.com/apis/applications/rotateapp.md): Rotates the configuration or settings for the specified application by UUID. On success, returns the updated application details as a ShowResponse wrapping an AppDTO. ### Install an application - [POST /api/v2/apps/{uuid}/install](https://developer.caraer.com/apis/applications/installapp.md): Installs the application specified by its UUID with optional initial configuration settings. Returns the updated application details as a ShowResponse wrapping an AppDTO. ### Create a webhook for an app (app-scoped path) - [POST /api/v2/apps/{appUuid}/webhooks](https://developer.caraer.com/apis/applications/createappwebhookforapp.md): Creates a new webhook for the specified app using normal bearer authentication. The app must be installed for the authenticated user's selected company. This endpoint is an app-scoped equivalent of the generic webhook creation endpoint. ### Test a webhook for an app - [POST /api/v2/apps/{appUuid}/webhooks/test/{webhookUuid}/{recordUuid}/{eventType}](https://developer.caraer.com/apis/applications/testappwebhook.md): Triggers a test event for a webhook belonging to the specified app and company. Uses the same payload generation logic as the generic webhook test endpoint. ### Retrieve a paginated list of webhooks for an app - [POST /api/v2/apps/{appUuid}/webhooks/index](https://developer.caraer.com/apis/applications/getappwebhooks.md): Fetches a paginated and optionally filtered list of webhooks associated with the specified app and the authenticated user's selected company. ### Create a public app - [POST /api/v2/apps/public](https://developer.caraer.com/apis/applications/createpublicapp.md): Creates a new public app with the provided label and optional description. Public apps are automatically published for the creating user's company. Returns the created app details as a CreateResponse wrapping an AppDTO. ### Submit a public app for review - [POST /api/v2/apps/public/{uuid}/submit](https://developer.caraer.com/apis/applications/submitpublicapp.md): Submits a public app specified by its UUID for review. Returns the submitted app details as a ShowResponse wrapping an AppDTO. ### Review a public app - [POST /api/v2/apps/public/{uuid}/review](https://developer.caraer.com/apis/applications/reviewpublicapp.md): Sets review outcome (approve/reject/changes requested), feedback, and optional reviewer notes. Returns the updated app details as a ShowResponse wrapping an AppDTO. ### Create a private app - [POST /api/v2/apps/private](https://developer.caraer.com/apis/applications/createprivateapp.md): Creates a new private app with the provided label and optional description. Private apps are automatically installed for the creating user's company. Returns the created app details as a CreateResponse wrapping an AppDTO. ### Retrieve apps created by the logged-in user's selected company - [POST /api/v2/apps/my/index](https://developer.caraer.com/apis/applications/getmycreatedapps.md): Fetches a paginated and optionally filtered list of apps where the selected company is the creator. Returns a PaginationResponse containing AppDTO objects. ### Retrieve a paginated list of applications - [POST /api/v2/apps/index](https://developer.caraer.com/apis/applications/getapps.md): Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects. ### Retrieve application details by UUID - [GET /api/v2/apps/{uuid}](https://developer.caraer.com/apis/applications/getapp.md): Fetches details about an application specified by its UUID. Returns the application details as a ShowResponse wrapping an AppDetailDTO. ### Get available webhook formats - [GET /api/v2/apps/{appUuid}/webhooks/formats](https://developer.caraer.com/apis/applications/getwebhookformats.md): Returns all supported webhook payload formats with their details. ### Get available webhook record events - [GET /api/v2/apps/{appUuid}/webhooks/events](https://developer.caraer.com/apis/applications/getwebhookevents.md): Returns all supported record webhook events with their details. ### Get current user's company information - [GET /api/v2/apps/{appUuid}/me](https://developer.caraer.com/apis/applications/getcompanyinformation.md): Retrieves the company information of the authenticated user. The response includes public details of the user's selected company. ## Company Companies represent multi-tenant organizations in Caraer. Each company has its own isolated database, users, objects, Records, and data. Companies enable SaaS multi-tenancy where each organization's data is completely isolated from others. Companies have settings (branding, configuration), subdomains for custom URLs, and can be customized with their own Objects, Properties, Forms, and Webpages. Users belong to one or more companies and can switch between them. Companies maintain their own access control, scopes, and permissions. The Company system enables the platform to serve multiple organizations while maintaining strict data isolation and allowing each company to customize the platform to their needs. ### Get company by UUID - [GET /api/v2/company/{uuid}](https://developer.caraer.com/apis/company/getcompanybyuuid.md): Returns a company by its UUID. Requires TOOLS_COMPANY_SETTINGS_READ scope. ### Update company - [PUT /api/v2/company/{uuid}](https://developer.caraer.com/apis/company/updatecompany.md): Updates a company by UUID. Request body should contain the company fields to update. ### Get website settings - [GET /api/v2/company/website-settings](https://developer.caraer.com/apis/company/getwebsitesettings.md): Returns the website settings for the company currently selected by the logged-in user. ### Update website settings - [PUT /api/v2/company/website-settings](https://developer.caraer.com/apis/company/updatewebsitesettings.md): Updates the website settings for the company currently selected by the logged-in user. ### Get digital identity - [GET /api/v2/company/digital-identity](https://developer.caraer.com/apis/company/getdigitalidentity.md): Returns the digital identity (branding) for the company currently selected by the logged-in user. ### Update digital identity - [PUT /api/v2/company/digital-identity](https://developer.caraer.com/apis/company/updatedigitalidentity.md): Updates the digital identity (branding) for the company currently selected by the logged-in user. ### Get current company - [GET /api/v2/company](https://developer.caraer.com/apis/company/getcompany.md): Returns the company currently selected by the logged-in user. Requires TOOLS_COMPANY_SETTINGS_READ scope. ### Create a new company - [POST /api/v2/company](https://developer.caraer.com/apis/company/createcompany.md): Creates a new company based on the provided request data. ## Objects CaraerObjects are schema definitions for dynamic domain entities (e.g., "Candidate", "Vacancy", "Company"). They define the structure and behavior of Records through Properties (field definitions), Relations (connections to other objects), Views (display configurations), and Traits (behavioral features like Flow, Table, Webpage, User). Objects enable a flexible, schema-on-read data model where entities can be customized per company without code changes. Each Object has a name (lowercase identifier), label (display name), plural form, description, icon, and can be organized into groups. Objects can have traits that add specific behaviors: Flow enables kanban-style workflows, Table provides tabular data views, Webpage allows Records to have public-facing pages, and User enables authentication and user profiles. Objects are the foundation of the platform's dynamic data modeling system. ### Get object by UUID - [GET /api/v2/objects/{uuid}](https://developer.caraer.com/apis/objects/getobject.md): Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. ### Update object by UUID - [PUT /api/v2/objects/{uuid}](https://developer.caraer.com/apis/objects/updateobject.md): Updates an existing object identified by its UUID with new details. Optional parameters determine if views, properties, and relations should be included in the response. Validation rules: label (required, must be a string, maximum 32 characters), plural (required, must be a string, maximum 32 characters), name (required, must be a string, must be lowercase, must be unique, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), description (optional, maximum 255 characters), groups (required, must be an array of string, no duplicate values allowed), showInMenu (required, must be a boolean). ### Delete object by UUID - [DELETE /api/v2/objects/{uuid}](https://developer.caraer.com/apis/objects/deleteobject.md): Deletes a specific object identified by its UUID. ### Update object indices - [PUT /api/v2/objects/updateIndices](https://developer.caraer.com/apis/objects/updateindices_3.md): Updates indices of objects based on the provided mapping. The request body should contain a mapping of object UUIDs to index values. Optional request parameters determine if views, properties, and relations should be included in the response. ### Get specific preview by name - [GET /api/v2/objects/{uuid}/previews/{name}](https://developer.caraer.com/apis/objects/getpreview.md): Fetches a preview for an object by the object's UUID and the preview name. Returns the preview data wrapped in a ShowResponse. ### Save object preview - [POST /api/v2/objects/{uuid}/previews/{name}](https://developer.caraer.com/apis/objects/savepreview.md): Creates or updates a preview for a specific object. The preview type is determined by the 'name' path variable. Depending on the preview type (e.g., 'detail', 'flow', 'pill', or 'page'), the request body will be mapped to the corresponding PreviewDTO and converted to the appropriate Preview model. ### Get all previews over all objects - [POST /api/v2/objects/previews](https://developer.caraer.com/apis/objects/getpreviews.md): Fetches all previews over all objects. Returns a PaginationResponse containing a list of preview DTOs. ### Fetch paginated objects - [POST /api/v2/objects/index](https://developer.caraer.com/apis/objects/getobjects.md): Fetches a paginated list of objects, optionally including views, properties, and/or relations. The request body should contain pagination details such as limit, page, filters, sort, and query. ### Create new object - [POST /api/v2/objects](https://developer.caraer.com/apis/objects/createobject.md): Creates a new Caraer object using the provided details. Optional request parameters specify whether to include views, properties, and relations in the response. Validation rules: label (required, must be a string, maximum 32 characters), plural (required, must be a string, maximum 32 characters), name (required, must be a string, must be lowercase, must be unique, must match name pattern (lowercase letters, numbers, underscores)), description (optional, maximum 255 characters), groups (required, must be an array of string, no duplicate values allowed), showInMenu (required, must be a boolean). ### Get all previews of an object - [GET /api/v2/objects/{uuid}/previews](https://developer.caraer.com/apis/objects/getpreviews_1.md): Fetches all previews associated with a specific object. Returns a PaginationResponse containing a list of preview DTOs.