GraphQL - Mutations

activity_create

Arguments

Name Type
payload ActivityPayload

Returns

Name Type Description
id ID
payload ActivityPayload
uuid String

activity_delete_all

Arguments

Name Type
confirm Boolean

Returns

Name Type Description
activity_delete_all ID Delete all activities and clean up ALL feeds

activity_publish

Arguments

Name Type
feed_type String
ids ID
uuid ID

Returns

Name Type Description
activity_publish JSONDate add activity to feeds

activity_unpublish

Arguments

Name Type
related_to_object ActiveRecordReference
uuid ID

Returns

Name Type Description
activity_unpublish ID Clean up feeds from selected activities

activity_unpublish_all

Arguments

Name Type
confirm Boolean

Returns

Name Type Description
activity_unpublish_all ID Clean up ALL feeds

admin_api_call_notification_create

Arguments

Name Type
api_call_notification ApiCallNotificationInputType

Returns

Name Type Description
callback String liquid code which can be used to process the response from the endpoint. You have access to "response" variable.
content String liquid code to evaluate to whatever you want to send, for example a JSON.
created_at JSONDate
delay_by String 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 FormConfiguration form configurations which trigger the email
forms Form forms which trigger the email
headers String liquid code to evaluate to valid json of request headers
id ID
metadata HashObject
name String name of the api call, which is used in form_configurations or mutation to trigger it
physical_file_path String defines the physical path of the file
request_type String Liquid code which should evaluate to valid request type: Get, Post, Put, Patch, Delete or if you want to send binary files: Post_Multipart, Put_Multipart, Patch_Multipart
to String liquid code to evaluate to valid endpoint for the request.
trigger_condition String liquid code which should evaluate to true if the api call should be sent
updated_at JSONDate

admin_api_call_notification_delete

Arguments

Name Type
id ID

Returns

Name Type Description
callback String liquid code which can be used to process the response from the endpoint. You have access to "response" variable.
content String liquid code to evaluate to whatever you want to send, for example a JSON.
created_at JSONDate
delay_by String 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 FormConfiguration form configurations which trigger the email
forms Form forms which trigger the email
headers String liquid code to evaluate to valid json of request headers
id ID
metadata HashObject
name String name of the api call, which is used in form_configurations or mutation to trigger it
physical_file_path String defines the physical path of the file
request_type String Liquid code which should evaluate to valid request type: Get, Post, Put, Patch, Delete or if you want to send binary files: Post_Multipart, Put_Multipart, Patch_Multipart
to String liquid code to evaluate to valid endpoint for the request.
trigger_condition String liquid code which should evaluate to true if the api call should be sent
updated_at JSONDate

admin_api_call_notification_update

Arguments

Name Type
api_call_notification UpdateApiCallNotificationInputType
id ID

Returns

Name Type Description
callback String liquid code which can be used to process the response from the endpoint. You have access to "response" variable.
content String liquid code to evaluate to whatever you want to send, for example a JSON.
created_at JSONDate
delay_by String 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 FormConfiguration form configurations which trigger the email
forms Form forms which trigger the email
headers String liquid code to evaluate to valid json of request headers
id ID
metadata HashObject
name String name of the api call, which is used in form_configurations or mutation to trigger it
physical_file_path String defines the physical path of the file
request_type String Liquid code which should evaluate to valid request type: Get, Post, Put, Patch, Delete or if you want to send binary files: Post_Multipart, Put_Multipart, Patch_Multipart
to String liquid code to evaluate to valid endpoint for the request.
trigger_condition String liquid code which should evaluate to true if the api call should be sent
updated_at JSONDate

admin_assets_create

Arguments

Name Type
assets AssetInput

Returns

Name Type Description
assets Asset

admin_assets_presign_urls

Arguments

Name Type
paths AssetPresignInput

Returns

Name Type Description
urls PresignedUrl

admin_authorization_policy_create

Arguments

Name Type
authorization_policy AuthorizationPolicyInputType

Returns

Name Type Description
authorization_policy_associations AuthorizationPolicyAssociation
content String
created_at JSONDate
flash_alert String
http_status Int use this status code when authorization fails; usually 404 or 403
id ID
metadata HashObject
name String
physical_file_path String defines the physical path of the file
redirect_to String
updated_at JSONDate

admin_authorization_policy_delete

Arguments

Name Type
id ID

Returns

Name Type Description
authorization_policy_associations AuthorizationPolicyAssociation
content String
created_at JSONDate
flash_alert String
http_status Int use this status code when authorization fails; usually 404 or 403
id ID
metadata HashObject
name String
physical_file_path String defines the physical path of the file
redirect_to String
updated_at JSONDate

admin_authorization_policy_update

Arguments

Name Type
authorization_policy UpdateAuthorizationPolicyInputType
id ID

Returns

Name Type Description
authorization_policy_associations AuthorizationPolicyAssociation
content String
created_at JSONDate
flash_alert String
http_status Int use this status code when authorization fails; usually 404 or 403
id ID
metadata HashObject
name String
physical_file_path String defines the physical path of the file
redirect_to String
updated_at JSONDate

admin_email_notification_create

Arguments

Name Type
email_notification EmailNotificationInputType

Returns

Name Type Description
attachments String json of the form { "file_name.jpg": { "url": "http://example.com/file.jpg" } } which defines email attachments. Liquid will be processed.
bcc String Comma separated blind carbon copy list. Liquid allowed. For example "john@example.com, jane@example.com"
cc String Comma separated carbon copy list. Liquid allowed. For example "john@example.com, jane@example.com"
content String 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.
created_at JSONDate
delay_by String 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 FormConfiguration form configurations which trigger the email
forms Form forms which trigger the email
from String email address from which you would like to send the email, for example notifications@mydomain.com
id ID
layout_path String name of the liquid layout to which the content should be injected
metadata HashObject
name String name of the email, which is used in form_configurations or mutation to trigger it
physical_file_path String defines the physical path of the file
reply_to String email address to which users should reply, for example support@mydomain.com
subject String liquid code to evaluate to text
to String Comma separated recipient list. Liquid allowed. For example: "john@example.com, jane@example.com"
trigger_condition String liquid code which should evaluate to true if the email should be sent
updated_at JSONDate

admin_email_notification_delete

Arguments

Name Type
id ID

Returns

Name Type Description
attachments String json of the form { "file_name.jpg": { "url": "http://example.com/file.jpg" } } which defines email attachments. Liquid will be processed.
bcc String Comma separated blind carbon copy list. Liquid allowed. For example "john@example.com, jane@example.com"
cc String Comma separated carbon copy list. Liquid allowed. For example "john@example.com, jane@example.com"
content String 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.
created_at JSONDate
delay_by String 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 FormConfiguration form configurations which trigger the email
forms Form forms which trigger the email
from String email address from which you would like to send the email, for example notifications@mydomain.com
id ID
layout_path String name of the liquid layout to which the content should be injected
metadata HashObject
name String name of the email, which is used in form_configurations or mutation to trigger it
physical_file_path String defines the physical path of the file
reply_to String email address to which users should reply, for example support@mydomain.com
subject String liquid code to evaluate to text
to String Comma separated recipient list. Liquid allowed. For example: "john@example.com, jane@example.com"
trigger_condition String liquid code which should evaluate to true if the email should be sent
updated_at JSONDate

admin_email_notification_update

Arguments

Name Type
email_notification UpdateEmailNotificationInputType
id ID

Returns

