API reference

Input types

The input objects and long enums that several operations take, described once: each field's GraphQL type, whether it is required and what it accepts.

Operation pages link here for an input type more than one operation takes, and for an enum too long to list in a table. A type only one operation takes is described on that operation's page. A filter lists its fields by the type they take, and none of them is required.

Input objects

BigFloatFilter

BigFloat (Decimal as a string, e.g. "12.50". matches ^-?\d+(\.\d+)?$): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[BigFloat!] (Decimal as a string, e.g. "12.50". each matches ^-?\d+(\.\d+)?$): in, notIn
Boolean: isNull

BooleanFilter

Boolean: equalTo, greaterThan, greaterThanOrEqualTo, isNull, lessThan, lessThanOrEqualTo, notEqualTo
[Boolean!]: in, notIn

DateFilter

Date (ISO 8601 date, YYYY-MM-DD): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[Date!] (ISO 8601 date, YYYY-MM-DD): in, notIn
Boolean: isNull

DatetimeFilter

Datetime (ISO 8601 with a zone, e.g. 2026-01-01T00:00:00Z): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[Datetime!] (ISO 8601 with a zone, e.g. 2026-01-01T00:00:00Z): in, notIn
Boolean: isNull

DiscountCodeFilter

IntFilter: aliasCount, usageCount
[DiscountCodeFilter!] (DiscountCodeFilter): and, or
StringFilter: code, displayName, tier, title
DatetimeFilter: createdAt, endsAt, updatedAt
DiscountCreatedByFilter: createdBy
DiscountCodeFilter: not
Boolean: partnerByPartnerIdExists
UUIDFilter: partnerId, rowId
DiscountStatusFilter: status
BigFloatFilter: valueAmount, valuePercent

DiscountCreatedByFilter

DiscountCreatedBy (One of IMPORTED, MISSIN, SHOPIFY): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[DiscountCreatedBy!] (One of IMPORTED, MISSIN, SHOPIFY): in, notIn
Boolean: isNull

DiscountStatusFilter

DiscountStatus (One of ACTIVE, DRAFT, EXPIRED, SCHEDULED): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[DiscountStatus!] (One of ACTIVE, DRAFT, EXPIRED, SCHEDULED): in, notIn
Boolean: isNull

FinancialStatusFilter

FinancialStatus (One of AUTHORIZED, PAID, PARTIALLY_PAID, PARTIALLY_REFUNDED, PENDING, REFUNDED, VOIDED): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[FinancialStatus!] (One of AUTHORIZED, PAID, PARTIALLY_PAID, PARTIALLY_REFUNDED, PENDING, REFUNDED, VOIDED): in, notIn
Boolean: isNull

FloatFilter

Float: equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[Float!]: in, notIn
Boolean: isNull

FormResponseFilter

[FormResponseFilter!] (FormResponseFilter): and, or
Boolean: channelByChannelIdExists, connectionByConnectionIdExists, customerByCustomerIdExists, discountCodeByDiscountCodeIdExists, formPlacementByFormPlacementIdExists, partnerByPartnerIdExists, shortLinkByShortLinkIdExists
UUIDFilter: channelId, connectionId, customerId, discountCodeId, formPlacementId, formVariantId, partnerId, rowId, shortLinkId, visitorId
StringFilter: clickId, clickIdKind, originRef, sessionId
DatetimeFilter: completedAt, createdAt
FormResponseFilter: not
FormResponseStatusFilter: status

FormResponseStatusFilter

FormResponseStatus (One of COMPLETE, INCOMPLETE, SKIPPED): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[FormResponseStatus!] (One of COMPLETE, INCOMPLETE, SKIPPED): in, notIn
Boolean: isNull

FulfillmentStatusFilter

FulfillmentStatus (One of FULFILLED, INCOMPLETE, NOT_APPLICABLE, OPEN, PARTIALLY_FULFILLED, PENDING, RESTOCKED, SCHEDULED): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[FulfillmentStatus!] (One of FULFILLED, INCOMPLETE, NOT_APPLICABLE, OPEN, PARTIALLY_FULFILLED, PENDING, RESTOCKED, SCHEDULED): in, notIn
Boolean: isNull

GrantDecisionInput

Field	Type	Required	Accepts	Description
`grantId`	`UUID!`	yes

IntFilter

Int (32-bit integer): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[Int!] (32-bit integer): in, notIn
Boolean: isNull

OrderFilter

