GraphQL - Inputs

ActiveRecordReference

Input fields

Name Type Description
id ID
ids ID
type String

AddressImport

Input fields

Name Type Description
address String
address2 String
apartment String
city String
country String
iso_country_code String
lat Float
lng Float
name String name of the defined property
postcode String
service_radius String
state String
street String
street_number String
suburb String

AggregationField

Input fields

Name Type Description
aggregations AggregationField
customization_name String
customization_property_name String
field_name String
name String
profile_property_name String
profile_type String
size Int
sort AggregationSort sort buckets; default is by doc-count descending
type AggregationTypeEnum

AggregationSort

Input fields

Name Type Description
name AggregationSortFieldEnum
order AggregationSortOrderEnum

ApiCallNotificationInputType

Input fields

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.
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_configuration_ids ID ids of form configurations which should trigger the api call
headers HashObject Request headers
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 where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/notifications/api_call_notifications/my_api_call_notification
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

ApiCallNotificationsFilterInput

Input fields

Name Type Description
callback StringFilter
content StringFilter
created_at DateFilter
delay StringFilter Deprecated - use delay_by
delay_by StringFilter
headers StringFilter
id UniqIdFilter
metadata JsonbFilter Filter by metadata properties
name StringFilter
to StringFilter
trigger_condition StringFilter
updated_at DateFilter

ApiCallNotificationsSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
name StandardSort
updated_at StandardSort

AssetInput

Input fields

Name Type Description
name String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/assets/logo.png
url String

AssetPresignInput

Input fields

Name Type Description
path String

AssetsFilterInput

Input fields

Name Type Description
created_at DateFilter
id UniqIdFilter
metadata JsonbFilter Filter by metadata properties
name StringFilter
updated_at DateFilter

AssetsSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
name StandardSort
updated_at StandardSort

AtachmentInputType

Input fields

Name Type Description
file String File URL returned by directly uploading it to platformOS s3 bucket using pre-signed URL
name String Name of the property
remote_file_url String External url to the file

AttachmentsImport

Input fields

Name Type Description
direct_path String direct path to file on S3
id ID ID will ignored.
name String name of the defined property
url String URL to presigned slot on S3

AuthenticationInputType

Input fields

Name Type Description
provider AuthenticationProvider
raw_info HashObject
token String
token_expires_at JSONDate
uid String

AuthorizationPoliciesFilterInput

Input fields

Name Type Description
content StringFilter
created_at DateFilter
flash_alert StringFilter
id UniqIdFilter
metadata JsonbFilter Filter by metadata properties
name StringFilter
redirect_to StringFilter
updated_at DateFilter

AuthorizationPoliciesSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
name StandardSort
updated_at StandardSort

AuthorizationPolicyInputType

Input fields

Name Type Description
content String
flash_alert String
metadata HashObject
name String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/authorization_policies/my_policy
redirect_to String

BackgroundJobsFilterInput

Input fields

Name Type Description
created_at DateFilter
failed_at DateFilter
form_configuration_name StringFilter
id UniqIdFilter
label StringFilter
locked_at DateFilter
queue StringFilter
resource_id UniqIdFilter
resource_type StringFilter
run_at DateFilter
source_name StringFilter
source_type StringFilter
updated_at DateFilter

BackgroundJobsSortInput

Input fields

Name Type Description
attempts StandardSort
created_at StandardSort
failed_at StandardSort
form_configuration_name StandardSort
id StandardSort
label StandardSort
locked_at StandardSort
queue StandardSort
resource_id StandardSort
resource_type StandardSort
run_at StandardSort
source_name StandardSort
source_type StandardSort
updated_at StandardSort

BankAccountInputType

Input fields

Name Type Description
payment_method_id ID
public_token String

BooleanFilter

Input fields

Name Type Description
is_null Boolean filter whether value was not set
not_value Boolean
value Boolean

ContentLengthRange

Input fields

Name Type Description
gte Int
lte Int

CreditCardInputType

Input fields

Name Type Description
credit_card_token String
payment_method_id ID

CustomAttachmentInputType

Input fields

Name Type Description
custom_attribute_name String attribute of type file with which the created attachment should be associated - must be defined in the schema of the record, for example CustomModelType for Customization, InstanceProfileType for UserProfile or user.yml for User
generate_file ProcessStrategyInputType allows you to create attachment with your own content; useful for generating reports, pdf, csv etc
owner_id ID id of associated record - Model, UserProfile, User
owner_type String class of associated record - Model, UserProfile, User
page_slug String deprecated, ignore
raw_remote_file_url String create attachment based on a file available on remote location
uploader_id ID id of a user who uploads the attachment

CustomAttributeInputType

Input fields