Name Type Description
attachments String json of the form { "file_name.jpg": { "url": "http://example.com/file.jpg" } } which defines email attachments. Liquid will be processed.
bcc String Comma separated blind carbon copy list. Liquid allowed. For example "john@example.com, jane@example.com"
cc String Comma separated carbon copy list. Liquid allowed. For example "john@example.com, jane@example.com"
content String 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.
created_at JSONDate
delay_by String 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 FormConfiguration form configurations which trigger the email
forms Form forms which trigger the email
from String email address from which you would like to send the email, for example notifications@mydomain.com
id ID
layout_path String name of the liquid layout to which the content should be injected
metadata HashObject
name String name of the email, which is used in form_configurations or mutation to trigger it
physical_file_path String defines the physical path of the file
reply_to String email address to which users should reply, for example support@mydomain.com
subject String liquid code to evaluate to text
to String Comma separated recipient list. Liquid allowed. For example: "john@example.com, jane@example.com"
trigger_condition String liquid code which should evaluate to true if the email should be sent
updated_at JSONDate

admin_field_create

Arguments

Name Type
field StandalonePropertyInputType

Returns

Name Type Description
attribute_type PropertyTypeEnum Type of the property
created_at JSONDate
default_value String Default value for new objects
id ID
metadata HashObject
name String Name of the property
physical_file_path String defines the physical path of the file
target_id ID Id of the schema to which this property definition belongs
target_type String Type of the schema to which this property definition belongs
updated_at JSONDate

admin_field_delete

Arguments

Name Type
id ID

Returns

Name Type Description
attribute_type PropertyTypeEnum Type of the property
created_at JSONDate
default_value String Default value for new objects
id ID
metadata HashObject
name String Name of the property
physical_file_path String defines the physical path of the file
target_id ID Id of the schema to which this property definition belongs
target_type String Type of the schema to which this property definition belongs
updated_at JSONDate

admin_field_update

Arguments

Name Type
field UpdateStandalonePropertyInputType
id ID

Returns

Name Type Description
attribute_type PropertyTypeEnum Type of the property
created_at JSONDate
default_value String Default value for new objects
id ID
metadata HashObject
name String Name of the property
physical_file_path String defines the physical path of the file
target_id ID Id of the schema to which this property definition belongs
target_type String Type of the schema to which this property definition belongs
updated_at JSONDate

admin_form_configuration_create

Arguments

Name Type
form_configuration FormConfigurationInputType

Returns

Name Type Description
api_call_notifications ApiCallNotification associated api call notifications
async_callback_actions String Same as callback, but invoked asynchronously. Recommended for performance reason.
async_callback_delay String 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.
async_callback_max_attempts Int Defines max number of retrying attempts in case of an error. Usually you do not want to change it.
async_callback_priority AsyncCallbackPriority defines the invocaction priority, the higher the quicker timeout
authorization_policies AuthorizationPolicy associated authorization policies
callback_actions String liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead
configuration HashObject 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 )
created_at JSONDate
default_payload String 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
email_notifications EmailNotification associated email notifications
flash_alert String Message which you want to display to user upon validation errors.Output is available via context.flash_alert. Liquid allowed.
flash_notice String Message which you want to display to user after successful form submission. Output is available via context.flash_notice. Liquid allowed.
id ID
liquid_body String liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.
metadata HashObject
name String
physical_file_path String defines the physical path of the file
redirect_to String Path or URL to which user should be redirected after successful form submission. Liquid allowed.
resource String
resource_owner String defines who can submit the form. If set to anyone, please make sure to provide authorization_policies
sms_notifications SmsNotification associated sms notifications
spam_protection HashObject name of the strategy and configuration for them
updated_at JSONDate

admin_form_configuration_delete

Arguments

Name Type
id ID

Returns

Name Type Description
api_call_notifications ApiCallNotification associated api call notifications
async_callback_actions String Same as callback, but invoked asynchronously. Recommended for performance reason.
async_callback_delay String 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.
async_callback_max_attempts Int Defines max number of retrying attempts in case of an error. Usually you do not want to change it.
async_callback_priority AsyncCallbackPriority defines the invocaction priority, the higher the quicker timeout
authorization_policies AuthorizationPolicy associated authorization policies
callback_actions String liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead
configuration HashObject 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 )
created_at JSONDate
default_payload String 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
email_notifications EmailNotification associated email notifications
flash_alert String Message which you want to display to user upon validation errors.Output is available via context.flash_alert. Liquid allowed.
flash_notice String Message which you want to display to user after successful form submission. Output is available via context.flash_notice. Liquid allowed.
id ID
liquid_body String liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.
metadata HashObject
name String
physical_file_path String defines the physical path of the file
redirect_to String Path or URL to which user should be redirected after successful form submission. Liquid allowed.
resource String
resource_owner String defines who can submit the form. If set to anyone, please make sure to provide authorization_policies
sms_notifications SmsNotification associated sms notifications
spam_protection HashObject name of the strategy and configuration for them
updated_at JSONDate

admin_form_configuration_update

Arguments

Name Type
form_configuration UpdateFormConfigurationInputType
id ID

Returns

Name Type Description
api_call_notifications ApiCallNotification associated api call notifications
async_callback_actions String Same as callback, but invoked asynchronously. Recommended for performance reason.
async_callback_delay String 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.
async_callback_max_attempts Int Defines max number of retrying attempts in case of an error. Usually you do not want to change it.
async_callback_priority AsyncCallbackPriority defines the invocaction priority, the higher the quicker timeout
authorization_policies AuthorizationPolicy associated authorization policies
callback_actions String liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead
configuration HashObject 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 )
created_at JSONDate
default_payload String 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
email_notifications EmailNotification associated email notifications
flash_alert String Message which you want to display to user upon validation errors.Output is available via context.flash_alert. Liquid allowed.
flash_notice String Message which you want to display to user after successful form submission. Output is available via context.flash_notice. Liquid allowed.
id ID
liquid_body String liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.
metadata HashObject
name String
physical_file_path String defines the physical path of the file
redirect_to String Path or URL to which user should be redirected after successful form submission. Liquid allowed.
resource String
resource_owner String defines who can submit the form. If set to anyone, please make sure to provide authorization_policies
sms_notifications SmsNotification associated sms notifications
spam_protection HashObject name of the strategy and configuration for them
updated_at JSONDate

admin_form_create

Arguments

Name Type
form FormInput

Returns

Name Type Description
api_call_notifications ApiCallNotification associated api call notifications
async_callback_actions String Same as callback, but invoked asynchronously. Recommended for performance reason.
async_callback_delay String 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.
async_callback_max_attempts Int Defines max number of retrying attempts in case of an error. Usually you do not want to change it.
async_callback_priority AsyncCallbackPriority defines the invocaction priority, the higher the quicker timeout
authorization_policies AuthorizationPolicy associated authorization policies
callback_actions String liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead
configuration HashObject 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 )
created_at JSONDate
default_payload String 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
email_notifications EmailNotification associated email notifications
flash_alert String Message which you want to display to user upon validation errors.Output is available via context.flash_alert. Liquid allowed.
flash_notice String Message which you want to display to user after successful form submission. Output is available via context.flash_notice. Liquid allowed.
id ID
liquid_body String liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.
metadata HashObject
name String
physical_file_path String defines the physical path of the file
redirect_to String Path or URL to which user should be redirected after successful form submission. Liquid allowed.
resource String
resource_owner String defines who can submit the form. If set to anyone, please make sure to provide authorization_policies
sms_notifications SmsNotification associated sms notifications
spam_protection HashObject name of the strategy and configuration for them
updated_at JSONDate

