GraphQL - Objects

Activity

Fields

Name Type Description
id ID
payload ActivityPayload
uuid String

ActivityCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results Activity
total_entries Int
total_pages Int

ActivityStreamCollection

Fields

Name Type Description
results Activity
total_entries Int
total_pages Int
unread_count Int

ActivityStreamsFeed

Fields

Name Type Description
ids ID
name String

Aggregations

Fields

Name Type Description
compact JSONPayload
raw JSONPayload

ApiCallNotification

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.
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

ApiCallNotificationCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results ApiCallNotification
total_entries Int
total_pages Int

ApiCallSendPayload

Fields

Name Type Description
errors BaseError
response Response

Asset

Fields

Name Type Description
created_at JSONDate
deleted_at JSONDate
id ID
metadata HashObject
name String Name of the asset
physical_file_path String defines the physical path of the file
updated_at JSONDate
url String Url to the file

AssetCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results Asset
total_entries Int
total_pages Int

AssetsCreateMutationPayload

Fields

Name Type Description
assets Asset

AssetsPresignUrlsMutationPayload

Fields

Name Type Description
urls PresignedUrl

Authentication

Fields

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.
id ID
provider AuthenticationProvider name of authentication provider used for creating this authentication
raw_info HashObject
token String
token_expires_at JSONDate
uid String
updated_at JSONDate timestamp of when the record was updated, automatically generated by the system

AuthorizationPolicy

Fields

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

AuthorizationPolicyAssociation

Fields

Name Type Description
authorizable_id ID id of the admin resource
authorizable_type String type of the admin resource - Page or Form
authorization_policy_id ID id of the authorization policy
created_at JSONDate
id ID
updated_at JSONDate

AuthorizationPolicyCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results AuthorizationPolicy
total_entries Int
total_pages Int

BackgroundJob

Fields

Name Type Description
attempts Int how many times the job was tried to be processed. By default the job is not retried on error.
created_at JSONDate
error String error which made the job fail
failed_at JSONDate not null when exception encounered during processing the job
form_configuration_name String populated if the background job was invoked by form configuration
form_name String populated if the background job was invoked by form configuration
id ID
label String job label
locked_at JSONDate
queue String which queue is used to process the job
resource_id ID populated if the background job was invoked by form configuration
resource_type String populated if the background job was invoked by form configuration
run_at JSONDate
source_name String populated if the background job was invoked by form configuration
source_type String populated if the background job was invoked by form configuration
updated_at JSONDate

BackgroundJobCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results BackgroundJob
total_entries Int
total_pages Int

BankAccount

Fields

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

BaseError

Fields

Name Type Description
message String A description of the error

CMSItemDefinition

Fields

Name Type Description
fields String
name CMSItemType
path JSONPayload

CMSItemDefinitionCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results CMSItemDefinition
total_entries Int
total_pages Int

CMSItemPayload

Fields

Name Type Description
data JSONPayload
resource_name String
type CMSItemType

CMSItemPayloadCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results CMSItemPayload
total_entries Int
total_pages Int

Communication

Fields

Name Type Description
phone_number String
verified Boolean

CreditCard

Fields

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

CustomAddrress

Fields

Name Type Description
address String
address2 String
apartment String
city String
country String
id Int
iso_country_code String
lat Float
lng Float
name String
point GeoPointType
postcode String
service_radius String
state String
street String
street_number String
suburb String

CustomAttachment

Fields

Name Type Description
created_at JSONDate
file_url String
id ID

CustomAttributeDefinition

Fields

Name Type Description
attribute_type String
id ID
name String

CustomImage

Fields

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

CustomImageCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results CustomImage
total_entries Int
total_pages Int

Customization

Fields

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_boolean Boolean Fetch any property of Boolean by name, ex: price: property_boolean(name: "enabled")
property_float Float Fetch any property of Float by name, ex: price: property_float(name: "price")
property_int Int Fetch any property of Integer by name, ex: age: property_int(name: "age")
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

EmailNotification

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 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

EmailNotificationCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results EmailNotification
total_entries Int
total_pages Int

EncryptedConstant

Fields

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

EncryptedConstantCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results EncryptedConstant
total_entries Int
total_pages Int

FlashMessages

Fields

Name Type Description
alert String
notice String

Form

Fields

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

FormCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results Form
total_entries Int
total_pages Int

FormConfiguration

Fields

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

FormConfigurationCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results FormConfiguration
total_entries Int
total_pages Int

FormSubmitPayload

Fields

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

GeoPointType

Fields

Name Type Description
lat Float
lon Float

GraphQuery

Fields

Name Type Description
created_at JSONDate
id ID
metadata HashObject
name String Name of the graph query
physical_file_path String defines the physical path of the file
query_string String The query
updated_at JSONDate

GraphQueryCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results GraphQuery
total_entries Int
total_pages Int