[OrderFilter!] (OrderFilter): and, or
BigFloatFilter: attributedRevenue
DatetimeFilter: attributionScoredAt, createdAt, paidAt, placedAt
StringFilter: bestTier, customerRef, externalRef, integrationSlug
Boolean: connectionByConnectionIdExists, customerByCustomerIdExists, discountCodeByDiscountCodeIdExists, formResponseByFormResponseIdExists, orderCustomByOrderIdExists, orderReportedByOrderIdExists, orderShopifyByOrderIdExists, orderStripeByOrderIdExists, partnerByPartnerIdExists
UUIDFilter: connectionId, currencyId, customerId, discountCodeId, formResponseId, partnerId, rowId, workspaceId
FinancialStatusFilter: financialStatus
FulfillmentStatusFilter: fulfillmentStatus
BooleanFilter: isReal
OrderFilter: not
OrderStatusFilter: orderStatus
StringListFilter: originRefs
DateFilter: placedDay

OrderStatusFilter

OrderStatus (One of ARCHIVED, CANCELLED, CLOSED, FRAUD, OPEN, PENDING): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[OrderStatus!] (One of ARCHIVED, CANCELLED, CLOSED, FRAUD, OPEN, PENDING): in, notIn
Boolean: isNull

PartnerPostFilter

[PartnerPostFilter!] (PartnerPostFilter): and, or
UUIDFilter: authorAccountId, campaignId, campaignSignalId, crosspostGroupId, partnerId, revisedFromId, rowId, suiteId
Boolean: campaignByCampaignIdExists, campaignSignalByCampaignSignalIdExists, partnerPostAnalyticsScopedByRowIdExists, partnerPostCustomByPartnerPostIdExists, partnerPostFacebookPostByPartnerPostIdExists, partnerPostInstagramPostByPartnerPostIdExists, partnerPostInstagramReelByPartnerPostIdExists, partnerPostInstagramStoryByPartnerPostIdExists, partnerPostTiktokVideoByPartnerPostIdExists, partnerPostTwitterPostByPartnerPostIdExists, partnerPostYoutubeVideoByPartnerPostIdExists, revisedFromExists
StringListFilter: hashtags, mentions
BooleanFilter: isSponsored, trackingEnabled
IntFilter: likes, views
DatetimeFilter: metricsUpdatedAt, publishedAt
PartnerPostFilter: not
PartnerPostKindFilter: postType
PartnerPostStatusFilter: status
StringFilter: title
PartnerPostValidityFilter: validity

PartnerPostKindFilter

PartnerPostKind (One of CUSTOM, FACEBOOK_POST, INSTAGRAM_POST, INSTAGRAM_REEL, INSTAGRAM_STORY, TIKTOK_VIDEO, TWITTER_POST, YOUTUBE_VIDEO): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[PartnerPostKind!] (One of CUSTOM, FACEBOOK_POST, INSTAGRAM_POST, INSTAGRAM_REEL, INSTAGRAM_STORY, TIKTOK_VIDEO, TWITTER_POST, YOUTUBE_VIDEO): in, notIn
Boolean: isNull

PartnerPostStatusFilter

PartnerPostStatus (One of DELETED, LIVE): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[PartnerPostStatus!] (One of DELETED, LIVE): in, notIn
Boolean: isNull

PartnerPostValidityFilter

PartnerPostValidity (One of APPROVED, CHANGE_REQUESTED, NEEDS_REVIEW, PENDING, REJECTED): equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[PartnerPostValidity!] (One of APPROVED, CHANGE_REQUESTED, NEEDS_REVIEW, PENDING, REJECTED): in, notIn
Boolean: isNull

PromotionShareInput

One form's share of the workspace's promotion.

Field	Type	Required	Accepts	Description
`formId`	`UUID!`	yes
`main`	`Boolean!`	yes		The control. Exactly one entry carries it.
`share`	`Int!`	yes	32-bit integer. 0 to 100	Whole percent, 0-100. The rotation's shares sum to exactly 100.

StringFilter

String: equalTo, greaterThan, greaterThanOrEqualTo, includesInsensitive, lessThan, lessThanOrEqualTo, notEqualTo
[String!]: in, notIn
Boolean: isNull

StringListFilter

String: anyEqualTo
[String]: equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
Boolean: isNull

UUIDFilter

UUID: equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo, notEqualTo
[UUID!]: in, notIn
Boolean: isNull

Enums

BillingUsageBucket

Value	Meaning
`DAY`	One bucket per UTC day.
`WEEK`	One bucket per ISO week (Monday 00:00 UTC); the window's first and last weeks hold only its own days.

CaptureRunStatus

completing, dispatched, empty, failed, ok, queued, settling, starting, stopped

CaptureTrigger