admin_form_delete

Arguments

Name Type
id ID

Returns

Name Type Description
api_call_notifications ApiCallNotification associated api call notifications
async_callback_actions String Same as callback, but invoked asynchronously. Recommended for performance reason.
async_callback_delay String 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.
async_callback_max_attempts Int Defines max number of retrying attempts in case of an error. Usually you do not want to change it.
async_callback_priority AsyncCallbackPriority defines the invocaction priority, the higher the quicker timeout
authorization_policies AuthorizationPolicy associated authorization policies
callback_actions String liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead
configuration HashObject 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 )
created_at JSONDate
default_payload String 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
email_notifications EmailNotification associated email notifications
flash_alert String Message which you want to display to user upon validation errors.Output is available via context.flash_alert. Liquid allowed.
flash_notice String Message which you want to display to user after successful form submission. Output is available via context.flash_notice. Liquid allowed.
id ID
liquid_body String liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.
metadata HashObject
name String
physical_file_path String defines the physical path of the file
redirect_to String Path or URL to which user should be redirected after successful form submission. Liquid allowed.
resource String
resource_owner String defines who can submit the form. If set to anyone, please make sure to provide authorization_policies
sms_notifications SmsNotification associated sms notifications
spam_protection HashObject name of the strategy and configuration for them
updated_at JSONDate

admin_form_update

Arguments

Name Type
form UpdateFormInput
id ID

Returns

Name Type Description
api_call_notifications ApiCallNotification associated api call notifications
async_callback_actions String Same as callback, but invoked asynchronously. Recommended for performance reason.
async_callback_delay String 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.
async_callback_max_attempts Int Defines max number of retrying attempts in case of an error. Usually you do not want to change it.
async_callback_priority AsyncCallbackPriority defines the invocaction priority, the higher the quicker timeout
authorization_policies AuthorizationPolicy associated authorization policies
callback_actions String liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead
configuration HashObject 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 )
created_at JSONDate
default_payload String 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
email_notifications EmailNotification associated email notifications
flash_alert String Message which you want to display to user upon validation errors.Output is available via context.flash_alert. Liquid allowed.
flash_notice String Message which you want to display to user after successful form submission. Output is available via context.flash_notice. Liquid allowed.
id ID
liquid_body String liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.
metadata HashObject
name String
physical_file_path String defines the physical path of the file
redirect_to String Path or URL to which user should be redirected after successful form submission. Liquid allowed.
resource String
resource_owner String defines who can submit the form. If set to anyone, please make sure to provide authorization_policies
sms_notifications SmsNotification associated sms notifications
spam_protection HashObject name of the strategy and configuration for them
updated_at JSONDate

admin_liquid_layout_create

Arguments

Name Type
liquid_layout LiquidLayoutInputType

Returns

Name Type Description
body String liquid code to evaluate to valid html. To inject content of the resources using the layout use {{ content_for_layout }}
created_at JSONDate
format PageFormat
id ID
metadata HashObject
path String defines the the path for layout, must starts with layouts/, for example layouts/my_layout
physical_file_path String defines the physical path of the file
updated_at JSONDate

admin_liquid_layout_delete

Arguments

Name Type
id ID

Returns

Name Type Description
body String liquid code to evaluate to valid html. To inject content of the resources using the layout use {{ content_for_layout }}
created_at JSONDate
format PageFormat
id ID
metadata HashObject
path String defines the the path for layout, must starts with layouts/, for example layouts/my_layout
physical_file_path String defines the physical path of the file
updated_at JSONDate

admin_liquid_layout_update

Arguments

Name Type
id ID
liquid_layout UpdateLiquidLayoutInputType

Returns

Name Type Description
body String liquid code to evaluate to valid html. To inject content of the resources using the layout use {{ content_for_layout }}
created_at JSONDate
format PageFormat
id ID
metadata HashObject
path String defines the the path for layout, must starts with layouts/, for example layouts/my_layout
physical_file_path String defines the physical path of the file
updated_at JSONDate

admin_liquid_partial_create

Arguments

Name Type
liquid_partial LiquidPartialInputType

Returns

Name Type Description
body String liquid code to evaluate to valid html
created_at JSONDate
format PageFormat
id ID
metadata HashObject
path String defines the name of the partial to be used with include tag
physical_file_path String defines the physical path of the file
updated_at JSONDate

admin_liquid_partial_delete

Arguments

Name Type
id ID

Returns

Name Type Description
body String liquid code to evaluate to valid html
created_at JSONDate
format PageFormat
id ID
metadata HashObject
path String defines the name of the partial to be used with include tag
physical_file_path String defines the physical path of the file
updated_at JSONDate

admin_liquid_partial_update

Arguments

Name Type
id ID
liquid_partial UpdateLiquidPartialInputType

Returns

Name Type Description
body String liquid code to evaluate to valid html
created_at JSONDate
format PageFormat
id ID
metadata HashObject
path String defines the name of the partial to be used with include tag
physical_file_path String defines the physical path of the file
updated_at JSONDate

admin_model_schema_create

Arguments

Name Type
model_schema ModelSchemaInputType

Returns

Name Type Description
created_at JSONDate
fields Property Deprecated, use properties instead.
id ID
metadata HashObject
name String
parameterized_name String
physical_file_path String defines the physical path of the file
properties Property List of properties attributes to be included in the results
updated_at JSONDate

admin_model_schema_delete

Arguments

Name Type
id ID

Returns

Name Type Description
created_at JSONDate
fields Property Deprecated, use properties instead.
id ID
metadata HashObject
name String
parameterized_name String
physical_file_path String defines the physical path of the file
properties Property List of properties attributes to be included in the results
updated_at JSONDate

admin_model_schema_update

Arguments

Name Type
id ID
model_schema UpdateModelSchemaInputType

Returns

Name Type Description
created_at JSONDate
fields Property Deprecated, use properties instead.
id ID
metadata HashObject
name String
parameterized_name String
physical_file_path String defines the physical path of the file
properties Property List of properties attributes to be included in the results
updated_at JSONDate

admin_page_create

Arguments

Name Type
page PageInputType

Returns

Name Type Description
authorization_policies AuthorizationPolicy associated authorization policies
content String
created_at JSONDate
dynamic_cache_expire Int 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)
dynamic_cache_key String 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.
dynamic_cache_layout Boolean 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.
format PageFormat
handler PageRequestMethod
id ID
layout_name String
max_deep_level Int 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.
metadata HashObject
physical_file_path String defines the physical path of the file
redirect_code Int
redirect_to String
request_method PageRequestMethod
response_headers HashObject
searchable Boolean
slug String
static_cache_expire Int 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
updated_at JSONDate

admin_page_delete

Arguments

Name Type
id ID

Returns

Name Type Description
authorization_policies AuthorizationPolicy associated authorization policies
content String
created_at JSONDate
dynamic_cache_expire Int 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)
dynamic_cache_key String 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.
dynamic_cache_layout Boolean 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.
format PageFormat
handler PageRequestMethod
id ID
layout_name String
max_deep_level Int 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.
metadata HashObject
physical_file_path String defines the physical path of the file
redirect_code Int
redirect_to String
request_method PageRequestMethod
response_headers HashObject
searchable Boolean
slug String
static_cache_expire Int 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
updated_at JSONDate

admin_page_update

Arguments

Name Type
id ID
page UpdatePageInputType

