Lasso GraphQL API Reference

Welcome to Lasso's GraphQL API Reference Documentation.

Contact

GraphQL API Support

support@lassotech.com

https://www.lassotech.com

Terms of Service

https://www.lassotech.com/terms

API Endpoints
# Endpoint:
https://api.lassotech.com/graphql
Headers
# Use a generated API Access Token
x-lasso-access-token: <YOUR_TOKEN_HERE>

Authentication

To authenticate with the Lasso GraphQL API, you will need to generate an API Access Token.

This token should be included in the x-lasso-access-token header for all requests.

You can generate an API Access Token from the Lasso Admin Dashboard under Settings.

Security

It is important to keep your API Access Token secure.

The Lasso Admin GraphQL API is designed to be used on server side. The Access Token should be kept secure and should not be exposed in public repositories or client-side code. You should not share your API Access Token with untrusted parties.

The API Access Token have an associated role. The role determines the permissions of the API Access Token. To ensure the security of the API, you should only use the API Access Token with the role that you need.

Rate Limiting

The Lasso Admin GraphQL API enforces rate limiting to ensure the stability and reliability of the service.

The rate limit is 3 requests per second per account. If you exceed this limit, you will receive a 429 Too Many Requests response.

Webhooks

Webhook Overview

Webhooks are a way for you to receive real-time notifications from Lasso when certain events happen, and trigger custom code or integrations.

How It Works

When an event occurs, Lasso will send an HTTP POST request to the URL you specify for a subscribed topic. The request will contain a JSON payload with information about the event that occurred.

You can use this information to trigger custom code, send notifications, or integrate with other services. For example, you could use webhooks to update an email provider platform when a partner joins the program.

Setting up a webhook

You can create a webhook subscription from Webhooks page. You will need to provide a URL for receiving the webhook.

Handling Webhooks

If you receive a webhook with any other status code or takes longer than 3 seconds to respond, it will be considered failed. After 10 consecutive failed attempts, the webhook subscription will be disabled. You will have to delete and re-create the webhook subscription to start receiving webhooks again.

Webhooks can be delivered out of order and can be delivered multiple times. To manage this, you can use the X-Webhook-Event-ID as a unique identifier for each event. You can use this ID to deduplicate events and ensure that you process each event only once.

Security Considerations

When you receive a webhook, you should verify the request came from Lasso by checking the signature in the request header X-Signature. The value of the signature is calculated by taking the HMAC-SHA256 of the request body using your webhook secret as the key.

Topics

Webhooks will include the subscribed topic in the X-Topic header that describes the event that triggered the webhook. Lasso can send Webhooks for the following topics:

Topic Description
lead.open When a new lead is created
lead.accepted When a lead is accepted by a user or auto-accepted
lead.qualified When a lead is marked as qualified via CRM Integration or manually
lead.closed_lost When a lead is marked as lost via CRM Integration or manually
lead.closed_won When a lead is marked as won via CRM Integration or manually
partner.created When a new partner is created
partner.updated When a partner's details are updated
partner.deleted When a partner is deleted
partner_user.created When a new partner user is created
partner_user.updated When a partner user's details are updated
partner_user.deleted When a partner user is deleted
payment.payout_pending When a payment is marked as pending payout
payment.voided When a payment is voided
payout.successful When a payout is successfully processed
payout.failed When a payout fails to process

Payload

Lead Payload

{
  "identifier": "LEAD-C238A3",
  "status": "accepted",
  "partner": {
    "identifier": "acme",
    "name": "Acme Corporation",
    "segment": { "name": "Fixed Closed Won" },
    "partner_type": { "identifier": "PT-PARTNER", "name": "Partner" },
    "payment_terms": "net_30",
    "payment_frequency": "yearly",
    "allow_members": true,
    "created_at": "2024-10-30T18:47:53Z",
    "updated_at": "2025-01-20T20:27:34Z"
  },
  "partner_member": {
    "identifier": "17d8563",
    "full_name": "Ashley Miller",
    "email": "ashley@acme.com",
    "role": "partner_admin",
    "referral_url": "https://mylasso.link/a/4DMHJA2",
    "referral_qr_code_url": "https://lasso-app-cdn.s3.us-east-2.amazonaws.com/cache/partneruser/26/referral_qr_code/6ebe46addab4a138da15b765d337fcdb.png",
    "apple_wallet_pass_url": "http://api.lassotech.com/v1/apple_pass/17d8563",
    "google_wallet_pass_url": "http://api.lassotech.com/v1/google_pass/17d8563"
  },
  "managed_by": { "full_name": "David Lee", "email": "david@company.com" },
  "created_at": "2025-01-21T01:59:41Z",
  "updated_at": "2025-01-21T01:59:41Z",
  "expires_at": "2025-04-16T00:59:41Z",
  "created_by": { "full_name": "Christopher Brown", "email": "chris@company.com" }
}

Partner Payload

{
  "identifier": "PT-ACME-CORP",
  "name": "ACME Corporation",
  "segment": { "name": "Fixed Closed Won" },
  "partner_type": { "identifier": "digital-marketing-agency", "name": "Digital Marketing Agency" },
  "payment_terms": "net_30",
  "payment_frequency": "yearly",
  "allow_members": true,
  "created_at": "2025-01-22T21:44:43Z",
  "updated_at": "2025-01-22T21:45:23Z"
}

Partner User Payload

{
  "identifier": "17d8563",
  "full_name": "Ashley Miller",
  "email": "ashley@acme.com",
  "role": "partner_admin",
  "referral_url": "https://mylasso.link/a/4DMHJA2",
  "referral_qr_code_url": "https://lasso-app-cdn.s3.us-east-2.amazonaws.com/cache/partneruser/26/referral_qr_code/6ebe46addab4a138da15b765d337fcdb.png",
  "apple_wallet_pass_url": "http://api.lassotech.com/v1/apple_pass/17d8563",
  "google_wallet_pass_url": "http://api.lassotech.com/v1/google_pass/17d8563"
}

Payment Payload

{
  "identifier": "PAY-2B7BAD",
  "amount": "1000.0",
  "currency": "USD",
  "status": "pending_payout",
  "created_at": "2025-01-22T21:54:33Z",
  "updated_at": "2025-01-22T21:54:34Z",
  "partner": {
    "identifier": "acme",
    "name": "Acme Corporation",
    "segment": { "name": "Fixed Closed Won" },
    "partner_type": { "identifier": "PT-PARTNER", "name": "Partner" },
    "payment_terms": "net_30",
    "payment_frequency": "yearly",
    "allow_members": true,
    "created_at": "2024-10-30T18:47:53Z",
    "updated_at": "2025-01-20T20:27:34Z"
  },
  "partner_member": null,
  "invoice_identifiers": ["INV-45C2A5"]
}

Payout Payload

{
  "identifier": "PAYOUT-97230C",
  "status": "successful",
  "info": null,
  "amount": "200.0",
  "currency": "USD",
  "created_at": "2025-01-22T19:41:57Z",
  "updated_at": "2025-01-22T19:43:04Z",
  "partner": {
    "identifier": "acme",
    "name": "Acme Corporation",
    "segment": { "name": "Fixed Closed Won" },
    "partner_type": { "identifier": "PT-PARTNER", "name": "Partner" },
    "payment_terms": "net_30",
    "payment_frequency": "yearly",
    "allow_members": true,
    "created_at": "2024-10-30T18:47:53Z",
    "updated_at": "2025-01-20T20:27:34Z"
  },
  "partner_member": null
}

Queries

accountUsers

Description

Get all users of the account

Response

Returns [AccountUser!]!

Arguments
Name Description
hasPermission - UserPermission

Example

Query
query AccountUsers($hasPermission: UserPermission) {
  accountUsers(hasPermission: $hasPermission) {
    account {
      currency
      customPartnerPortalDomain
      customPartnerPortalDomainVerified
      customReferralDomain
      customReferralDomainVerified
      defaultLeadGenerationForm {
        ...HostedFormFragment
      }
      domain
      features
      identifier
      leadSettings {
        ...LeadSettingsFragment
      }
      name
      onboardingStatus {
        ...OnboardingStatusFragment
      }
      partnerEmailSettings {
        ...PartnerEmailSettingFragment
      }
      partnerPortalSettings {
        ...PartnerPortalSettingFragment
      }
      partnerPortalUrl
      partnerTypes {
        ...PartnerTypeFragment
      }
      paymentFeePlan {
        ...PaymentFeePlanFragment
      }
      payoutMethods {
        ...PayoutMethodFragment
      }
      segments {
        ...SegmentFragment
      }
      status
      testMode
      themeSettings {
        ...ThemeSettingFragment
      }
      tierPlans {
        ...TierPlanFragment
      }
      timezone
      users {
        ...UserFragment
      }
      uuid
    }
    communicationTopics
    featureAnnouncementsSeen
    role {
      id
      name
      permissions
    }
    title
    user {
      accountAccess {
        ...AccountUserFragment
      }
      activated
      connectors {
        ...ConnectorFragment
      }
      createdAt
      deleted
      email
      firstName
      fullName
      id
      isRefilliateUser
      lastName
      name
      phone
      profileImageUrl
    }
  }
}
Variables
{"hasPermission": "ALL"}
Response
{
  "data": {
    "accountUsers": [
      {
        "account": Account,
        "communicationTopics": ["ACCOUNT_USER_ACCOUNT_FUNDING_NOTIFICATIONS"],
        "featureAnnouncementsSeen": [
          "abc123"
        ],
        "role": UserRole,
        "title": "xyz789",
        "user": User
      }
    ]
  }
}
Queries

currentAccount

Description

Account identified by the x-account-id header

Response

Returns an Account

Example

Query
query CurrentAccount {
  currentAccount {
    currency
    customPartnerPortalDomain
    customPartnerPortalDomainVerified
    customReferralDomain
    customReferralDomainVerified
    defaultLeadGenerationForm {
      companyNameRequirement
      countryCodeDefault
      createdAt
      css
      description
      formQuestions {
        ...FormQuestionFragment
      }
      formType
      id
      marketingConsentText
      phoneNumberRequirement
      postSubmissionRedirectUrl
      previewUrl
      slug
      submitButtonText
      successMessage
      termsAndConditionsText
      title
      updatedAt
      websiteRequirement
    }
    domain
    features
    identifier
    leadSettings {
      acceptanceSlaDays
      attributionWindowDays
      destinationType
      destinationUrl
      enableManualStateTransitions
      leadExpirationDays
      popupCss
      rejectionReasonRequired
      rejectionReasons
    }
    name
    onboardingStatus {
      paymentMethodRequired
    }
    partnerEmailSettings {
      authenticatedEmailDomain
      authenticatedEmailDomainVerified
      emailHeader
      footerText
      logoAsset {
        ...UploadedFileFragment
      }
      primaryColor
      replyToEmail
      senderEmail
      senderName
      sendgridDnsRecords {
        ...CustomDomainDnsRecordFragment
      }
    }
    partnerPortalSettings {
      calendarWidgetContainerBackgroundColor
      calendarWidgetContainerBorderColor
      calendarWidgetContainerClassName
      calendarWidgetCssOverrides
      calendarWidgetEventBadgeBackgroundColor
      calendarWidgetEventBadgeClassName
      calendarWidgetEventBadgeTextColor
      calendarWidgetEventBodyClassName
      calendarWidgetEventBodyTextColor
      calendarWidgetEventButtonBackgroundColor
      calendarWidgetEventButtonClassName
      calendarWidgetEventButtonTextColor
      calendarWidgetEventTitleClassName
      calendarWidgetEventTitleTextColor
      calendarWidgetSelectionButtonActiveBackgroundColor
      calendarWidgetSelectionButtonActiveClassName
      calendarWidgetSelectionButtonActiveTextColor
      calendarWidgetSelectionButtonInactiveBackgroundColor
      calendarWidgetSelectionButtonInactiveClassName
      calendarWidgetSelectionButtonInactiveTextColor
      calendarWidgetTitleClassName
      calendarWidgetTitleFontSize
      calendarWidgetTitleTextColor
      crmDealStageMapping {
        ...ValueLabelFragment
      }
      crmType
      cssEmbedCode
      cssEmbedCodeSass
      eventCalendarEnabled
      eventCalendarEventTypes
      eventCalendarTitle
      faqEnabled
      faqTitle
      faviconAsset {
        ...UploadedFileFragment
      }
      galleryEnabled
      galleryTitle
      jsEmbedCode
      loggedInBody {
        ...StyledTextFragment
      }
      loggedInFooter {
        ...StyledTextFragment
      }
      loggedInNavHeader {
        ...StyledTextFragment
      }
      loggedInNavLogo {
        ...StyledTextFragment
      }
      loggedInSideNav {
        ...StyledTextFragment
      }
      loggedInSideNavItem {
        ...StyledTextFragment
      }
      loggedInSideNavItemActive {
        ...StyledTextFragment
      }
      loggedInSideNavItemHover {
        ...StyledTextFragment
      }
      loggedOutBody {
        ...StyledTextFragment
      }
      loginPageAsset {
        ...UploadedFileFragment
      }
      loginPageSubtitle
      loginPageTitle
      logoAsset {
        ...UploadedFileFragment
      }
      primaryButton {
        ...StyledTextFragment
      }
      showCrmDealExpectedAmount
      showCrmDealExpectedCloseDate
      showCrmDealStage
      showRevenueItemsWithInvoices
      showUpcomingInvoices
      siteTitle
    }
    partnerPortalUrl
    partnerTypes {
      id
      name
      slug
    }
    paymentFeePlan {
      currency
      interval
      payoutAdditionalPricePercentage
      payoutStartValue
    }
    payoutMethods {
      config
      description
      id
      name
      payoutMethodType
      provider
    }
    segments {
      createdAt
      externalDescription
      externalTitle
      id
      internalDescription
      multiCurrencyEnabled
      name
      rewards {
        ...SegmentRewardFragment
      }
      slug
    }
    status
    testMode
    themeSettings {
      accentColor
      brandColor
      fonts
      input
      modalContent
      modalHeading
      modalOverlay
      primaryButton
      secondaryButton
      textStyles
    }
    tierPlans {
      createdAt
      daysInTier
      description
      downgradeScheduleType
      features {
        ...TierPlanFeatureFragment
      }
      id
      name
      slug
      tiers {
        ...TierFragment
      }
      updatedAt
      upgradeScheduleType
    }
    timezone
    users {
      accountAccess {
        ...AccountUserFragment
      }
      activated
      connectors {
        ...ConnectorFragment
      }
      createdAt
      deleted
      email
      firstName
      fullName
      id
      isRefilliateUser
      lastName
      name
      phone
      profileImageUrl
    }
    uuid
  }
}
Response
{
  "data": {
    "currentAccount": {
      "currency": "USD",
      "customPartnerPortalDomain": "xyz789",
      "customPartnerPortalDomainVerified": true,
      "customReferralDomain": "xyz789",
      "customReferralDomainVerified": true,
      "defaultLeadGenerationForm": HostedForm,
      "domain": "xyz789",
      "features": ["rewards_upsell_crosssell"],
      "identifier": "xyz789",
      "leadSettings": LeadSettings,
      "name": "xyz789",
      "onboardingStatus": OnboardingStatus,
      "partnerEmailSettings": PartnerEmailSetting,
      "partnerPortalSettings": PartnerPortalSetting,
      "partnerPortalUrl": "abc123",
      "partnerTypes": [PartnerType],
      "paymentFeePlan": PaymentFeePlan,
      "payoutMethods": [PayoutMethod],
      "segments": [Segment],
      "status": "created",
      "testMode": true,
      "themeSettings": ThemeSetting,
      "tierPlans": [TierPlan],
      "timezone": "xyz789",
      "users": [User],
      "uuid": "abc123"
    }
  }
}
Queries