fill, import, manual, profile_resync, refresh, reply_fetch, resync, scheduled, tracking

CheckoutOrderBy

CONNECTION_ID_ASC, CONNECTION_ID_DESC, CUSTOMER_REF_ASC, CUSTOMER_REF_DESC, EXTERNAL_REF_ASC, EXTERNAL_REF_DESC, NATURAL, ORDER_ID_ASC, ORDER_ID_DESC, PARTNER_ID_ASC, PARTNER_ID_DESC, PRIMARY_KEY_ASC, PRIMARY_KEY_DESC, PROVIDER_UPDATED_AT_ASC, PROVIDER_UPDATED_AT_DESC, ROW_ID_ASC, ROW_ID_DESC, STARTED_DAY_ASC, STARTED_DAY_DESC, WORKSPACE_ID_ASC, WORKSPACE_ID_DESC

DiscountCodeOrderBy

ALIAS_COUNT_ASC, ALIAS_COUNT_DESC, CODE_ASC, CODE_DESC, CREATED_AT_ASC, CREATED_AT_DESC, DISPLAY_NAME_ASC, DISPLAY_NAME_DESC, ENDS_AT_ASC, ENDS_AT_DESC, NATURAL, PARTNER_ID_ASC, PARTNER_ID_DESC, PRIMARY_KEY_ASC, PRIMARY_KEY_DESC, ROW_ID_ASC, ROW_ID_DESC, STATUS_ASC, STATUS_DESC, TIER_ASC, TIER_DESC, TITLE_ASC, TITLE_DESC, UPDATED_AT_ASC, UPDATED_AT_DESC, USAGE_COUNT_ASC, USAGE_COUNT_DESC, VALUE_AMOUNT_ASC, VALUE_AMOUNT_DESC, VALUE_PERCENT_ASC, VALUE_PERCENT_DESC, WORKSPACE_ID_ASC, WORKSPACE_ID_DESC

FormPlacementCopyField

Value	Meaning
`tier_note_text`	The tier picker row's reward line.
`upsell_text`	The end-of-form upsell button's sentence.

MarketingAdOrderBy

AD_NETWORK_CHANNEL_ASC, AD_NETWORK_CHANNEL_DESC, CAMPAIGN_ID_ASC, CAMPAIGN_ID_DESC, CAMPAIGN_SIGNAL_ID_ASC, CAMPAIGN_SIGNAL_ID_DESC, CHANNEL_ID_ASC, CHANNEL_ID_DESC, CONNECTION_ID_ASC, CONNECTION_ID_DESC, LEVEL_ASC, LEVEL_DESC, NAME_ASC, NAME_DESC, NATURAL, ORIGIN_ID_ASC, ORIGIN_ID_DESC, PARENT_ORIGIN_ID_ASC, PARENT_ORIGIN_ID_DESC, PRIMARY_KEY_ASC, PRIMARY_KEY_DESC, PROGRAM_ORIGIN_ID_ASC, PROGRAM_ORIGIN_ID_DESC, ROW_ID_ASC, ROW_ID_DESC, STARTED_AT_ASC, STARTED_AT_DESC, STATUS_ASC, STATUS_DESC, TRACKING_ENABLED_ASC, TRACKING_ENABLED_DESC, UTM_CAMPAIGN_ASC, UTM_CAMPAIGN_DESC, UTM_MEDIUM_ASC, UTM_MEDIUM_DESC, UTM_SOURCE_ASC, UTM_SOURCE_DESC, WORKSPACE_ID_ASC, WORKSPACE_ID_DESC

MarketingSendOrderBy

CAMPAIGN_ID_ASC, CAMPAIGN_ID_DESC, CAMPAIGN_SIGNAL_ID_ASC, CAMPAIGN_SIGNAL_ID_DESC, CHANNEL_ID_ASC, CHANNEL_ID_DESC, CONNECTION_ID_ASC, CONNECTION_ID_DESC, NAME_ASC, NAME_DESC, NATURAL, ORIGIN_ID_ASC, ORIGIN_ID_DESC, PRIMARY_KEY_ASC, PRIMARY_KEY_DESC, PROGRAM_ORIGIN_ID_ASC, PROGRAM_ORIGIN_ID_DESC, ROW_ID_ASC, ROW_ID_DESC, SEND_CHANNEL_ASC, SEND_CHANNEL_DESC, SENT_AT_ASC, SENT_AT_DESC, STATUS_ASC, STATUS_DESC, SUBJECT_ASC, SUBJECT_DESC, TRACKING_ENABLED_ASC, TRACKING_ENABLED_DESC, UTM_CAMPAIGN_ASC, UTM_CAMPAIGN_DESC, UTM_MEDIUM_ASC, UTM_MEDIUM_DESC, UTM_SOURCE_ASC, UTM_SOURCE_DESC, WORKSPACE_ID_ASC, WORKSPACE_ID_DESC