Name Type Description
array_append String Adds provided value at the end of an array property. It's secure atomic operation executed in separate transaction
array_remove String Removes provided value from an array property. It's secure atomic operation executed in separate transaction
decrement Float Decrements property value by provided value. It's secure atomic operation executed in separate transaction
increment Float Increments property value by provided value. It's secure atomic operation executed in separate transaction
name String
value String
value_array String
value_boolean Boolean
value_float Float
value_int Int
value_json JSONPayload

CustomImageInputType

Input fields

Name Type Description
custom_attribute_name String
owner_id ID id of associated record - Customization, UserProfile, User
owner_type String class of associated record - Customization, UserProfile, User
page_slug String deprecated
uploader_id ID id of the user who uploads the attachment

CustomizationImport

Input fields

Name Type Description
addresses AddressImport
attachments AttachmentsImport
created_at ISO8601DateTime
customizable_id ID
customizable_type CustomizableTypeEnum
id ID ID will be stored as external_id, relations will be preseved. We generate it when empty.
images ImagesImport
properties HashObject ex. {"color": "red"}
type_name String
updated_at ISO8601DateTime
user_id ID

CustomizationInputType

Input fields

Name Type Description
created_at JSONDate
custom_attachments AtachmentInputType
custom_images ImageInputType
custom_model_type_id ID
custom_model_type_name String deprecated, use model_schema_name
customizable_id ID
customizable_type CustomizableTypeEnum
customizations CustomizationsInputType
deleted_at JSONDate
external_id ID
id ID
model_schema_name String
models CustomizationsInputType
properties CustomAttributeInputType
title String deprectated, use properties
user_id ID

CustomizationSortOrder

Input fields

Name Type Description
field String Sort by given field value
order String
property String Sort by given property value

CustomizationsInputType

Input fields

Name Type Description
name String
values CustomizationInputType

CustomizationsSortOrder

Input fields

Name Type Description
name String Sort by field name
order String
property_name String Sort by property field

DateFilter

Input fields

Name Type Description
exists Boolean
gt String
gte String
lt String
lte String
not_value String
not_value_in String
value String
value_in String

DateRange

Input fields

Name Type Description
gt String
gte String
lt String
lte String

DefaultProfileInputType

Input fields

Name Type Description
custom_attachments AtachmentInputType
custom_images ImageInputType
deleted_at JSONDate
properties CustomAttributeInputType

EmailNotificationInputType

Input fields

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 liquid code to evaluate to valid, comma separated blind carbon copy list, for example "john@example.com, jane@example.com"
cc String liquid code to evaluate to valid, comma separated carbon copy list, 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 configuration.
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_configuration_ids ID ids of form configurations which should trigger the email
from String email address from which you would like to send the email, for example notifications@mydomain.com
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 where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/notifications/email_notifications/my_email_notification
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 liquid code to evaluate to valid, comma separated recipient list, for example "john@example.com, jane@example.com"
trigger_condition String liquid code which should evaluate to true if the email should be sent

EmailNotificationsFilterInput

Input fields

Name Type Description
attachments StringFilter
bcc StringFilter
cc StringFilter
content StringFilter
created_at DateFilter
delay StringFilter Deprecated - use delay_by
delay_by StringFilter
id UniqIdFilter
layout_path StringFilter
metadata JsonbFilter Filter by metadata properties
name StringFilter
subject StringFilter
to StringFilter
trigger_condition StringFilter
updated_at DateFilter

EmailNotificationsSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
name StandardSort
updated_at StandardSort

EncryptedConstantFilterInput

Input fields

Name Type Description
created_at DateFilter
id UniqIdFilter
name String
updated_at DateFilter

EncryptedConstantsFilterInput

Input fields

Name Type Description
created_at DateFilter
id UniqIdFilter
name StringFilter
updated_at DateFilter

EncryptedConstantsSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
name StandardSort
updated_at StandardSort

Endpoint

Input fields

Name Type Description
token String authentication token
url String endpoint url

FormConfigurationInputType

Input fields

Name Type Description
async_callback_actions String Same as callback, but invoked asynchronously. Recommended for performance reason.
async_callback_delay String liquid code which should evaluate to float. 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.
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_policy_ids ID ids of authorization policies which should be checked
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 )
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
flash_alert String liquid code which should evaluate to message which you want to display to user upon validation errors. Output is available via context.flash_alert
flash_notice String liquid code which should evaluate to message which you want to display to user after successful form submission. Output is available via context.flash_notice
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 where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/form_configurations/my_form_configuration
redirect_to String liquid code which should evaluate to valid path or url to which user should be redirected after successful form submission.
resource String
resource_owner String defines who can submit the form. If set to anyone, please make sure to provide authorization_policies
spam_protection SpamProtectionInputType strategy to protect against spam attacks.