Returns

Name Type Description
authorization_policies AuthorizationPolicy associated authorization policies
content String
created_at JSONDate
dynamic_cache_expire Int 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)
dynamic_cache_key String 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.
dynamic_cache_layout Boolean 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.
format PageFormat
handler PageRequestMethod
id ID
layout_name String
max_deep_level Int 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.
metadata HashObject
physical_file_path String defines the physical path of the file
redirect_code Int
redirect_to String
request_method PageRequestMethod
response_headers HashObject
searchable Boolean
slug String
static_cache_expire Int 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
updated_at JSONDate

admin_property_create

Arguments

Name Type
property StandalonePropertyInputType

Returns

Name Type Description
attribute_type PropertyTypeEnum Type of the property
created_at JSONDate
default_value String Default value for new objects
id ID
metadata HashObject
name String Name of the property
physical_file_path String defines the physical path of the file
target_id ID Id of the schema to which this property definition belongs
target_type String Type of the schema to which this property definition belongs
updated_at JSONDate

admin_property_delete

Arguments

Name Type
id ID

Returns

Name Type Description
attribute_type PropertyTypeEnum Type of the property
created_at JSONDate
default_value String Default value for new objects
id ID
metadata HashObject
name String Name of the property
physical_file_path String defines the physical path of the file
target_id ID Id of the schema to which this property definition belongs
target_type String Type of the schema to which this property definition belongs
updated_at JSONDate

admin_property_update

Arguments

Name Type
id ID
property UpdateStandalonePropertyInputType

Returns

Name Type Description
attribute_type PropertyTypeEnum Type of the property
created_at JSONDate
default_value String Default value for new objects
id ID
metadata HashObject
name String Name of the property
physical_file_path String defines the physical path of the file
target_id ID Id of the schema to which this property definition belongs
target_type String Type of the schema to which this property definition belongs
updated_at JSONDate

admin_sms_notification_create

Arguments

Name Type
sms_notification SmsNotificationInputType

Returns

Name Type Description
content String 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.
created_at JSONDate
delay_by String 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 FormConfiguration form configurations which trigger the email
forms Form forms which trigger the email
id ID
metadata HashObject
name String name of the sms, which is used in form_configurations or mutation to trigger it
physical_file_path String defines the physical path of the file
to String 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".
trigger_condition String liquid code which should evaluate to true if the sms should be sent
updated_at JSONDate

admin_sms_notification_delete

Arguments

Name Type
id ID

Returns

Name Type Description
content String 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.
created_at JSONDate
delay_by String 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 FormConfiguration form configurations which trigger the email
forms Form forms which trigger the email
id ID
metadata HashObject
name String name of the sms, which is used in form_configurations or mutation to trigger it
physical_file_path String defines the physical path of the file
to String 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".
trigger_condition String liquid code which should evaluate to true if the sms should be sent
updated_at JSONDate

admin_sms_notification_update

Arguments

Name Type
id ID
sms_notification UpdateSmsNotificationInputType

Returns

Name Type Description
content String 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.
created_at JSONDate
delay_by String 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 FormConfiguration form configurations which trigger the email
forms Form forms which trigger the email
id ID
metadata HashObject
name String name of the sms, which is used in form_configurations or mutation to trigger it
physical_file_path String defines the physical path of the file
to String 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".
trigger_condition String liquid code which should evaluate to true if the sms should be sent
updated_at JSONDate

admin_transactable_schema_create

Arguments

Name Type
transactable_schema TransactableSchemaInputType

Returns

Name Type Description
created_at JSONDate
fields Property Deprecated, use properties instead.
id ID
metadata HashObject
name String
parameterized_name String
physical_file_path String defines the physical path of the file
properties Property List of properties attributes to be included in the results
updated_at JSONDate

admin_transactable_schema_delete

Arguments

Name Type
id ID

Returns

Name Type Description
created_at JSONDate
fields Property Deprecated, use properties instead.
id ID
metadata HashObject
name String
parameterized_name String
physical_file_path String defines the physical path of the file
properties Property List of properties attributes to be included in the results
updated_at JSONDate

admin_transactable_schema_update

Arguments

Name Type
id ID
transactable_schema UpdateTransactableSchemaInputType

Returns

Name Type Description
created_at JSONDate
fields Property Deprecated, use properties instead.
id ID
metadata HashObject
name String
parameterized_name String
physical_file_path String defines the physical path of the file
properties Property List of properties attributes to be included in the results
updated_at JSONDate

admin_user_profile_schema_create

Arguments

Name Type
user_profile_schema UserProfileSchemaInputType

Returns

Name Type Description
created_at JSONDate
fields Property Deprecated, use properties instead.
id ID
metadata HashObject
name String
parameterized_name String
physical_file_path String defines the physical path of the file
properties Property List of properties attributes to be included in the results
updated_at JSONDate

admin_user_profile_schema_delete

Arguments

Name Type
id ID

Returns

Name Type Description
created_at JSONDate
fields Property Deprecated, use properties instead.
id ID
metadata HashObject
name String
parameterized_name String
physical_file_path String defines the physical path of the file
properties Property List of properties attributes to be included in the results
updated_at JSONDate

admin_user_profile_schema_update

Arguments

Name Type
id ID
user_profile_schema UpdateUserProfileSchemaInputType

Returns

Name Type Description
created_at JSONDate
fields Property Deprecated, use properties instead.
id ID
metadata HashObject
name String
parameterized_name String
physical_file_path String defines the physical path of the file
properties Property List of properties attributes to be included in the results
updated_at JSONDate

api_call_send

Arguments

Name Type
data HashObject
template NotificationTemplateInput

Returns

Name Type Description
errors BaseError
response Response

bank_account_create

Arguments

Name Type
bank_account BankAccountInputType
form_configuration_name String

Returns

Name Type Description
bank_name String
id ID
instance_client_id ID
name String
payment_method_id ID

bank_account_delete

Arguments

Name Type
form_configuration_name String
id ID

Returns

Name Type Description
bank_name String
id ID
instance_client_id ID
name String
payment_method_id ID

constant_set

Arguments

Name Type
name String
value String

Returns

Name Type Description
created_at JSONDate
deleted_at JSONDate
name String Name of the constant
updated_at JSONDate
value String Decrypted value of a constant

constant_unset

Arguments

Name Type
name String

Returns

Name Type Description
created_at JSONDate
deleted_at JSONDate
name String Name of the constant
updated_at JSONDate
value String Decrypted value of a constant

credit_card_create

Arguments

Name Type
credit_card CreditCardInputType
form_configuration_name String

Returns

Name Type Description
default_card Boolean
id ID
instance_client_id ID
name String
payment_method_id ID
token String

credit_card_delete

Arguments

Name Type
form_configuration_name String
id ID

Returns

Name Type Description
default_card Boolean
id ID
instance_client_id ID
name String
payment_method_id ID
token String

custom_attachment_create

Arguments

Name Type
custom_attachment CustomAttachmentInputType
form_configuration_name String
form_name String

Returns

Name Type Description
created_at JSONDate
file_url String
id ID

custom_attachment_delete

Arguments

Name Type
form_configuration_name String
form_name String
id ID

Returns

Name Type Description
created_at JSONDate
file_url String
id ID

custom_attachment_update

Arguments

Name Type
custom_attachment UpdateCustomAttachmentInputType
form_configuration_name String
form_name String
id ID

Returns

Name Type Description
created_at JSONDate
file_url String
id ID

