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.
Caraer API Documentation (1.8.9)
Download OpenAPI description
Languages
Servers
Mock server
https://developer.caraer.com/_mock/apis
Production
https://v2.api.caraer.com
Auth endpoints handle user authentication and session management. They support login (email/password), registration, password reset (request and reset), email verification (verify and resend), logout, company selection, and user profile retrieval (/me). Authentication uses Bearer tokens and integrates with the multi-tenant company system, allowing users to access multiple companies. The auth system manages user sessions, email verification tokens, password reset tokens, and company access. Auth endpoints temporarily disable scope violation tracking during authentication operations to allow unauthenticated access to login/register endpoints.
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.
Operations
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.
Operations
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.
Operations
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/{formUuid}
- Productionhttps://v2.api.caraer.com/api/v2/forms/{formUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.caraer.com/_mock/apis/api/v2/forms/{formUuid}' \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>'Response
application/json
{ "message": "Success", "data": null }
Request
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.
Security
bearerAuth
List of form items that make up the form's structure. Each grid represents a section or group of form elements
List of lead scoring rules associated with this form. Used to evaluate and score form submissions
List of form relations that define the relationships between this form conversion record and other records in the system
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/{formUuid}
- Productionhttps://v2.api.caraer.com/api/v2/forms/{formUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://developer.caraer.com/_mock/apis/api/v2/forms/{formUuid}' \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"object": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"favorite": true,
"team": true,
"shared": true,
"personal": true,
"trait": "string",
"filters": {
"groups": [
{
"items": {}
}
]
},
"shows": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"separator": "|",
"sticky": false,
"width": 100,
"calculationFunction": "max",
"calculationResult": 100
}
],
"sorts": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"direction": "ASC"
}
],
"limit": 0,
"showIcons": true,
"rowHeight": "string",
"query": "string",
"icon": "string",
"flowProperty": "string",
"flowPreview": "string",
"defaultView": true,
"isInternallyPublic": true
}
],
"properties": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
{
"name": "string",
"label": "string",
"icon": "string",
"color": "string",
"disabled": true,
"usedIn": {
"recordUuids": [
null
],
"count": 0
}
}
],
"group": "string",
"format": {
"label": "string",
"name": "string",
"icon": "string",
"type": "string",
"settings": [
{
"name": "string",
"label": "string",
"helpText": "string",
"type": "STRING",
"required": true,
"dynamic": true,
"hidden": true,
"disabled": true,
"options": [
null
],
"value": null,
"defaultValue": null
}
],
"filters": [
"string"
],
"rules": [
"string"
]
},
"rules": [
"string"
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {
"property1": null,
"property2": null
},
"usedIn": {
"recordUuids": [
"string"
],
"count": 0
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {
"t1": 0,
"t2": 0
}
}
],
"relations": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{}
],
"immutable": true,
"editable": true
}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
},
"grids": [
{
"aiprompt": "string",
"title": "string",
"description": "string",
"type": "string",
"AIPrompt": "string",
"grid": [
[
{
"property": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"properties": [],
"objects": {}
},
"updatedAt": 0,
"updatedBy": {
"properties": [],
"objects": {}
},
"deletedAt": 0,
"deletedBy": {
"properties": [],
"objects": {}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
null
],
"group": "string",
"format": {
"settings": [],
"filters": [],
"rules": []
},
"rules": [
null
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {},
"usedIn": {
"recordUuids": []
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {}
},
"text": "string",
"form": {},
"submitButton": "string",
"settings": {
"relation": {
"objects": []
},
"record": {
"properties": [],
"objects": {}
},
"aiprompt": "string",
"label": "string",
"defaultValue": "string",
"isRequired": true,
"hidden": true,
"placeholder": "string",
"helpText": "string",
"AIPrompt": "string",
"styling": "string",
"stretch": true,
"align": "string",
"rangeMin": 0,
"rangeMax": 0
},
"value": "string"
}
]
]
}
],
"description": "string",
"styling": "string",
"leadscores": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"relationIncluded": true,
"operator": "EQUALS",
"value": 12345,
"smartContent": true,
"smart_value": true,
"score": 10
}
],
"relations": [
{
"type": "CONVERSION_PAGE_RECORD",
"relation": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"shows": [],
"sorts": []
}
],
"properties": [
{
"options": [],
"rules": [],
"formatSettings": {}
}
],
"relations": [
{}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
}
],
"immutable": true,
"editable": true
},
"relatedRelation": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"shows": [],
"sorts": []
}
],
"properties": [
{
"options": [],
"rules": [],
"formatSettings": {}
}
],
"relations": [
{}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
}
],
"immutable": true,
"editable": true
},
"relatedObject": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"favorite": true,
"team": true,
"shared": true,
"personal": true,
"trait": "string",
"filters": {
"groups": [
null
]
},
"shows": [
{}
],
"sorts": [
{}
],
"limit": 0,
"showIcons": true,
"rowHeight": "string",
"query": "string",
"icon": "string",
"flowProperty": "string",
"flowPreview": "string",
"defaultView": true,
"isInternallyPublic": true
}
],
"properties": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
{}
],
"group": "string",
"format": {
"label": "string",
"name": "string",
"icon": "string",
"type": "string",
"settings": [
null
],
"filters": [
null
],
"rules": [
null
]
},
"rules": [
"string"
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {
"property1": null,
"property2": null
},
"usedIn": {
"recordUuids": [
null
],
"count": 0
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {
"t1": 0,
"t2": 0
}
}
],
"relations": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"description": "string",
"objects": [
{}
],
"immutable": true,
"editable": true
}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
},
"recordUuid": "fc453abc-123e-4567-890a-6789abcd1234",
"relatedObjectConnection": "PRIMARY"
}
],
"wizard": true,
"metadata": {
"property1": "string",
"property2": "string"
},
"thankYouMessage": "string",
"redirectUrl": "string"
}'Response
application/json
{ "message": "Success", "data": null }
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/{formUuid}
- Productionhttps://v2.api.caraer.com/api/v2/forms/{formUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://developer.caraer.com/_mock/apis/api/v2/forms/{formUuid}' \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>'Response
application/json
{ "message": "Success", "data": null }
Request
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.
Security
bearerAuth
any(PaginationRequest)
Pagination and filtering options for the request
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/{objectUuid}/index
- Productionhttps://v2.api.caraer.com/api/v2/forms/{objectUuid}/index
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.caraer.com/_mock/apis/api/v2/forms/{objectUuid}/index' \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"filters": [
{
"key": "name",
"operator": "contains",
"value": "example_value"
},
{
"key": "deletedAt",
"operator": "isnull"
}
],
"sort": [
{
"key": "createdAt",
"direction": "desc"
}
],
"show": [
"id",
"name",
"status",
"dateCreated"
],
"limit": 25,
"page": 1,
"query": "searchText"
}'Response
application/json
{ "message": "Success", "data": [ { … }, { … } ], "total": 100, "page": 1, "perPage": 10, "lastPage": 10 }
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/{formUuid}/restore
- Productionhttps://v2.api.caraer.com/api/v2/forms/{formUuid}/restore
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.caraer.com/_mock/apis/api/v2/forms/{formUuid}/restore' \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>'Response
application/json
{ "message": "Success", "data": null }
Request
When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
Security
bearerAuth
any(PaginationRequest)
Pagination and filtering options for the request
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/{propertyUuid}/options
- Productionhttps://v2.api.caraer.com/api/v2/forms/public/{companyUuid}/{propertyUuid}/options
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/{propertyUuid}/options' \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"filters": [
{
"key": "name",
"operator": "contains",
"value": "example_value"
},
{
"key": "deletedAt",
"operator": "isnull"
}
],
"sort": [
{
"key": "createdAt",
"direction": "desc"
}
],
"show": [
"id",
"name",
"status",
"dateCreated"
],
"limit": 25,
"page": 1,
"query": "searchText"
}'- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/{formUuid}/upload
- Productionhttps://v2.api.caraer.com/api/v2/forms/public/{companyUuid}/{formUuid}/upload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/{formUuid}/upload?files=string' \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>'Response
application/json
{ "message": "Success", "data": null }
Request
Submits a form with the provided data. Returns a SuccessResponse upon successful submission. When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
Security
bearerAuth
List of form items that make up the form's structure. Each grid represents a section or group of form elements
List of lead scoring rules associated with this form. Used to evaluate and score form submissions
List of form relations that define the relationships between this form conversion record and other records in the system
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/{formUuid}/submit
- Productionhttps://v2.api.caraer.com/api/v2/forms/public/{companyUuid}/{formUuid}/submit
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/{formUuid}/submit' \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"object": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"favorite": true,
"team": true,
"shared": true,
"personal": true,
"trait": "string",
"filters": {
"groups": [
{
"items": {}
}
]
},
"shows": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"separator": "|",
"sticky": false,
"width": 100,
"calculationFunction": "max",
"calculationResult": 100
}
],
"sorts": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"direction": "ASC"
}
],
"limit": 0,
"showIcons": true,
"rowHeight": "string",
"query": "string",
"icon": "string",
"flowProperty": "string",
"flowPreview": "string",
"defaultView": true,
"isInternallyPublic": true
}
],
"properties": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
{
"name": "string",
"label": "string",
"icon": "string",
"color": "string",
"disabled": true,
"usedIn": {
"recordUuids": [
null
],
"count": 0
}
}
],
"group": "string",
"format": {
"label": "string",
"name": "string",
"icon": "string",
"type": "string",
"settings": [
{
"name": "string",
"label": "string",
"helpText": "string",
"type": "STRING",
"required": true,
"dynamic": true,
"hidden": true,
"disabled": true,
"options": [
null
],
"value": null,
"defaultValue": null
}
],
"filters": [
"string"
],
"rules": [
"string"
]
},
"rules": [
"string"
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {
"property1": null,
"property2": null
},
"usedIn": {
"recordUuids": [
"string"
],
"count": 0
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {
"t1": 0,
"t2": 0
}
}
],
"relations": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{}
],
"immutable": true,
"editable": true
}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
},
"grids": [
{
"aiprompt": "string",
"title": "string",
"description": "string",
"type": "string",
"AIPrompt": "string",
"grid": [
[
{
"property": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"properties": [],
"objects": {}
},
"updatedAt": 0,
"updatedBy": {
"properties": [],
"objects": {}
},
"deletedAt": 0,
"deletedBy": {
"properties": [],
"objects": {}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
null
],
"group": "string",
"format": {
"settings": [],
"filters": [],
"rules": []
},
"rules": [
null
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {},
"usedIn": {
"recordUuids": []
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {}
},
"text": "string",
"form": {},
"submitButton": "string",
"settings": {
"relation": {
"objects": []
},
"record": {
"properties": [],
"objects": {}
},
"aiprompt": "string",
"label": "string",
"defaultValue": "string",
"isRequired": true,
"hidden": true,
"placeholder": "string",
"helpText": "string",
"AIPrompt": "string",
"styling": "string",
"stretch": true,
"align": "string",
"rangeMin": 0,
"rangeMax": 0
},
"value": "string"
}
]
]
}
],
"description": "string",
"styling": "string",
"leadscores": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"relationIncluded": true,
"operator": "EQUALS",
"value": 12345,
"smartContent": true,
"smart_value": true,
"score": 10
}
],
"relations": [
{
"type": "CONVERSION_PAGE_RECORD",
"relation": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"shows": [],
"sorts": []
}
],
"properties": [
{
"options": [],
"rules": [],
"formatSettings": {}
}
],
"relations": [
{}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
}
],
"immutable": true,
"editable": true
},
"relatedRelation": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"shows": [],
"sorts": []
}
],
"properties": [
{
"options": [],
"rules": [],
"formatSettings": {}
}
],
"relations": [
{}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
}
],
"immutable": true,
"editable": true
},
"relatedObject": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"favorite": true,
"team": true,
"shared": true,
"personal": true,
"trait": "string",
"filters": {
"groups": [
null
]
},
"shows": [
{}
],
"sorts": [
{}
],
"limit": 0,
"showIcons": true,
"rowHeight": "string",
"query": "string",
"icon": "string",
"flowProperty": "string",
"flowPreview": "string",
"defaultView": true,
"isInternallyPublic": true
}
],
"properties": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
{}
],
"group": "string",
"format": {
"label": "string",
"name": "string",
"icon": "string",
"type": "string",
"settings": [
null
],
"filters": [
null
],
"rules": [
null
]
},
"rules": [
"string"
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {
"property1": null,
"property2": null
},
"usedIn": {
"recordUuids": [
null
],
"count": 0
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {
"t1": 0,
"t2": 0
}
}
],
"relations": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"description": "string",
"objects": [
{}
],
"immutable": true,
"editable": true
}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
},
"recordUuid": "fc453abc-123e-4567-890a-6789abcd1234",
"relatedObjectConnection": "PRIMARY"
}
],
"wizard": true,
"metadata": {
"property1": "string",
"property2": "string"
},
"thankYouMessage": "string",
"redirectUrl": "string"
}'Response
application/json
{ "message": "Success", "data": null }
Request
When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
Security
bearerAuth
any(PaginationRequest)
Pagination and filtering options for the request
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/index
- Productionhttps://v2.api.caraer.com/api/v2/forms/public/{companyUuid}/index
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/index' \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"filters": [
{
"key": "name",
"operator": "contains",
"value": "example_value"
},
{
"key": "deletedAt",
"operator": "isnull"
}
],
"sort": [
{
"key": "createdAt",
"direction": "desc"
}
],
"show": [
"id",
"name",
"status",
"dateCreated"
],
"limit": 25,
"page": 1,
"query": "searchText"
}'Request
When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
Security
bearerAuth
List of form items that make up the form's structure. Each grid represents a section or group of form elements
List of lead scoring rules associated with this form. Used to evaluate and score form submissions
List of form relations that define the relationships between this form conversion record and other records in the system
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/ai/step/{stepTitle}/{prompt}
- Productionhttps://v2.api.caraer.com/api/v2/forms/public/{companyUuid}/ai/step/{stepTitle}/{prompt}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/ai/step/{stepTitle}/{prompt}' \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"object": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"favorite": true,
"team": true,
"shared": true,
"personal": true,
"trait": "string",
"filters": {
"groups": [
{
"items": {}
}
]
},
"shows": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"separator": "|",
"sticky": false,
"width": 100,
"calculationFunction": "max",
"calculationResult": 100
}
],
"sorts": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"direction": "ASC"
}
],
"limit": 0,
"showIcons": true,
"rowHeight": "string",
"query": "string",
"icon": "string",
"flowProperty": "string",
"flowPreview": "string",
"defaultView": true,
"isInternallyPublic": true
}
],
"properties": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
{
"name": "string",
"label": "string",
"icon": "string",
"color": "string",
"disabled": true,
"usedIn": {
"recordUuids": [
null
],
"count": 0
}
}
],
"group": "string",
"format": {
"label": "string",
"name": "string",
"icon": "string",
"type": "string",
"settings": [
{
"name": "string",
"label": "string",
"helpText": "string",
"type": "STRING",
"required": true,
"dynamic": true,
"hidden": true,
"disabled": true,
"options": [
null
],
"value": null,
"defaultValue": null
}
],
"filters": [
"string"
],
"rules": [
"string"
]
},
"rules": [
"string"
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {
"property1": null,
"property2": null
},
"usedIn": {
"recordUuids": [
"string"
],
"count": 0
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {
"t1": 0,
"t2": 0
}
}
],
"relations": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{}
],
"immutable": true,
"editable": true
}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
},
"grids": [
{
"aiprompt": "string",
"title": "string",
"description": "string",
"type": "string",
"AIPrompt": "string",
"grid": [
[
{
"property": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"properties": [],
"objects": {}
},
"updatedAt": 0,
"updatedBy": {
"properties": [],
"objects": {}
},
"deletedAt": 0,
"deletedBy": {
"properties": [],
"objects": {}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
null
],
"group": "string",
"format": {
"settings": [],
"filters": [],
"rules": []
},
"rules": [
null
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {},
"usedIn": {
"recordUuids": []
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {}
},
"text": "string",
"form": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"properties": [],
"objects": {}
},
"updatedAt": 0,
"updatedBy": {
"properties": [],
"objects": {}
},
"deletedAt": 0,
"deletedBy": {
"properties": [],
"objects": {}
},
"index": 0,
"object": {
"groups": [],
"traits": [],
"views": [],
"properties": [],
"relations": [],
"suites": [],
"extendsTo": []
},
"grids": [
null
],
"description": "string",
"styling": "string",
"leadscores": [
null
],
"relations": [
null
],
"wizard": true,
"metadata": {},
"thankYouMessage": "string",
"redirectUrl": "string"
},
"submitButton": "string",
"settings": {
"relation": {
"objects": []
},
"record": {
"properties": [],
"objects": {}
},
"aiprompt": "string",
"label": "string",
"defaultValue": "string",
"isRequired": true,
"hidden": true,
"placeholder": "string",
"helpText": "string",
"AIPrompt": "string",
"styling": "string",
"stretch": true,
"align": "string",
"rangeMin": 0,
"rangeMax": 0
},
"value": "string"
}
]
]
}
],
"description": "string",
"styling": "string",
"leadscores": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"relationIncluded": true,
"operator": "EQUALS",
"value": 12345,
"smartContent": true,
"smart_value": true,
"score": 10
}
],
"relations": [
{
"type": "CONVERSION_PAGE_RECORD",
"relation": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"shows": [],
"sorts": []
}
],
"properties": [
{
"options": [],
"rules": [],
"formatSettings": {}
}
],
"relations": [
{}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
}
],
"immutable": true,
"editable": true
},
"relatedRelation": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"shows": [],
"sorts": []
}
],
"properties": [
{
"options": [],
"rules": [],
"formatSettings": {}
}
],
"relations": [
{}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
}
],
"immutable": true,
"editable": true
},
"relatedObject": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"favorite": true,
"team": true,
"shared": true,
"personal": true,
"trait": "string",
"filters": {
"groups": [
null
]
},
"shows": [
{}
],
"sorts": [
{}
],
"limit": 0,
"showIcons": true,
"rowHeight": "string",
"query": "string",
"icon": "string",
"flowProperty": "string",
"flowPreview": "string",
"defaultView": true,
"isInternallyPublic": true
}
],
"properties": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
{}
],
"group": "string",
"format": {
"label": "string",
"name": "string",
"icon": "string",
"type": "string",
"settings": [
null
],
"filters": [
null
],
"rules": [
null
]
},
"rules": [
"string"
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {
"property1": null,
"property2": null
},
"usedIn": {
"recordUuids": [
null
],
"count": 0
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {
"t1": 0,
"t2": 0
}
}
],
"relations": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"description": "string",
"objects": [
{}
],
"immutable": true,
"editable": true
}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
},
"recordUuid": "fc453abc-123e-4567-890a-6789abcd1234",
"relatedObjectConnection": "PRIMARY"
}
],
"wizard": true,
"metadata": {
"property1": "string",
"property2": "string"
},
"thankYouMessage": "string",
"redirectUrl": "string",
"aiPrompt": "string"
}'Request
When X-CARAER-TOKEN or X-Caraer-Company-Uuid is sent, that value selects the tenant company and overrides the companyUuid path segment.
Security
bearerAuth
List of form items that make up the form's structure. Each grid represents a section or group of form elements
List of lead scoring rules associated with this form. Used to evaluate and score form submissions
List of form relations that define the relationships between this form conversion record and other records in the system
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/ai/field/{fieldUuid}/{prompt}
- Productionhttps://v2.api.caraer.com/api/v2/forms/public/{companyUuid}/ai/field/{fieldUuid}/{prompt}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/ai/field/{fieldUuid}/{prompt}' \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"object": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"favorite": true,
"team": true,
"shared": true,
"personal": true,
"trait": "string",
"filters": {
"groups": [
{
"items": {}
}
]
},
"shows": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"separator": "|",
"sticky": false,
"width": 100,
"calculationFunction": "max",
"calculationResult": 100
}
],
"sorts": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"direction": "ASC"
}
],
"limit": 0,
"showIcons": true,
"rowHeight": "string",
"query": "string",
"icon": "string",
"flowProperty": "string",
"flowPreview": "string",
"defaultView": true,
"isInternallyPublic": true
}
],
"properties": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
{
"name": "string",
"label": "string",
"icon": "string",
"color": "string",
"disabled": true,
"usedIn": {
"recordUuids": [
null
],
"count": 0
}
}
],
"group": "string",
"format": {
"label": "string",
"name": "string",
"icon": "string",
"type": "string",
"settings": [
{
"name": "string",
"label": "string",
"helpText": "string",
"type": "STRING",
"required": true,
"dynamic": true,
"hidden": true,
"disabled": true,
"options": [
null
],
"value": null,
"defaultValue": null
}
],
"filters": [
"string"
],
"rules": [
"string"
]
},
"rules": [
"string"
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {
"property1": null,
"property2": null
},
"usedIn": {
"recordUuids": [
"string"
],
"count": 0
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {
"t1": 0,
"t2": 0
}
}
],
"relations": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{}
],
"immutable": true,
"editable": true
}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
},
"grids": [
{
"aiprompt": "string",
"title": "string",
"description": "string",
"type": "string",
"AIPrompt": "string",
"grid": [
[
{
"property": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"properties": [],
"objects": {}
},
"updatedAt": 0,
"updatedBy": {
"properties": [],
"objects": {}
},
"deletedAt": 0,
"deletedBy": {
"properties": [],
"objects": {}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
null
],
"group": "string",
"format": {
"settings": [],
"filters": [],
"rules": []
},
"rules": [
null
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {},
"usedIn": {
"recordUuids": []
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {}
},
"text": "string",
"form": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"properties": [],
"objects": {}
},
"updatedAt": 0,
"updatedBy": {
"properties": [],
"objects": {}
},
"deletedAt": 0,
"deletedBy": {
"properties": [],
"objects": {}
},
"index": 0,
"object": {
"groups": [],
"traits": [],
"views": [],
"properties": [],
"relations": [],
"suites": [],
"extendsTo": []
},
"grids": [
null
],
"description": "string",
"styling": "string",
"leadscores": [
null
],
"relations": [
null
],
"wizard": true,
"metadata": {},
"thankYouMessage": "string",
"redirectUrl": "string"
},
"submitButton": "string",
"settings": {
"relation": {
"objects": []
},
"record": {
"properties": [],
"objects": {}
},
"aiprompt": "string",
"label": "string",
"defaultValue": "string",
"isRequired": true,
"hidden": true,
"placeholder": "string",
"helpText": "string",
"AIPrompt": "string",
"styling": "string",
"stretch": true,
"align": "string",
"rangeMin": 0,
"rangeMax": 0
},
"value": "string"
}
]
]
}
],
"description": "string",
"styling": "string",
"leadscores": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"relationIncluded": true,
"operator": "EQUALS",
"value": 12345,
"smartContent": true,
"smart_value": true,
"score": 10
}
],
"relations": [
{
"type": "CONVERSION_PAGE_RECORD",
"relation": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"shows": [],
"sorts": []
}
],
"properties": [
{
"options": [],
"rules": [],
"formatSettings": {}
}
],
"relations": [
{}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
}
],
"immutable": true,
"editable": true
},
"relatedRelation": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"shows": [],
"sorts": []
}
],
"properties": [
{
"options": [],
"rules": [],
"formatSettings": {}
}
],
"relations": [
{}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
}
],
"immutable": true,
"editable": true
},
"relatedObject": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"favorite": true,
"team": true,
"shared": true,
"personal": true,
"trait": "string",
"filters": {
"groups": [
null
]
},
"shows": [
{}
],
"sorts": [
{}
],
"limit": 0,
"showIcons": true,
"rowHeight": "string",
"query": "string",
"icon": "string",
"flowProperty": "string",
"flowPreview": "string",
"defaultView": true,
"isInternallyPublic": true
}
],
"properties": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
{}
],
"group": "string",
"format": {
"label": "string",
"name": "string",
"icon": "string",
"type": "string",
"settings": [
null
],
"filters": [
null
],
"rules": [
null
]
},
"rules": [
"string"
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {
"property1": null,
"property2": null
},
"usedIn": {
"recordUuids": [
null
],
"count": 0
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {
"t1": 0,
"t2": 0
}
}
],
"relations": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"description": "string",
"objects": [
{}
],
"immutable": true,
"editable": true
}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
},
"recordUuid": "fc453abc-123e-4567-890a-6789abcd1234",
"relatedObjectConnection": "PRIMARY"
}
],
"wizard": true,
"metadata": {
"property1": "string",
"property2": "string"
},
"thankYouMessage": "string",
"redirectUrl": "string",
"aiPrompt": "string"
}'Request
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.
Security
bearerAuth
any(PaginationRequest)
Pagination and filtering options for the request
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/index
- Productionhttps://v2.api.caraer.com/api/v2/forms/index
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.caraer.com/_mock/apis/api/v2/forms/index \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"filters": [
{
"key": "name",
"operator": "contains",
"value": "example_value"
},
{
"key": "deletedAt",
"operator": "isnull"
}
],
"sort": [
{
"key": "createdAt",
"direction": "desc"
}
],
"show": [
"id",
"name",
"status",
"dateCreated"
],
"limit": 25,
"page": 1,
"query": "searchText"
}'Response
application/json
{ "message": "Success", "data": [ { … }, { … } ], "total": 100, "page": 1, "perPage": 10, "lastPage": 10 }
Request
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.
Security
bearerAuth
List of form items that make up the form's structure. Each grid represents a section or group of form elements
List of lead scoring rules associated with this form. Used to evaluate and score form submissions
List of form relations that define the relationships between this form conversion record and other records in the system
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms
- Productionhttps://v2.api.caraer.com/api/v2/forms
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.caraer.com/_mock/apis/api/v2/forms \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{
"items": {}
}
]
},
"property2": {
"groups": [
{
"items": {}
}
]
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"object": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": [
{}
]
},
"property2": {
"groups": [
{}
]
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"favorite": true,
"team": true,
"shared": true,
"personal": true,
"trait": "string",
"filters": {
"groups": [
{
"items": {}
}
]
},
"shows": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"separator": "|",
"sticky": false,
"width": 100,
"calculationFunction": "max",
"calculationResult": 100
}
],
"sorts": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"direction": "ASC"
}
],
"limit": 0,
"showIcons": true,
"rowHeight": "string",
"query": "string",
"icon": "string",
"flowProperty": "string",
"flowPreview": "string",
"defaultView": true,
"isInternallyPublic": true
}
],
"properties": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
{
"name": "string",
"label": "string",
"icon": "string",
"color": "string",
"disabled": true,
"usedIn": {
"recordUuids": [
null
],
"count": 0
}
}
],
"group": "string",
"format": {
"label": "string",
"name": "string",
"icon": "string",
"type": "string",
"settings": [
{
"name": "string",
"label": "string",
"helpText": "string",
"type": "STRING",
"required": true,
"dynamic": true,
"hidden": true,
"disabled": true,
"options": [
null
],
"value": null,
"defaultValue": null
}
],
"filters": [
"string"
],
"rules": [
"string"
]
},
"rules": [
"string"
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {
"property1": null,
"property2": null
},
"usedIn": {
"recordUuids": [
"string"
],
"count": 0
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {
"t1": 0,
"t2": 0
}
}
],
"relations": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{}
],
"immutable": true,
"editable": true
}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
},
"grids": [
{
"aiprompt": "string",
"title": "string",
"description": "string",
"type": "string",
"AIPrompt": "string",
"grid": [
[
{
"property": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"properties": [],
"objects": {}
},
"updatedAt": 0,
"updatedBy": {
"properties": [],
"objects": {}
},
"deletedAt": 0,
"deletedBy": {
"properties": [],
"objects": {}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
null
],
"group": "string",
"format": {
"settings": [],
"filters": [],
"rules": []
},
"rules": [
null
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {},
"usedIn": {
"recordUuids": []
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {}
},
"text": "string",
"form": {},
"submitButton": "string",
"settings": {
"relation": {
"objects": []
},
"record": {
"properties": [],
"objects": {}
},
"aiprompt": "string",
"label": "string",
"defaultValue": "string",
"isRequired": true,
"hidden": true,
"placeholder": "string",
"helpText": "string",
"AIPrompt": "string",
"styling": "string",
"stretch": true,
"align": "string",
"rangeMin": 0,
"rangeMax": 0
},
"value": "string"
}
]
]
}
],
"description": "string",
"styling": "string",
"leadscores": [
{
"object": "User",
"relation": "hasProperty",
"property": "email",
"relationIncluded": true,
"operator": "EQUALS",
"value": 12345,
"smartContent": true,
"smart_value": true,
"score": 10
}
],
"relations": [
{
"type": "CONVERSION_PAGE_RECORD",
"relation": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"shows": [],
"sorts": []
}
],
"properties": [
{
"options": [],
"rules": [],
"formatSettings": {}
}
],
"relations": [
{}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
}
],
"immutable": true,
"editable": true
},
"relatedRelation": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"description": "string",
"objects": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"shows": [],
"sorts": []
}
],
"properties": [
{
"options": [],
"rules": [],
"formatSettings": {}
}
],
"relations": [
{}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
}
],
"immutable": true,
"editable": true
},
"relatedObject": {
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
{
"icon": "string",
"name": "string",
"value": null,
"type": "string",
"label": "string"
}
],
"objects": {
"property1": null,
"property2": null
},
"user": {
"uuid": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"initials": "string",
"scopes": [
"string"
],
"filters": {
"property1": {
"groups": []
},
"property2": {
"groups": []
}
},
"role": "string",
"record": {}
}
},
"index": 0,
"plural": "string",
"description": "string",
"groups": [
"string"
],
"icon": "string",
"showInMenu": true,
"defaultTrait": "string",
"traits": [
"string"
],
"views": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"favorite": true,
"team": true,
"shared": true,
"personal": true,
"trait": "string",
"filters": {
"groups": [
null
]
},
"shows": [
{}
],
"sorts": [
{}
],
"limit": 0,
"showIcons": true,
"rowHeight": "string",
"query": "string",
"icon": "string",
"flowProperty": "string",
"flowPreview": "string",
"defaultView": true,
"isInternallyPublic": true
}
],
"properties": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"description": "string",
"type": "string",
"options": [
{}
],
"group": "string",
"format": {
"label": "string",
"name": "string",
"icon": "string",
"type": "string",
"settings": [
null
],
"filters": [
null
],
"rules": [
null
]
},
"rules": [
"string"
],
"immutable": true,
"hidden": true,
"nonPublic": true,
"indexed": true,
"editable": true,
"formatSettings": {
"property1": null,
"property2": null
},
"usedIn": {
"recordUuids": [
null
],
"count": 0
},
"icon": "string",
"webpagePublic": true,
"embeddable": true,
"minAndMaxValue": {
"t1": 0,
"t2": 0
}
}
],
"relations": [
{
"uuid": "string",
"name": "string",
"label": "string",
"createdAt": 0,
"createdBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"updatedAt": 0,
"updatedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"deletedAt": 0,
"deletedBy": {
"name": "string",
"label": "string",
"createdAt": 0,
"updatedAt": 0,
"deletedAt": 0,
"createdByUuid": "string",
"updatedByUuid": "string",
"deletedByUuid": "string",
"index": 0,
"deleted": true,
"complete": true,
"uuid": "string",
"properties": [
null
],
"objects": {},
"user": {
"scopes": [],
"filters": {}
}
},
"index": 0,
"description": "string",
"objects": [
{}
],
"immutable": true,
"editable": true
}
],
"suites": [
"string"
],
"extendsTo": [
{}
]
},
"recordUuid": "fc453abc-123e-4567-890a-6789abcd1234",
"relatedObjectConnection": "PRIMARY"
}
],
"wizard": true,
"metadata": {
"property1": "string",
"property2": "string"
},
"thankYouMessage": "string",
"redirectUrl": "string"
}'Response
application/json
{ "message": "Success", "data": null }
- Mock serverhttps://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/{formUuid}
- Productionhttps://v2.api.caraer.com/api/v2/forms/public/{companyUuid}/{formUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.caraer.com/_mock/apis/api/v2/forms/public/{companyUuid}/{formUuid}' \
-H 'Authorization: Bearer <YOUR_Opaque_HERE>'Response
application/json
{ "message": "Success", "data": null }
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.
Operations
Users represent authenticated individuals in the system. Users belong to one or more Companies and can switch between them. Users can be members of Teams, have roles (SUPER_ADMIN, DEVELOPER, etc.) and scopes that determine their permissions. Users can have associated Records (if the User trait is enabled on an object), enabling user profiles and authentication. Each User has access configurations (HAS_ACCESS_TO) per company that define scopes, filters, and permissions. Users can request additional permissions, reset their permissions to match their team's permissions, and manage their own profile data. The User system enables authentication, authorization, and user management across the multi-tenant platform.
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.
Operations
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.
Operations
Partner endpoints manage partner relationships and integrations. Partners may have special access, integrations, or white-label configurations. Partner endpoints enable reseller functionality, allowing partners to create companies, copy databases, and manage their partner relationships. Partners can have reseller relationships with companies, enabling multi-level partner structures. The partner system supports database copying for white-label deployments and partner-specific company management.
Teams are user groups within a Company that enable role-based access control and collaboration. Teams can be assigned to Records, enabling team-based workflows and permissions. Teams help organize users and manage access to data and features. Team members inherit team permissions and scopes, allowing administrators to manage access at the team level rather than individually. Teams support member management (add/remove members), permission reset (applying team permissions to members), and can be used in filtering and access control. Teams enable collaborative workflows where groups of users work together on Records, with shared permissions and access patterns.
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.
Operations
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.
Operations
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.
Operations
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 (publish_at/unpublish_at), 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.
Operations
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.
Operations
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.
Operations
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.
Operations