FormConfigurationsFilterInput

Input fields

Name Type Description
async_callback_actions StringFilter
callback_actions StringFilter
created_at DateFilter
default_payload StringFilter
flash_notice StringFilter
id UniqIdFilter
liquid_body StringFilter
metadata JsonbFilter Filter by metadata properties
name StringFilter
redirect_to StringFilter
resource StringFilter
resource_owner StringFilter
updated_at DateFilter

FormConfigurationsSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
name StandardSort
updated_at StandardSort

FormInput

Input fields

Name Type Description
async_callback_actions String Same as callback, but invoked asynchronously. Recommended for performance reason.
async_callback_delay String liquid code which should evaluate to float. 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.
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_policy_ids ID ids of authorization policies which should be checked
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 )
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
flash_alert String liquid code which should evaluate to message which you want to display to user upon validation errors. Output is available via context.flash_alert
flash_notice String liquid code which should evaluate to message which you want to display to user after successful form submission. Output is available via context.flash_notice
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 where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/forms/my_form
redirect_to String liquid code which should evaluate to valid path or url to which user should be redirected after successful form submission.
resource String
resource_owner String defines who can submit the form. If set to anyone, please make sure to provide authorization_policies
spam_protection SpamProtectionInput strategy to protect against spam attacks.

FormsFilterInput

Input fields

Name Type Description
async_callback_actions StringFilter
callback_actions StringFilter
created_at DateFilter
default_payload StringFilter
flash_notice StringFilter
id UniqIdFilter
liquid_body StringFilter
metadata JsonbFilter Filter by metadata properties
name StringFilter
redirect_to StringFilter
resource StringFilter
resource_owner StringFilter
updated_at DateFilter

FormsSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
name StandardSort
updated_at StandardSort

FullTextQueryField

Input fields

Name Type Description
name String
priority Int
profile_field String

GeoBox

Input fields

Name Type Description
bottom LatDegree
left LngDegree
right LngDegree
top LatDegree

GeoBoxTopLeftBottomRight

Input fields

Name Type Description
bottom_right GeoPoint
top_left GeoPoint

GeoBoxTopRightBottomLeft

Input fields

Name Type Description
bottom_left GeoPoint
top_right GeoPoint

GeoPoint

Input fields

Name Type Description
lat LatDegree
lng LngDegree

GeoPointInShape

Input fields

Name Type Description
point GeoPoint

GeoPolygon

Input fields

Name Type Description
points GeoPoint Remember to keep right order, follow GeoJSON spec

GeoPropertyFilterInput

Input fields

Name Type Description
center GeometryJSON GeoJSON Object: of type Point, MultiPoint, LineString, Polygon. example: `{ type: "Point", coordinates: [-84.3, 39.8] }`. Read documentation for more
distance_in_km Int distance in km

GeoQuery

Input fields

Name Type Description
box GeoBox
box_top_left_bottom_right GeoBoxTopLeftBottomRight
box_top_right_bottom_left GeoBoxTopRightBottomLeft
point_in_shape GeoPointInShape
polygon GeoPolygon
radius GeoRadius

GeoRadius

Input fields

Name Type Description
center GeoPoint
distance String ex. 1km, 100mi, 50yards, 2meters

GraphqlFilterInput

Input fields

Name Type Description
created_at DateFilter
id UniqIdFilter
metadata JsonbFilter Filter by metadata properties
name StringFilter
query_string StringFilter
updated_at DateFilter

GraphqlSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
name StandardSort
updated_at StandardSort

ImageInputType

Input fields

Name Type Description
image String Image URL returned by directly uploading it to platformOS s3 bucket using pre-signed URL
name String name of the property
remote_image_url String external url to the image

ImagePresignUrlInput

Input fields

Name Type Description
content_length ContentLengthRange file size limitation in KiB. ex. [gte: 1, lte: 1024] allows file size from 1KiB to 1 MiB
versions VersionInput if image is uploaded, multiple versions of it will be generated automatically

ImagesFilterInput

Input fields

Name Type Description
created_at DateFilter
deleted_at DateFilter
id UniqIdFilter
name StringFilter
property_id UniqIdFilter
updated_at DateFilter
uploader_id UniqIdFilter

ImagesImport

Input fields

Name Type Description
direct_path String direct path to file on S3
id ID ID will ignored.
name String name of the defined property
url String URL to presigned slot on S3

ImagesSortInput

Input fields

Name Type Description
created_at StandardSort
deleted_at StandardSort
id StandardSort
property_id StandardSort
updated_at StandardSort
uploader_id StandardSort

JoinModelCollection

Input fields

