API Reference

GraphQL - Interfaces

AdminPropertiesInterface

Implemented by

Fields

Name Type Description
fields Property Deprecated, use properties instead.
properties Property List of properties attributes to be included in the results

AdminSharedAttributesInterface

Implemented by

Fields

Name Type Description
created_at JSONDate
id ID
metadata HashObject
physical_file_path String defines the physical path of the file
updated_at JSONDate

HasModelsInterface

Implemented by

Fields

Name Type Description
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 }
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 }

LegacyCustomAttributeInterface

Implemented by

Fields

Name Type Description
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")

ListingCustomAttributeInterface

Implemented by

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

ListingsMetadata

Implemented by

Fields

Name Type Description
sort_score Int when sorting by distance - field contains distance to target location

PropertiesInterface

Implemented by

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")
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")
properties HashObject List of all properties assigned to the object.
property String Fetch any property by name, ex: hair_color: property(name: "hair_color")
property_array String Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String. E.g: todo_list: property_array(name: "todo_list")
property_json JSONPayload Fetch property of JSON type by name, it returns JSON in contrast to "property" which returns String.

RelationOnDemandInterface

Implemented by

Fields

Name Type Description
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 }
user User Defines relation with other user, e.g: invited_by: user(join_on_property: "invited_by_id") { id }

RemoteModelInterface

Implemented by

Fields

Name Type Description
remote_model Customization Defines relation object accessible over HTTP in JSON collection identified by it's ID.

Questions?

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

contact us