GraphQL - Queries

activities

Type: ActivityCollection

Arguments

Name Type Description
ids ID
page Int Default: 1
per_page Int Default: 20
uuids String

admin_api_call_notifications

Type: ApiCallNotificationCollection

Arguments

Name Type Description
filter ApiCallNotificationsFilterInput
page Int Default: 1
per_page Int Default: 20
sort ApiCallNotificationsSortInput

admin_assets

Type: AssetCollection

Arguments

Name Type Description
filter AssetsFilterInput
page Int Default: 1
per_page Int Default: 20
sort AssetsSortInput

admin_authorization_policies

Type: AuthorizationPolicyCollection

Arguments

Name Type Description
filter AuthorizationPoliciesFilterInput
page Int Default: 1
per_page Int Default: 20
sort AuthorizationPoliciesSortInput

admin_background_jobs

Type: BackgroundJobCollection

Arguments

Name Type Description
filter BackgroundJobsFilterInput
page Int Default: 1
per_page Int Default: 20
sort BackgroundJobsSortInput

admin_email_notifications

Type: EmailNotificationCollection

Arguments

Name Type Description
filter EmailNotificationsFilterInput
page Int Default: 1
per_page Int Default: 20
sort EmailNotificationsSortInput

admin_form_configurations

Type: FormConfigurationCollection

Arguments

Name Type Description
filter FormConfigurationsFilterInput
page Int Default: 1
per_page Int Default: 20
sort FormConfigurationsSortInput

admin_forms

Type: FormCollection

Arguments

Name Type Description
filter FormsFilterInput
page Int Default: 1
per_page Int Default: 20
sort FormsSortInput

admin_graphql

Type: GraphQueryCollection

Arguments

Name Type Description
filter GraphqlFilterInput
page Int Default: 1
per_page Int Default: 20
sort GraphqlSortInput

admin_liquid_layouts

Type: LiquidLayoutCollection

Arguments

Name Type Description
filter LiquidLayoutsFilterInput
page Int Default: 1
per_page Int Default: 20
sort LiquidLayoutsSortInput

admin_liquid_partials

Type: LiquidPartialCollection

Arguments

Name Type Description
filter LiquidPartialsFilterInput
page Int Default: 1
per_page Int Default: 20
sort LiquidPartialsSortInput

admin_model_schemas

Type: ModelSchemaCollection

Arguments

Name Type Description
filter ModelSchemasFilterInput
page Int Default: 1
per_page Int Default: 20
sort ModelSchemasSortInput

admin_pages

Type: PageCollection

Arguments

Name Type Description
exclude Boolean deprecated use filter: { metadata: { exclude: $exclude }}
filter PageFilterInput
has_key String deprecated use filter: { metadata: { has_key: $key }}
metadata String deprecated use filter: { metadata: { contains: $text }}
name String deprecated use filter: { metadata: { attribute: { key: $name, value: $value }}}
page Int Default: 1
per_page Int Default: 20
sort PagesSortInput
value String deprecated use filter: { metadata: { attribute: { key: $key, value: $value }}}

admin_sms_notifications

Type: SmsNotificationCollection

Arguments

Name Type Description
filter SmsNotificationsFilterInput
page Int Default: 1
per_page Int Default: 20
sort SmsNotificationsSortInput

admin_third_party_integrations

Type: ThirdPartyIntegrationCollection

Arguments

Name Type Description
filter ThirdPartyIntegrationsFilterInput
page Int Default: 1
per_page Int Default: 20
sort ThirdPartyIntegrationsSortInput

admin_transactable_schemas

Type: TransactableSchemaCollection

Arguments

Name Type Description
filter TransactableSchemasFilterInput
page Int Default: 1
per_page Int Default: 20
sort TransactableSchemasSortInput

admin_user_profile_schemas

Type: UserProfileSchemaCollection

Arguments

Name Type Description
filter UserProfileSchemasFilterInput
page Int Default: 1
per_page Int Default: 20
sort UserProfileSchemasSortInput

cms_discovery

Type: CMSItemDefinitionCollection

Arguments

Name Type Description
types CMSItemType

cms_items

Type: CMSItemPayloadCollection

Arguments

Name Type Description
page Int Default: 1
per_page Int
type CMSItemType

constant

Type: EncryptedConstant

Arguments

Name Type Description
filter EncryptedConstantFilterInput

constants

Type: EncryptedConstantCollection

Arguments

Name Type Description
filter EncryptedConstantsFilterInput
page Int Default: 1
per_page Int Default: 20
sort EncryptedConstantsSortInput

credit_cards

Type: CreditCard

Arguments

Name Type Description
id ID
payment_method_id ID
user_id ID

current_user

Type: User

Arguments

Name Type Description

custom_attribute_definition

Type: CustomAttributeDefinition

Arguments

Name Type Description
name String