OrderOrderBy

ATTRIBUTED_REVENUE_ASC, ATTRIBUTED_REVENUE_DESC, ATTRIBUTION_SCORED_AT_ASC, ATTRIBUTION_SCORED_AT_DESC, BEST_TIER_ASC, BEST_TIER_DESC, CONNECTION_ID_ASC, CONNECTION_ID_DESC, CREATED_AT_ASC, CREATED_AT_DESC, CURRENCY_ID_ASC, CURRENCY_ID_DESC, CUSTOMER_ID_ASC, CUSTOMER_ID_DESC, CUSTOMER_REF_ASC, CUSTOMER_REF_DESC, DISCOUNT_CODE_ID_ASC, DISCOUNT_CODE_ID_DESC, EXTERNAL_REF_ASC, EXTERNAL_REF_DESC, FORM_RESPONSE_ID_ASC, FORM_RESPONSE_ID_DESC, INTEGRATION_SLUG_ASC, INTEGRATION_SLUG_DESC, NATURAL, PAID_AT_ASC, PAID_AT_DESC, PARTNER_ID_ASC, PARTNER_ID_DESC, PLACED_AT_ASC, PLACED_AT_DESC, PLACED_DAY_ASC, PLACED_DAY_DESC, PRIMARY_KEY_ASC, PRIMARY_KEY_DESC, ROW_ID_ASC, ROW_ID_DESC, WORKSPACE_ID_ASC, WORKSPACE_ID_DESC

PartnerOrderBy

CREATED_AT_ASC, CREATED_AT_DESC, EMAIL_ASC, EMAIL_DESC, NAME_ASC, NAME_DESC, NATURAL, PRIMARY_KEY_ASC, PRIMARY_KEY_DESC, ROW_ID_ASC, ROW_ID_DESC, USERNAME_ASC, USERNAME_DESC, UTM_CONTENT_ASC, UTM_CONTENT_DESC, UTM_MEDIUM_ASC, UTM_MEDIUM_DESC, UTM_SOURCE_ASC, UTM_SOURCE_DESC, WORKSPACE_ID_ASC, WORKSPACE_ID_DESC

PartnerPostOrderBy

AUTHOR_ACCOUNT_ID_ASC, AUTHOR_ACCOUNT_ID_DESC, CAMPAIGN_ID_ASC, CAMPAIGN_ID_DESC, CAMPAIGN_SIGNAL_ID_ASC, CAMPAIGN_SIGNAL_ID_DESC, CROSSPOST_GROUP_ID_ASC, CROSSPOST_GROUP_ID_DESC, CROSSPOST_KEY_ASC, CROSSPOST_KEY_DESC, IS_SPONSORED_ASC, IS_SPONSORED_DESC, LIKES_ASC, LIKES_DESC, METRICS_UPDATED_AT_ASC, METRICS_UPDATED_AT_DESC, NATURAL, ORIGIN_ID_ASC, ORIGIN_ID_DESC, PARTNER_ID_ASC, PARTNER_ID_DESC, POST_URL_ASC, POST_URL_DESC, PRIMARY_KEY_ASC, PRIMARY_KEY_DESC, PUBLISHED_AT_ASC, PUBLISHED_AT_DESC, REVISED_FROM_ID_ASC, REVISED_FROM_ID_DESC, ROW_ID_ASC, ROW_ID_DESC, SUITE_ID_ASC, SUITE_ID_DESC, TITLE_ASC, TITLE_DESC, TRACKING_ENABLED_ASC, TRACKING_ENABLED_DESC, VIEWS_ASC, VIEWS_DESC, WORKSPACE_ID_ASC, WORKSPACE_ID_DESC

WaitlistSignupOrderBy

CONFIRMED_AT_ASC, CONFIRMED_AT_DESC, CUSTOMER_ID_ASC, CUSTOMER_ID_DESC, EMAIL_CANONICAL_ASC, EMAIL_CANONICAL_DESC, EMAIL_NORMALIZED_ASC, EMAIL_NORMALIZED_DESC, NATURAL, PRIMARY_KEY_ASC, PRIMARY_KEY_DESC, ROW_ID_ASC, ROW_ID_DESC, WAITLIST_ID_ASC, WAITLIST_ID_DESC, WORKSPACE_ID_ASC, WORKSPACE_ID_DESC