custom_image_create

Arguments

Name Type
custom_image NewCustomImageInputType
form_configuration_name String
form_name String

Returns

Name Type Description
created_at JSONDate timestamp of when the record was created, automatically generated by the system
deleted_at JSONDate 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.
file_url String
id ID
name String
property_id ID
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
uploader_id ID

custom_image_delete

Arguments

Name Type
form_configuration_name String
form_name String
id ID

Returns

Name Type Description
created_at JSONDate timestamp of when the record was created, automatically generated by the system
deleted_at JSONDate 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.
file_url String
id ID
name String
property_id ID
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
uploader_id ID

custom_image_update

Arguments

Name Type
custom_image CustomImageInputType
form_configuration_name String
form_name String
id ID

Returns

Name Type Description
created_at JSONDate timestamp of when the record was created, automatically generated by the system
deleted_at JSONDate 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.
file_url String
id ID
name String
property_id ID
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
uploader_id ID

customization_create

Arguments

Name Type
customization CustomizationInputType
form_configuration_name String
form_name String
model CustomizationInputType

Returns

Name Type Description
address CustomAddrress Fetch address by name, e.g: address: address(name: "office_address")
addresses CustomAddrress Fetch all addresses, optionally you can filter results by name, e.g: home_address: addresses(name: "home")
attachment PrivateFile Fetch attachment by name, e.g: sales_report: attachment(name: "sales_report")
attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: attachments(name: "sales_report")
created_at JSONDate timestamp of when the record was created, automatically generated by the system
custom_address CustomAddrress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses CustomAddrress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment PrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: custom_attachments(name: "sales_report")
custom_image Image Fetch image by name, e.g: header: custom_image(name: "header")
custom_images Image Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizable Customizable
customizable_id ID id of a parent, which can other customization, user profile or user
customizable_type String class of a parent - Customization, User or UserProfile
deleted_at JSONDate 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.
external_id ID Used mainly for import/export, if you want to use third party service as a source of truth
human_name String
id ID
image Image Fetch image by name, e.g: header: image(name: "header")
images Image Fetch all images, optionally you can filter results by name, e.g: cat_images: images(name: "cat")
model ListingsCustomization Defines belongs-to relation with other model, e.g: parent: model(model_name: "parent", join_on_property: "parent_id") { id }
models ListingsCustomization Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
properties HashObject List of all properties assigned to the object.
property String Fetch any property by name, ex: hair_color: property(name: "hair_color")
property_array String Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String. E.g: todo_list: property_array(name: "todo_list")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.
remote_model Customization Defines relation object accessible over HTTP in JSON collection identified by it's ID.
sort_score Int when sorting by distance - field contains distance to target location
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }
user_id ID

customization_delete

Arguments

Name Type
form_configuration_name String
form_name String
id ID

Returns

Name Type Description
address CustomAddrress Fetch address by name, e.g: address: address(name: "office_address")
addresses CustomAddrress Fetch all addresses, optionally you can filter results by name, e.g: home_address: addresses(name: "home")
attachment PrivateFile Fetch attachment by name, e.g: sales_report: attachment(name: "sales_report")
attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: attachments(name: "sales_report")
created_at JSONDate timestamp of when the record was created, automatically generated by the system
custom_address CustomAddrress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses CustomAddrress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment PrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: custom_attachments(name: "sales_report")
custom_image Image Fetch image by name, e.g: header: custom_image(name: "header")
custom_images Image Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizable Customizable
customizable_id ID id of a parent, which can other customization, user profile or user
customizable_type String class of a parent - Customization, User or UserProfile
deleted_at JSONDate 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.
external_id ID Used mainly for import/export, if you want to use third party service as a source of truth
human_name String
id ID
image Image Fetch image by name, e.g: header: image(name: "header")
images Image Fetch all images, optionally you can filter results by name, e.g: cat_images: images(name: "cat")
model ListingsCustomization Defines belongs-to relation with other model, e.g: parent: model(model_name: "parent", join_on_property: "parent_id") { id }
models ListingsCustomization Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
properties HashObject List of all properties assigned to the object.
property String Fetch any property by name, ex: hair_color: property(name: "hair_color")
property_array String Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String. E.g: todo_list: property_array(name: "todo_list")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.
remote_model Customization Defines relation object accessible over HTTP in JSON collection identified by it's ID.
sort_score Int when sorting by distance - field contains distance to target location
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }
user_id ID

customization_update

Arguments

Name Type
customization CustomizationInputType
form_configuration_name String
form_name String
id ID
model CustomizationInputType

Returns

Name Type Description
address CustomAddrress Fetch address by name, e.g: address: address(name: "office_address")
addresses CustomAddrress Fetch all addresses, optionally you can filter results by name, e.g: home_address: addresses(name: "home")
attachment PrivateFile Fetch attachment by name, e.g: sales_report: attachment(name: "sales_report")
attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: attachments(name: "sales_report")
created_at JSONDate timestamp of when the record was created, automatically generated by the system
custom_address CustomAddrress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses CustomAddrress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment PrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: custom_attachments(name: "sales_report")
custom_image Image Fetch image by name, e.g: header: custom_image(name: "header")
custom_images Image Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizable Customizable
customizable_id ID id of a parent, which can other customization, user profile or user
customizable_type String class of a parent - Customization, User or UserProfile
deleted_at JSONDate 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.
external_id ID Used mainly for import/export, if you want to use third party service as a source of truth
human_name String
id ID
image Image Fetch image by name, e.g: header: image(name: "header")
images Image Fetch all images, optionally you can filter results by name, e.g: cat_images: images(name: "cat")
model ListingsCustomization Defines belongs-to relation with other model, e.g: parent: model(model_name: "parent", join_on_property: "parent_id") { id }
models ListingsCustomization Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
properties HashObject List of all properties assigned to the object.
property String Fetch any property by name, ex: hair_color: property(name: "hair_color")
property_array String Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String. E.g: todo_list: property_array(name: "todo_list")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.
remote_model Customization Defines relation object accessible over HTTP in JSON collection identified by it's ID.
sort_score Int when sorting by distance - field contains distance to target location
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }
user_id ID

customizations_delete_all

Arguments

Name Type
all_custom_model_types Boolean
all_model_schemas Boolean
custom_model_type_name String
model_schema_name String

Returns

Name Type Description
count Int

email_send

Arguments

Name Type
data HashObject
template NotificationTemplateInput

Returns

Name Type Description
errors BaseError
is_scheduled_to_send Boolean

form_submit

Arguments

Name Type
fields HashObject
form_name String
id ID

Returns

Name Type Description
result Result includes one of model or user, depending on which form was submitted
validation_errors HashObject validation error messages based on form fields

import_models

Arguments

Name Type
models CustomizationImport

Returns

Name Type Description
external_ids ID
ids ID

import_transactables

Arguments

Name Type
transactables TransactableImport

Returns

Name Type Description
external_ids ID
ids ID

import_users

Arguments

Name Type
users UserImport

Returns

Name Type Description
external_ids ID
ids ID

log

Arguments

Name Type
message Any
type LogEntryType

Returns

Name Type Description
id ID
message String
type String

model_create

Arguments

Name Type
customization CustomizationInputType
form_configuration_name String
form_name String
model CustomizationInputType

Returns