fileUploadPresignedUrl

Description

Get the presigned URL for a file upload

Response

Returns a FileUploadPresignedUrl!

Arguments
Name Description
contentType - String!
checksum - String!
fileSize - Int!
fileName - String!

Example

Query
query FileUploadPresignedUrl(
  $contentType: String!,
  $checksum: String!,
  $fileSize: Int!,
  $fileName: String!
) {
  fileUploadPresignedUrl(
    contentType: $contentType,
    checksum: $checksum,
    fileSize: $fileSize,
    fileName: $fileName
  ) {
    headers
    key
    method
    url
  }
}
Variables
{
  "contentType": "xyz789",
  "checksum": "abc123",
  "fileSize": 123,
  "fileName": "abc123"
}
Response
{
  "data": {
    "fileUploadPresignedUrl": {
      "headers": {},
      "key": "abc123",
      "method": "xyz789",
      "url": "xyz789"
    }
  }
}
Queries

invoice

Description

Invoice

Response

Returns an Invoice!

Arguments
Name Description
slug - String

Example

Query
query Invoice($slug: String) {
  invoice(slug: $slug) {
    amount {
      currencyCode
      value
    }
    createdAt
    description
    dueOn
    externalNote
    id
    internalNote
    invoiceItems {
      id
      revenueItem {
        ...RevenueItemFragment
      }
    }
    invoiceOn
    invoiceSequenceNumber
    lead {
      amount {
        ...MoneyFragment
      }
      createdAt
      expectedCloseDate
      expiresAt
      id
      revenueItems {
        ...RevenueItemFragment
      }
      shortCodeVisit {
        ...ShortCodeVisitFragment
      }
      slug
      status
    }
    leadReward {
      amountFixed {
        ...MoneyFragment
      }
      amountPercentage
      amountType
      currency
      externalDescription
      externalTitle
      id
      internalDescription
      maxPayoutAmount {
        ...MoneyFragment
      }
      name
      partner {
        ...PartnerFragment
      }
      partnerUser {
        ...PartnerUserFragment
      }
      percentageRateType
      periodMonths
      periods {
        ...SegmentRewardPeriodFragment
      }
      requiredCrmProducts {
        ...ValueLabelFragment
      }
      requiredProductsCrmType
      revenueConditions {
        ...SegmentRewardRevenueConditionFragment
      }
      revenueSource {
        ...RevenueSourceFragment
      }
      rewardType
      visibleToPartners
    }
    overrideAmount
    paidAt
    partner {
      createdAt
      id
      logo {
        ...AttachmentFragment
      }
      name
      slug
      websiteUrl
    }
    partnerUser {
      appleWalletPassUrl
      directReferralUrl
      externalIds {
        ...ExternalIdFragment
      }
      featureAnnouncementsSeen
      googleWalletPassUrl
      id
      partner {
        ...PartnerFragment
      }
      paymentsPending {
        ...PaymentFragment
      }
      referralQrCodeUrl
      referralUrl
      role
      title
      user {
        ...UserFragment
      }
    }
    payment {
      amount {
        ...MoneyFragment
      }
      createdAt
      id
      partner {
        ...PartnerFragment
      }
      partnerUser {
        ...PartnerUserFragment
      }
      slug
      status
      updatedAt
    }
    paymentFrequency
    revenueEndsAt
    revenueStartsAt
    rewardType
    slug
    status
    totalInvoicesInSequence
  }
}
Variables
{"slug": "xyz789"}
Response
{
  "data": {
    "invoice": {
      "amount": Money,
      "createdAt": ISO8601DateTime,
      "description": "xyz789",
      "dueOn": ISO8601Date,
      "externalNote": "xyz789",
      "id": 4,
      "internalNote": "abc123",
      "invoiceItems": [InvoiceItem],
      "invoiceOn": ISO8601Date,
      "invoiceSequenceNumber": 123,
      "lead": Lead,
      "leadReward": LeadReward,
      "overrideAmount": true,
      "paidAt": ISO8601DateTime,
      "partner": Partner,
      "partnerUser": PartnerUser,
      "payment": Payment,
      "paymentFrequency": "monthly",
      "revenueEndsAt": ISO8601DateTime,
      "revenueStartsAt": ISO8601DateTime,
      "rewardType": "QUALIFIED_LEAD_FIXED",
      "slug": "xyz789",
      "status": "draft",
      "totalInvoicesInSequence": 123
    }
  }
}
Queries

invoices

Description

Payout Invoices

Response

Returns an InvoiceConnection!

Arguments
Name Description
sort - String Sort column and sort direction separated by __. Example: id__asc. Default = "id__asc"
export - Boolean Export the Orders to a CSV file & email the current user
filters - InvoiceFilterInput Filters for the query
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query Invoices(
  $sort: String,
  $export: Boolean,
  $filters: InvoiceFilterInput,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  invoices(
    sort: $sort,
    export: $export,
    filters: $filters,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      cursor
      node {
        ...InvoiceFragment
      }
    }
    nodes {
      amount {
        ...MoneyFragment
      }
      createdAt
      description
      dueOn
      externalNote
      id
      internalNote
      invoiceItems {
        ...InvoiceItemFragment
      }
      invoiceOn
      invoiceSequenceNumber
      lead {
        ...LeadFragment
      }
      leadReward {
        ...LeadRewardFragment
      }
      overrideAmount
      paidAt
      partner {
        ...PartnerFragment
      }
      partnerUser {
        ...PartnerUserFragment
      }
      payment {
        ...PaymentFragment
      }
      paymentFrequency
      revenueEndsAt
      revenueStartsAt
      rewardType
      slug
      status
      totalInvoicesInSequence
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}
Variables
{
  "sort": "id__asc",
  "export": true,
  "filters": InvoiceFilterInput,
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "invoices": {
      "edges": [InvoiceEdge],
      "nodes": [Invoice],
      "pageInfo": PageInfo
    }
  }
}
Queries

lead

Description

Lead

Response

Returns a Lead!

Arguments
Name Description
id - ID
slug - String

Example

Query
query Lead(
  $id: ID,
  $slug: String
) {
  lead(
    id: $id,
    slug: $slug
  ) {
    amount {
      currencyCode
      value
    }
    createdAt
    expectedCloseDate
    expiresAt
    id
    revenueItems {
      amount {
        ...MoneyFragment
      }
      createdAt
      deletedAt
      description
      externalIdentifier
      externalSubIdentifier
      id
      recordedAt
      totalAmount {
        ...MoneyFragment
      }
      updatedAt
    }
    shortCodeVisit {
      createdAt
      ipAddress
      partnerUser {
        ...PartnerUserFragment
      }
      userAgent
      utmParams {
        ...UtmParamsFragment
      }
      uuid
    }
    slug
    status
  }
}
Variables
{"id": 4, "slug": "abc123"}
Response
{
  "data": {
    "lead": {
      "amount": Money,
      "createdAt": ISO8601DateTime,
      "expectedCloseDate": ISO8601Date,
      "expiresAt": ISO8601DateTime,
      "id": "4",
      "revenueItems": [RevenueItem],
      "shortCodeVisit": ShortCodeVisit,
      "slug": "xyz789",
      "status": "open"
    }
  }
}
Queries

leads

Description

Leads

Response

Returns a LeadConnection!

Arguments
Name Description
sort - String Sort column and sort direction separated by __. Example: id__asc. Default = "id__asc"
export - Boolean Export the Orders to a CSV file & email the current user
filters - LeadFilterInput Filters for the query
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query Leads(
  $sort: String,
  $export: Boolean,
  $filters: LeadFilterInput,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  leads(
    sort: $sort,
    export: $export,
    filters: $filters,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      cursor
      node {
        ...LeadFragment
      }
    }
    nodes {
      amount {
        ...MoneyFragment
      }
      createdAt
      expectedCloseDate
      expiresAt
      id
      revenueItems {
        ...RevenueItemFragment
      }
      shortCodeVisit {
        ...ShortCodeVisitFragment
      }
      slug
      status
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}
Variables
{
  "sort": "id__asc",
  "export": true,
  "filters": LeadFilterInput,
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "leads": {
      "edges": [LeadEdge],
      "nodes": [Lead],
      "pageInfo": PageInfo
    }
  }
}
Queries

mediaGalleries

Description

Show All Media Galleries for an account

Response

Returns [MediaGallery!]!

Arguments
Name Description
galleryType - MediaGalleryGalleryType!

Example

Query
query MediaGalleries($galleryType: MediaGalleryGalleryType!) {
  mediaGalleries(galleryType: $galleryType) {
    createdAt
    deletedAt
    galleryType
    id
    internalDescription
    items {
      attachment {
        ...AttachmentFragment
      }
      createdAt
      ctaText
      ctaUrl
      deletedAt
      description
      endTime
      eventType
      id
      itemType
      location
      locationDetails
      position
      startTime
      status
      title
      updatedAt
      visits {
        ...MediaGalleryItemVisitFragment
      }
      visitsCount
    }
    name
    partnerTypes {
      id
      name
      slug
    }
    pastEventsThresholdDays
    sorting
    updatedAt
  }
}
Variables
{"galleryType": "partner"}
Response
{
  "data": {
    "mediaGalleries": [
      {
        "createdAt": ISO8601DateTime,
        "deletedAt": ISO8601DateTime,
        "galleryType": "partner",
        "id": 4,
        "internalDescription": "xyz789",
        "items": [MediaGalleryItem],
        "name": "xyz789",
        "partnerTypes": [PartnerType],
        "pastEventsThresholdDays": 123,
        "sorting": "abc123",
        "updatedAt": ISO8601DateTime
      }
    ]
  }
}
Queries

mediaGallery

Description

Get Media Gallery By ID

Response

Returns a MediaGallery

Arguments
Name Description
id - ID!

Example

Query
query MediaGallery($id: ID!) {
  mediaGallery(id: $id) {
    createdAt
    deletedAt
    galleryType
    id
    internalDescription
    items {
      attachment {
        ...AttachmentFragment
      }
      createdAt
      ctaText
      ctaUrl
      deletedAt
      description
      endTime
      eventType
      id
      itemType
      location
      locationDetails
      position
      startTime
      status
      title
      updatedAt
      visits {
        ...MediaGalleryItemVisitFragment
      }
      visitsCount
    }
    name
    partnerTypes {
      id
      name
      slug
    }
    pastEventsThresholdDays
    sorting
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "mediaGallery": {
      "createdAt": ISO8601DateTime,
      "deletedAt": ISO8601DateTime,
      "galleryType": "partner",
      "id": 4,
      "internalDescription": "xyz789",
      "items": [MediaGalleryItem],
      "name": "xyz789",
      "partnerTypes": [PartnerType],
      "pastEventsThresholdDays": 987,
      "sorting": "abc123",
      "updatedAt": ISO8601DateTime
    }
  }
}
Queries

node

Description

Fetches an object given its ID.

Response

Returns a Node

Arguments
Name Description
id - ID! ID of the object.

Example

Query
query Node($id: ID!) {
  node(id: $id) {
    id
  }
}
Variables
{"id": "4"}
Response
{"data": {"node": {"id": "4"}}}
Queries

nodes

Description

Fetches a list of objects given a list of IDs.

