Account

An Account (AKA Organisation) in the Promotions API, which can have multiple Promotions

type Account {
  id: Int!
  uuid: String!
  name: String!
  active: Boolean!
  updatedAt: Date!
  plan: Plan
  usage: AccountUsage
  promotionsCount: Int!
  contactsCount: Int!
  redemptionCodesCount: Int!
  promotions(
    active: Boolean
    uuid: String
    limit: Int
    offset: Int
  ): [Promotion]
  connectedServices(
    serviceType: ConnectedServiceType
    enabled: Boolean
    exclude: [ConnectedServiceType]
  ): [ConnectedService]
  authTokens(
    tokenType: String
  ): [AuthToken]
  contacts(
    limit: Int
    offset: Int
    uuid: String
    email: String
    shopifyId: String
  ): [Contact]
  merchants: [Merchant!]
  webhooks: [Webhook!]!
  webhookDeliveries(
    webhookUuid: String!
    limit: Int
    eventType: WebhookEventType
    success: Boolean
  ): [WebhookDelivery!]!
  webhookErrorRate(
    webhookUuid: String!
    windowHours: Int
  ): WebhookErrorRate!
}

Fields

Account.id ● Int! non-null scalar

ID of the Account

Account.uuid ● String! non-null scalar

UUID of the Account

Account.name ● String! non-null scalar

The name of the Account

Account.active ● Boolean! non-null scalar

Active status of the Account

Account.updatedAt ● Date! non-null scalar

The updated date of the Account

Account.plan ● Plan object

The Plan associated with the Account

Account.usage ● AccountUsage object

Account usage

Account.promotionsCount ● Int! non-null scalar

Total number of promotions for the account

Account.contactsCount ● Int! non-null scalar

Total number of contacts for the account

Account.redemptionCodesCount ● Int! non-null scalar

Total number of redemption codes across all promotions for the account

Account.promotions ● [Promotion] list object

List of the Promotions associated with the Account

Account.promotions.active ● Boolean scalar

Filter the the promotions based on the active status

Account.promotions.uuid ● String scalar

Filter the promotions based on the UUID of the Promotion

Account.promotions.limit ● Int scalar

Limit the number of promotions returned

Account.promotions.offset ● Int scalar

Offset the list of promotions returned

Account.connectedServices ● [ConnectedService] list object

List of connected services

Account.connectedServices.serviceType ● ConnectedServiceType enum

Filter the connected services based on the service type

Account.connectedServices.enabled ● Boolean scalar

Filter the connected services based on the active status

Account.connectedServices.exclude ● [ConnectedServiceType] list enum

Services to exclude from the list of connected services

Account.authTokens ● [AuthToken] list object

Auth Tokens associated with the account - only available when authenticating using the JWT method

Account.authTokens.tokenType ● String scalar

Filter the auth tokens based on the token type

Account.contacts ● [Contact] list object

List of the Contacts associated with the Account

Account.contacts.limit ● Int scalar

Limit the number of contacts returned

Account.contacts.offset ● Int scalar

Offset the list of contacts returned

Account.contacts.uuid ● String scalar

Filter the contacts based on the UUID of the Contact

Account.contacts.email ● String scalar

Filter the contacts based on the email of the Contact

Account.contacts.shopifyId ● String scalar

Filter the contacts based on their Shopify Customer ID

Account.merchants ● [Merchant!] list object

Get all merchants for the account

Account.webhooks ● [Webhook!]! non-null object

List webhooks for the account

Account.webhookDeliveries ● [WebhookDelivery!]! non-null object

List webhook deliveries ordered by most recent first

Account.webhookDeliveries.webhookUuid ● String! non-null scalar

Webhook UUID

Account.webhookDeliveries.limit ● Int scalar

Limit results (default 30, max 100)

Account.webhookDeliveries.eventType ● WebhookEventType enum

Optional event filter

Account.webhookDeliveries.success ● Boolean scalar

Optional success/failure filter

Account.webhookErrorRate ● WebhookErrorRate! non-null object

Get aggregate webhook error rate for a rolling window

Account.webhookErrorRate.webhookUuid ● String! non-null scalar

Webhook UUID

Account.webhookErrorRate.windowHours ● Int scalar

Lookback window in hours (default 24, max 720)

Returned By

account query

Member Of

User object