HTTPRequestContext

Fields

Name Type Description
authentication_providers AuthenticationProvider Returns array of configured authentication providers
body String
current_full_path String Returns a String with the last requested path including their params. /foo?bar
current_path String
current_url String Returns the original request URL as a String. # => "http://www.example.com/articles?page=2"
flash FlashMessages
form_authenticity_token String
headers HeadersObject Access request headers
is_xhr Boolean Returns true if the “X-Requested-With” header contains “XMLHttpRequest” (case-insensitive), which may need to be manually added depending on the choice of JavaScript libraries and frameworks.
params ParamsObject Access data sent in by the user or other parameters in your controller actions
params_unfiltered HashObject
referer String The referer of the client

Handler

Fields

Name Type Description
filter ActivityPayload
id ID
name String
targets ActivityPayload

HandlerCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results Handler
total_entries Int
total_pages Int

Image

Fields

Name Type Description
filename String
id ID
image_original_height Int image original height
image_original_width Int image original width
name String
uploader_id ID
url String image url, ex: thumb: url(version: "thumb")

ImagePresignedUploadUrl

Fields

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

ImportCustomizationsMutationPayload

Fields

Name Type Description
external_ids ID
ids ID

ImportTransactablesMutationPayload

Fields

Name Type Description
external_ids ID
ids ID

ImportUsersMutationPayload

Fields

Name Type Description
external_ids ID
ids ID

Instance

Fields

Name Type Description
id Int
name String

LiquidLayout

Fields

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

LiquidLayoutCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results LiquidLayout
total_entries Int
total_pages Int

LiquidPartial

Fields

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

LiquidPartialCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results LiquidPartial
total_entries Int
total_pages Int

Listing

Fields

Name Type Description
created_at JSONDate
creator UserListing Remember to set `listing: { has_creator: true }` in query arguments
creator_id ID
custom_address ListingAddress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses ListingAddress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment ListingsPrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments ListingsPrivateFile
custom_image ListingImage Fetch image by name, e.g: header: custom_image(name: "header")
custom_images ListingImage Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizations ListingsCustomization
deleted_at JSONDate
external_id ID
id ID
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 custom attribute 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 any property of JSON type by name, it returns JSON in contrast to "property" which returns String. E.g: todo_list: property_json(name: "todo_list")
remote_model Customization Defines relation object accessible over HTTP in JSON collection identified by it's ID.
slug String
sort_score Int when sorting by distance - field contains distance to target location
type String
updated_at JSONDate
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }

ListingAddress

Fields

Name Type Description
address String
address2 String
apartment String
city String
country String
id Int
iso_country_code String
lat Float
lng Float
name String
point GeoPointType
postcode String
service_radius String
state String
street String
street_number String
suburb String

ListingCollection

Fields

Name Type Description
aggregations Aggregations
current_page Int
has_next_page Boolean
has_previous_page Boolean
page Int deprecated, use current_page
per_page Int
results Listing
size Int
total_entries Int
total_pages Int

ListingImage

Fields

Name Type Description
file_name String
filename String
id ID
image_original_height Int
image_original_width Int
name String
url String image url, ex: thumb: url(version: "thumb")

ListingUserProfile

Fields

Name Type Description
custom_address ListingAddress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses ListingAddress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment ListingsPrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments ListingsPrivateFile
custom_image ListingImage Fetch image by name, e.g: header: custom_image(name: "header")
custom_images ListingImage Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizations ListingsCustomization
external_id ID
id ID
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 }
profile_type String
properties HashObject List of all properties assigned to the object.
property String Fetch any custom attribute 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 any property of JSON type by name, it returns JSON in contrast to "property" which returns String. E.g: todo_list: property_json(name: "todo_list")
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 }

ListingsCommunication

Fields

Name Type Description
phone_number String
verified Boolean

ListingsCustomModelType

Fields

Name Type Description
id ID
name String

ListingsCustomization

Fields

Name Type Description
created_at JSONDate timestamp of when the record was created, automatically generated by the system
custom_address ListingAddress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses ListingAddress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment ListingsPrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments ListingsPrivateFile
custom_image ListingImage Fetch image by name, e.g: header: custom_image(name: "header")
custom_images ListingImage Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
custom_model_type ListingsCustomModelType
customizable Customizable
customizable_id ID
customizable_type String
customizations ListingsCustomizationCollection
deleted_at JSONDate
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
model ListingsCustomization Defines belongs-to relation with other model, e.g: parent: model(model_name: "parent", join_on_property: "parent_id") { id }
model_schema ListingsModelSchema
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
payment Payment
properties HashObject List of all properties assigned to the object.
property String Fetch any custom attribute 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 any property of JSON type by name, it returns JSON in contrast to "property" which returns String. E.g: todo_list: property_json(name: "todo_list")
remote_model Customization Defines relation object accessible over HTTP in JSON collection identified by it's ID.
updated_at JSONDate
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }
user_id ID