Response

Returns [Node]!

Arguments
Name Description
ids - [ID!]! IDs of the objects.

Example

Query
query Nodes($ids: [ID!]!) {
  nodes(ids: $ids) {
    id
  }
}
Variables
{"ids": ["4"]}
Response
{"data": {"nodes": [{"id": 4}]}}
Queries

partner

Description

Partner

Response

Returns a Partner!

Arguments
Name Description
id - ID
slug - String

Example

Query
query Partner(
  $id: ID,
  $slug: String
) {
  partner(
    id: $id,
    slug: $slug
  ) {
    createdAt
    id
    logo {
      attachmentType
      contentType
      filename
      id
      largeUrl
      mediumUrl
      thumbnailUrl
      url
    }
    name
    slug
    websiteUrl
  }
}
Variables
{"id": 4, "slug": "abc123"}
Response
{
  "data": {
    "partner": {
      "createdAt": ISO8601DateTime,
      "id": "4",
      "logo": Attachment,
      "name": "xyz789",
      "slug": "xyz789",
      "websiteUrl": "abc123"
    }
  }
}
Queries

partnerApplication

Description

Get Partner Application By ID

Response

Returns a HostedFormSubmission

Arguments
Name Description
slug - String!

Example

Query
query PartnerApplication($slug: String!) {
  partnerApplication(slug: $slug) {
    acceptsMarketing
    approval {
      approver {
        ...UserFragment
      }
      comment
      createdAt
      decision
      id
      rejectionReason
    }
    companyName
    createdAt
    createdPartner {
      createdAt
      id
      logo {
        ...AttachmentFragment
      }
      name
      slug
      websiteUrl
    }
    email
    fields {
      id
      question
      response
      responseJson
      responseType
    }
    fullName
    id
    ipAddress
    marketingConsent
    partnerType {
      id
      name
      slug
    }
    phoneNumber
    slug
    status
    termsAndConditions
    updatedAt
    userAgent
    utmParams {
      utmCampaign
      utmContent
      utmMedium
      utmSource
      utmTerm
    }
    website
  }
}
Variables
{"slug": "xyz789"}
Response
{
  "data": {
    "partnerApplication": {
      "acceptsMarketing": true,
      "approval": Approval,
      "companyName": "abc123",
      "createdAt": ISO8601DateTime,
      "createdPartner": Partner,
      "email": "abc123",
      "fields": [HostedFormSubmissionField],
      "fullName": "abc123",
      "id": "4",
      "ipAddress": "abc123",
      "marketingConsent": "xyz789",
      "partnerType": PartnerType,
      "phoneNumber": "xyz789",
      "slug": "abc123",
      "status": "pending",
      "termsAndConditions": "xyz789",
      "updatedAt": ISO8601DateTime,
      "userAgent": "abc123",
      "utmParams": UtmParams,
      "website": "abc123"
    }
  }
}
Queries

partnerApplications

Description

List hosted form submissions for the account

Response

Returns a HostedFormSubmissionConnection!

Arguments
Name Description
status - [ApprovalDecision!]
partnerTypeId - ID
sort - String Sort column and sort direction separated by __. Example: id__asc. Default = "id__asc"
export - Boolean Export a CSV file & email the current user
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query PartnerApplications(
  $status: [ApprovalDecision!],
  $partnerTypeId: ID,
  $sort: String,
  $export: Boolean,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  partnerApplications(
    status: $status,
    partnerTypeId: $partnerTypeId,
    sort: $sort,
    export: $export,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      cursor
      node {
        ...HostedFormSubmissionFragment
      }
    }
    nodes {
      acceptsMarketing
      approval {
        ...ApprovalFragment
      }
      companyName
      createdAt
      createdPartner {
        ...PartnerFragment
      }
      email
      fields {
        ...HostedFormSubmissionFieldFragment
      }
      fullName
      id
      ipAddress
      marketingConsent
      partnerType {
        ...PartnerTypeFragment
      }
      phoneNumber
      slug
      status
      termsAndConditions
      updatedAt
      userAgent
      utmParams {
        ...UtmParamsFragment
      }
      website
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}
Variables
{
  "status": ["pending"],
  "partnerTypeId": 4,
  "sort": "id__asc",
  "export": false,
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "partnerApplications": {
      "edges": [HostedFormSubmissionEdge],
      "nodes": [HostedFormSubmission],
      "pageInfo": PageInfo
    }
  }
}
Queries

partnerType

Description

Get Partner Type

Response

Returns a PartnerType!

Arguments
Name Description
slug - String!

Example

Query
query PartnerType($slug: String!) {
  partnerType(slug: $slug) {
    id
    name
    slug
  }
}
Variables
{"slug": "xyz789"}
Response
{
  "data": {
    "partnerType": {
      "id": "4",
      "name": "abc123",
      "slug": "xyz789"
    }
  }
}
Queries

partnerTypeHostedForm

Description

Get Partner Type Hosted Form

Response

Returns a HostedForm

Arguments
Name Description
formType - HostedFormForm!
slug - String
partnerTypeSlug - String

Example

Query
query PartnerTypeHostedForm(
  $formType: HostedFormForm!,
  $slug: String,
  $partnerTypeSlug: String
) {
  partnerTypeHostedForm(
    formType: $formType,
    slug: $slug,
    partnerTypeSlug: $partnerTypeSlug
  ) {
    companyNameRequirement
    countryCodeDefault
    createdAt
    css
    description
    formQuestions {
      createdAt
      formQuestionTemplate {
        ...FormQuestionTemplateFragment
      }
      hostedForm {
        ...HostedFormFragment
      }
      id
      position
      required
      updatedAt
    }
    formType
    id
    marketingConsentText
    phoneNumberRequirement
    postSubmissionRedirectUrl
    previewUrl
    slug
    submitButtonText
    successMessage
    termsAndConditionsText
    title
    updatedAt
    websiteRequirement
  }
}
Variables
{
  "formType": "partner_type_application",
  "slug": "xyz789",
  "partnerTypeSlug": "abc123"
}
Response
{
  "data": {
    "partnerTypeHostedForm": {
      "companyNameRequirement": "not_shown",
      "countryCodeDefault": "abc123",
      "createdAt": ISO8601DateTime,
      "css": "abc123",
      "description": "xyz789",
      "formQuestions": [FormQuestion],
      "formType": "partner_type_application",
      "id": 4,
      "marketingConsentText": "xyz789",
      "phoneNumberRequirement": "not_shown",
      "postSubmissionRedirectUrl": "xyz789",
      "previewUrl": "xyz789",
      "slug": "abc123",
      "submitButtonText": "xyz789",
      "successMessage": "xyz789",
      "termsAndConditionsText": "xyz789",
      "title": "xyz789",
      "updatedAt": ISO8601DateTime,
      "websiteRequirement": "not_shown"
    }
  }
}
Queries

partnerTypes

Description

Get Partner Types

Response

Returns [PartnerType!]

Example

Query
query PartnerTypes {
  partnerTypes {
    id
    name
    slug
  }
}
Response
{
  "data": {
    "partnerTypes": [
      {
        "id": "4",
        "name": "abc123",
        "slug": "xyz789"
      }
    ]
  }
}
Queries

partnerUsers

Description

Get Partner Users

Response

Returns [PartnerUser!]

Arguments
Name Description
partnerId - ID

Example

Query
query PartnerUsers($partnerId: ID) {
  partnerUsers(partnerId: $partnerId) {
    appleWalletPassUrl
    directReferralUrl
    externalIds {
      identifier
      objectType
      systemType
    }
    featureAnnouncementsSeen
    googleWalletPassUrl
    id
    partner {
      createdAt
      id
      logo {
        ...AttachmentFragment
      }
      name
      slug
      websiteUrl
    }
    paymentsPending {
      amount {
        ...MoneyFragment
      }
      createdAt
      id
      partner {
        ...PartnerFragment
      }
      partnerUser {
        ...PartnerUserFragment
      }
      slug
      status
      updatedAt
    }
    referralQrCodeUrl
    referralUrl
    role
    title
    user {
      accountAccess {
        ...AccountUserFragment
      }
      activated
      connectors {
        ...ConnectorFragment
      }
      createdAt
      deleted
      email
      firstName
      fullName
      id
      isRefilliateUser
      lastName
      name
      phone
      profileImageUrl
    }
  }
}
Variables
{"partnerId": 4}
Response
{
  "data": {
    "partnerUsers": [
      {
        "appleWalletPassUrl": "xyz789",
        "directReferralUrl": "xyz789",
        "externalIds": [ExternalId],
        "featureAnnouncementsSeen": [
          "xyz789"
        ],
        "googleWalletPassUrl": "abc123",
        "id": 4,
        "partner": Partner,
        "paymentsPending": [Payment],
        "referralQrCodeUrl": "abc123",
        "referralUrl": "abc123",
        "role": "partner_admin",
        "title": "abc123",
        "user": User
      }
    ]
  }
}
Queries

partners

Description

Partners

Response

Returns a PartnerConnection!