Name Type Description
foreign_property PropertyName
join_on_property PropertyName

JsonbAttributeFilter

Input fields

Name Type Description
contains String
key String
value Any

JsonbFilter

Input fields

Name Type Description
attribute JsonbAttributeFilter Filter by attribute key and value. Works for one level attributes
attributes JsonbAttributeFilter Filter by attributes - key and value. Works for one level attribute
contains String Filter metadata that contains part of the text
exclude Boolean Exclude matched resources from results
has_key String Filter resources that have certain key in metadata

JsonbSort

Input fields

Name Type Description
name String name of the first level metadata attribute
order SortOrderEnum

LiquidLayoutInputType

Input fields

Name Type Description
body String
format PageFormat
metadata HashObject
path String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/layouts/my_layout

LiquidLayoutsFilterInput

Input fields

Name Type Description
body StringFilter
created_at DateFilter
id UniqIdFilter
metadata JsonbFilter Filter by metadata properties
path StringFilter
updated_at DateFilter

LiquidLayoutsSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
path StandardSort
updated_at StandardSort

LiquidPartialInputType

Input fields

Name Type Description
body String
format PageFormat
metadata HashObject
path String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/partials/my_partial

LiquidPartialsFilterInput

Input fields

Name Type Description
body StringFilter
created_at DateFilter
id UniqIdFilter
metadata JsonbFilter Filter by metadata properties
path StringFilter
updated_at DateFilter

LiquidPartialsSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
path StandardSort
updated_at StandardSort

ListingAggregation

Input fields

Name Type Description
fields AggregationField
filter QueryListing
global Boolean
name String Name of the result

ModelSchemaInputType

Input fields

Name Type Description
fields NestedPropertyInputType deprecated, use properties
metadata HashObject
name String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/custom_model_types/my_model
properties NestedPropertyInputType

ModelSchemasFilterInput

Input fields

Name Type Description
created_at DateFilter
id UniqIdFilter
metadata JsonbFilter Filter by metadata properties
name StringFilter
parameterized_name StringFilter
updated_at DateFilter

ModelSchemasSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
name StandardSort
parameterized_name StandardSort
updated_at StandardSort

ModelUpdate

Input fields

Name Type Description
addresses AddressImport
attachments AttachmentsImport
created_at ISO8601DateTime
customizable_id ID
customizable_type CustomizableTypeEnum
id ID ID must match existing object id
images ImagesImport
properties HashObject ex. {"color": "red"}
type_name String
updated_at ISO8601DateTime
user_id ID

ModelsFilterInput

Input fields

Name Type Description
created_at DateFilter
deleted_at DateFilter
external_id StringFilter
id UniqIdFilter
model_schema_id UniqIdFilter
models RelatedModelsFilterInput
name StringFilter
properties PropertyFilterInput
updated_at DateFilter
user_id UniqIdFilter
users RelatedUsersFilterInput

ModelsSortInput

Input fields

Name Type Description
created_at StandardSort
deleted_at StandardSort
external_id StandardSort
id StandardSort
model_schema_id StandardSort
properties PropertySort
updated_at StandardSort

NestedCustomizationFilters

Input fields

Name Type Description
created_at DateRange
id ID
ids ID
ignore_deleted Boolean
is_deleted Boolean
name String Name of the Model Schema
properties QueryCustomAttribute
user_id ID
user_ids ID

NestedPropertyInputType

Input fields

Name Type Description
_destroy String 1 if property is meant to be removed, 0 otherwise
attribute_type PropertyTypeEnum Type of the property
default_value String Default value for new objects
id ID id of the property to update
metadata HashObject
name String Name of the property

NewCustomImageInputType

Input fields

Name Type Description
custom_attribute_name String
direct_url String URL to image that was uploaded to s3 presigned url
owner_id ID
owner_type String
page_slug String deprecated
raw_remote_image_url String
uploader_id ID

NotificationTemplateInput

Input fields

Name Type Description
name String Name of the template

PageFilterInput

Input fields

Name Type Description
content StringFilter Search for text in rendered page content. Page must be marked as searchable
created_at DateFilter
format PageFormatFilter Filter by format, ex. format: { value: HTML }
id UniqIdFilter
layout_name StringFilter
metadata JsonbFilter Filter by metadata properties
searchable BooleanFilter
slug StringFilter Filter by slug. Enter slug without leading /, ex. slug: { exact: "client/orders" }
updated_at DateFilter

PageFormatFilter

Input fields

Name Type Description
not_value PageFormat
not_value_in PageFormat
value PageFormat
value_in PageFormat

PageInputType

Input fields