Name Type Description
address CustomAddrress Fetch address by name, e.g: address: address(name: "office_address")
addresses CustomAddrress Fetch all addresses, optionally you can filter results by name, e.g: home_address: addresses(name: "home")
attachment PrivateFile Fetch attachment by name, e.g: sales_report: attachment(name: "sales_report")
attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: attachments(name: "sales_report")
created_at JSONDate timestamp of when the record was created, automatically generated by the system
custom_address CustomAddrress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses CustomAddrress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment PrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: custom_attachments(name: "sales_report")
custom_image Image Fetch image by name, e.g: header: custom_image(name: "header")
custom_images Image Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizable Customizable
customizable_id ID id of a parent, which can other customization, user profile or user
customizable_type String class of a parent - Customization, User or UserProfile
deleted_at JSONDate 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.
external_id ID Used mainly for import/export, if you want to use third party service as a source of truth
human_name String
id ID
image Image Fetch image by name, e.g: header: image(name: "header")
images Image Fetch all images, optionally you can filter results by name, e.g: cat_images: images(name: "cat")
model ListingsCustomization Defines belongs-to relation with other model, e.g: parent: model(model_name: "parent", join_on_property: "parent_id") { id }
models ListingsCustomization Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
properties HashObject List of all properties assigned to the object.
property String Fetch any property by name, ex: hair_color: property(name: "hair_color")
property_array String Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String. E.g: todo_list: property_array(name: "todo_list")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.
remote_model Customization Defines relation object accessible over HTTP in JSON collection identified by it's ID.
sort_score Int when sorting by distance - field contains distance to target location
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }
user_id ID

model_delete

Arguments

Name Type
form_configuration_name String
form_name String
id ID

Returns

Name Type Description
address CustomAddrress Fetch address by name, e.g: address: address(name: "office_address")
addresses CustomAddrress Fetch all addresses, optionally you can filter results by name, e.g: home_address: addresses(name: "home")
attachment PrivateFile Fetch attachment by name, e.g: sales_report: attachment(name: "sales_report")
attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: attachments(name: "sales_report")
created_at JSONDate timestamp of when the record was created, automatically generated by the system
custom_address CustomAddrress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses CustomAddrress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment PrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: custom_attachments(name: "sales_report")
custom_image Image Fetch image by name, e.g: header: custom_image(name: "header")
custom_images Image Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizable Customizable
customizable_id ID id of a parent, which can other customization, user profile or user
customizable_type String class of a parent - Customization, User or UserProfile
deleted_at JSONDate 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.
external_id ID Used mainly for import/export, if you want to use third party service as a source of truth
human_name String
id ID
image Image Fetch image by name, e.g: header: image(name: "header")
images Image Fetch all images, optionally you can filter results by name, e.g: cat_images: images(name: "cat")
model ListingsCustomization Defines belongs-to relation with other model, e.g: parent: model(model_name: "parent", join_on_property: "parent_id") { id }
models ListingsCustomization Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
properties HashObject List of all properties assigned to the object.
property String Fetch any property by name, ex: hair_color: property(name: "hair_color")
property_array String Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String. E.g: todo_list: property_array(name: "todo_list")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.
remote_model Customization Defines relation object accessible over HTTP in JSON collection identified by it's ID.
sort_score Int when sorting by distance - field contains distance to target location
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }
user_id ID

model_update

Arguments

Name Type
customization CustomizationInputType
form_configuration_name String
form_name String
id ID
model CustomizationInputType

Returns

Name Type Description
address CustomAddrress Fetch address by name, e.g: address: address(name: "office_address")
addresses CustomAddrress Fetch all addresses, optionally you can filter results by name, e.g: home_address: addresses(name: "home")
attachment PrivateFile Fetch attachment by name, e.g: sales_report: attachment(name: "sales_report")
attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: attachments(name: "sales_report")
created_at JSONDate timestamp of when the record was created, automatically generated by the system
custom_address CustomAddrress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses CustomAddrress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment PrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: custom_attachments(name: "sales_report")
custom_image Image Fetch image by name, e.g: header: custom_image(name: "header")
custom_images Image Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizable Customizable
customizable_id ID id of a parent, which can other customization, user profile or user
customizable_type String class of a parent - Customization, User or UserProfile
deleted_at JSONDate 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.
external_id ID Used mainly for import/export, if you want to use third party service as a source of truth
human_name String
id ID
image Image Fetch image by name, e.g: header: image(name: "header")
images Image Fetch all images, optionally you can filter results by name, e.g: cat_images: images(name: "cat")
model ListingsCustomization Defines belongs-to relation with other model, e.g: parent: model(model_name: "parent", join_on_property: "parent_id") { id }
models ListingsCustomization Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
properties HashObject List of all properties assigned to the object.
property String Fetch any property by name, ex: hair_color: property(name: "hair_color")
property_array String Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String. E.g: todo_list: property_array(name: "todo_list")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.
remote_model Customization Defines relation object accessible over HTTP in JSON collection identified by it's ID.
sort_score Int when sorting by distance - field contains distance to target location
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }
user_id ID

models_delete_all

Arguments

Name Type
all_custom_model_types Boolean
all_model_schemas Boolean
custom_model_type_name String
model_schema_name String

Returns

Name Type Description
count Int

payment_charge

Arguments

Name Type
form_configuration_name String
id ID

Returns

Name Type Description
additional_tax_price Float
additional_tax_price_cents Float
created_at JSONDate
currency String
direct_charge Boolean
external_id String
failed_at JSONDate
id ID
included_tax_price Float
included_tax_price_cents Float
merchant_account MerchantAccount
paid_at JSONDate
payable_id Int
payable_type String
payer User
payment_gateway PaymentGateway
payment_gateway_fee_cents Float
payment_method PaymentMethod
payment_transfers PaymentTransfer
receiver User
refunds Refund
service_fee_payer Float
service_fee_receiver Float
state PaymentState
subtotal_amount Float
total_amount Float
total_amount_cents Float
transferable_amount Float Amount that can be transferred to receiver
transferable_amount_cents Float Amount cents that can be transferred to receiver

payment_create

Arguments

Name Type
form_configuration_name String
payment PaymentInputType

Returns

Name Type Description
errors HashObject
result Payment
success Boolean

payment_delete

Arguments

Name Type
form_configuration_name String
id ID

Returns

Name Type Description
additional_tax_price Float
additional_tax_price_cents Float
created_at JSONDate
currency String
direct_charge Boolean
external_id String
failed_at JSONDate
id ID
included_tax_price Float
included_tax_price_cents Float
merchant_account MerchantAccount
paid_at JSONDate
payable_id Int
payable_type String
payer User
payment_gateway PaymentGateway
payment_gateway_fee_cents Float
payment_method PaymentMethod
payment_transfers PaymentTransfer
receiver User
refunds Refund
service_fee_payer Float
service_fee_receiver Float
state PaymentState
subtotal_amount Float
total_amount Float
total_amount_cents Float
transferable_amount Float Amount that can be transferred to receiver
transferable_amount_cents Float Amount cents that can be transferred to receiver

payment_refund

Arguments

Name Type
form_configuration_name String
id ID
payment RefundPaymentInputType

Returns

Name Type Description
errors HashObject
result Payment
success Boolean

payment_transfer_create

Arguments

Name Type
form_configuration_name String
payment_transfer PaymentTransferInputType

Returns

Name Type Description
errors HashObject
result PaymentTransfer
success Boolean

payment_transfer_payout

Arguments

Name Type
form_configuration_name String
id ID

Returns

Name Type Description
errors HashObject
result PaymentTransfer
success Boolean

payment_transfer_process

Arguments

Name Type
form_configuration_name String
id ID