Arguments
Name Description
sort - String Sort column and sort direction separated by __. Example: id__asc. Default = "id__asc"
export - Boolean Export the Orders to a CSV file & email the current user
filters - PartnerFilterInput Filters for the query
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query Partners(
  $sort: String,
  $export: Boolean,
  $filters: PartnerFilterInput,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  partners(
    sort: $sort,
    export: $export,
    filters: $filters,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      cursor
      node {
        ...PartnerFragment
      }
    }
    nodes {
      createdAt
      id
      logo {
        ...AttachmentFragment
      }
      name
      slug
      websiteUrl
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}
Variables
{
  "sort": "id__asc",
  "export": true,
  "filters": PartnerFilterInput,
  "after": "abc123",
  "before": "xyz789",
  "first": 987,
  "last": 123
}
Response
{
  "data": {
    "partners": {
      "edges": [PartnerEdge],
      "nodes": [Partner],
      "pageInfo": PageInfo
    }
  }
}
Queries

payment

Description

Payment

Response

Returns a Payment!

Arguments
Name Description
slug - String

Example

Query
query Payment($slug: String) {
  payment(slug: $slug) {
    amount {
      currencyCode
      value
    }
    createdAt
    id
    partner {
      createdAt
      id
      logo {
        ...AttachmentFragment
      }
      name
      slug
      websiteUrl
    }
    partnerUser {
      appleWalletPassUrl
      directReferralUrl
      externalIds {
        ...ExternalIdFragment
      }
      featureAnnouncementsSeen
      googleWalletPassUrl
      id
      partner {
        ...PartnerFragment
      }
      paymentsPending {
        ...PaymentFragment
      }
      referralQrCodeUrl
      referralUrl
      role
      title
      user {
        ...UserFragment
      }
    }
    slug
    status
    updatedAt
  }
}
Variables
{"slug": "abc123"}
Response
{
  "data": {
    "payment": {
      "amount": Money,
      "createdAt": ISO8601DateTime,
      "id": "4",
      "partner": Partner,
      "partnerUser": PartnerUser,
      "slug": "xyz789",
      "status": "draft",
      "updatedAt": ISO8601DateTime
    }
  }
}
Queries

payments

Description

Payments

Response

Returns a PaymentConnection!

Arguments
Name Description
sort - String Sort column and sort direction separated by __. Example: id__asc. Default = "id__asc"
export - Boolean Export the Orders to a CSV file & email the current user
filters - PaymentFilterInput Filters for the query
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query Payments(
  $sort: String,
  $export: Boolean,
  $filters: PaymentFilterInput,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  payments(
    sort: $sort,
    export: $export,
    filters: $filters,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      cursor
      node {
        ...PaymentFragment
      }
    }
    nodes {
      amount {
        ...MoneyFragment
      }
      createdAt
      id
      partner {
        ...PartnerFragment
      }
      partnerUser {
        ...PartnerUserFragment
      }
      slug
      status
      updatedAt
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}
Variables
{
  "sort": "id__asc",
  "export": true,
  "filters": PaymentFilterInput,
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "payments": {
      "edges": [PaymentEdge],
      "nodes": [Payment],
      "pageInfo": PageInfo
    }
  }
}
Queries

referrerPayments

Description

Referrer Payments to be shown through the embedded widget

Response

Returns [Payment!]!

Example

Query
query ReferrerPayments {
  referrerPayments {
    amount {
      currencyCode
      value
    }
    createdAt
    id
    partner {
      createdAt
      id
      logo {
        ...AttachmentFragment
      }
      name
      slug
      websiteUrl
    }
    partnerUser {
      appleWalletPassUrl
      directReferralUrl
      externalIds {
        ...ExternalIdFragment
      }
      featureAnnouncementsSeen
      googleWalletPassUrl
      id
      partner {
        ...PartnerFragment
      }
      paymentsPending {
        ...PaymentFragment
      }
      referralQrCodeUrl
      referralUrl
      role
      title
      user {
        ...UserFragment
      }
    }
    slug
    status
    updatedAt
  }
}
Response
{
  "data": {
    "referrerPayments": [
      {
        "amount": Money,
        "createdAt": ISO8601DateTime,
        "id": 4,
        "partner": Partner,
        "partnerUser": PartnerUser,
        "slug": "xyz789",
        "status": "draft",
        "updatedAt": ISO8601DateTime
      }
    ]
  }
}

Mutations

leadGenerationFormSubmissionCreate

Response

Returns a LeadGenerationFormSubmissionCreatePayload

Arguments
Name Description
visitId - String
shortCode - String!
input - HostedFormSubmissionCreateInput!

Example

Query
mutation LeadGenerationFormSubmissionCreate(
  $visitId: String,
  $shortCode: String!,
  $input: HostedFormSubmissionCreateInput!
) {
  leadGenerationFormSubmissionCreate(
    visitId: $visitId,
    shortCode: $shortCode,
    input: $input
  ) {
    errors {
      field
      message
    }
    referenceNumber
  }
}
Variables
{
  "visitId": "xyz789",
  "shortCode": "abc123",
  "input": HostedFormSubmissionCreateInput
}
Response
{
  "data": {
    "leadGenerationFormSubmissionCreate": {
      "errors": [UserError],
      "referenceNumber": "abc123"
    }
  }
}
Mutations

leadUpdate

Description

Update a lead for a partner through partner portal or app portal

Response

Returns a LeadUpdatePayload

Arguments
Name Description
leadIdentifier - LeadRetrievalInput!
input - LeadUpsertInput

Example

Query
mutation LeadUpdate(
  $leadIdentifier: LeadRetrievalInput!,
  $input: LeadUpsertInput
) {
  leadUpdate(
    leadIdentifier: $leadIdentifier,
    input: $input
  ) {
    errors {
      field
      message
    }
    lead {
      amount {
        ...MoneyFragment
      }
      createdAt
      expectedCloseDate
      expiresAt
      id
      revenueItems {
        ...RevenueItemFragment
      }
      shortCodeVisit {
        ...ShortCodeVisitFragment
      }
      slug
      status
    }
  }
}
Variables
{
  "leadIdentifier": LeadRetrievalInput,
  "input": LeadUpsertInput
}
Response
{
  "data": {
    "leadUpdate": {
      "errors": [UserError],
      "lead": Lead
    }
  }
}
Mutations

partnerApplicationFormSubmissionCreate

Response

Returns a PartnerApplicationFormSubmissionCreatePayload

Arguments
Name Description
partnerTypeSlug - String!
input - HostedFormSubmissionCreateInput!

Example

Query
mutation PartnerApplicationFormSubmissionCreate(
  $partnerTypeSlug: String!,
  $input: HostedFormSubmissionCreateInput!
) {
  partnerApplicationFormSubmissionCreate(
    partnerTypeSlug: $partnerTypeSlug,
    input: $input
  ) {
    errors {
      field
      message
    }
    referenceNumber
  }
}
Variables
{
  "partnerTypeSlug": "abc123",
  "input": HostedFormSubmissionCreateInput
}
Response
{
  "data": {
    "partnerApplicationFormSubmissionCreate": {
      "errors": [UserError],
      "referenceNumber": "xyz789"
    }
  }
}
Mutations

revenueItemCreate

Response

Returns a RevenueItemCreatePayload

Arguments
Name Description
input - RevenueItemCreateInput!

Example

Query
mutation RevenueItemCreate($input: RevenueItemCreateInput!) {
  revenueItemCreate(input: $input) {
    errors {
      field
      message
    }
    revenueItem {
      amount {
        ...MoneyFragment
      }
      createdAt
      deletedAt
      description
      externalIdentifier
      externalSubIdentifier
      id
      recordedAt
      totalAmount {
        ...MoneyFragment
      }
      updatedAt
    }
  }
}
Variables
{"input": RevenueItemCreateInput}
Response
{
  "data": {
    "revenueItemCreate": {
      "errors": [UserError],
      "revenueItem": RevenueItem
    }
  }
}
Mutations

revenueItemUpdate

Response

Returns a RevenueItemUpdatePayload

Arguments
Name Description
input - RevenueItemUpdateInput!

Example

Query
mutation RevenueItemUpdate($input: RevenueItemUpdateInput!) {
  revenueItemUpdate(input: $input) {
    errors {
      field
      message
    }
    revenueItem {
      amount {
        ...MoneyFragment
      }
      createdAt
      deletedAt
      description
      externalIdentifier
      externalSubIdentifier
      id
      recordedAt
      totalAmount {
        ...MoneyFragment
      }
      updatedAt
    }
  }
}
Variables
{"input": RevenueItemUpdateInput}
Response
{
  "data": {
    "revenueItemUpdate": {
      "errors": [UserError],
      "revenueItem": RevenueItem
    }
  }
}

Types

Account

Fields
Field Name Description
currency - Currency!
customPartnerPortalDomain - String
customPartnerPortalDomainVerified - Boolean
customReferralDomain - String
customReferralDomainVerified - Boolean
defaultLeadGenerationForm - HostedForm
domain - String!
features - [AccountFeature!]
identifier - String!
leadSettings - LeadSettings
name - String!
onboardingStatus - OnboardingStatus!
partnerEmailSettings - PartnerEmailSetting
partnerPortalSettings - PartnerPortalSetting
partnerPortalUrl - String
partnerTypes - [PartnerType!]
paymentFeePlan - PaymentFeePlan
payoutMethods - [PayoutMethod!]
segments - [Segment!]
status - AccountStatus
testMode - Boolean!
themeSettings - ThemeSetting
tierPlans - [TierPlan!]
timezone - String
users - [User!]
uuid - String
Example
{
  "currency": "USD",
  "customPartnerPortalDomain": "abc123",
  "customPartnerPortalDomainVerified": false,
  "customReferralDomain": "xyz789",
  "customReferralDomainVerified": false,
  "defaultLeadGenerationForm": HostedForm,
  "domain": "xyz789",
  "features": ["rewards_upsell_crosssell"],
  "identifier": "xyz789",
  "leadSettings": LeadSettings,
  "name": "xyz789",
  "onboardingStatus": OnboardingStatus,
  "partnerEmailSettings": PartnerEmailSetting,
  "partnerPortalSettings": PartnerPortalSetting,
  "partnerPortalUrl": "abc123",
  "partnerTypes": [PartnerType],
  "paymentFeePlan": PaymentFeePlan,
  "payoutMethods": [PayoutMethod],
  "segments": [Segment],
  "status": "created",
  "testMode": true,
  "themeSettings": ThemeSetting,
  "tierPlans": [TierPlan],
  "timezone": "abc123",
  "users": [User],
  "uuid": "xyz789"
}
Types

AccountFeature

Values
Enum Value Description

rewards_upsell_crosssell

 Rewards Upsell Crosssell

rewards_advanced

 Rewards Advanced

api_webhooks

 Api Webhooks

event_calendar

 Event Calendar

partner_tiers

 Partner Tiers
Example
"rewards_upsell_crosssell"
Types

AccountStatus

Description

Account Status

Values
Enum Value Description

created

 Created

trialing

 Trialing

active

 Active

canceled

 Canceled

suspended

 Suspended
Example
"created"
Types

AccountUser

Fields
Field Name Description
account - Account
communicationTopics - [CommunicationTopic!]!
featureAnnouncementsSeen - [String!]!
role - UserRole
title - String
user - User
Example
{
  "account": Account,
  "communicationTopics": ["ACCOUNT_USER_ACCOUNT_FUNDING_NOTIFICATIONS"],
  "featureAnnouncementsSeen": ["abc123"],
  "role": UserRole,
  "title": "abc123",
  "user": User
}
Types

AmountFilterInput

Fields
Input Field Description
operator - QueryOperator
value - Float
Example
{"operator": "eq", "value": 987.65}
Types

AmountType

Description

Amount type

Values
Enum Value Description

percentage

 Percentage

fixed_amount

 Fixed Amount
Example
"percentage"
Types

Approval

Fields
Field Name Description
approver - User
comment - String
createdAt - ISO8601DateTime!
decision - ApprovalDecision!
id - ID!
rejectionReason - String
Example
{
  "approver": User,
  "comment": "abc123",
  "createdAt": ISO8601DateTime,
  "decision": "pending",
  "id": "4",
  "rejectionReason": "xyz789"
}
Types

ApprovalDecision

Description

Approval Decision Type Enum

Values
Enum Value Description

pending

 Approval is pending

accepted

 Approval is accepted

rejected

 Approval is rejected
Example
"pending"
Types

Attachment

Description

Uploaded File

Fields
Field Name Description
attachmentType - String
contentType - String content type
filename - String Name of the uploaded file
id - ID
largeUrl - String
mediumUrl - String
thumbnailUrl - String
url - String Download URL
Example
{
  "attachmentType": "abc123",
  "contentType": "xyz789",
  "filename": "xyz789",
  "id": "4",
  "largeUrl": "abc123",
  "mediumUrl": "xyz789",
  "thumbnailUrl": "xyz789",
  "url": "xyz789"
}
Types

Boolean

Description

Represents true or false values.

Example
true
Types

CommunicationTopic

Description

Communication Topic

Values
Enum Value Description

ACCOUNT_USER_ACCOUNT_FUNDING_NOTIFICATIONS

 Account User Account Funding Notifications

ACCOUNT_USER_PARTNER_APPLICATION_NOTIFICATIONS_ALL

 Account User Partner Application Notifications All

ACCOUNT_USER_PARTNER_APPLICATION_NOTIFICATIONS_MY

 Account User Partner Application Notifications My

ACCOUNT_USER_PARTNER_INVOICE_NOTIFICATIONS_ALL

 Account User Partner Invoice Notifications All

ACCOUNT_USER_PARTNER_INVOICE_NOTIFICATIONS_MY

 Account User Partner Invoice Notifications My

ACCOUNT_USER_PAYMENT_FINALIZED_NOTIFICATIONS

 Account User Payment Finalized Notifications

ACCOUNT_USER_PAYMENT_APPROVED_NOTIFICATIONS

 Account User Payment Approved Notifications

ACCOUNT_USER_PAYMENT_PROCESSED_NOTIFICATIONS

 Account User Payment Processed Notifications

ACCOUNT_USER_PARTNER_PAYMENT_NOTIFICATIONS_MY

 Account User Partner Payment Notifications My

ACCOUNT_USER_LEAD_RECEIVED_NOTIFICATIONS_ALL

 Account User Lead Received Notifications All

ACCOUNT_USER_LEAD_RECEIVED_NOTIFICATIONS_MY

 Account User Lead Received Notifications My

ACCOUNT_USER_LEAD_QUALIFIED_NOTIFICATIONS_ALL

 Account User Lead Qualified Notifications All

ACCOUNT_USER_LEAD_QUALIFIED_NOTIFICATIONS_MY

 Account User Lead Qualified Notifications My

ACCOUNT_USER_LEAD_CLOSED_NOTIFICATIONS_ALL

 Account User Lead Closed Notifications All

ACCOUNT_USER_LEAD_CLOSED_NOTIFICATIONS_MY

 Account User Lead Closed Notifications My

ACCOUNT_USER_LEAD_EXPIRED_NOTIFICATIONS_ALL

 Account User Lead Expired Notifications All

ACCOUNT_USER_LEAD_EXPIRED_NOTIFICATIONS_MY

 Account User Lead Expired Notifications My

ACCOUNT_USER_MISSING_REVENUE_SOURCE_LINK_NOTIFICATIONS_ALL

 Account User Missing Revenue Source Link Notifications All

ACCOUNT_USER_MISSING_REVENUE_SOURCE_LINK_NOTIFICATIONS_MY

 Account User Missing Revenue Source Link Notifications My

PARTNER_PAYOUT_NOTIFICATIONS

 Partner Payout Notifications

PARTNER_LEAD_NOTIFICATIONS_ALL

 Partner Lead Notifications All

ACCOUNT_USER_PARTNER_NOTE_NOTIFICATIONS_ALL

 Account User Partner Note Notifications All

ACCOUNT_USER_PARTNER_NOTE_NOTIFICATIONS_MY

 Account User Partner Note Notifications My

ACCOUNT_USER_LEAD_NOTE_NOTIFICATIONS_ALL

 Account User Lead Note Notifications All

ACCOUNT_USER_LEAD_NOTE_NOTIFICATIONS_MY

 Account User Lead Note Notifications My

ACCOUNT_USER_WEEKLY_UPDATE_NOTIFICATIONS

 Account User Weekly Update Notifications
Example
"ACCOUNT_USER_ACCOUNT_FUNDING_NOTIFICATIONS"
Types

Connector

Fields
Field Name Description
active - Boolean!
connectorType - ConnectorType!
createdAt - ISO8601DateTime
createdBy - String
credentials - JSON!
details - JSON
id - ID!
settings - ConnectorSettings
updatedAt - ISO8601DateTime
Example
{
  "active": false,
  "connectorType": "HUBSPOT",
  "createdAt": ISO8601DateTime,
  "createdBy": "xyz789",
  "credentials": {},
  "details": {},
  "id": 4,
  "settings": ConnectorSettings,
  "updatedAt": ISO8601DateTime
}
Types

ConnectorSettings

Fields
Field Name Description
crmDealStatusAcceptedValue - String
crmDealStatusChurnedValues - [String!]
crmDealStatusClosedLostValues - [String!]
crmDealStatusClosedWonValues - [String!]
crmDealStatusExpiredValue - String
crmDealStatusOpenValue - String
crmDealStatusQualifiedValues - [String!]
leadAcceptedAction - LeadCrmAction
leadOpenAction - LeadCrmAction
salesforcePartnerAccountRoleValue - ValueLabel
salesforcePartnerUserContactRoleValue - ValueLabel
syncActive - Boolean
syncDealsFromCrmToLasso - Boolean
syncLeadAssociationsToCrm - Boolean
syncLeadHsLead - Boolean
syncPartnerHsCompany - Boolean
topics - [CommunicationTopic!]
Example
{
  "crmDealStatusAcceptedValue": "abc123",
  "crmDealStatusChurnedValues": ["abc123"],
  "crmDealStatusClosedLostValues": [
    "abc123"
  ],
  "crmDealStatusClosedWonValues": [
    "abc123"
  ],
  "crmDealStatusExpiredValue": "xyz789",
  "crmDealStatusOpenValue": "abc123",
  "crmDealStatusQualifiedValues": [
    "xyz789"
  ],
  "leadAcceptedAction": "hubspot_create_lead",
  "leadOpenAction": "hubspot_create_lead",
  "salesforcePartnerAccountRoleValue": ValueLabel,
  "salesforcePartnerUserContactRoleValue": ValueLabel,
  "syncActive": false,
  "syncDealsFromCrmToLasso": true,
  "syncLeadAssociationsToCrm": false,
  "syncLeadHsLead": false,
  "syncPartnerHsCompany": false,
  "topics": ["ACCOUNT_USER_ACCOUNT_FUNDING_NOTIFICATIONS"]
}
Types

ConnectorType

Description

Connector type

Values
Enum Value Description

HUBSPOT

 HUBSPOT

SALESFORCE

 SALESFORCE

SLACK

 SLACK

SLACK_USER

 SLACK_USER

STRIPE

 STRIPE

CHARGEBEE

 CHARGEBEE

SHOPIFY_PARTNER

 SHOPIFY_PARTNER

PARTNERSTACK_MIGRATION

 PARTNERSTACK_MIGRATION

PIPEDRIVE

 PIPEDRIVE
Example
"HUBSPOT"
Types

Currency

Description

Currency types supported by the system

Values
Enum Value Description

USD

GBP

EUR

INR

CAD
Example
"USD"
Types

CustomDomainDnsRecord

Fields
Field Name Description
errorMessage - String
hostname - String!
recordType - String!
value - String!
verified - Boolean!
Example
{
  "errorMessage": "abc123",
  "hostname": "xyz789",
  "recordType": "xyz789",
  "value": "abc123",
  "verified": true
}
Types

DataGroupingPeriod

Values
Enum Value Description

day

 Day

week

 Week

month

 Month

quarter

 Quarter

year

 Year
Example
"day"
Types

ExternalId

Fields
Field Name Description
identifier - String!
objectType - ExternalObject!
systemType - ExternalSystem!
Example
{
  "identifier": "xyz789",
  "objectType": "company",
  "systemType": "HUBSPOT"
}
Types

ExternalIdUpsertInput

Fields
Input Field Description
systemType - ExternalSystem!
objectType - String!
identifier - String
Example
{
  "systemType": "HUBSPOT",
  "objectType": "abc123",
  "identifier": "xyz789"
}
Types

ExternalObject

Description

External object types

Values
Enum Value Description

company

 company

contact

 contact

deal

 deal

lead

 lead

opportunity

 opportunity

account

 account

organization

 organization

person

 person

internal_account

 internal_account

deal_product

 deal_product

opportunity_product

 opportunity_product

salesforce_contact_role

 salesforce_contact_role

salesforce_partner_role

 salesforce_partner_role

salesforce_lasso_configuration

 salesforce_lasso_configuration

stripe_invoice

 stripe_invoice

stripe_invoice_net_amount

 stripe_invoice_net_amount

stripe_invoice_item_product

 stripe_invoice_item_product

stripe_customer

 stripe_customer

shopify_app_store_domain

 shopify_app_store_domain

shopify_app_subscription_and_usage_transactions

 shopify_app_subscription_and_usage_transactions

shopify_app_subscription_only_transactions

 shopify_app_subscription_only_transactions

shopify_app_usage_only_transactions

 shopify_app_usage_only_transactions

chargebee_customer

 chargebee_customer

chargebee_invoice_total

 chargebee_invoice_total
Example
"company"
Types

ExternalSystem

Description

External system types

Values
Enum Value Description

HUBSPOT

 HUBSPOT

SALESFORCE

 SALESFORCE

STRIPE

 STRIPE

SHOPIFY_APP

 SHOPIFY_APP

INTERNAL_ACCOUNT

 INTERNAL_ACCOUNT

PIPEDRIVE

 PIPEDRIVE

CHARGEBEE

 CHARGEBEE

LASSO

 LASSO
Example
"HUBSPOT"
Types

FeatureValueMetricValue

Fields
Field Name Description
booleanValue - Boolean
decimalValue - Float
integerValue - Int
metricDefinitionId - ID!
Example
{
  "booleanValue": true,
  "decimalValue": 123.45,
  "integerValue": 987,
  "metricDefinitionId": "4"
}
Types

FileUploadPresignedUrl

Fields
Field Name Description
headers - JSON!
key - String!
method - String!
url - String!
Example
{
  "headers": {},
  "key": "xyz789",
  "method": "xyz789",
  "url": "xyz789"
}
Types

Float

Description

Represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45
Types

FormQuestion

Fields
Field Name Description
createdAt - ISO8601DateTime!
formQuestionTemplate - FormQuestionTemplate!
hostedForm - HostedForm!
id - ID!
position - Int!
required - Boolean!
updatedAt - ISO8601DateTime!
Example
{
  "createdAt": ISO8601DateTime,
  "formQuestionTemplate": FormQuestionTemplate,
  "hostedForm": HostedForm,
  "id": "4",
  "position": 123,
  "required": true,
  "updatedAt": ISO8601DateTime
}
Types

FormQuestionTemplate

Fields
Field Name Description
createdAt - ISO8601DateTime!
deletedAt - ISO8601DateTime
description - String
formQuestions - [FormQuestion!]!
id - ID!
internalDescription - String
options - [ValueLabel!]
question - String!
responseProperties - FormQuestionTemplateResponseProperties
responseType - HostedFieldResponseType!
slug - String!
updatedAt - ISO8601DateTime!
Example
{
  "createdAt": ISO8601DateTime,
  "deletedAt": ISO8601DateTime,
  "description": "abc123",
  "formQuestions": [FormQuestion],
  "id": 4,
  "internalDescription": "abc123",
  "options": [ValueLabel],
  "question": "xyz789",
  "responseProperties": FormQuestionTemplateResponseProperties,
  "responseType": "single_line",
  "slug": "xyz789",
  "updatedAt": ISO8601DateTime
}
Types

FormQuestionTemplateResponseProperties

Fields
Field Name Description
defaultCountryIso2 - String
Example
{"defaultCountryIso2": "xyz789"}
Types

HostedFieldResponseType

Description

Question Type Enum

Values
Enum Value Description

single_line

 Single line

text

 Text

number

 Number

date

 Date

dropdown

 Dropdown

checkbox

 Checkbox

checkbox_group

 Checkbox group

radio

 Radio

url

 Url

address

 Address
Example
"single_line"
Types

HostedForm

Fields
Field Name Description
companyNameRequirement - HostedFormFieldRequirement!
countryCodeDefault - String
createdAt - ISO8601DateTime!
css - String
description - String
formQuestions - [FormQuestion!]!
formType - HostedFormForm!
id - ID!
marketingConsentText - String
phoneNumberRequirement - HostedFormFieldRequirement!
postSubmissionRedirectUrl - String
previewUrl - String
slug - String!
submitButtonText - String
successMessage - String
termsAndConditionsText - String
title - String
updatedAt - ISO8601DateTime!
websiteRequirement - HostedFormFieldRequirement!
Example
{
  "companyNameRequirement": "not_shown",
  "countryCodeDefault": "xyz789",
  "createdAt": ISO8601DateTime,
  "css": "xyz789",
  "description": "xyz789",
  "formQuestions": [FormQuestion],
  "formType": "partner_type_application",
  "id": "4",
  "marketingConsentText": "abc123",
  "phoneNumberRequirement": "not_shown",
  "postSubmissionRedirectUrl": "xyz789",
  "previewUrl": "xyz789",
  "slug": "xyz789",
  "submitButtonText": "abc123",
  "successMessage": "xyz789",
  "termsAndConditionsText": "xyz789",
  "title": "xyz789",
  "updatedAt": ISO8601DateTime,
  "websiteRequirement": "not_shown"
}
Types

HostedFormFieldRequirement

Description

Hosted form field requirement type

Values
Enum Value Description

not_shown

 Field is not shown

required

 Field is required

optional

 Field is optional
Example
"not_shown"
Types

HostedFormForm

Values
Enum Value Description

partner_type_application

 Partner type application

lead_generation

 Lead generation
Example
"partner_type_application"
Types

HostedFormSubmission

Fields
Field Name Description
acceptsMarketing - Boolean!
approval - Approval
companyName - String
createdAt - ISO8601DateTime!
createdPartner - Partner
email - String!
fields - [HostedFormSubmissionField!]!
fullName - String!
id - ID!
ipAddress - String
marketingConsent - String
partnerType - PartnerType
phoneNumber - String
slug - String!
status - ApprovalDecision
termsAndConditions - String
updatedAt - ISO8601DateTime!
userAgent - String
utmParams - UtmParams
website - String
Example
{
  "acceptsMarketing": true,
  "approval": Approval,
  "companyName": "abc123",
  "createdAt": ISO8601DateTime,
  "createdPartner": Partner,
  "email": "xyz789",
  "fields": [HostedFormSubmissionField],
  "fullName": "abc123",
  "id": 4,
  "ipAddress": "xyz789",
  "marketingConsent": "xyz789",
  "partnerType": PartnerType,
  "phoneNumber": "abc123",
  "slug": "xyz789",
  "status": "pending",
  "termsAndConditions": "abc123",
  "updatedAt": ISO8601DateTime,
  "userAgent": "xyz789",
  "utmParams": UtmParams,
  "website": "xyz789"
}
Types

HostedFormSubmissionConnection

Description

The connection type for HostedFormSubmission.

Fields
Field Name Description
edges - [HostedFormSubmissionEdge] A list of edges.
nodes - [HostedFormSubmission] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [HostedFormSubmissionEdge],
  "nodes": [HostedFormSubmission],
  "pageInfo": PageInfo
}
Types