Name Type Description
authorization_policy_ids ID ids of authorization policies which should be checked
content String
dynamic_cache_expire Int
dynamic_cache_key String
dynamic_cache_layout Boolean
format PageFormat
handler PageHandler
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 where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/pages/my-page
redirect_code PageRedifectCode
redirect_to String
request_method PageRequestMethod
response_headers HashObject
searchable Boolean
slug String
static_cache_expire Int

PagesSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
slug StandardSort
updated_at StandardSort

PaymentAmountInputType

Input fields

Name Type Description
currency String
service_fee_payer Float
service_fee_receiver Float
subtotal_amount Float
total_amount Float

PaymentInputType

Input fields

Name Type Description
amount PaymentAmountInputType
bank_account_id ID
credit_card_id ID
credit_card_token String
direct_charge Boolean
paid_at String
payable_id ID
payable_type String
payer_id ID
payment_method_id ID
receiver_id ID

PaymentTransferAmountInputType

Input fields

Name Type Description
currency String
transfer_amount Float

PaymentTransferFilters

Input fields

Name Type Description
created_at DateRange
external_id String
id ID
payment_gateway_id ID
receiver_id ID
transferred_at DateRange

PaymentTransferInputType

Input fields

Name Type Description
amount PaymentTransferAmountInputType
failed_at String
payment_ids ID
transferred_at String

PaymentTransferSort

Input fields

Name Type Description
field String Sort by given field value
order OrderDirection

PresignUrlInput

Input fields

Name Type Description
acl ACL defines whether it is a public file that anyone who knows the url can access it, or if its private and even with the known URL it is not possible to see the file without a signature.
content_disposition String
content_length ContentLengthRange file size limitation in KiB. ex. [gte: 1, lte: 1024] allows file size from 1KiB to 1 MiB
type UploadType
versions VersionInput if image is uploaded, multiple versions of it will be generated automatically

ProcessPageInputType

Input fields

Name Type Description
params HashObject Parameters you would like to pass to the page to render it dynamically. They will beavailable via context.params.
slug String Slug of the page which you would like to use as a template

ProcessStrategyInputType

Input fields

Name Type Description
body String Expected content depends on strategy, however usually it is text, html, csv, json, xml etc.Alternativey you can process page via page argument.
file_name String Name of the output file
page ProcessPageInputType Provided page will be rendered and its output will be used as a body. Alternatively you can pass body directly via body argument
strategy ProcessStrategy
synchronous Boolean if you set to true and strategy requires asynchronous processing by us (like pdf generation) then the mutation will wait until the file is actually generated so you can for example attach it to an email

ProfileFilterInput

Input fields

Name Type Description
name String Name of the user profile type
properties PropertyFilterInput

PropertyFilterInput

Input fields

Name Type Description
contains String
distance_sphere GeoPropertyFilterInput select items for which a distance between its point from <:property> and <:center> point is less than <:distance>.</:distance></:center></:property>
ends_with String
exists Boolean
name String
not_contains String
not_ends_with String
not_starts_with String
not_value String
not_value_in String
range RangeFilter
starts_with String
value String
value_in String Property should match one of the provided arguments

PropertySort

Input fields

Name Type Description
name String
order SortOrderEnum

Query

Input fields

Name Type Description
fields FullTextQueryField
keyword String Accept wildcards, ? for single character, * for more
match_type QueryMatchTypeEnum
operator OperatorEnum

QueryCustomAttribute

Input fields

Name Type Description
exclude Boolean Set it when you want to exclude value/values/range from results
exists Boolean
name String
range Range
value String
values String
values_operator OperatorEnum

QueryCustomModelType

Input fields

Name Type Description
id Int
ids Int
name String
names String

QueryCustomization

Input fields

Name Type Description
addresses QueryListingLocation
id ID
name String
parameterized_name String
properties QueryCustomAttribute Need to narrow profiles by profile_type
user_id ID

QueryListing

Input fields

Name Type Description
addresses QueryListingLocation
created_at DateRange
creator QueryUser
creator_id ID
creator_ids ID
custom_attributes QueryCustomAttribute
customizations QueryCustomization
external_id ID
external_ids ID
has_creator Boolean
id ID
ids ID
is_deleted Boolean
name String
properties QueryCustomAttribute
slug String
transactable_type QueryTransactableType
without_ids ID do not use this please

QueryListingLocation

Input fields

Name Type Description
cities String
city String
country String
exists Boolean
geo_query GeoQuery Geo search
postcode String
state String
street String
suburb String

QueryModelSchema

Input fields

Name Type Description
id Int
ids Int
name String
names String

QueryTransactableType

Input fields

Name Type Description
id Int
ids Int
name String
names String

QueryUser

Input fields