customization

Type: Customization

Arguments

Name Type Description
id ID
name String

customizations

Type: ListingsCustomizationCollection

Arguments

Name Type Description
aggregations ListingAggregation
created_at DateRange
custom_model_type QueryCustomModelType deprecated: use model_schema
customizable_id ID
customizable_ids ID
customizable_type String
external_id ID
external_ids ID
id ID
ids ID
is_deleted Boolean
model_schema QueryModelSchema
name String Name of the Model Schema
names String Array of names of the Model Schema
page Int Default: 1
per_page Int Default: 20
properties QueryCustomAttribute
query Query Fulltext search
sort SortOrder
updated_at DateRange
user_id ID
user_ids ID
without_ids ID Array of ids to exclude from results
without_names String Array of names of the Model Schema which will be excluded from results

feeds

Type: ActivityStreamsFeed

Arguments

Name Type Description

handlers

Type: HandlerCollection

Arguments

Name Type Description
page Int Default: 1
per_page Int Default: 20

images

Type: CustomImageCollection

Arguments

Name Type Description
filter ImagesFilterInput
page Int Default: 1
per_page Int
sort ImagesSortInput

instance

Type: Instance

Arguments

Name Type Description

listings

Type: ListingCollection

Arguments

Name Type Description
aggregations ListingAggregation
geo_query GeoQuery Geo search Deprecetad
listing QueryListing
page Int Default: 1
per_page Int Default: 20
query Query Fulltext search
sort SortOrder

login_providers

Type: String

Arguments

Name Type Description

merchant_accounts

Type: MerchantAccountCollection

Arguments

Name Type Description
created_at DateRange
page Int Default: 1
payment_gateway_id ID
per_page Int Default: 25
state MerchantAccountState
test Boolean

model

Type: Customization

Arguments

Name Type Description
id ID
name String

models

Type: ModelCollection

Arguments

Name Type Description
filter ModelsFilterInput
page Int Default: 1
per_page Int
sort ModelsSortInput

pages

Type: PageCollection

Arguments

Name Type Description
exclude Boolean deprecated use filter: { metadata: { exclude: $exclude }}
filter PageFilterInput
has_key String deprecated use filter: { metadata: { has_key: $key }}
metadata String deprecated use filter: { metadata: { contains: $text }}
name String deprecated use filter: { metadata: { attribute: { key: $name, value: $value }}}
page Int Default: 1
per_page Int Default: 20
sort PagesSortInput
value String deprecated use filter: { metadata: { attribute: { key: $key, value: $value }}}

payment

Type: Payment

Arguments

Name Type Description
id ID
payable_id ID
payable_type String

payment_gateways

Type: PaymentGateway

Arguments

Name Type Description
for_current_mode Boolean If True, return gateways by a mode set in Instance Admin, default true.
mode PaymentGatewayMode
payment_method_active Boolean
payment_method_type PaymentMethodType
type PaymentGatewayType

payment_transfers

Type: PaymentTransferCollection

Arguments

Name Type Description
filter PaymentTransferFilters
page Int Default: 1
per_page Int Default: 25
sort PaymentTransferSort

payments

Type: PaymentCollection

Arguments

Name Type Description
created_at DateRange
mode PaymentMode
page Int Default: 1
payable_id ID
payable_type String
payer_name String
payment_gateway_id ID
per_page Int Default: 25
receiver_id ID
receiver_name String
state PaymentState
transferred String

people

Type: UserListingCollection

Arguments

Name Type Description
aggregations ListingAggregation
geo_query GeoQuery Geo search
page Int Default: 1
per_page Int Default: 20
query Query Fulltext search
sort SortOrder
user QueryUser

request

Type: HTTPRequestContext

Arguments

Name Type Description

seo_keywords

Type: SeoKeywordCollection

Arguments

Name Type Description
keywords String
page Int Default: 1
per_page Int Default: 20
source String

streams

Type: ActivityStreamCollection

Arguments

Name Type Description
feed_id ID
feed_name String
feed_type String
page Int Default: 1
per_page Int Default: 20
reset_last_read Boolean Default: true

transactable

Type: Transactable

Arguments

Name Type Description
creator_id ID
id ID
slug String Slug of the transactable

transactable_type

Type: TransactableType

Arguments

Name Type Description
id ID
name String Name of Transactable Type

transactable_types

Type: TransactableType

Arguments

Name Type Description
ids ID List of ids
names String List of names

transactables

Type: TransactableCollection

Arguments

Name Type Description
page Int Default: 1
per_page Int Default: 20

user

Type: User

Arguments

Name Type Description
email String
external_id String
id ID
is_deleted Boolean
slug String

users

Type: UserCollection

Arguments

Name Type Description
filter UsersFilterInput
page Int Default: 1
per_page Int
sort UsersSortInput

Questions?

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