HostedFormSubmissionCreateInput

Fields
Input Field Description
fullName - String!
email - String!
phoneNumber - String
companyName - String
website - String
utmParams - UtmParamsInput
acceptsMarketing - Boolean
marketingConsent - String
termsAndConditions - String
fields - [HostedFormSubmissionFieldCreateInput!]!
Example
{
  "fullName": "abc123",
  "email": "abc123",
  "phoneNumber": "abc123",
  "companyName": "abc123",
  "website": "xyz789",
  "utmParams": UtmParamsInput,
  "acceptsMarketing": false,
  "marketingConsent": "abc123",
  "termsAndConditions": "abc123",
  "fields": [HostedFormSubmissionFieldCreateInput]
}
Types

HostedFormSubmissionEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - HostedFormSubmission The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": HostedFormSubmission
}
Types

HostedFormSubmissionField

Fields
Field Name Description
id - ID!
question - String!
response - String!
responseJson - JSON
responseType - HostedFieldResponseType!
Example
{
  "id": "4",
  "question": "abc123",
  "response": "xyz789",
  "responseJson": {},
  "responseType": "single_line"
}
Types

HostedFormSubmissionFieldCreateInput

Fields
Input Field Description
fieldSlug - String!
response - JSON
responseJson - JSON
Example
{
  "fieldSlug": "abc123",
  "response": {},
  "responseJson": {}
}
Types

ID

Description

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

Example
4
Types

ISO8601Date

Description

An ISO 8601-encoded date

Example
ISO8601Date
Types

ISO8601DateTime

Description

An ISO 8601-encoded datetime

Example
ISO8601DateTime
Types

Icon

Values
Enum Value Description

x

 X

check

 Check

check_circle

 Check circle

x_circle

 X circle

star

 Star
Example
"x"
Types

Int

Description

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
123
Types

Invoice

Fields
Field Name Description
amount - Money!
createdAt - ISO8601DateTime!
description - String
dueOn - ISO8601Date!
externalNote - String
id - ID!
internalNote - String
invoiceItems - [InvoiceItem!]!
invoiceOn - ISO8601Date!
invoiceSequenceNumber - Int!
lead - Lead
leadReward - LeadReward
overrideAmount - Boolean
paidAt - ISO8601DateTime
partner - Partner
partnerUser - PartnerUser
payment - Payment
paymentFrequency - PaymentFrequency
revenueEndsAt - ISO8601DateTime
revenueStartsAt - ISO8601DateTime
rewardType - SegmentRewardType!
slug - String!
status - InvoiceStatus!
totalInvoicesInSequence - Int!
Example
{
  "amount": Money,
  "createdAt": ISO8601DateTime,
  "description": "xyz789",
  "dueOn": ISO8601Date,
  "externalNote": "xyz789",
  "id": 4,
  "internalNote": "xyz789",
  "invoiceItems": [InvoiceItem],
  "invoiceOn": ISO8601Date,
  "invoiceSequenceNumber": 123,
  "lead": Lead,
  "leadReward": LeadReward,
  "overrideAmount": false,
  "paidAt": ISO8601DateTime,
  "partner": Partner,
  "partnerUser": PartnerUser,
  "payment": Payment,
  "paymentFrequency": "monthly",
  "revenueEndsAt": ISO8601DateTime,
  "revenueStartsAt": ISO8601DateTime,
  "rewardType": "QUALIFIED_LEAD_FIXED",
  "slug": "xyz789",
  "status": "draft",
  "totalInvoicesInSequence": 987
}
Types

InvoiceConnection

Description

The connection type for Invoice.

