Objects are the types that queries and mutations return. Each object has a set of fields that you can ask for in a query. Use this page as a reference for the object types in the Insites GraphQL schema.
Avoid fields marked Deprecated in new code. Where there is a replacement, the note names it.
ActivityStreamsActivity
Code example:
Fields
ActivityStreamsActivityCollection
Code example:
Fields
ActivityStreamsActivityStreamCollection
Code example:
Fields
ActivityStreamsFeed
Code example:
Fields
ActivityStreamsHandler
Code example:
Fields
ActivityStreamsHandlerCollection
Code example:
Fields
Aggregations
Code example:
Fields
ApiCallNotification
ApiCall Notification.
Fields
Liquid code which can be used to process the response from the endpoint. You have access to "response" variable.
Liquid code to evaluate to whatever you want to send, for example a JSON.
Liquid code which should evaluate to integer. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.
Form configurations which trigger the email. Deprecated. Use forms.
Forms which trigger the email.
Liquid code to evaluate to valid json of request headers.
When true, insites-cli deploy and sync do not change this object.
Name of the api call, which is used in form_configurations or mutation to trigger it.
Defines the physical path of the file.
Liquid code which should evaluate to valid request type: Get, Post, Put, Patch, Delete, Head or if you want to send binary files: Post_Multipart, Put_Multipart, Patch_Multipart.
Liquid code to evaluate to valid endpoint for the request.
Liquid code which should evaluate to true if the api call should be sent.
ApiCallNotificationCollection
Code example:
Fields
ApiCallSendPayload
Autogenerated return type of ApiCallSend.
Fields
Deprecated. Not needed.
Asset
Code example:
Fields
File content type.
File size.
When true, insites-cli deploy and sync do not change this object.
Name of the asset.
Defines the physical path of the file.
Url to the file.
Deprecated. Use deleted_at instead.
AssetCollection
Code example:
Fields
AssetsCreateMutationPayload
Autogenerated return type of AssetsCreateMutation.
Fields
AssetsListing
Code example:
Fields
ID of the assets listing object.
AssetsListingIdentifier
Code example:
Fields
ID of the assets listing create job which can be queried.
AssetsPresignUrlsMutationPayload
Autogenerated return type of AssetsPresignUrlsMutation.
Fields
AttachmentPresignedUploadUrl
Code example:
Fields
Direct s3 upload endpoint to which you can upload files. Make sure you include upload_url_payload with the request.
Payload you need to provide for upload_url.
Authenticate
Code example:
Fields
Returns true if the provided JWT is valid for the given user and has not expired yet.
Validates otp_code.
OTP code sent to user.
Allowed TOTP time drift between client and server.
Plain text password which will be matched against stored encrypted_password. Returns true if password matches.
Returns true if the provided temporary_token is valid for the given user and has not expired yet.
Authentication
Authentication using provider.
Fields
Timestamp of when the record was created, automatically generated by the system.
Timestamp of when the record was soft delete, populated by delete action. It is also possible to manually set it via update. To undelete change it back to empty value, but please note that associated records would need to be manually undeleted as well.
Name of authentication provider used for creating this authentication.
Timestamp of when the record was updated, automatically generated by the system.
AuthorizationPolicy
Authorization Policy is used to restrict access to pages and forms.
Fields
Use this status code when authorization fails; usually 404 or 403.
When true, insites-cli deploy and sync do not change this object.
Defines the physical path of the file.
AuthorizationPolicyAssociation
Code example:
Fields
Id of the admin resource.
Type of the admin resource - Page or Form.
Id of the authorization policy.
AuthorizationPolicyCollection
Code example:
Fields
BackgroundJob
Background Job.
Fields
How many times the job was tried to be processed. By default the job is not retried on error.
When job has been considered as dead.
Deprecated.
Class of an error which made the job fail.
Error which made the job fail.
When job failed.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Liquid partial name path that will be executed.
Which queue is used to process the job.
Deprecated.
Deprecated.
When job will retry to run.
When job is scheduled to run.
Deprecated.
When job started to be processed.
Deprecated.
BackgroundJobCollection
Code example:
Fields
BackgroundJobsResult
Background Jobs Result.
Fields
BaseError
Base error message.
Fields
A description of the error.
CMSItemDefinition
Code example:
Fields
CMSItemDefinitionCollection
Code example:
Fields
CMSItemPayload
Code example:
Fields
CMSItemPayloadCollection
Code example:
Fields
Communication
Deprecated.
Fields
CustomAddrress
Code example:
Fields
CustomAttachment
Code example:
Fields
CustomAttributeDefinition
Definition of Custom attribute.
Fields
CustomImage
Code example:
Fields
Timestamp of when the record was created, automatically generated by the system.
Timestamp of when the record was soft delete, populated by delete action. It is also possible to manually set it via update. To undelete change it back to empty value, but please note that associated records would need to be manually undeleted as well.
Deprecated. Use url.
Timestamp of when the record was updated, automatically generated by the system.
Image url; ex: thumb: url(version: "thumb").
CustomImageCollection
Code example:
Fields
Customization
Code example:
Fields
Fetch address by name; ex: address: address(name: "office_address"). Deprecated. Store the address in your own table instead.
Fetch all addresses, optionally you can filter results by name; ex: home_address: addresses(name: "home"). Deprecated. Store the address in your own table instead.
Fetch attachment by name; ex: sales_report: attachment(name: "sales_report"). Deprecated. Use property_upload instead.
Fetch all attachments, optionally you can filter results by name; ex: sales_reports: attachments(name: "sales_report"). Deprecated. Use property_upload instead.
Timestamp of when the record was created, automatically generated by the system.
Fetch address by name; ex: address: custom_address(name: "office_address"). Deprecated. Store the address in your own table instead.
Fetch all addresses, optionally you can filter results by name; ex: home: custom_addresses(name: "home"). Deprecated. Store the address in your own table instead.
Fetch attachment by name; ex: sales_report: custom_attachment(name: "sales_report"). Deprecated. Use property_upload instead.
Fetch all attachments, optionally you can filter results by name; ex: sales_reports: custom_attachments(name: "sales_report"). Deprecated. Use property_upload instead.
Fetch image by name; ex: header: custom_image(name: "header"). Deprecated. Use property_upload instead.
Fetch all images, optionally you can filter results by name; ex: cat_images: custom_images(name: "cat"). Deprecated. Use property_upload instead.
Id of a parent, which can other customization, user profile or user.
Class of a parent - Customization, User or UserProfile.
Timestamp of when the record was soft delete, populated by delete action. It is also possible to manually set it via update. To undelete change it back to empty value, but please note that associated records would need to be manually undeleted as well.
Used mainly for import/export, if you want to use third party service as a source of truth.
Fetch image by name; ex: header: image(name: "header"). Deprecated. Use property_upload instead.
Fetch all images, optionally you can filter results by name; ex: cat_images: images(name: "cat"). Deprecated. Use property_upload instead.
Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id }. Deprecated. Use related_model.
Load resources with foreign_property == join_on_property.
Load remote resource with id == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_models.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with custom-model-type-name == model_name.
List of all properties assigned to the object.
Fetch any property by name and return value as a String; ex: hair_color: property(name: "hair_color").
Fetch any property by name and return value as an Array of Strings. ex: todo_list: property_array(name: "todo_list").
Fetch any property by name and return value as a Boolean; ex: price: property_boolean(name: "enabled").
Fetch any property by name and return value as a Float; ex: price: property_float(name: "price").
Fetch any property by name and return value as an Integer; ex: age: property_int(name: "age").
Fetch any property by name and return value as a JSON string.
Fetch any property by name, parse it as a JSON and return object.
Fetch any property by name and returns upload details.
Defines the number of seconds for which the generated url will be accessible. Must be set if acl was set to private.
Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load remote resource with id == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines has-many relation with other model, returns maximum of 10000 records at once; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines relation with other user, returns maximum of 10000 records at once; ex: invited_by: user(join_on_property: "invited_by_id") { id }.
Defines relation object accessible over HTTP in JSON collection identified by its ID.
Endpoint that will return resources for given ids in json format.
Load remote resource with id == join_on_property.
When sorting by distance - field contains distance to target location. Deprecated. Not supported everywhere.
Timestamp of when the record was updated, automatically generated by the system.
Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }. Deprecated. Use related_users.
DataExport
Code example:
Fields
ID of the export task, which can be queried. When it is done, the task includes the URL of the zip file.
DataExportCollection
Code example:
Fields
Document
Code example:
Fields
ID of an object.
List of all properties assigned to the object.
Fetch any property by name and return value as a String; ex: hair_color: property(name: "hair_color").
Fetch any property by name and return value as an Array of Strings. ex: todo_list: property_array(name: "todo_list").
Fetch any property by name and return value as a Boolean; ex: price: property_boolean(name: "enabled").
Fetch any property by name and return value as a Float; ex: price: property_float(name: "price").
Fetch any property by name and return value as an Integer; ex: age: property_int(name: "age").
Fetch any property by name and return value as a JSON string.
Fetch any property by name, parse it as a JSON and return object.
EmailNotification
Email Notification.
Fields
Json of the form { "file_name.jpg": { "url": "http://example.com/file.jpg" } } which defines email attachments. Liquid will be processed.
Comma separated blind carbon copy list. Liquid allowed. For example "john@example.com, jane@example.com".
Comma separated carbon copy list. Liquid allowed. For example "john@example.com, jane@example.com".
Liquid code to evaluate to valid form html. If email is triggered via form configuration, You have access to "form" variable, with data specified in the configuration.
Liquid code which should evaluate to integer. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.
Form configurations which trigger the email. Deprecated. Use forms.
Forms which trigger the email.
Email address from which you would like to send the email, for example notifications@mydomain.com.
Name of the liquid layout to which the content should be injected.
Name of the liquid layout to which the content should be injected. Deprecated. Use layout.
When true, insites-cli deploy and sync do not change this object.
Name of the email, which is used in form_configurations or mutation to trigger it.
Defines the physical path of the file.
Email address to which users should reply, for example support@mydomain.com.
Liquid code to evaluate to text.
Comma separated recipient list. Liquid allowed. For example: "john@example.com, jane@example.com".
Liquid code which should evaluate to true if the email should be sent.
EmailNotificationCollection
Code example:
Fields
Embedding
Code example:
Fields
Original text that was converted to embedding.
Timestamp of when the record was created, automatically generated by the system.
Vector with 1536 dimensions, compatible with openai embeddings.
Tokens.
Timestamp of when the record was updated, automatically generated by the system.
EmbeddingCollection
Code example:
Fields
EncryptedConstant
Code example:
Fields
Name of the constant.
Decrypted value of a constant.
EncryptedConstantCollection
Code example:
Fields
FlashMessages
Code example:
Fields
Form
Form configuration - deprecated, use Form.
Fields
Associated api call notifications.
Same as callback, but invoked asynchronously. Recommended for performance reason.
Delays invoking the job by specified number of minutes. Liquid allowed - useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.
Defines max number of retrying attempts in case of an error. Usually you do not want to change it.
Defines the invocaction priority, the higher the quicker timeout.
Associated authorization policies.
Liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead.
Whitelist of attributes which can be persisted in the DB. On server side (callbacks, emails etc) you have access to submited values via form variable (for exapmple configuration: properties: my_var is accessible via form.properties.my_var ). Deprecated. Use fields.
Liquid code which has to evaluate to JSON. This extends/overwrites user submitted input via form, before validation. Most useful to store in DB sensitive data which you do not want user to modify, for example context.current_user.id.
Associated email notifications.
Whitelist of attributes which can be persisted in the DB. On server side (callbacks, emails etc) you have access to submited values via form variable (for exapmple fields: properties: my_var is accessible via form.properties.my_var ).
Message which you want to display to user upon validation errors.Output is available via context.flash_alert. Liquid allowed.
Message which you want to display to user after successful form submission. Output is available via context.flash_notice. Liquid allowed.
Liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.
When true, insites-cli deploy and sync do not change this object.
Defines the physical path of the file.
Path or URL to which user should be redirected after successful form submission. Liquid allowed.
Defines who can submit the form. If set to anyone, please make sure to provide authorization_policies.
Response headers for the form.
Associated sms notifications.
Name of the strategy and configuration for them.
FormCollection
Code example:
Fields
FormConfiguration
Form configuration - deprecated, use Form.
Fields
Associated api call notifications.
Same as callback, but invoked asynchronously. Recommended for performance reason.
Delays invoking the job by specified number of minutes. Liquid allowed - useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.
Defines max number of retrying attempts in case of an error. Usually you do not want to change it.
Defines the invocaction priority, the higher the quicker timeout.
Associated authorization policies.
Liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead.
Whitelist of attributes which can be persisted in the DB. On server side (callbacks, emails etc) you have access to submited values via form variable (for exapmple configuration: properties: my_var is accessible via form.properties.my_var ).
Liquid code which has to evaluate to JSON. This extends/overwrites user submitted input via form, before validation. Most useful to store in DB sensitive data which you do not want user to modify, for example context.current_user.id.
Associated email notifications.
Message which you want to display to user upon validation errors.Output is available via context.flash_alert. Liquid allowed.
Message which you want to display to user after successful form submission. Output is available via context.flash_notice. Liquid allowed.
Liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.
When true, insites-cli deploy and sync do not change this object.
Defines the physical path of the file.
Path or URL to which user should be redirected after successful form submission. Liquid allowed.
Defines who can submit the form. If set to anyone, please make sure to provide authorization_policies.
Associated sms notifications.
Name of the strategy and configuration for them.
FormConfigurationCollection
Code example:
Fields
FormSubmitPayload
Autogenerated return type of FormSubmit.
Fields
Includes one of model or user, depending on which form was submitted.
Validation error messages based on form fields.
GeoPointType
Code example:
Fields
GraphQL
Graphql query or mutation.
Fields
Graphql query string.
When true, insites-cli deploy and sync do not change this object.
Defines the physical path of the file.
GraphQuery
Code example:
Fields
When true, insites-cli deploy and sync do not change this object.
Name of the graph query.
Defines the physical path of the file.
The query.
GraphQueryCollection
Code example:
Fields
HTTPRequestContext
Code example:
Fields
Returns array of configured authentication providers.
Returns a String with the last requested path including their params. /foo?bar.
Returns the original request URL as a String. # => "http://www.example.com/articles?page=2".
Access request headers.
Returns true if the “X-Requested-With” header contains “XMLHttpRequest” (case-insensitive),which may need to be manually added depending on the choice of JavaScript libraries and frameworks.
Access data sent in by the user or other parameters in your controller actions.
The referer of the client.
Image
Generic image.
Fields
Deprecated. Not used in direct s3 way of uploading file.
Image original height. Deprecated. Not used in direct s3 way of uploading file.
Image original width. Deprecated. Not used in direct s3 way of uploading file.
Deprecated. Not needed.
Id of the User who uploaded the image.
Image url; ex: thumb: url(version: "thumb").
Name of the image version to which url will point.
Object with versions, ex. "urls": { "big": { "url": "https://uploads.example.com/images/big_photo.jpg"}, "small": { "url": "https://example.com/images/small_photo.jpg" } } }.
ImagePresignedUploadUrl
Code example:
Fields
Direct s3 upload endpoint to which you can upload files. Make sure you include upload_url_payload with the request.
Payload you need to provide for upload_url.
ImportCustomizationsMutationPayload
Autogenerated return type of ImportCustomizationsMutation.
Fields
ImportTransactablesMutationPayload
Autogenerated return type of ImportTransactablesMutation.
Fields
ImportUsersMutationPayload
Autogenerated return type of ImportUsersMutation.
Fields
IndexSearchCollection
Code example:
Fields
Instance
Returns information about the current instance.
Fields
Lists all feature flags defined in app/config.yml.
InstanceMetrics
Code example:
Fields
Number of activities.
Number of addresses.
Number of attachments.
Number of images.
Number of records.
Number of transactables.
Number of user profiles.
Number of users.
LiquidLayout
Liquid Layouts.
Fields
Liquid code to evaluate to valid html. To inject content of the resources using the layout use {{ content_for_layout }}.
When true, insites-cli deploy and sync do not change this object.
Defines the the path for layout, must starts with layouts/, for example layouts/my_layout. Please note that the layouts/ prefix must be skipped when setting layout in Page or EmailNotification.
Defines the physical path of the file.
LiquidLayoutCollection
Code example:
Fields
LiquidPartial
Liquid Partials.
Fields
Liquid code to evaluate to valid html.
When true, insites-cli deploy and sync do not change this object.
Defines the name of the partial to be used with include tag.
Defines the physical path of the file.
LiquidPartialCollection
Code example:
Fields
Listing
Code example:
Fields
Remember to set `listing: { has_creator: true }` in query arguments.
Fetch address by name; ex: address: custom_address(name: "office_address").
Fetch all addresses, optionally you can filter results by name; ex: home: custom_addresses(name: "home").
Fetch attachment by name; ex: sales_report: custom_attachment(name: "sales_report").
Fetch image by name; ex: header: custom_image(name: "header").
Fetch all images, optionally you can filter results by name; ex: cat_images: custom_images(name: "cat").
Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id }. Deprecated. Use related_model.
Load resources with foreign_property == join_on_property.
Load remote resource with id == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_models.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with custom-model-type-name == model_name.
List of all properties assigned to the object.
Fetch any custom attribute by name; ex: hair_color: property(name: "hair_color").
Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String; ex: todo_list: property_array(name: "todo_list").
Fetch any property of JSON type by name, it returns JSON in contrast to "property" which returns String; ex: todo_list: property_json(name: "todo_list").
Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load remote resource with id == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines has-many relation with other model, returns maximum of 10000 records at once; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines relation with other user, returns maximum of 10000 records at once; ex: invited_by: user(join_on_property: "invited_by_id") { id }.
Defines relation object accessible over HTTP in JSON collection identified by its ID.
Endpoint that will return resources for given ids in json format.
Load remote resource with id == join_on_property.
When sorting by distance - field contains distance to target location. Deprecated. Not supported everywhere.
Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }. Deprecated. Use related_users.
ListingAddress
An address.
Fields
ListingCollection
Code example:
Fields
Deprecated. Use current_page.
ListingImage
Code example:
Fields
Deprecated. Use file_name.
Image url; ex: thumb: url(version: "thumb").
ListingsCommunication
Deprecated.
Fields
ListingsCustomization
Code example:
Fields
Timestamp of when the record was created, automatically generated by the system.
Fetch address by name; ex: address: custom_address(name: "office_address").
Fetch all addresses, optionally you can filter results by name; ex: home: custom_addresses(name: "home").
Fetch attachment by name; ex: sales_report: custom_attachment(name: "sales_report").
Fetch image by name; ex: header: custom_image(name: "header").
Fetch all images, optionally you can filter results by name; ex: cat_images: custom_images(name: "cat").
Deprecated. Use models instead.
Used mainly for import/export, if you want to use third party service as a source of truth.
Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id }. Deprecated. Use related_model.
Load resources with foreign_property == join_on_property.
Load remote resource with id == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_models.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with custom-model-type-name == model_name.
List of all properties assigned to the object.
Fetch any custom attribute by name; ex: hair_color: property(name: "hair_color").
Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String; ex: todo_list: property_array(name: "todo_list").
Fetch any property of JSON type by name, it returns JSON in contrast to "property" which returns String; ex: todo_list: property_json(name: "todo_list").
Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load remote resource with id == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines has-many relation with other model, returns maximum of 10000 records at once; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines relation with other user, returns maximum of 10000 records at once; ex: invited_by: user(join_on_property: "invited_by_id") { id }.
Defines relation object accessible over HTTP in JSON collection identified by its ID.
Endpoint that will return resources for given ids in json format.
Load remote resource with id == join_on_property.
Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }. Deprecated. Use related_users.
ListingsCustomizationCollection
Code example:
Fields
Deprecated. Use current_page.
ListingsCustomModelType
Code example:
Fields
ListingsModelSchema
Code example:
Fields
ListingsPrivateFile
Code example:
Fields
Number of seconds before presigned URL expires. Max value is one week (604800).
ListingUserProfile
A profile.
Fields
Fetch address by name; ex: address: custom_address(name: "office_address").
Fetch all addresses, optionally you can filter results by name; ex: home: custom_addresses(name: "home").
Fetch attachment by name; ex: sales_report: custom_attachment(name: "sales_report").
Fetch image by name; ex: header: custom_image(name: "header").
Fetch all images, optionally you can filter results by name; ex: cat_images: custom_images(name: "cat").
Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id }. Deprecated. Use related_model.
Load resources with foreign_property == join_on_property.
Load remote resource with id == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_models.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with custom-model-type-name == model_name.
List of all properties assigned to the object.
Fetch any custom attribute by name; ex: hair_color: property(name: "hair_color").
Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String; ex: todo_list: property_array(name: "todo_list").
Fetch any property of JSON type by name, it returns JSON in contrast to "property" which returns String; ex: todo_list: property_json(name: "todo_list").
Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load remote resource with id == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines has-many relation with other model, returns maximum of 10000 records at once; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines relation with other user, returns maximum of 10000 records at once; ex: invited_by: user(join_on_property: "invited_by_id") { id }.
Defines relation object accessible over HTTP in JSON collection identified by its ID.
Endpoint that will return resources for given ids in json format.
Load remote resource with id == join_on_property.
Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }. Deprecated. Use related_users.
LogEntry
Code example:
Fields
Model
Code example:
Fields
Fetch address by name; ex: address: address(name: "office_address"). Deprecated. Store the address in your own table instead.
Fetch all addresses, optionally you can filter results by name; ex: home_address: addresses(name: "home"). Deprecated. Store the address in your own table instead.
Fetch attachment by name; ex: sales_report: attachment(name: "sales_report"). Deprecated. Use property_upload instead.
Fetch all attachments, optionally you can filter results by name; ex: sales_reports: attachments(name: "sales_report"). Deprecated. Use property_upload instead.
Timestamp of when the record was created, automatically generated by the system.
Deprecated. Use property to store foreign keys.
Deprecated. Use property to store foreign keys.
Timestamp of when the record was soft delete, populated by delete action. It is also possible to manually set it via update. To undelete change it back to empty value, but please note that associated records would need to be manually undeleted as well.
Used mainly for import/export, if you want to use third party service as a source of truth.
ID of an object.
Fetch image by name; ex: header: image(name: "header"). Deprecated. Use property_upload instead.
Fetch all images, optionally you can filter results by name; ex: cat_images: images(name: "cat"). Deprecated. Use property_upload instead.
Defines has-one relation with other model, e.g: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }. Deprecated. Use related_record.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_name.
ID of Model Schema to which it belongs. Deprecated. Use table_id.
Name of the model schema to which it belongs. Deprecated. Use table.
Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_records.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_name.
Name of the model schema. Deprecated. Use table.
List of all properties assigned to the object.
Fetch any property by name and return value as a String; ex: hair_color: property(name: "hair_color").
Fetch any property by name and return value as an Array of Strings. ex: todo_list: property_array(name: "todo_list").
Fetch any property by name and return value as a Boolean; ex: price: property_boolean(name: "enabled").
Fetch any property by name and return value as a Float; ex: price: property_float(name: "price").
Fetch any property by name and return value as an Integer; ex: age: property_int(name: "age").
Fetch any property by name and return value as a JSON string.
Fetch any property by name, parse it as a JSON and return object.
Fetch any property by name and returns upload details.
Defines the number of seconds for which the generated url will be accessible. Must be set if acl was set to private.
Defines has-one relation with other model; ex: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }. Deprecated. Use related_record.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_schema_name.
Defines has-many relation with other model; ex: children: related_models(model_schema_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_records.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_schema_name.
Defines relation with other user; ex: invited_by: related_user(join_on_property: "invited_by_id") { id }.
Load resources with foreign_property == join_on_property.
Defines has-many relation with other user; ex: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Name of the Table to which it belongs.
ID of the Table to which it belongs.
Timestamp of when the record was updated, automatically generated by the system.
Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }. Deprecated. Use related_user.
Load resources with foreign_property == join_on_property.
Id of the User who created and owns the Model.
Defines has-many relation with other user; ex: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_users.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
ModelCollection
Code example:
Fields
ModelSchema
Schema for model.
Fields
Deprecated, use properties instead. Deprecated. Use properties.
When true, insites-cli deploy and sync do not change this object.
Defines the physical path of the file.
List of properties attributes to be included in the results.
ModelSchemaCollection
Code example:
Fields
NotificationSendEmailPayload
Autogenerated return type of NotificationSendEmail.
Fields
Deprecated. Not needed.
ObjectCount
Code example:
Fields
ObjectUpload
Code example:
Fields
Otp
Code example:
Fields
SVG from QRcode.
Page
Page.
Fields
Associated authorization policies.
Content provider by the develop, can be markdown, can be html with liquid etc.
Specfic timestamp of when the content was updated last time, useful for cache.
The number of seconds for which this page will be cached; set dynamic_cache_layout accordingly to your scenario. Triggers authorization. Use only if cache_key cannot be easily determined (for example for search results page).
Liquid which evaluates to the cache key, for example {{ context.page.slug }}/{{ context.params.slug2 }}for page with slug "abc" will cache separately /abc/1 and /abc/2, however abc/1/1 will return the same value as abc/1/2. If left blank, the full url will be used.
Defines whether layout should be cached as well, or only page. Usually it is not possible to cache layout due to dynamic data in it, like name of a logged in user, hence default is false.
Evaluated html content, especially useful if content was provided as markdown.
Deprecated. Use layout.
When true, insites-cli deploy and sync do not change this object.
Max nesting of the url to be resolved by this slug. For example slug "abc" with max_deep_level 2 will resolve /abc, abc/1, abc/2, but will NOT resolve abc/2/something.
Defines the physical path of the file.
The number of seconds for which this page will be cached as a static html page; works only for not logged in users, skips any authorization.
PageCollection
Code example:
Fields
PresignedUploadUrl
Code example:
Fields
Direct s3 upload endpoint to which you can upload files. Make sure you include upload_url_payload with the request.
Payload you need to provide for upload_url.
PresignedUrl
Code example:
Fields
URL to CDN with your file. Will be available once you upload file.
Presigned URL where you should upload file.
PrivateFile
Code example:
Fields
Number of seconds before presigned URL expires. Max value is one week (604800).
Profile
A profile.
Fields
Fetch address by name; ex: address: address(name: "office_address"). Deprecated. Store the address in your own table instead.
Fetch all addresses, optionally you can filter results by name; ex: home_address: addresses(name: "home"). Deprecated. Store the address in your own table instead.
Fetch attachment by name; ex: sales_report: attachment(name: "sales_report"). Deprecated. Use property_upload instead.
Fetch all attachments, optionally you can filter results by name; ex: sales_reports: attachments(name: "sales_report"). Deprecated. Use property_upload instead.
Fetch address by name; ex: address: custom_address(name: "office_address"). Deprecated. Store the address in your own table instead.
Fetch all addresses, optionally you can filter results by name; ex: home: custom_addresses(name: "home"). Deprecated. Store the address in your own table instead.
Fetch attachment by name; ex: sales_report: custom_attachment(name: "sales_report"). Deprecated. Use property_upload instead.
Fetch all attachments, optionally you can filter results by name; ex: sales_reports: custom_attachments(name: "sales_report"). Deprecated. Use property_upload instead.
Fetch image by name; ex: header: custom_image(name: "header"). Deprecated. Use property_upload instead.
Fetch all images, optionally you can filter results by name; ex: cat_images: custom_images(name: "cat"). Deprecated. Use property_upload instead.
Timestamp of when the record was soft delete, populated by delete action. It is also possible to manually set it via update. To undelete change it back to empty value, but please note that associated records would need to be manually undeleted as well.
ID of an object.
Fetch image by name; ex: header: image(name: "header"). Deprecated. Use property_upload instead.
Fetch all images, optionally you can filter results by name; ex: cat_images: images(name: "cat"). Deprecated. Use property_upload instead.
Defines has-one relation with other model, e.g: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }. Deprecated. Use related_record.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_name.
Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_records.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_name.
List of all properties assigned to the object.
Fetch any property by name and return value as a String; ex: hair_color: property(name: "hair_color").
Fetch any property by name and return value as an Array of Strings. ex: todo_list: property_array(name: "todo_list").
Fetch any property by name and return value as a Boolean; ex: price: property_boolean(name: "enabled").
Fetch any property by name and return value as a Float; ex: price: property_float(name: "price").
Fetch any property by name and return value as an Integer; ex: age: property_int(name: "age").
Fetch any property by name and return value as a JSON string.
Fetch any property by name, parse it as a JSON and return object.
Fetch any property by name and returns upload details.
Defines the number of seconds for which the generated url will be accessible. Must be set if acl was set to private.
Defines has-one relation with other model; ex: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }. Deprecated. Use related_record.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_schema_name.
Defines has-many relation with other model; ex: children: related_models(model_schema_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_records.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_schema_name.
Defines has-one relation with other record; ex: children: records(table: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins record with record-schema-name == table.
Defines has-many relation with other records; ex: children: related_records(table: "children", join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Define table name which should be used as a source for related records.
Defines relation with other user; ex: invited_by: related_user(join_on_property: "invited_by_id") { id }.
Load resources with foreign_property == join_on_property.
Defines has-many relation with other user; ex: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Defines relation object accessible over HTTP in JSON collection identified by its ID.
Endpoint that will return resources for given ids in json format.
Load remote resource with id == join_on_property.
Defines relation object accessible over HTTP in JSON collection identified by its ID.
Endpoint that will return resources for given ids in json format.
Load remote resource with id == join_on_property.
Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }. Deprecated. Use related_user.
Load resources with foreign_property == join_on_property.
Defines has-many relation with other user; ex: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_users.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Property
Property definition.
Fields
Type of the property.
Defines a relationship with other model schema or the user schema. Used during importing/exporting data.
Default value for new objects.
When true, insites-cli deploy and sync do not change this object.
Name of the property.
Options, used only by type upload.
Defines the physical path of the file.
Id of the schema to which this property definition belongs.
Type of the schema to which this property definition belongs.
PropertyUpload
Code example:
Fields
Extension extracted from the url, downcased; for example jpg, pdf etc.
File name extracted from the url.
Url pointing to the file in CDN.
Hash where key is a version name and value is the url to the cdn; populated if the upload file is an image and versions were specified.
Specified only those versions which you want to be returned.
PropertyUploadPresignedUrl
Code example:
Fields
Direct s3 upload endpoint to which you can upload files. Make sure you include upload_url_payload with the request.
Payload you need to provide for upload_url.
Record
Code example:
Fields
Fetch address by name; ex: address: address(name: "office_address"). Deprecated. Store the address in your own table instead.
Fetch all addresses, optionally you can filter results by name; ex: home_address: addresses(name: "home"). Deprecated. Store the address in your own table instead.
Fetch attachment by name; ex: sales_report: attachment(name: "sales_report"). Deprecated. Use property_upload instead.
Fetch all attachments, optionally you can filter results by name; ex: sales_reports: attachments(name: "sales_report"). Deprecated. Use property_upload instead.
Timestamp of when the record was created, automatically generated by the system.
Deprecated. Use property to store foreign keys.
Deprecated. Use property to store foreign keys.
Timestamp of when the record was soft delete, populated by delete action. It is also possible to manually set it via update. To undelete change it back to empty value, but please note that associated records would need to be manually undeleted as well.
Used mainly for import/export, if you want to use third party service as a source of truth.
ID of an object.
Fetch image by name; ex: header: image(name: "header"). Deprecated. Use property_upload instead.
Fetch all images, optionally you can filter results by name; ex: cat_images: images(name: "cat"). Deprecated. Use property_upload instead.
Defines has-one relation with other model, e.g: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }. Deprecated. Use related_record.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_name.
ID of Model Schema to which it belongs. Deprecated. Use table_id.
Name of the model schema to which it belongs. Deprecated. Use table.
Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_records.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_name.
Name of the model schema. Deprecated. Use table.
List of all properties assigned to the object.
Fetch any property by name and return value as a String; ex: hair_color: property(name: "hair_color").
Fetch any property by name and return value as an Array of Strings. ex: todo_list: property_array(name: "todo_list").
Fetch any property by name and return value as a Boolean; ex: price: property_boolean(name: "enabled").
Fetch any property by name and return value as a Float; ex: price: property_float(name: "price").
Fetch any property by name and return value as an Integer; ex: age: property_int(name: "age").
Fetch any property by name and return value as a JSON string.
Fetch any property by name, parse it as a JSON and return object.
Fetch any property by name and returns upload details.
Defines the number of seconds for which the generated url will be accessible. Must be set if acl was set to private.
Defines has-one relation with other model; ex: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }. Deprecated. Use related_record.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_schema_name.
Defines has-many relation with other model; ex: children: related_models(model_schema_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_records.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_schema_name.
Defines has-one relation with other record; ex: children: records(table: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins record with record-schema-name == table.
Defines has-many relation with other records; ex: children: related_records(table: "children", join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Define table name which should be used as a source for related records.
Defines relation with other user; ex: invited_by: related_user(join_on_property: "invited_by_id") { id }.
Load resources with foreign_property == join_on_property.
Defines has-many relation with other user; ex: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Defines relation object accessible over HTTP in JSON collection identified by its ID.
Endpoint that will return resources for given ids in json format.
Load remote resource with id == join_on_property.
Defines relation object accessible over HTTP in JSON collection identified by its ID.
Endpoint that will return resources for given ids in json format.
Load remote resource with id == join_on_property.
Name of the Table to which it belongs.
ID of the Table to which it belongs.
Timestamp of when the record was updated, automatically generated by the system.
Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }. Deprecated. Use related_user.
Load resources with foreign_property == join_on_property.
Id of the User who created and owns the Record.
Defines has-many relation with other user; ex: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_users.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
RecordCollection
Code example:
Fields
RecordCreate
Code example:
Fields
Name of the Table to which it belongs.
Response
Code example:
Fields
Hash of headers returned by the server.
Standard HTTP status code.
Result
Code example:
Fields
Hash with calculated difference of what has changed.
Updated model, assuming submited form was for resource model.
Create/Updated transactable, assuming submitted form was for resource Transactable. Deprecated. Use model.
Updated user, assuming submited form was for resource User.
SentNotification
Sent Notification(api call, email, sms).
Fields
SentNotificationCollection
Code example:
Fields
SmsNotification
Sms Notification.
Fields
Liquid code to evaluate to valid text. If sms is triggered via form configuration, You have access to "form" variable, with data specified in the configuration.
Liquid code which should evaluate to integer. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.
Form configurations which trigger the email. Deprecated. Use forms.
Forms which trigger the email.
When true, insites-cli deploy and sync do not change this object.
Name of the sms, which is used in form_configurations or mutation to trigger it.
Defines the physical path of the file.
Liquid code to evaluate to valid mobile number with country code, for example +1 541 754 3010. Useful filter to build valid mobile number is "$to_mobile_number".
Liquid code which should evaluate to true if the sms should be sent.
SmsNotificationCollection
Code example:
Fields
SmsSendPayload
Autogenerated return type of SmsSend.
Fields
Deprecated. Not needed.
Table
Table definition.
Fields
Deprecated, use properties instead. Deprecated. Use properties.
When true, insites-cli deploy and sync do not change this object.
Defines the physical path of the file.
List of properties attributes to be included in the results.
TableCollection
Code example:
Fields
ThirdPartyIntegration
Third Party Integration.
Fields
ThirdPartyIntegrationCollection
Code example:
Fields
Transactable
Code example:
Fields
Fetch any customization by name or id; ex: hair_color: customization(name: "hair_color").
Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id }. Deprecated. Use related_model.
Load resources with foreign_property == join_on_property.
Load remote resource with id == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_models.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with custom-model-type-name == model_name.
Fetch any Property by name; ex: hair_color: property(name: "hair_color").
Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load remote resource with id == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines has-many relation with other model, returns maximum of 10000 records at once; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines relation with other user, returns maximum of 10000 records at once; ex: invited_by: user(join_on_property: "invited_by_id") { id }.
Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }. Deprecated. Use related_users.
TransactableCollection
Code example:
Fields
TransactableSchema
Schema for transactable. Deprecated, use ModelSchema.
Fields
Deprecated, use properties instead. Deprecated. Use properties.
When true, insites-cli deploy and sync do not change this object.
Defines the physical path of the file.
List of properties attributes to be included in the results.
TransactableSchemaCollection
Code example:
Fields
TransactableType
Code example:
Fields
Translation
Translation.
Fields
TranslationJson
TranslationJson.
Fields
UpdateCustomizationsMutationPayload
Autogenerated return type of UpdateCustomizationsMutation.
Fields
UpdateUsersMutationPayload
Autogenerated return type of UpdateUsersMutation.
Fields
User
Code example:
Fields
Fetch address by name; ex: address: address(name: "office_address"). Deprecated. Store the address in your own table instead.
Fetch all addresses, optionally you can filter results by name; ex: home_address: addresses(name: "home"). Deprecated. Store the address in your own table instead.
Fetch attachment by name; ex: sales_report: attachment(name: "sales_report"). Deprecated. Use property_upload instead.
Fetch all attachments, optionally you can filter results by name; ex: sales_reports: attachments(name: "sales_report"). Deprecated. Use property_upload instead.
Validate user credentials.
Stores information about user integrations with authentication providers like auth0, facebook, twitter etc.
Used for twilio click-to-call integraation to verify phone number. Deprecated. Use records.
Timestamp of when the record was created, automatically generated by the system.
Fetch address by name; ex: address: custom_address(name: "office_address"). Deprecated. Store the address in your own table instead.
Fetch all addresses, optionally you can filter results by name; ex: home: custom_addresses(name: "home"). Deprecated. Store the address in your own table instead.
Fetch attachment by name; ex: sales_report: custom_attachment(name: "sales_report"). Deprecated. Use property_upload instead.
Fetch all attachments, optionally you can filter results by name; ex: sales_reports: custom_attachments(name: "sales_report"). Deprecated. Use property_upload instead.
Fetch image by name; ex: header: custom_image(name: "header"). Deprecated. Use property_upload instead.
Fetch all images, optionally you can filter results by name; ex: cat_images: custom_images(name: "cat"). Deprecated. Use property_upload instead.
Model schema name.
ID of user that created customization.
Timestamp of when the record was soft delete, populated by delete action. It is also possible to manually set it via update. To undelete change it back to empty value, but please note that associated records would need to be manually undeleted as well.
Used mainly for import/export, if you want to use third party service as a source of truth.
ID of an object.
Fetch image by name; ex: header: image(name: "header"). Deprecated. Use property_upload instead.
Fetch all images, optionally you can filter results by name; ex: cat_images: images(name: "cat"). Deprecated. Use property_upload instead.
JWT token that can be used for authentication.
Number of seconds after which the token expires, clamped to a maximum of one year. When omitted, the token expires after the instance session timeout (same source as the `{% sign_in %}` tag). Expired tokens are rejected on decode.
Used by translations to set the language of currently logged in user.
Defines has-one relation with other model, e.g: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }. Deprecated. Use related_record.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_name.
Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_records.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_name.
Two factor authentication with TOTP(time based one time password).
Get custom OTP token names.
Deprecated. Use profiles.
Associated user profiles, which can be used as user role or namespace for certain group of user properties.
List of all properties assigned to the object.
Fetch any property by name and return value as a String; ex: hair_color: property(name: "hair_color").
Fetch any property by name and return value as an Array of Strings. ex: todo_list: property_array(name: "todo_list").
Fetch any property by name and return value as a Boolean; ex: price: property_boolean(name: "enabled").
Fetch any property by name and return value as a Float; ex: price: property_float(name: "price").
Fetch any property by name and return value as an Integer; ex: age: property_int(name: "age").
Fetch any property by name and return value as a JSON string.
Fetch any property by name, parse it as a JSON and return object.
Fetch any property by name and returns upload details.
Defines the number of seconds for which the generated url will be accessible. Must be set if acl was set to private.
Defines has-one relation with other model; ex: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }. Deprecated. Use related_record.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_schema_name.
Defines has-many relation with other model; ex: children: related_models(model_schema_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_records.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with model-schema-name == model_schema_name.
Defines has-one relation with other record; ex: children: records(table: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins record with record-schema-name == table.
Defines has-many relation with other records; ex: children: related_records(table: "children", join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Define table name which should be used as a source for related records.
Defines relation with other user; ex: invited_by: related_user(join_on_property: "invited_by_id") { id }.
Load resources with foreign_property == join_on_property.
Defines has-many relation with other user; ex: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Defines relation object accessible over HTTP in JSON collection identified by its ID.
Endpoint that will return resources for given ids in json format.
Load remote resource with id == join_on_property.
Defines relation object accessible over HTTP in JSON collection identified by its ID.
Endpoint that will return resources for given ids in json format.
Load remote resource with id == join_on_property.
To be used in the url instead of id for SEO purposes. Must be unique. By default generated based on first-name and last-name.
Determined based on authentications. For example, if user connects FB account, this will make API call to FB and check, if any of his friends have account on your Site. Deprecated. Use api calls.
A token valid for desired number of hours, which you can use to authorize the user in third party application. To do it, include it in a header with name UserTemporaryToken. You can also manually verify the token with users{ authenticate { temporary_token(..) } } query. Token will be invalidated on password change.
Number of hours after which the token expire.
Deprecated, use expires_in.
Deprecated. Use records.
Timestamp of when the record was updated, automatically generated by the system.
Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }. Deprecated. Use related_user.
Load resources with foreign_property == join_on_property.
Defines has-many relation with other user; ex: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_users.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
UserCollection
Code example:
Fields
UserListing
Code example:
Fields
Fetch address by name; ex: address: custom_address(name: "office_address").
Fetch all addresses, optionally you can filter results by name; ex: home: custom_addresses(name: "home").
Fetch attachment by name; ex: sales_report: custom_attachment(name: "sales_report").
Fetch image by name; ex: header: custom_image(name: "header").
Fetch all images, optionally you can filter results by name; ex: cat_images: custom_images(name: "cat").
Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id }. Deprecated. Use related_model.
Load resources with foreign_property == join_on_property.
Load remote resource with id == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }. Deprecated. Use related_models.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with custom-model-type-name == model_name.
List of all properties assigned to the object.
Fetch any custom attribute by name; ex: hair_color: property(name: "hair_color").
Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String; ex: todo_list: property_array(name: "todo_list").
Fetch any property of JSON type by name, it returns JSON in contrast to "property" which returns String; ex: todo_list: property_json(name: "todo_list").
Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load remote resource with id == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines has-many relation with other model, returns maximum of 10000 records at once; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }.
Load resources with foreign_property == join_on_property.
Load resources with foreign_property == join_on_property.
Joins model with custom-model-type-name == model_name.
Defines relation with other user, returns maximum of 10000 records at once; ex: invited_by: user(join_on_property: "invited_by_id") { id }.
Defines relation object accessible over HTTP in JSON collection identified by its ID.
Endpoint that will return resources for given ids in json format.
Load remote resource with id == join_on_property.
When sorting by distance - field contains distance to target location. Deprecated. Not supported everywhere.
Number of hours before the token expires, default 48 hours.
Deprecated use expires_in.
Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }. Deprecated. Use related_users.
UserListingCollection
Code example:
Fields
Deprecated. Use current_page.
UserOtpDeleteTokenInformation
Code example:
Fields
ID of the user.
UserOtpSecretRefreshInformation
Code example:
Fields
ID of the user.
UserProfileSchema
Schema for user profile.
Fields
Deprecated, use properties instead. Deprecated. Use properties.
When true, insites-cli deploy and sync do not change this object.
Defines the physical path of the file.
List of properties attributes to be included in the results.
UserProfileSchemaCollection
Code example:
Fields
UserSchema
Schema for user defined in user.yml.
Fields
List of properties attributes to be included in the results.
Version
Version of object change from the last 7 days.
Fields
Timestamp when the event happened.
Id of an object which has been created/updated/deleted.
Type of an object which has been created/updated/deleted.
Json representation of a resource prior to the action; null for create action.
Most of the time ID of a User who performed the event. Can be something else if the action was taken by the Insites support team.
VersionCollection
Code example:
Fields