ListingsCustomizationCollection

Fields

Name Type Description
aggregations Aggregations
current_page Int
has_next_page Boolean
has_previous_page Boolean
page Int deprecated, use current_page
per_page Int
results ListingsCustomization
size Int
total_entries Int
total_pages Int

ListingsModelSchema

Fields

Name Type Description
id ID
name String

ListingsPrivateFile

Fields

Name Type Description
content_type String
created_at JSONDate
file_name String
id ID
name String
size_bytes Int
url String

LogEntry

Fields

Name Type Description
id ID
message String
type String

MerchantAccount

Fields

Name Type Description
account_type String
attachments PrivateFile
bank_account_number String
created_at JSONDate
date_of_birth String
external_id String Reference to object in external Payment Gateway
first_name String
id ID
last_name String
merchantable_id ID
merchantable_type String
payment_gateway PaymentGateway
payment_gateway_balance PaymentGatewayBalance Returns actual Stripe subaccount balance
state MerchantAccountState

MerchantAccountCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results MerchantAccount
total_entries Int
total_pages Int

Model

Fields

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
customizable_id ID ID of releated object
customizable_type String Type name of releated object
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
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 }
model_schema_id ID ID of Model Schema to which it belongs
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 Name of the model type
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_boolean Boolean Fetch any property of Boolean by name, ex: price: property_boolean(name: "enabled")
property_float Float Fetch any property of Float by name, ex: price: property_float(name: "price")
property_int Int Fetch any property of Integer by name, ex: age: property_int(name: "age")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.
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 ID of user
users User Defines has-many relation with other user, e.g: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id }

ModelCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results Model
total_entries Int
total_pages Int

ModelSchema

Fields

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

ModelSchemaCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results ModelSchema
total_entries Int
total_pages Int

NotificationSendEmailPayload

Fields

Name Type Description
errors BaseError
is_scheduled_to_send Boolean

ObjectCount

Fields

Name Type Description
count Int

Page

Fields

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

PageCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results Page
total_entries Int
total_pages Int

Payment

Fields

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

PaymentCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results Payment
total_entries Int
total_pages Int

PaymentGateway

Fields

Name Type Description
current_mode_publishable_key String
id ID
live_active Boolean
live_publishable_key String
payment_methods PaymentMethod
test_active Boolean
test_publishable_key String
type String

PaymentGatewayBalance

Fields

Name Type Description
available PaymentGatewayBalanceEntry
id ID
pending PaymentGatewayBalanceEntry

PaymentGatewayBalanceEntry

Fields

Name Type Description
amount Int
currency String
source_types HashObject

PaymentMethod

Fields

Name Type Description
active Boolean
environment String
id ID
key String
payment_gateway PaymentGateway
payment_method_type PaymentMethodType

PaymentMutationResult

Fields

Name Type Description
errors HashObject
result Payment
success Boolean

PaymentTransfer

Fields

Name Type Description
amount Float
amount_cents Float
created_at JSONDate
currency String
failed_at JSONDate
gateway_response String
id ID
payment_gateway_fee_cents Float
payments Payment
payout_attempts PayoutAttempt
receiver User
service_fee_amount_guest Float
service_fee_amount_guest_cents Int
service_fee_amount_host Float
service_fee_amount_host_cents Int
token String
transferred_at JSONDate

PaymentTransferCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results PaymentTransfer
total_entries Int
total_pages Int

PaymentTransferMutationResult

Fields

Name Type Description
errors HashObject
result PaymentTransfer
success Boolean

PayoutAttempt

Fields

Name Type Description
amount Float
amount_cents Int
created_at JSONDate
failed Boolean
failure_message String
gateway_response String
id ID
pending Boolean
success Boolean

PresignedUploadUrl

Fields

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

PresignedUrl

Fields

Name Type Description
access_url String URL to CDN with your file. Will be available once you upload file
path String
upload_url String Presigned URL where you should upload file

PrivateFile

Fields

Name Type Description
content_type String
created_at JSONDate
file_name String
id ID
name String
size_bytes Int
url String

Profile

Fields

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_boolean Boolean Fetch any property of Boolean by name, ex: price: property_boolean(name: "enabled")
property_float Float Fetch any property of Float by name, ex: price: property_float(name: "price")
property_int Int Fetch any property of Integer by name, ex: age: property_int(name: "age")
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 }

Property

Fields

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

Refund

Fields

Name Type Description
amount Float
amount_cents Int
created_at JSONDate
id ID
payment Payment
payment_gateway PaymentGateway
response String

Response

Fields

Name Type Description
body String
headers HashObject Hash of headers returned by the server
status Int Standard HTTP status code

Result