Fields
Field Name Description
edges - [InvoiceEdge] A list of edges.
nodes - [Invoice] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [InvoiceEdge],
  "nodes": [Invoice],
  "pageInfo": PageInfo
}
Types

InvoiceEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Invoice The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Invoice
}
Types

InvoiceFilterInput

Fields
Input Field Description
partnerTypeId - ID
partnerId - ID
status - [InvoiceStatus!]
leadId - ID
invoiceOn - QueryDateFilterInput
dueOn - QueryDateFilterInput
paidAt - QueryDateFilterInput
segmentRewardType - SegmentRewardType
amount - AmountFilterInput
currency - Currency
Example
{
  "partnerTypeId": 4,
  "partnerId": 4,
  "status": ["draft"],
  "leadId": "4",
  "invoiceOn": QueryDateFilterInput,
  "dueOn": QueryDateFilterInput,
  "paidAt": QueryDateFilterInput,
  "segmentRewardType": "QUALIFIED_LEAD_FIXED",
  "amount": AmountFilterInput,
  "currency": "USD"
}
Types

InvoiceItem

Fields
Field Name Description
id - ID!
revenueItem - RevenueItem!
Example
{
  "id": "4",
  "revenueItem": RevenueItem
}
Types

InvoiceStatus

Values
Enum Value Description

draft

 Draft

payment_ready

 Payment ready

finalized

 Finalized

paid

 Paid

voided

 Voided
Example
"draft"
Types

JSON

Description

Represents untyped JSON

Example
{}
Types

Lead

Fields
Field Name Description
amount - Money!
createdAt - ISO8601DateTime!
expectedCloseDate - ISO8601Date
expiresAt - ISO8601DateTime
id - ID!
revenueItems - [RevenueItem!]
shortCodeVisit - ShortCodeVisit
slug - String!
status - LeadStatus!
Example
{
  "amount": Money,
  "createdAt": ISO8601DateTime,
  "expectedCloseDate": ISO8601Date,
  "expiresAt": ISO8601DateTime,
  "id": 4,
  "revenueItems": [RevenueItem],
  "shortCodeVisit": ShortCodeVisit,
  "slug": "abc123",
  "status": "open"
}
Types

LeadConnection

Description

The connection type for Lead.

Fields
Field Name Description
edges - [LeadEdge] A list of edges.
nodes - [Lead] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [LeadEdge],
  "nodes": [Lead],
  "pageInfo": PageInfo
}
Types

LeadCrmAction

Description

Lead actions for CRM

Values
Enum Value Description

hubspot_create_lead

 Create a lead in Hubspot

hubspot_create_deal

 Create a deal in Hubspot

salesforce_create_lead

 Create a lead in Salesforce

salesforce_create_opportunity

 Create an opportunity in Salesforce

pipedrive_create_deal

 Create a deal in Pipedrive

none

 Do not create a lead or deal in CRM
Example
"hubspot_create_lead"
Types

LeadEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Lead The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Lead
}
Types

LeadFilterInput

Fields
Input Field Description
partnerTypeId - ID
partnerId - ID
segmentId - ID
managedById - ID
status - [LeadStatus!]
utmParams - UtmParamsInput
partnerIndirect - Boolean
Example
{
  "partnerTypeId": "4",
  "partnerId": 4,
  "segmentId": 4,
  "managedById": 4,
  "status": ["open"],
  "utmParams": UtmParamsInput,
  "partnerIndirect": true
}
Types

LeadGenerationFormSubmissionCreatePayload

Description

Autogenerated return type of LeadGenerationFormSubmissionCreate.

Fields
Field Name Description
errors - [UserError!]
referenceNumber - String
Example
{
  "errors": [UserError],
  "referenceNumber": "xyz789"
}
Types

LeadRetrievalInput

Fields
Input Field Description
slug - String Referral Slug. This is the Lasso Key field in your CRM
email - String Contact email
externalId - ExternalIdUpsertInput External system identifier
companyName - String Company name (exact match)
Example
{
  "slug": "xyz789",
  "email": "xyz789",
  "externalId": ExternalIdUpsertInput,
  "companyName": "xyz789"
}
Types

LeadReward

Fields
Field Name Description
amountFixed - Money
amountPercentage - Float
amountType - AmountType!
currency - String!
externalDescription - String
externalTitle - String
id - ID!
internalDescription - String
maxPayoutAmount - Money
name - String
partner - Partner
partnerUser - PartnerUser
percentageRateType - PercentageRateType
periodMonths - Int!
periods - [SegmentRewardPeriod!]
requiredCrmProducts - [ValueLabel!]
requiredProductsCrmType - ExternalSystem
revenueConditions - [SegmentRewardRevenueCondition!]
revenueSource - RevenueSource
rewardType - SegmentRewardType!
visibleToPartners - Boolean!
Example
{
  "amountFixed": Money,
  "amountPercentage": 987.65,
  "amountType": "percentage",
  "currency": "xyz789",
  "externalDescription": "abc123",
  "externalTitle": "abc123",
  "id": "4",
  "internalDescription": "abc123",
  "maxPayoutAmount": Money,
  "name": "xyz789",
  "partner": Partner,
  "partnerUser": PartnerUser,
  "percentageRateType": "basic",
  "periodMonths": 123,
  "periods": [SegmentRewardPeriod],
  "requiredCrmProducts": [ValueLabel],
  "requiredProductsCrmType": "HUBSPOT",
  "revenueConditions": [SegmentRewardRevenueCondition],
  "revenueSource": RevenueSource,
  "rewardType": "QUALIFIED_LEAD_FIXED",
  "visibleToPartners": true
}
Types

LeadSettings

Fields
Field Name Description
acceptanceSlaDays - Int!
attributionWindowDays - Int!
destinationType - String!
destinationUrl - String!
enableManualStateTransitions - Boolean!
leadExpirationDays - Int!
popupCss - String!
rejectionReasonRequired - Boolean!
rejectionReasons - [String!]!
Example
{
  "acceptanceSlaDays": 987,
  "attributionWindowDays": 123,
  "destinationType": "xyz789",
  "destinationUrl": "abc123",
  "enableManualStateTransitions": true,
  "leadExpirationDays": 987,
  "popupCss": "abc123",
  "rejectionReasonRequired": false,
  "rejectionReasons": ["xyz789"]
}
Types

LeadStatus

Description

Lead Status

Values
Enum Value Description

open

 Open

accepted

 Accepted

qualified

 Qualified

closed_lost

 Closed lost

closed_won

 Closed won

rejected

 Rejected

churned

 Churned

expired

 Expired
Example
"open"
Types

LeadUpdatePayload

Description

Autogenerated return type of LeadUpdate.

Fields
Field Name Description
errors - [UserError!]
lead - Lead
Example
{
  "errors": [UserError],
  "lead": Lead
}
Types

LeadUpsertInput

Fields
Input Field Description
markAsQualified - Boolean
markAsAccepted - Boolean
markAsRejected - Boolean
markAsClosedWon - Boolean
markAsClosedLost - Boolean
markAsChurned - Boolean
markAsRevived - Boolean
companyName - String
contactName - String
email - String
Example
{
  "markAsQualified": true,
  "markAsAccepted": true,
  "markAsRejected": true,
  "markAsClosedWon": false,
  "markAsClosedLost": true,
  "markAsChurned": false,
  "markAsRevived": true,
  "companyName": "abc123",
  "contactName": "abc123",
  "email": "abc123"
}
Types

MediaGallery

Fields
Field Name Description
createdAt - ISO8601DateTime!
deletedAt - ISO8601DateTime
galleryType - MediaGalleryGalleryType!
id - ID!
internalDescription - String
items - [MediaGalleryItem!]!
name - String!
partnerTypes - [PartnerType!]!
pastEventsThresholdDays - Int
sorting - String
updatedAt - ISO8601DateTime!
Example
{
  "createdAt": ISO8601DateTime,
  "deletedAt": ISO8601DateTime,
  "galleryType": "partner",
  "id": 4,
  "internalDescription": "abc123",
  "items": [MediaGalleryItem],
  "name": "abc123",
  "partnerTypes": [PartnerType],
  "pastEventsThresholdDays": 123,
  "sorting": "abc123",
  "updatedAt": ISO8601DateTime
}
Types

MediaGalleryGalleryType

Description

Medium Gallery Type

Values
Enum Value Description

partner

partner_faq

calendar
Example
"partner"
Types

MediaGalleryItem

Fields
Field Name Description
attachment - Attachment
createdAt - ISO8601DateTime!
ctaText - String
ctaUrl - String
deletedAt - ISO8601DateTime
description - String
endTime - ISO8601DateTime
eventType - String
id - ID!
itemType - MediaGalleryItemItem!
location - String
locationDetails - JSON
position - Int
startTime - ISO8601DateTime
status - MediaGalleryItemStatus!
title - String
updatedAt - ISO8601DateTime!
visits - MediaGalleryItemVisit!
visitsCount - Int!
Example
{
  "attachment": Attachment,
  "createdAt": ISO8601DateTime,
  "ctaText": "xyz789",
  "ctaUrl": "xyz789",
  "deletedAt": ISO8601DateTime,
  "description": "xyz789",
  "endTime": ISO8601DateTime,
  "eventType": "xyz789",
  "id": 4,
  "itemType": "downloadable_media",
  "location": "abc123",
  "locationDetails": {},
  "position": 123,
  "startTime": ISO8601DateTime,
  "status": "draft",
  "title": "abc123",
  "updatedAt": ISO8601DateTime,
  "visits": MediaGalleryItemVisit,
  "visitsCount": 987
}
Types

MediaGalleryItemItem

Description

Media Gallery Item Item Type

Values
Enum Value Description

downloadable_media

 Downloadable Media

image_with_link

 Image With Link

link

 Link

faq

 Faq

calendar_event

 Calendar Event
Example
"downloadable_media"
Types

MediaGalleryItemStatus

Description

Medium Gallery Item Status

Values
Enum Value Description

draft

published

archived

deleted
Example
"draft"
Types

MediaGalleryItemVisit

Fields
Field Name Description
createdAt - ISO8601DateTime!
partner - Partner
partnerUser - PartnerUser
updatedAt - ISO8601DateTime!
visitType - String!
Example
{
  "createdAt": ISO8601DateTime,
  "partner": Partner,
  "partnerUser": PartnerUser,
  "updatedAt": ISO8601DateTime,
  "visitType": "abc123"
}
Types

MetricDefinition

Fields
Field Name Description
aggregationMethod - MetricDefinitionAggregation!
aggregationPeriod - MetricDefinitionDuration!
createdAt - ISO8601DateTime!
description - String
eventType - String!
formattingType - MetricDefinitionFormatting!
id - ID!
name - String!
showOnPartnerPage - Boolean!
showOnPartnerPortal - Boolean!
systemManaged - Boolean!
updatedAt - ISO8601DateTime!
valueType - MetricDefinitionValue!
Example
{
  "aggregationMethod": "sum",
  "aggregationPeriod": "days_30",
  "createdAt": ISO8601DateTime,
  "description": "abc123",
  "eventType": "abc123",
  "formattingType": "integer",
  "id": "4",
  "name": "xyz789",
  "showOnPartnerPage": true,
  "showOnPartnerPortal": false,
  "systemManaged": false,
  "updatedAt": ISO8601DateTime,
  "valueType": "integer"
}
Types

MetricDefinitionAggregation

Values
Enum Value Description

sum

 Sum

average

 Average

max

 Max

min

 Min

count

 Count

percentage

 Percentage

last

 Last
Example
"sum"
Types

MetricDefinitionDuration

Values
Enum Value Description

days_30

 Days 30

days_90

 Days 90

days_180

 Days 180

days_365

 Days 365

this_year

 This year

all_time

 All time
Example
"days_30"
Types

MetricDefinitionFormatting

Values
Enum Value Description

integer

 Integer

currency

 Currency

percentage

 Percentage

boolean

 Boolean

decimal

 Decimal
Example
"integer"
Types

MetricDefinitionValue

Values
Enum Value Description

integer

 Integer

decimal

 Decimal

boolean

 Boolean

string

 String

timestamp

 Timestamp
Example
"integer"
Types

Money

Fields
Field Name Description
currencyCode - Currency!
value - Float!
Example
{"currencyCode": "USD", "value": 987.65}
Types

Node

Description

An object with an ID.

Fields
Field Name Description
id - ID! ID of the object.
Example
{"id": 4}
Types

OnboardingStatus

Fields
Field Name Description
paymentMethodRequired - Boolean!
Example
{"paymentMethodRequired": false}
Types

PageInfo

Description

Information about pagination in a connection.

Fields
Field Name Description
endCursor - String When paginating forwards, the cursor to continue.
hasNextPage - Boolean! When paginating forwards, are there more items?
hasPreviousPage - Boolean! When paginating backwards, are there more items?
startCursor - String When paginating backwards, the cursor to continue.
Example
{
  "endCursor": "xyz789",
  "hasNextPage": false,
  "hasPreviousPage": false,
  "startCursor": "xyz789"
}
Types

Partner

Fields
Field Name Description
createdAt - ISO8601DateTime
id - ID!
logo - Attachment
name - String
slug - String
websiteUrl - String
Example
{
  "createdAt": ISO8601DateTime,
  "id": 4,
  "logo": Attachment,
  "name": "abc123",
  "slug": "abc123",
  "websiteUrl": "xyz789"
}
Types

PartnerApplicationFormSubmissionCreatePayload

Description

Autogenerated return type of PartnerApplicationFormSubmissionCreate.