Name Type Description
created_at DateRange
customizations QueryCustomization
email String
emails String
external_id ID
externals_id ID
first_name String
id ID
ids ID
is_deleted Boolean
last_name String
middle_name String
name String
profiles QueryUserProfile
slug String
without_ids ID

QueryUserProfile

Input fields

Name Type Description
addresses QueryListingLocation
custom_attributes QueryCustomAttribute
customizations QueryCustomization
geo_query GeoQuery Geo search based on searchable custom_addresses
is_deleted Boolean
name String Name of the user profile type
profile_type String Alias for name argument
properties QueryCustomAttribute Need to narrow profiles by profile_type

Range

Input fields

Name Type Description
gt String
gte String
lt String
lte String

RangeFilter

Input fields

Name Type Description
gt String
gte String
lt String
lte String

RefundPaymentInputType

Input fields

Name Type Description
amount_cents Int

RelatedModelsFilterInput

Input fields

Name Type Description
filter ModelsFilterInput
join JoinModelCollection

RelatedUsersFilterInput

Input fields

Name Type Description
filter UsersFilterInput
join JoinModelCollection

SmsNotificationInputType

Input fields

Name Type Description
content String liquid code to evaluate to valid form html. If sms is triggered via form configuration, You have access to "form" variable, with data specified in configuration.
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_configuration_ids ID deprecated, use form_ids
form_ids ID ids of form configurations which should trigger the sms
metadata HashObject
name String name of the sms, which is used in form_configurations or mutation to trigger it
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/notifications/sms_notifications/my_sms_notification
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

SmsNotificationsFilterInput

Input fields

Name Type Description
callback StringFilter
content StringFilter
created_at DateFilter
delay StringFilter Deprecated - use delay_by
delay_by StringFilter
id UniqIdFilter
metadata JsonbFilter Filter by metadata properties
name StringFilter
to StringFilter
trigger_condition StringFilter
updated_at DateFilter

SmsNotificationsSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
name StandardSort
updated_at StandardSort

SortByChildField

Input fields

Name Type Description
child_type String Child type, for ex. transactable
field_name String Sort by this field, example: "id".

SortByDistance

Input fields

Name Type Description
field_name String Sort by this field, example: "geo_location"
reference_point GeoPoint Reference point, usually current location
unit DistanceUnit

SortByFieldOrder

Input fields

Name Type Description
field_name String Sort by this field, example: "id".
values String Sort by provided values, example: [109, 903]. Full example: If { field_name: "id", values: [109, 903] }, Object#109 will be 1st, Object#903 will be 2nd, and then the rest.

SortOrder

Input fields