Fields

Name Type Description
changes HashObject hash with calculated difference of what has changed
model Model Updated model, assuming submited form was for resource model
user User Updated user, assuming submited form was for resource User

SeoData

Fields

Name Type Description
highlighted String
id String
slug String
snippet String
url String

SeoKeyword

Fields

Name Type Description
category String
category_url String
default_page_meta_description String
full_keyword_match_score Int
listings ListingCollection
name String
related_keywords SeoKeywordCollection
related_keywords_seo_data SeoData
slug String
transactable_seo_data SeoData
transactables TransactableCollection
updated_at JSONDate
url String

SeoKeywordCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results SeoKeyword
total_entries Int
total_pages Int

SmsNotification

Fields

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

SmsNotificationCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results SmsNotification
total_entries Int
total_pages Int

ThirdPartyIntegration

Fields

Name Type Description
created_at JSONDate
id ID
settings HashObject
type String
updated_at JSONDate

ThirdPartyIntegrationCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results ThirdPartyIntegration
total_entries Int
total_pages Int

Transactable

Fields

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 }

TransactableCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results Transactable
total_entries Int
total_pages Int

TransactableSchema

Fields

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

TransactableSchemaCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results TransactableSchema
total_entries Int
total_pages Int

TransactableType

Fields

Name Type Description
id ID
name String

UpdateCustomizationsMutationPayload

Fields

Name Type Description
ids ID

UpdateUsersMutationPayload

Fields

Name Type Description
ids ID

User

Fields

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")
jwt_token String JWT token that can be used for authentication
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_boolean Boolean Fetch any property of Boolean by name, ex: price: property_boolean(name: "enabled")
property_float Float Fetch any property of Float by name, ex: price: property_float(name: "price")
property_int Int Fetch any property of Integer by name, ex: age: property_int(name: "age")
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 }

UserCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results User
total_entries Int
total_pages Int

UserListing

Fields

Name Type Description
authentications Authentication
communication ListingsCommunication
created_at JSONDate
custom_address ListingAddress Fetch address by name, e.g: address: custom_address(name: "office_address")
custom_addresses ListingAddress Fetch all addresses, optionaly you can filter results by name, e.g: home: custom_addresses(name: "home")
custom_attachment ListingsPrivateFile Fetch attachment by name, e.g: sales_report: custom_attachment(name: "sales_report")
custom_attachments ListingsPrivateFile
custom_image ListingImage Fetch image by name, e.g: header: custom_image(name: "header")
custom_images ListingImage Fetch all images, optionaly you can filter results by name, e.g: cat_images: custom_images(name: "cat")
customizations ListingsCustomization
deleted_at JSONDate
email String
external_id ID
first_name String
id ID
language String
last_name String
middle_name String
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
profile ListingUserProfile
profiles ListingUserProfile
properties HashObject List of all properties assigned to the object.
property String Fetch any custom attribute 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 any property of JSON type by name, it returns JSON in contrast to "property" which returns String. E.g: todo_list: property_json(name: "todo_list")
remote_model Customization Defines relation object accessible over HTTP in JSON collection identified by it's ID.
slug String
sort_score Int when sorting by distance - field contains distance to target location
temporary_token String
updated_at JSONDate
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }

UserListingCollection

Fields

Name Type Description
aggregations Aggregations
current_page Int
has_next_page Boolean
has_previous_page Boolean
page Int deprecated, use current_page
per_page Int
results UserListing
size Int
total_entries Int
total_pages Int

UserProfileSchema

Fields

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

UserProfileSchemaCollection

Fields

Name Type Description
current_page Int
has_next_page Boolean
has_previous_page Boolean
per_page Int
results UserProfileSchema
total_entries Int
total_pages Int

__Directive

Fields

Name Type Description
name String
description String
locations __DirectiveLocation
args __InputValue
onOperation Boolean
onFragment Boolean
onField Boolean

__EnumValue

Fields

Name Type Description
name String
description String
isDeprecated Boolean
deprecationReason String

__Field

Fields

Name Type Description
name String
description String
args __InputValue
type __Type
isDeprecated Boolean
deprecationReason String

__InputValue

Fields

Name Type Description
name String
description String
type __Type
defaultValue String A GraphQL-formatted string representing the default value for this input value.

__Schema

Fields

Name Type Description
types __Type A list of all types supported by this server.
queryType __Type The type that query operations will be rooted at.
mutationType __Type If this server supports mutation, the type that mutation operations will be rooted at.
subscriptionType __Type If this server support subscription, the type that subscription operations will be rooted at.
directives __Directive A list of all directives supported by this server.

__Type

Fields

Name Type Description
kind __TypeKind
name String
description String
fields __Field
interfaces __Type
possibleTypes __Type
enumValues __EnumValue
inputFields __InputValue
ofType __Type

Questions?

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