Fields
Field Name Description
errors - [UserError!]
referenceNumber - String
Example
{
  "errors": [UserError],
  "referenceNumber": "abc123"
}
Types

PartnerConnection

Description

The connection type for Partner.

Fields
Field Name Description
edges - [PartnerEdge] A list of edges.
nodes - [Partner] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [PartnerEdge],
  "nodes": [Partner],
  "pageInfo": PageInfo
}
Types

PartnerEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Partner The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": Partner
}
Types

PartnerEmailSetting

Fields
Field Name Description
authenticatedEmailDomain - String
authenticatedEmailDomainVerified - Boolean
emailHeader - String
footerText - String
logoAsset - UploadedFile
primaryColor - String
replyToEmail - String
senderEmail - String
senderName - String
sendgridDnsRecords - [CustomDomainDnsRecord!]
Example
{
  "authenticatedEmailDomain": "xyz789",
  "authenticatedEmailDomainVerified": false,
  "emailHeader": "xyz789",
  "footerText": "xyz789",
  "logoAsset": UploadedFile,
  "primaryColor": "xyz789",
  "replyToEmail": "xyz789",
  "senderEmail": "xyz789",
  "senderName": "abc123",
  "sendgridDnsRecords": [CustomDomainDnsRecord]
}
Types

PartnerFilterInput

Fields
Input Field Description
partnerTypeId - ID
segmentId - ID
tierId - ID
managedById - ID
healthBandLabel - String
Example
{
  "partnerTypeId": "4",
  "segmentId": 4,
  "tierId": 4,
  "managedById": 4,
  "healthBandLabel": "xyz789"
}
Types

PartnerPortalSetting

Fields
Field Name Description
calendarWidgetContainerBackgroundColor - String
calendarWidgetContainerBorderColor - String
calendarWidgetContainerClassName - String
calendarWidgetCssOverrides - String
calendarWidgetEventBadgeBackgroundColor - String
calendarWidgetEventBadgeClassName - String
calendarWidgetEventBadgeTextColor - String
calendarWidgetEventBodyClassName - String
calendarWidgetEventBodyTextColor - String
calendarWidgetEventButtonBackgroundColor - String
calendarWidgetEventButtonClassName - String
calendarWidgetEventButtonTextColor - String
calendarWidgetEventTitleClassName - String
calendarWidgetEventTitleTextColor - String
calendarWidgetSelectionButtonActiveBackgroundColor - String
calendarWidgetSelectionButtonActiveClassName - String
calendarWidgetSelectionButtonActiveTextColor - String
calendarWidgetSelectionButtonInactiveBackgroundColor - String
calendarWidgetSelectionButtonInactiveClassName - String
calendarWidgetSelectionButtonInactiveTextColor - String
calendarWidgetTitleClassName - String
calendarWidgetTitleFontSize - String
calendarWidgetTitleTextColor - String
crmDealStageMapping - [ValueLabel!]
crmType - ExternalSystem
cssEmbedCode - String
cssEmbedCodeSass - String
eventCalendarEnabled - Boolean!
eventCalendarEventTypes - [String!]!
eventCalendarTitle - String!
faqEnabled - Boolean!
faqTitle - String!
faviconAsset - UploadedFile
galleryEnabled - Boolean!
galleryTitle - String!
jsEmbedCode - String
loggedInBody - StyledText
loggedInFooter - StyledText
loggedInNavHeader - StyledText
loggedInNavLogo - StyledText
loggedInSideNav - StyledText
loggedInSideNavItem - StyledText
loggedInSideNavItemActive - StyledText
loggedInSideNavItemHover - StyledText
loggedOutBody - StyledText
loginPageAsset - UploadedFile
loginPageSubtitle - String
loginPageTitle - String
logoAsset - UploadedFile
primaryButton - StyledText
showCrmDealExpectedAmount - Boolean
showCrmDealExpectedCloseDate - Boolean
showCrmDealStage - Boolean
showRevenueItemsWithInvoices - Boolean
showUpcomingInvoices - Boolean
siteTitle - String
Example
{
  "calendarWidgetContainerBackgroundColor": "abc123",
  "calendarWidgetContainerBorderColor": "xyz789",
  "calendarWidgetContainerClassName": "abc123",
  "calendarWidgetCssOverrides": "abc123",
  "calendarWidgetEventBadgeBackgroundColor": "abc123",
  "calendarWidgetEventBadgeClassName": "xyz789",
  "calendarWidgetEventBadgeTextColor": "xyz789",
  "calendarWidgetEventBodyClassName": "xyz789",
  "calendarWidgetEventBodyTextColor": "xyz789",
  "calendarWidgetEventButtonBackgroundColor": "abc123",
  "calendarWidgetEventButtonClassName": "xyz789",
  "calendarWidgetEventButtonTextColor": "abc123",
  "calendarWidgetEventTitleClassName": "abc123",
  "calendarWidgetEventTitleTextColor": "abc123",
  "calendarWidgetSelectionButtonActiveBackgroundColor": "xyz789",
  "calendarWidgetSelectionButtonActiveClassName": "xyz789",
  "calendarWidgetSelectionButtonActiveTextColor": "xyz789",
  "calendarWidgetSelectionButtonInactiveBackgroundColor": "xyz789",
  "calendarWidgetSelectionButtonInactiveClassName": "abc123",
  "calendarWidgetSelectionButtonInactiveTextColor": "abc123",
  "calendarWidgetTitleClassName": "xyz789",
  "calendarWidgetTitleFontSize": "abc123",
  "calendarWidgetTitleTextColor": "xyz789",
  "crmDealStageMapping": [ValueLabel],
  "crmType": "HUBSPOT",
  "cssEmbedCode": "abc123",
  "cssEmbedCodeSass": "xyz789",
  "eventCalendarEnabled": false,
  "eventCalendarEventTypes": ["xyz789"],
  "eventCalendarTitle": "abc123",
  "faqEnabled": true,
  "faqTitle": "xyz789",
  "faviconAsset": UploadedFile,
  "galleryEnabled": false,
  "galleryTitle": "xyz789",
  "jsEmbedCode": "abc123",
  "loggedInBody": StyledText,
  "loggedInFooter": StyledText,
  "loggedInNavHeader": StyledText,
  "loggedInNavLogo": StyledText,
  "loggedInSideNav": StyledText,
  "loggedInSideNavItem": StyledText,
  "loggedInSideNavItemActive": StyledText,
  "loggedInSideNavItemHover": StyledText,
  "loggedOutBody": StyledText,
  "loginPageAsset": UploadedFile,
  "loginPageSubtitle": "xyz789",
  "loginPageTitle": "xyz789",
  "logoAsset": UploadedFile,
  "primaryButton": StyledText,
  "showCrmDealExpectedAmount": false,
  "showCrmDealExpectedCloseDate": true,
  "showCrmDealStage": false,
  "showRevenueItemsWithInvoices": true,
  "showUpcomingInvoices": false,
  "siteTitle": "xyz789"
}
Types

PartnerRole

Description

Partner Role Type enum

Values
Enum Value Description

partner_admin

 Partner Admin

partner_finance

 Partner Finance

partner_member

 Partner Member
Example
"partner_admin"
Types

PartnerType

Fields
Field Name Description
id - ID!
name - String!
slug - String!
Example
{
  "id": "4",
  "name": "xyz789",
  "slug": "xyz789"
}
Types

PartnerUser

Fields
Field Name Description
appleWalletPassUrl - String!
directReferralUrl - String!
externalIds - [ExternalId!]!
featureAnnouncementsSeen - [String!]!
googleWalletPassUrl - String!
id - ID!
partner - Partner!
paymentsPending - [Payment!]!
referralQrCodeUrl - String
referralUrl - String!
role - PartnerRole!
title - String
user - User
Example
{
  "appleWalletPassUrl": "xyz789",
  "directReferralUrl": "xyz789",
  "externalIds": [ExternalId],
  "featureAnnouncementsSeen": ["xyz789"],
  "googleWalletPassUrl": "abc123",
  "id": "4",
  "partner": Partner,
  "paymentsPending": [Payment],
  "referralQrCodeUrl": "xyz789",
  "referralUrl": "xyz789",
  "role": "partner_admin",
  "title": "abc123",
  "user": User
}
Types

Payment

Fields
Field Name Description
amount - Money!
createdAt - ISO8601DateTime!
id - ID!
partner - Partner
partnerUser - PartnerUser
slug - String!
status - PaymentStatus!
updatedAt - ISO8601DateTime!
Example
{
  "amount": Money,
  "createdAt": ISO8601DateTime,
  "id": 4,
  "partner": Partner,
  "partnerUser": PartnerUser,
  "slug": "abc123",
  "status": "draft",
  "updatedAt": ISO8601DateTime
}
Types

PaymentConnection

Description

The connection type for Payment.

Fields
Field Name Description
edges - [PaymentEdge] A list of edges.
nodes - [Payment] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [PaymentEdge],
  "nodes": [Payment],
  "pageInfo": PageInfo
}
Types

PaymentEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Payment The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": Payment
}
Types

PaymentFeePlan

Fields
Field Name Description
currency - Currency!
interval - StripeRecurringInterval!
payoutAdditionalPricePercentage - Float!
payoutStartValue - Float!
Example
{
  "currency": "USD",
  "interval": "month",
  "payoutAdditionalPricePercentage": 123.45,
  "payoutStartValue": 987.65
}
Types

PaymentFilterInput

Fields
Input Field Description
partnerTypeId - ID
partnerId - ID
tierPlanId - ID
createdAt - QueryDateFilterInput
amount - AmountFilterInput
currency - Currency
paymentRunId - ID
leadId - ID
includeInvoicesInExport - Boolean
status - PaymentStatus
Example
{
  "partnerTypeId": "4",
  "partnerId": 4,
  "tierPlanId": "4",
  "createdAt": QueryDateFilterInput,
  "amount": AmountFilterInput,
  "currency": "USD",
  "paymentRunId": 4,
  "leadId": 4,
  "includeInvoicesInExport": false,
  "status": "draft"
}
Types

PaymentFrequency

Values
Enum Value Description

monthly

 Monthly

quarterly

 Quarterly

semi_annually

 Semi annually

yearly

 Yearly
Example
"monthly"
Types

PaymentStatus

Description

Payment Status

Values
Enum Value Description

draft

 Draft

awaiting_funds

 Awaiting Funds

payout_pending

 Payout Pending

payout_processing

 Payout Processing

payout_processed

 Payout Processed

voided

 Voided
Example
"draft"
Types

PayoutMethod

Fields
Field Name Description
config - JSON!
description - String
id - ID!
name - String!
payoutMethodType - PayoutMethodType!
provider - PayoutProvider!
Example
{
  "config": {},
  "description": "abc123",
  "id": "4",
  "name": "abc123",
  "payoutMethodType": "lasso_managed_cash",
  "provider": "paypal"
}
Types

PayoutMethodType

Values
Enum Value Description

lasso_managed_cash

 Lasso managed cash

external_cash

 External cash
Example
"lasso_managed_cash"
Types

PayoutProvider

Values
Enum Value Description

paypal

 Paypal

venmo

 Venmo

wise_ach_us

 Wise ach us

tremendous

 Tremendous

external_invoice

 External invoice
Example
"paypal"
Types

PercentageRateType

Values
Enum Value Description

basic

 Basic

tier_based

 Tier based

progressive

 Progressive
Example
"basic"
Types

QueryDateFilterInput

Fields
Input Field Description
dateFrom - ISO8601Date!
dateTo - ISO8601Date!
groupingPeriod - DataGroupingPeriod!
Example
{
  "dateFrom": ISO8601Date,
  "dateTo": ISO8601Date,
  "groupingPeriod": "day"
}
Types

QueryOperator

Values
Enum Value Description

eq

 Equal

gt

 Greater Than

gte

 Greater Than or Equal

lt

 Less Than

lte

 Less Than or Equal

ne

 Not Equal

contains

 Contains

not_contains

 Not Contains
Example
"eq"
Types

RequirementCondition

Values
Enum Value Description

all

 All

any

 Any
Example
"all"
Types

RevenueItem

Fields
Field Name Description
amount - Money!
createdAt - ISO8601DateTime!
deletedAt - ISO8601DateTime
description - String
externalIdentifier - String
externalSubIdentifier - String
id - ID!
recordedAt - ISO8601DateTime!
totalAmount - Money!
updatedAt - ISO8601DateTime!
Example
{
  "amount": Money,
  "createdAt": ISO8601DateTime,
  "deletedAt": ISO8601DateTime,
  "description": "abc123",
  "externalIdentifier": "abc123",
  "externalSubIdentifier": "xyz789",
  "id": "4",
  "recordedAt": ISO8601DateTime,
  "totalAmount": Money,
  "updatedAt": ISO8601DateTime
}
Types

RevenueItemCreateInput

Fields
Input Field Description
leadSlug - String!
amount - Float!
currency - String
description - String
externalIdentifier - String
externalSubIdentifier - String
recordedAt - ISO8601DateTime
Example
{
  "leadSlug": "abc123",
  "amount": 987.65,
  "currency": "xyz789",
  "description": "xyz789",
  "externalIdentifier": "abc123",
  "externalSubIdentifier": "xyz789",
  "recordedAt": ISO8601DateTime
}
Types

RevenueItemCreatePayload

Description

Autogenerated return type of RevenueItemCreate.

Fields
Field Name Description
errors - [UserError!]
revenueItem - RevenueItem
Example
{
  "errors": [UserError],
  "revenueItem": RevenueItem
}
Types