Name Type Description
child_field SortByChildField
distance SortByDistance Sort by distance to geo point
field SortByFieldOrder Sort by given field by provided values
name String Sort by field
order String
profile_distance SortByDistance Sort by distance to geo point based on custom_addresses
profile_field String To sort by profile property use `properties.` prefix, ex. `profile_field: "properties.color"`
profile_property String Sort by profile property`
profile_type String Name of the user profile type
property_name String Sort by property field

SpamProtectionInput

Input fields

Name Type Description
recaptcha_v2 HashObject
recaptcha_v3 SpamProtectionRecaptchaV3Input

SpamProtectionInputType

Input fields

Name Type Description
recaptcha_v2 HashObject
recaptcha_v3 SpamProtectionRecaptchaV3InputType

SpamProtectionRecaptchaV3Input

Input fields

Name Type Description
action String
minimum_score Float

SpamProtectionRecaptchaV3InputType

Input fields

Name Type Description
action String
minimum_score Float

StandalonePropertyInputType

Input fields

Name Type Description
attribute_type PropertyTypeEnum Type of the property
default_value String Default value for new objects
metadata HashObject
name String Name of the property
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

StandardSort

Input fields

Name Type Description
order SortOrderEnum
order_by_values String Order by specific values

StringFilter

Input fields

Name Type Description
contains String matches string within other string
ends_with String
exact String deprecated, use "value" instead
not_contains String
not_ends_with String
not_starts_with String
not_value String
not_value_in String
starts_with String
value String
value_in String

ThirdPartyIntegrationsFilterInput

Input fields

Name Type Description
created_at DateFilter
id UniqIdFilter
type StringFilter
updated_at DateFilter

ThirdPartyIntegrationsSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
type StandardSort
updated_at StandardSort

TransactableImport

Input fields

Name Type Description
addresses AddressImport
attachments AttachmentsImport
created_at ISO8601DateTime
creator_id ID
id ID ID will be changed after import, relations will be preseved
images ImagesImport
name String
properties HashObject ex. {"color": "red"}
slug String
type_name String
updated_at ISO8601DateTime

TransactableInputType

Input fields

Name Type Description
creator_id ID
currency String
description String
name String
properties CustomAttributeInputType
quantity Int
slug String
state_event String
transactable_type_name String

TransactableSchemaInputType

Input fields

Name Type Description
fields NestedPropertyInputType deprecated, use properties
name String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/transactable_types/my_transactable
properties NestedPropertyInputType

TransactableSchemasFilterInput

Input fields

Name Type Description
created_at DateFilter
id UniqIdFilter
name StringFilter
parameterized_name StringFilter
updated_at DateFilter

TransactableSchemasSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
name StandardSort
parameterized_name StandardSort
updated_at StandardSort

UniqIdFilter

Input fields

Name Type Description
not_value_in ID
value ID
value_in ID

UpdateApiCallNotificationInputType

Input fields

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.
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_configuration_ids ID ids of form configurations which should trigger the api call
headers HashObject Request headers
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 where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/notifications/api_call_notifications/my_api_call_notification
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

UpdateAuthorizationPolicyInputType

Input fields

Name Type Description
content String
flash_alert String
metadata HashObject
name String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/authorization_policies/my_policy
redirect_to String

UpdateCustomAttachmentInputType

Input fields

Name Type Description
custom_attribute_name String
owner_id ID
owner_type String
page_slug String
uploader_id ID

UpdateEmailNotificationInputType

Input fields

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 liquid code to evaluate to valid, comma separated blind carbon copy list, for example "john@example.com, jane@example.com"
cc String liquid code to evaluate to valid, comma separated carbon copy list, 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 configuration.
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_configuration_ids ID ids of form configurations which should trigger the email
from String email address from which you would like to send the email, for example notifications@mydomain.com
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 where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/notifications/email_notifications/my_email_notification
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 liquid code to evaluate to valid, comma separated recipient list, for example "john@example.com, jane@example.com"
trigger_condition String liquid code which should evaluate to true if the email should be sent

UpdateFormConfigurationInputType

Input fields

Name Type Description
async_callback_actions String Same as callback, but invoked asynchronously. Recommended for performance reason.
async_callback_delay String liquid code which should evaluate to float. 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.
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_policy_ids ID ids of authorization policies which should be checked
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 )
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
flash_alert String liquid code which should evaluate to message which you want to display to user upon validation errors. Output is available via context.flash_alert
flash_notice String liquid code which should evaluate to message which you want to display to user after successful form submission. Output is available via context.flash_notice
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 where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/form_configurations/my_form_configuration
redirect_to String liquid code which should evaluate to valid path or url to which user should be redirected after successful form submission.
resource String
resource_owner String defines who can submit the form. If set to anyone, please make sure to provide authorization_policies
spam_protection SpamProtectionInputType strategy to protect against spam attacks.

UpdateFormInput

Input fields

Name Type Description
async_callback_actions String Same as callback, but invoked asynchronously. Recommended for performance reason.
async_callback_delay String liquid code which should evaluate to float. 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.
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_policy_ids ID ids of authorization policies which should be checked
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 )
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
flash_alert String liquid code which should evaluate to message which you want to display to user upon validation errors. Output is available via context.flash_alert
flash_notice String liquid code which should evaluate to message which you want to display to user after successful form submission. Output is available via context.flash_notice
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 where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/forms/my_form
redirect_to String liquid code which should evaluate to valid path or url to which user should be redirected after successful form submission.
resource String
resource_owner String defines who can submit the form. If set to anyone, please make sure to provide authorization_policies
spam_protection SpamProtectionInput strategy to protect against spam attacks.

UpdateLiquidLayoutInputType

Input fields

Name Type Description
body String
format PageFormat
metadata HashObject
path String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/layouts/my_layout

UpdateLiquidPartialInputType

Input fields

Name Type Description
body String
format PageFormat
metadata HashObject
path String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/partials/my_partial

UpdateModelSchemaInputType

Input fields

Name Type Description
fields NestedPropertyInputType deprecated, use properties
metadata HashObject
name String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/custom_model_types/my_model
properties NestedPropertyInputType

UpdatePageInputType

Input fields

Name Type Description
authorization_policy_ids ID ids of authorization policies which should be checked
content String
dynamic_cache_expire Int
dynamic_cache_key String
dynamic_cache_layout Boolean
format PageFormat
handler PageHandler
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 where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/pages/my-page
redirect_code PageRedifectCode
redirect_to String
request_method PageRequestMethod
response_headers HashObject
searchable Boolean
slug String
static_cache_expire Int

UpdatePaymentInputType

Input fields

Name Type Description
amount PaymentAmountInputType
bank_account_id ID
credit_card_id ID
credit_card_token String
direct_charge Boolean
paid_at String
payable_id ID
payable_type String
payer_id ID
payment_method_id ID
receiver_id ID

UpdateSmsNotificationInputType

Input fields

Name Type Description
content String liquid code to evaluate to valid form html. If sms is triggered via form configuration, You have access to "form" variable, with data specified in configuration.
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_configuration_ids ID deprecated, use form_ids
metadata HashObject
name String name of the sms, which is used in form_configurations or mutation to trigger it
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/notifications/sms_notifications/my_sms_notification
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

UpdateStandalonePropertyInputType

Input fields

Name Type Description
attribute_type PropertyTypeEnum Type of the property
default_value String Default value for new objects
metadata HashObject
name String Name of the property
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

UpdateTransactableSchemaInputType

Input fields

Name Type Description
fields NestedPropertyInputType deprecated, use properties
name String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/transactable_types/my_transactable
properties NestedPropertyInputType

UpdateUserProfileSchemaInputType

Input fields

Name Type Description
fields NestedPropertyInputType deprecated, use properties
metadata HashObject
name String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/user_profile_types/my_user_profile
properties NestedPropertyInputType

UserImport

Input fields

Name Type Description
created_at JSONDate
email String
external_id ID
first_name String
id ID ID will be stored as external_id, relations will be preseved. We generate it when empty.
last_name String
middle_name String
name String
password String
profiles UserProfileImportType
properties HashObject ex. {"color": "red"}
slug String
updated_at JSONDate

UserInputType

Input fields

Name Type Description
authentications AuthenticationInputType
custom_attachments AtachmentInputType
custom_images ImageInputType
deleted_at JSONDate
email String
external_id ID
first_name String
last_name String
name String
password String
profiles UserProfileInputType
properties CustomAttributeInputType
slug String

UserProfileImportType

Input fields

Name Type Description
addresses AddressImport
attachments AttachmentsImport
id ID ID will be stored as external_id, relations will be preseved. We generate it when empty.
images ImagesImport
properties HashObject ex. {"color": "red"}
type_name String

UserProfileInputType

Input fields

Name Type Description
name String
values DefaultProfileInputType

UserProfileSchemaInputType

Input fields

Name Type Description
fields NestedPropertyInputType deprecated, use properties
metadata HashObject
name String
physical_file_path String defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/user_profile_types/my_user_profile
properties NestedPropertyInputType

UserProfileSchemasFilterInput

Input fields

Name Type Description
created_at DateFilter
id UniqIdFilter
metadata JsonbFilter Filter by metadata properties
name StringFilter
parameterized_name StringFilter
updated_at DateFilter

UserProfileSchemasSortInput

Input fields

Name Type Description
created_at StandardSort
id StandardSort
metadata JsonbSort
name StandardSort
parameterized_name StandardSort
updated_at StandardSort

UserProfileUpdateType

Input fields

Name Type Description
addresses AddressImport
attachments AttachmentsImport
id ID ID must match existing object id
images ImagesImport
properties HashObject ex. {"color": "red"}
type_name String

UserUpdate

Input fields

Name Type Description
created_at JSONDate
email String
external_id ID
first_name String
id ID ID must match existing object id
last_name String
middle_name String
name String
profiles UserProfileUpdateType
slug String
updated_at JSONDate

UsersFilterInput

Input fields

Name Type Description
created_at DateFilter
deleted_at DateFilter
email StringFilter
external_id UniqIdFilter
id UniqIdFilter
profiles ProfileFilterInput
properties PropertyFilterInput
slug StringFilter
updated_at DateFilter

UsersSortInput

Input fields

Name Type Description
created_at StandardSort
deleted_at StandardSort
email StandardSort
external_id StandardSort
id StandardSort
profile_properties PropertySort
slug StandardSort
updated_at StandardSort

VersionInput

Input fields

Name Type Description
manipulate VersionManipulateInput
name String name of the version, for example thumb
output VersionOutputInput
resize VersionResizeInput

VersionManipulateInput

Input fields

Name Type Description
blur ImageBlur value representing the sigma of the Gaussian mask, where sigma = 1 + radius / 2
flatten HexColor color for flatten
greyscale Boolean Convert to 8-bit greyscale; 256 shades of grey.

VersionOutputInput

Input fields

Name Type Description
format ImageFormat
quality ImageQuality defines the quality of the image; used to automatically compress the image

VersionResizeInput

Input fields

Name Type Description
backgound HexColor background color when using a fit of containDefault: #000000
fit ImageResizeFit
height Int max height of an image. If left undefined, will depend on other parameters to determine size (like: width)
position ImageResizePosition position to use when fit is cover or contain
width Int max width of an image. If left undefined, will depend on other parameters to determine size (like: height)
without_enlargement Boolean do not enlarge if the width or height are already less than the specified dimensions

Questions?

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