Returns

Name Type Description
errors HashObject
result PaymentTransfer
success Boolean

payment_transfer_update

Arguments

Name Type
form_configuration_name String
id ID
payment_transfer PaymentTransferInputType

Returns

Name Type Description
errors HashObject
result PaymentTransfer
success Boolean

payment_update

Arguments

Name Type
form_configuration_name String
id ID
payment UpdatePaymentInputType

Returns

Name Type Description
additional_tax_price Float
additional_tax_price_cents Float
created_at JSONDate
currency String
direct_charge Boolean
external_id String
failed_at JSONDate
id ID
included_tax_price Float
included_tax_price_cents Float
merchant_account MerchantAccount
paid_at JSONDate
payable_id Int
payable_type String
payer User
payment_gateway PaymentGateway
payment_gateway_fee_cents Float
payment_method PaymentMethod
payment_transfers PaymentTransfer
receiver User
refunds Refund
service_fee_payer Float
service_fee_receiver Float
state PaymentState
subtotal_amount Float
total_amount Float
total_amount_cents Float
transferable_amount Float Amount that can be transferred to receiver
transferable_amount_cents Float Amount cents that can be transferred to receiver

presigned_upload_url

Arguments

Name Type
options PresignUrlInput

Returns

Name Type Description
upload_url String Direct s3 upload endpoint to which you can upload files. Make sure you include upload_url_payload with the request
upload_url_payload HashObject Payload you need to provide for upload_url

session_create_field

Arguments

Name Type
name String
value Any

Returns

Name Type Description
session_create_field HashObject Adds a field to session

session_delete_field

Arguments

Name Type
name String

Returns

Name Type Description
session_delete_field HashObject Adds a field to session

transactable_create

Arguments

Name Type
form_configuration_name String
transactable TransactableInputType

Returns

Name Type Description
created_at JSONDate
creator User
creator_id ID
custom_address CustomAddrress
custom_image ListingImage
customizations Customization Fetch any customization by name or id, ex: hair_color: customization(name: "hair_color")
external_id ID
id ID
is_deleted Boolean
model ListingsCustomization Defines belongs-to relation with other model, e.g: parent: model(model_name: "parent", join_on_property: "parent_id") { id }
models ListingsCustomization Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
property String Fetch any Property by name, ex: hair_color: property(name: "hair_color")
property_array String
slug String
updated_at JSONDate
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }

transactable_delete

Arguments

Name Type
form_configuration_name String
id ID

Returns

Name Type Description
created_at JSONDate
creator User
creator_id ID
custom_address CustomAddrress
custom_image ListingImage
customizations Customization Fetch any customization by name or id, ex: hair_color: customization(name: "hair_color")
external_id ID
id ID
is_deleted Boolean
model ListingsCustomization Defines belongs-to relation with other model, e.g: parent: model(model_name: "parent", join_on_property: "parent_id") { id }
models ListingsCustomization Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
property String Fetch any Property by name, ex: hair_color: property(name: "hair_color")
property_array String
slug String
updated_at JSONDate
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }

transactable_update

Arguments

Name Type
form_configuration_name String
id ID
transactable TransactableInputType

Returns

Name Type Description
created_at JSONDate
creator User
creator_id ID
custom_address CustomAddrress
custom_image ListingImage
customizations Customization Fetch any customization by name or id, ex: hair_color: customization(name: "hair_color")
external_id ID
id ID
is_deleted Boolean
model ListingsCustomization Defines belongs-to relation with other model, e.g: parent: model(model_name: "parent", join_on_property: "parent_id") { id }
models ListingsCustomization Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
property String Fetch any Property by name, ex: hair_color: property(name: "hair_color")
property_array String
slug String
updated_at JSONDate
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }

transactables_delete_all

Arguments

Name Type
all_transactable_types Boolean
transactable_type_name String

Returns

Name Type Description
count Int

update_models

Arguments

Name Type
models ModelUpdate

Returns

Name Type Description
ids ID

update_users

Arguments

Name Type
users UserUpdate

Returns

Name Type Description
ids ID

user_create

Arguments

Name Type
form_configuration_name String
form_name String
id ID
user UserInputType

Returns

Name Type Description
address CustomAddrress Fetch address by name, e.g: address: address(name: "office_address")
addresses CustomAddrress Fetch all addresses, optionally you can filter results by name, e.g: home_address: addresses(name: "home")
attachment PrivateFile Fetch attachment by name, e.g: sales_report: attachment(name: "sales_report")
attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: attachments(name: "sales_report")
authentications Authentication stores information about user integrations with authentication providers like auth0, facebook, twitter etc
bank_accounts BankAccount deprecated, use our module https://github.com/mdyd-dev/platformos-payments
communication Communication used for twilio click-to-call integraation to verify phone number
created_at JSONDate timestamp of when the record was created, automatically generated by the system
credit_cards CreditCard deprecated, use our module https://github.com/mdyd-dev/platformos-payments
custom_address CustomAddrress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses CustomAddrress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment PrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: custom_attachments(name: "sales_report")
custom_image Image Fetch image by name, e.g: header: custom_image(name: "header")
custom_images Image Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizations Customization
deleted_at JSONDate 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.
email String
external_id String Used mainly for import/export, if you want to use third party service as a source of truth
first_name String
id ID ID of an object.
image Image Fetch image by name, e.g: header: image(name: "header")
images Image Fetch all images, optionally you can filter results by name, e.g: cat_images: images(name: "cat")
language String Used by translations to set the language of currently logged in user
last_name String
merchant_accounts MerchantAccount deprecated, use our module https://github.com/mdyd-dev/platformos-payments
middle_name String
model Model Defines has-one relation with other model, e.g: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }
models Model Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
profile Profile deprecated, use profiles
profiles Profile associated user profiles, which can be used as user role or namespace for certain group of user properties
properties HashObject List of all properties assigned to the object.
property String Fetch any property by name, ex: hair_color: property(name: "hair_color")
property_array String Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String. E.g: todo_list: property_array(name: "todo_list")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.
slug String To be used in the url instead of id for SEO purposes. Must be unique. By default generated based on first-name and last-mame
social_friends UserCollection 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
temporary_token String 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 in liquid using is_token_valid filter
transactables Transactable deprecated, use customizations
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }
users User Defines has-many relation with other user, e.g: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }

user_delete

Arguments

Name Type
form_configuration_name String
form_name String
id ID

Returns