RevenueItemUpdateInput

Fields
Input Field Description
id - ID!
delete - Boolean
restore - Boolean
amount - Float
description - String
externalIdentifier - String
externalSubIdentifier - String
recordedAt - ISO8601DateTime
Example
{
  "id": 4,
  "delete": true,
  "restore": true,
  "amount": 123.45,
  "description": "abc123",
  "externalIdentifier": "abc123",
  "externalSubIdentifier": "abc123",
  "recordedAt": ISO8601DateTime
}
Types

RevenueItemUpdatePayload

Description

Autogenerated return type of RevenueItemUpdate.

Fields
Field Name Description
errors - [UserError!]
revenueItem - RevenueItem
Example
{
  "errors": [UserError],
  "revenueItem": RevenueItem
}
Types

RevenueSource

Fields
Field Name Description
fieldName - String
fieldValue - String
id - ID!
name - String!
objectType - ExternalObject
productFilters - [ValueLabel!]!
settings - JSON
systemType - ExternalSystem!
Example
{
  "fieldName": "abc123",
  "fieldValue": "xyz789",
  "id": "4",
  "name": "abc123",
  "objectType": "company",
  "productFilters": [ValueLabel],
  "settings": {},
  "systemType": "HUBSPOT"
}
Types

Schedule

Description

Schedule Type for upgrades and downgrades

Values
Enum Value Description

manual

 Manual

end_of_day

 End of day

end_of_week

 End of week

end_of_month

 End of month

end_of_quarter

 End of quarter

end_of_six_months

 End of six months

end_of_year

 End of year
Example
"manual"
Types

SearchResult

Fields
Field Name Description
deleted - Boolean
displayName - String
displaySecondary - String
displaySlug - String
objectType - SearchResultObject
recordId - ID
Example
{
  "deleted": true,
  "displayName": "abc123",
  "displaySecondary": "abc123",
  "displaySlug": "abc123",
  "objectType": "partner",
  "recordId": 4
}
Types

SearchResultObject

Description

Search Result Object Type enum

Values
Enum Value Description

partner

 Partner

partner_user

 Partner User

segment

 Segment

partner_type

 Partner Type

lead

 Lead

invoice

 Invoice

payment

 Payment
Example
"partner"
Types

Segment

Fields
Field Name Description
createdAt - ISO8601DateTime!
externalDescription - String
externalTitle - String
id - ID!
internalDescription - String
multiCurrencyEnabled - Boolean!
name - String!
rewards - [SegmentReward!]!
slug - String!
Example
{
  "createdAt": ISO8601DateTime,
  "externalDescription": "abc123",
  "externalTitle": "xyz789",
  "id": "4",
  "internalDescription": "abc123",
  "multiCurrencyEnabled": true,
  "name": "xyz789",
  "rewards": [SegmentReward],
  "slug": "abc123"
}
Types

SegmentReward

Fields
Field Name Description
amountFixed - Money
amountPercentage - Float
amountType - AmountType!
currency - String!
externalDescription - String
externalTitle - String
id - ID!
internalDescription - String
maxPayoutAmount - Money
name - String
payeeType - SegmentRewardPayeeType!
percentageRateType - PercentageRateType
periodMonths - Int!
periods - [SegmentRewardPeriod!]
requiredCrmProducts - [ValueLabel!]
requiredProductsCrmType - ExternalSystem
revenueConditions - [SegmentRewardRevenueCondition!]
revenueSource - RevenueSource
rewardType - SegmentRewardType!
visibleToPartners - Boolean!
Example
{
  "amountFixed": Money,
  "amountPercentage": 987.65,
  "amountType": "percentage",
  "currency": "xyz789",
  "externalDescription": "abc123",
  "externalTitle": "xyz789",
  "id": 4,
  "internalDescription": "abc123",
  "maxPayoutAmount": Money,
  "name": "abc123",
  "payeeType": "partner",
  "percentageRateType": "basic",
  "periodMonths": 123,
  "periods": [SegmentRewardPeriod],
  "requiredCrmProducts": [ValueLabel],
  "requiredProductsCrmType": "HUBSPOT",
  "revenueConditions": [SegmentRewardRevenueCondition],
  "revenueSource": RevenueSource,
  "rewardType": "QUALIFIED_LEAD_FIXED",
  "visibleToPartners": true
}
Types

SegmentRewardPayeeType

Values
Enum Value Description

partner

 Partner

partner_user

 Partner User
Example
"partner"
Types

SegmentRewardPeriod

Fields
Field Name Description
endMonth - Int!
rewardAmount - Float!
startMonth - Int!
Example
{"endMonth": 987, "rewardAmount": 123.45, "startMonth": 123}
Types

SegmentRewardRevenueCondition

Fields
Field Name Description
maxRevenue - Float
minRevenue - Float!
rewardAmount - Float!
Example
{"maxRevenue": 123.45, "minRevenue": 123.45, "rewardAmount": 987.65}
Types

SegmentRewardType

Values
Enum Value Description

QUALIFIED_LEAD_FIXED

 QUALIFIED_LEAD_FIXED

CLOSED_WON_FIXED

 CLOSED_WON_FIXED

CLOSED_WON_PERCENTAGE

 CLOSED_WON_PERCENTAGE

ONE_TIME_PAYOUT

 ONE_TIME_PAYOUT
Example
"QUALIFIED_LEAD_FIXED"
Types

ShortCodeVisit

Fields
Field Name Description
createdAt - ISO8601DateTime!
ipAddress - String!
partnerUser - PartnerUser!
userAgent - String!
utmParams - UtmParams!
uuid - String!
Example
{
  "createdAt": ISO8601DateTime,
  "ipAddress": "xyz789",
  "partnerUser": PartnerUser,
  "userAgent": "abc123",
  "utmParams": UtmParams,
  "uuid": "abc123"
}
Types

String

Description

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"
Types

StripeRecurringInterval

Values
Enum Value Description

month

 Month

year

 Year
Example
"month"
Types

StyledText

Fields
Field Name Description
backgroundColor - String
className - String
textColor - String
textHtml - String
Example
{
  "backgroundColor": "xyz789",
  "className": "abc123",
  "textColor": "xyz789",
  "textHtml": "xyz789"
}
Types

ThemeSetting

Description

Settings for theme

Fields
Field Name Description
accentColor - String Color for primary call to action buttons
brandColor - String Brand Color
fonts - [JSON!] Fonts
input - JSON Fonts
modalContent - JSON Modal Content
modalHeading - JSON Modal Heading
modalOverlay - JSON Modal Overlay
primaryButton - JSON Fonts
secondaryButton - JSON Fonts
textStyles - [JSON!] Text Styles
Example
{
  "accentColor": "xyz789",
  "brandColor": "xyz789",
  "fonts": [{}],
  "input": {},
  "modalContent": {},
  "modalHeading": {},
  "modalOverlay": {},
  "primaryButton": {},
  "secondaryButton": {},
  "textStyles": [{}]
}
Types

Tier

Fields
Field Name Description
badgeAsset - Attachment
createdAt - ISO8601DateTime!
id - ID!
imageAsset - Attachment
name - String!
position - Int!
segment - Segment!
slug - String!
updatedAt - ISO8601DateTime!
Example
{
  "badgeAsset": Attachment,
  "createdAt": ISO8601DateTime,
  "id": "4",
  "imageAsset": Attachment,
  "name": "abc123",
  "position": 123,
  "segment": Segment,
  "slug": "abc123",
  "updatedAt": ISO8601DateTime
}
Types

TierPlan

Fields
Field Name Description
createdAt - ISO8601DateTime!
daysInTier - Int
description - String
downgradeScheduleType - Schedule!
features - [TierPlanFeature!]!
id - ID!
name - String!
slug - String!
tiers - [Tier!]!
updatedAt - ISO8601DateTime!
upgradeScheduleType - Schedule!
Example
{
  "createdAt": ISO8601DateTime,
  "daysInTier": 987,
  "description": "xyz789",
  "downgradeScheduleType": "manual",
  "features": [TierPlanFeature],
  "id": "4",
  "name": "abc123",
  "slug": "abc123",
  "tiers": [Tier],
  "updatedAt": ISO8601DateTime,
  "upgradeScheduleType": "manual"
}
Types

TierPlanFeature

Fields
Field Name Description
active - Boolean!
createdAt - ISO8601DateTime!
description - String
featureValues - [TierPlanFeatureValue!]
id - ID!
metricDefinitions - [MetricDefinition!]
position - Int!
requirementConditionType - RequirementCondition
section - String
title - String!
updatedAt - ISO8601DateTime!
visible - Boolean!
Example
{
  "active": false,
  "createdAt": ISO8601DateTime,
  "description": "xyz789",
  "featureValues": [TierPlanFeatureValue],
  "id": "4",
  "metricDefinitions": [MetricDefinition],
  "position": 123,
  "requirementConditionType": "all",
  "section": "xyz789",
  "title": "xyz789",
  "updatedAt": ISO8601DateTime,
  "visible": false
}
Types

TierPlanFeatureValue

Fields
Field Name Description
createdAt - ISO8601DateTime!
iconType - Icon
id - ID!
metricValues - [FeatureValueMetricValue!]!
tier - Tier!
title - String!
updatedAt - ISO8601DateTime!
Example
{
  "createdAt": ISO8601DateTime,
  "iconType": "x",
  "id": "4",
  "metricValues": [FeatureValueMetricValue],
  "tier": Tier,
  "title": "xyz789",
  "updatedAt": ISO8601DateTime
}
Types

UploadedFile

Description

Uploaded File

Fields
Field Name Description
contentType - String content type
filename - String Name of the uploaded file
id - ID
largeUrl - String
mediumUrl - String
thumbnailUrl - String
url - String Download URL
Example
{
  "contentType": "abc123",
  "filename": "abc123",
  "id": "4",
  "largeUrl": "abc123",
  "mediumUrl": "abc123",
  "thumbnailUrl": "xyz789",
  "url": "abc123"
}
Types

User

Fields
Field Name Description
accountAccess - [AccountUser!]!
activated - Boolean
connectors - [Connector!]
createdAt - ISO8601DateTime
deleted - Boolean
email - String
firstName - String
fullName - String
id - ID!
isRefilliateUser - Boolean
lastName - String
name - String
phone - String
profileImageUrl - String
Example
{
  "accountAccess": [AccountUser],
  "activated": false,
  "connectors": [Connector],
  "createdAt": ISO8601DateTime,
  "deleted": false,
  "email": "xyz789",
  "firstName": "abc123",
  "fullName": "abc123",
  "id": 4,
  "isRefilliateUser": true,
  "lastName": "abc123",
  "name": "abc123",
  "phone": "xyz789",
  "profileImageUrl": "xyz789"
}
Types

UserError

Fields
Field Name Description
field - String
message - String!
Example
{
  "field": "abc123",
  "message": "xyz789"
}
Types

UserPermission

Description

User Permission

Values
Enum Value Description

ALL

 ALL

BILLING_WRITE

 BILLING_WRITE

TEAM_WRITE

 TEAM_WRITE

PARTNERS_WRITE

 PARTNERS_WRITE

PARTNERS_READ

 PARTNERS_READ

PARTNERS_EXPORT

 PARTNERS_EXPORT

COMMUNICATIONS_WRITE

 COMMUNICATIONS_WRITE

PARTNER_SETTINGS_WRITE

 PARTNER_SETTINGS_WRITE

EVENT_CALENDARS_WRITE

 EVENT_CALENDARS_WRITE

PAYMENT_READ

 PAYMENT_READ

PAYMENT_WRITE

 PAYMENT_WRITE

PAYMENT_APPROVE

 PAYMENT_APPROVE

ACCOUNT_FUNDS_WRITE

 ACCOUNT_FUNDS_WRITE

ROLES_WRITE

 ROLES_WRITE

DEVELOPER

 DEVELOPER

DATA_IMPORT

 DATA_IMPORT

AGREEMENT_TEMPLATES_WRITE

 AGREEMENT_TEMPLATES_WRITE

AGREEMENTS_READ

 AGREEMENTS_READ

AGREEMENTS_WRITE

 AGREEMENTS_WRITE

AGREEMENTS_SIGN

 AGREEMENTS_SIGN
Example
"ALL"
Types

UserRole

Fields
Field Name Description
id - ID!
name - String!
permissions - [UserPermission!]!
Example
{
  "id": 4,
  "name": "xyz789",
  "permissions": ["ALL"]
}
Types

UtmParams

Fields
Field Name Description
utmCampaign - String
utmContent - String
utmMedium - String
utmSource - String
utmTerm - String
Example
{
  "utmCampaign": "xyz789",
  "utmContent": "xyz789",
  "utmMedium": "abc123",
  "utmSource": "abc123",
  "utmTerm": "xyz789"
}
Types

UtmParamsInput

Fields
Input Field Description
utmSource - String
utmMedium - String
utmCampaign - String
utmTerm - String
utmContent - String
Example
{
  "utmSource": "xyz789",
  "utmMedium": "xyz789",
  "utmCampaign": "xyz789",
  "utmTerm": "abc123",
  "utmContent": "abc123"
}
Types

ValueLabel

Fields
Field Name Description
description - String
label - String!
value - ID!
valueFloat - Float
valueInt - Int
Example
{
  "description": "xyz789",
  "label": "xyz789",
  "value": 4,
  "valueFloat": 123.45,
  "valueInt": 987
}
Documentation by Anvil SpectaQL