Name Type Description
address CustomAddrress Fetch address by name, e.g: address: address(name: "office_address")
addresses CustomAddrress Fetch all addresses, optionally you can filter results by name, e.g: home_address: addresses(name: "home")
attachment PrivateFile Fetch attachment by name, e.g: sales_report: attachment(name: "sales_report")
attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: attachments(name: "sales_report")
authentications Authentication stores information about user integrations with authentication providers like auth0, facebook, twitter etc
bank_accounts BankAccount deprecated, use our module https://github.com/mdyd-dev/platformos-payments
communication Communication used for twilio click-to-call integraation to verify phone number
created_at JSONDate timestamp of when the record was created, automatically generated by the system
credit_cards CreditCard deprecated, use our module https://github.com/mdyd-dev/platformos-payments
custom_address CustomAddrress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses CustomAddrress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment PrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: custom_attachments(name: "sales_report")
custom_image Image Fetch image by name, e.g: header: custom_image(name: "header")
custom_images Image Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizations Customization
deleted_at JSONDate 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.
email String
external_id String Used mainly for import/export, if you want to use third party service as a source of truth
first_name String
id ID ID of an object.
image Image Fetch image by name, e.g: header: image(name: "header")
images Image Fetch all images, optionally you can filter results by name, e.g: cat_images: images(name: "cat")
language String Used by translations to set the language of currently logged in user
last_name String
merchant_accounts MerchantAccount deprecated, use our module https://github.com/mdyd-dev/platformos-payments
middle_name String
model Model Defines has-one relation with other model, e.g: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }
models Model Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
profile Profile deprecated, use profiles
profiles Profile associated user profiles, which can be used as user role or namespace for certain group of user properties
properties HashObject List of all properties assigned to the object.
property String Fetch any property by name, ex: hair_color: property(name: "hair_color")
property_array String Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String. E.g: todo_list: property_array(name: "todo_list")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.
slug String To be used in the url instead of id for SEO purposes. Must be unique. By default generated based on first-name and last-mame
social_friends UserCollection 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
temporary_token String 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 in liquid using is_token_valid filter
transactables Transactable deprecated, use customizations
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }
users User Defines has-many relation with other user, e.g: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }

user_profile_delete

Arguments

Name Type
form_configuration_name String
form_name String
profile_type String
user_id ID

Returns

Name Type Description
address CustomAddrress Fetch address by name, e.g: address: address(name: "office_address")
addresses CustomAddrress Fetch all addresses, optionally you can filter results by name, e.g: home_address: addresses(name: "home")
attachment PrivateFile Fetch attachment by name, e.g: sales_report: attachment(name: "sales_report")
attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: attachments(name: "sales_report")
custom_address CustomAddrress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses CustomAddrress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment PrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: custom_attachments(name: "sales_report")
custom_image Image Fetch image by name, e.g: header: custom_image(name: "header")
custom_images Image Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizations Customization
id ID ID of an object.
image Image Fetch image by name, e.g: header: image(name: "header")
images Image Fetch all images, optionally you can filter results by name, e.g: cat_images: images(name: "cat")
model Model Defines has-one relation with other model, e.g: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }
models Model Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
profile_type String
properties HashObject List of all properties assigned to the object.
property String Fetch any property by name, ex: hair_color: property(name: "hair_color")
property_array String Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String. E.g: todo_list: property_array(name: "todo_list")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.
remote_model Customization Defines relation object accessible over HTTP in JSON collection identified by it's ID.
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }
users User Defines has-many relation with other user, e.g: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }

user_profiles_delete_all

Arguments

Name Type
all_user_profile_types Boolean
user_profile_type_name String

Returns

Name Type Description
count Int

user_session_create

Arguments

Name Type
email String
form_configuration_name String
form_name String
password String
remember_me String

Returns

Name Type Description
address CustomAddrress Fetch address by name, e.g: address: address(name: "office_address")
addresses CustomAddrress Fetch all addresses, optionally you can filter results by name, e.g: home_address: addresses(name: "home")
attachment PrivateFile Fetch attachment by name, e.g: sales_report: attachment(name: "sales_report")
attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: attachments(name: "sales_report")
authentications Authentication stores information about user integrations with authentication providers like auth0, facebook, twitter etc
bank_accounts BankAccount deprecated, use our module https://github.com/mdyd-dev/platformos-payments
communication Communication used for twilio click-to-call integraation to verify phone number
created_at JSONDate timestamp of when the record was created, automatically generated by the system
credit_cards CreditCard deprecated, use our module https://github.com/mdyd-dev/platformos-payments
custom_address CustomAddrress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses CustomAddrress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment PrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: custom_attachments(name: "sales_report")
custom_image Image Fetch image by name, e.g: header: custom_image(name: "header")
custom_images Image Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizations Customization
deleted_at JSONDate 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.
email String
external_id String Used mainly for import/export, if you want to use third party service as a source of truth
first_name String
id ID ID of an object.
image Image Fetch image by name, e.g: header: image(name: "header")
images Image Fetch all images, optionally you can filter results by name, e.g: cat_images: images(name: "cat")
language String Used by translations to set the language of currently logged in user
last_name String
merchant_accounts MerchantAccount deprecated, use our module https://github.com/mdyd-dev/platformos-payments
middle_name String
model Model Defines has-one relation with other model, e.g: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }
models Model Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
profile Profile deprecated, use profiles
profiles Profile associated user profiles, which can be used as user role or namespace for certain group of user properties
properties HashObject List of all properties assigned to the object.
property String Fetch any property by name, ex: hair_color: property(name: "hair_color")
property_array String Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String. E.g: todo_list: property_array(name: "todo_list")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.
slug String To be used in the url instead of id for SEO purposes. Must be unique. By default generated based on first-name and last-mame
social_friends UserCollection 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
temporary_token String 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 in liquid using is_token_valid filter
transactables Transactable deprecated, use customizations
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }
users User Defines has-many relation with other user, e.g: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }

user_session_destroy

Arguments

Name Type
form_configuration_name String
form_name String

Returns

Name Type Description
user_session_destroy HashObject Sign Out User

user_update

Arguments

Name Type
form_configuration_name String
form_name String
id ID
user UserInputType

Returns

Name Type Description
address CustomAddrress Fetch address by name, e.g: address: address(name: "office_address")
addresses CustomAddrress Fetch all addresses, optionally you can filter results by name, e.g: home_address: addresses(name: "home")
attachment PrivateFile Fetch attachment by name, e.g: sales_report: attachment(name: "sales_report")
attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: attachments(name: "sales_report")
authentications Authentication stores information about user integrations with authentication providers like auth0, facebook, twitter etc
bank_accounts BankAccount deprecated, use our module https://github.com/mdyd-dev/platformos-payments
communication Communication used for twilio click-to-call integraation to verify phone number
created_at JSONDate timestamp of when the record was created, automatically generated by the system
credit_cards CreditCard deprecated, use our module https://github.com/mdyd-dev/platformos-payments
custom_address CustomAddrress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses CustomAddrress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment PrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments PrivateFile Fetch all attachments, optionally you can filter results by name, e.g: sales_reports: custom_attachments(name: "sales_report")
custom_image Image Fetch image by name, e.g: header: custom_image(name: "header")
custom_images Image Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizations Customization
deleted_at JSONDate 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.
email String
external_id String Used mainly for import/export, if you want to use third party service as a source of truth
first_name String
id ID ID of an object.
image Image Fetch image by name, e.g: header: image(name: "header")
images Image Fetch all images, optionally you can filter results by name, e.g: cat_images: images(name: "cat")
language String Used by translations to set the language of currently logged in user
last_name String
merchant_accounts MerchantAccount deprecated, use our module https://github.com/mdyd-dev/platformos-payments
middle_name String
model Model Defines has-one relation with other model, e.g: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id }
models Model Defines has-many relation with other model, e.g: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
name String
profile Profile deprecated, use profiles
profiles Profile associated user profiles, which can be used as user role or namespace for certain group of user properties
properties HashObject List of all properties assigned to the object.
property String Fetch any property by name, ex: hair_color: property(name: "hair_color")
property_array String Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String. E.g: todo_list: property_array(name: "todo_list")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.
slug String To be used in the url instead of id for SEO purposes. Must be unique. By default generated based on first-name and last-mame
social_friends UserCollection 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
temporary_token String 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 in liquid using is_token_valid filter
transactables Transactable deprecated, use customizations
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }
users User Defines has-many relation with other user, e.g: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }

Questions?

We are always happy to help with any questions you may have.