---
title: Partner API reference
description: The Partner API provides access to data in the Partners Dashboard. Learn how to get started using efficient GraphQL queries.
api_name: partner
source_url:
  html: https://shopify.dev/docs/api/partner/2025-01/full-index
  md: https://shopify.dev/docs/api/partner/2025-01/full-index.md
---

Congratulations! You've found the page we use to help dumb crawlers find all our API pages.

* App events

  * Objects

    * [AppSubscription](https://shopify.dev/docs/api/partner/2025-01/objects/appsubscription)
    * [CreditApplied](https://shopify.dev/docs/api/partner/2025-01/objects/creditapplied)
    * [CreditFailed](https://shopify.dev/docs/api/partner/2025-01/objects/creditfailed)
    * [CreditPending](https://shopify.dev/docs/api/partner/2025-01/objects/creditpending)
    * [OneTimeChargeAccepted](https://shopify.dev/docs/api/partner/2025-01/objects/onetimechargeaccepted)
    * [OneTimeChargeActivated](https://shopify.dev/docs/api/partner/2025-01/objects/onetimechargeactivated)
    * [OneTimeChargeDeclined](https://shopify.dev/docs/api/partner/2025-01/objects/onetimechargedeclined)
    * [OneTimeChargeExpired](https://shopify.dev/docs/api/partner/2025-01/objects/onetimechargeexpired)
    * [RelationshipDeactivated](https://shopify.dev/docs/api/partner/2025-01/objects/relationshipdeactivated)
    * [RelationshipInstalled](https://shopify.dev/docs/api/partner/2025-01/objects/relationshipinstalled)
    * [RelationshipReactivated](https://shopify.dev/docs/api/partner/2025-01/objects/relationshipreactivated)
    * [RelationshipUninstalled](https://shopify.dev/docs/api/partner/2025-01/objects/relationshipuninstalled)
    * [SubscriptionChargeAccepted](https://shopify.dev/docs/api/partner/2025-01/objects/subscriptionchargeaccepted)
    * [SubscriptionChargeActivated](https://shopify.dev/docs/api/partner/2025-01/objects/subscriptionchargeactivated)
    * [SubscriptionChargeCanceled](https://shopify.dev/docs/api/partner/2025-01/objects/subscriptionchargecanceled)
    * [SubscriptionChargeDeclined](https://shopify.dev/docs/api/partner/2025-01/objects/subscriptionchargedeclined)
    * [SubscriptionChargeExpired](https://shopify.dev/docs/api/partner/2025-01/objects/subscriptionchargeexpired)
    * [SubscriptionChargeFrozen](https://shopify.dev/docs/api/partner/2025-01/objects/subscriptionchargefrozen)
    * [SubscriptionChargeUnfrozen](https://shopify.dev/docs/api/partner/2025-01/objects/subscriptionchargeunfrozen)
    * [UsageChargeApplied](https://shopify.dev/docs/api/partner/2025-01/objects/usagechargeapplied)

* Common objects

  * Queries

    * [app](https://shopify.dev/docs/api/partner/2025-01/queries/app)
    * [conversation](https://shopify.dev/docs/api/partner/2025-01/queries/conversation)
    * [conversations](https://shopify.dev/docs/api/partner/2025-01/queries/conversations)
    * [publicApiVersions](https://shopify.dev/docs/api/partner/2025-01/queries/publicapiversions)

  * Objects

    * [ApiVersion](https://shopify.dev/docs/api/partner/2025-01/objects/apiversion)
    * [App](https://shopify.dev/docs/api/partner/2025-01/objects/app)
    * [Conversation](https://shopify.dev/docs/api/partner/2025-01/objects/conversation)
    * [JobRequirement](https://shopify.dev/docs/api/partner/2025-01/objects/jobrequirement)
    * [MerchantUser](https://shopify.dev/docs/api/partner/2025-01/objects/merchantuser)
    * [Money](https://shopify.dev/docs/api/partner/2025-01/objects/money)
    * [MutationRoot](https://shopify.dev/docs/api/partner/2025-01/objects/mutationroot)
    * [Organization](https://shopify.dev/docs/api/partner/2025-01/objects/organization)
    * [PageInfo](https://shopify.dev/docs/api/partner/2025-01/objects/pageinfo)
    * [QueryRoot](https://shopify.dev/docs/api/partner/2025-01/objects/queryroot)
    * [Shop](https://shopify.dev/docs/api/partner/2025-01/objects/shop)
    * [ShopifyEmployee](https://shopify.dev/docs/api/partner/2025-01/objects/shopifyemployee)
    * [SubscriptionApproachingCappedAmount](https://shopify.dev/docs/api/partner/2025-01/objects/subscriptionapproachingcappedamount)
    * [SubscriptionCappedAmountUpdated](https://shopify.dev/docs/api/partner/2025-01/objects/subscriptioncappedamountupdated)
    * [TeamMember](https://shopify.dev/docs/api/partner/2025-01/objects/teammember)
    * [Theme](https://shopify.dev/docs/api/partner/2025-01/objects/theme)

* Jobs

  * Queries

    * [job](https://shopify.dev/docs/api/partner/2025-01/queries/job)
    * [jobs](https://shopify.dev/docs/api/partner/2025-01/queries/jobs)

  * Objects

    * [Job](https://shopify.dev/docs/api/partner/2025-01/objects/job)
    * [Message](https://shopify.dev/docs/api/partner/2025-01/objects/message)
    * [Service](https://shopify.dev/docs/api/partner/2025-01/objects/service)

* Transactions

  * Queries

    * [transaction](https://shopify.dev/docs/api/partner/2025-01/queries/transaction)
    * [transactions](https://shopify.dev/docs/api/partner/2025-01/queries/transactions)

  * Mutations
    * [appCreditCreate](https://shopify.dev/docs/api/partner/2025-01/mutations/appcreditcreate)

  * Objects

    * [AppCredit](https://shopify.dev/docs/api/partner/2025-01/objects/appcredit)
    * [AppOneTimeSale](https://shopify.dev/docs/api/partner/2025-01/objects/apponetimesale)
    * [AppPurchaseOneTime](https://shopify.dev/docs/api/partner/2025-01/objects/apppurchaseonetime)
    * [AppSaleAdjustment](https://shopify.dev/docs/api/partner/2025-01/objects/appsaleadjustment)
    * [AppSaleCredit](https://shopify.dev/docs/api/partner/2025-01/objects/appsalecredit)
    * [AppSubscriptionSale](https://shopify.dev/docs/api/partner/2025-01/objects/appsubscriptionsale)
    * [AppUsageRecord](https://shopify.dev/docs/api/partner/2025-01/objects/appusagerecord)
    * [AppUsageSale](https://shopify.dev/docs/api/partner/2025-01/objects/appusagesale)
    * [LegacyTransaction](https://shopify.dev/docs/api/partner/2025-01/objects/legacytransaction)
    * [ReferralAdjustment](https://shopify.dev/docs/api/partner/2025-01/objects/referraladjustment)
    * [ReferralTransaction](https://shopify.dev/docs/api/partner/2025-01/objects/referraltransaction)
    * [ServiceSale](https://shopify.dev/docs/api/partner/2025-01/objects/servicesale)
    * [ServiceSaleAdjustment](https://shopify.dev/docs/api/partner/2025-01/objects/servicesaleadjustment)
    * [TaxTransaction](https://shopify.dev/docs/api/partner/2025-01/objects/taxtransaction)
    * [ThemeSale](https://shopify.dev/docs/api/partner/2025-01/objects/themesale)
    * [ThemeSaleAdjustment](https://shopify.dev/docs/api/partner/2025-01/objects/themesaleadjustment)

* GraphQL Types

  * Connections

    * [AppEventConnection](https://shopify.dev/docs/api/partner/2025-01/connections/appeventconnection)
    * [ConversationConnection](https://shopify.dev/docs/api/partner/2025-01/connections/conversationconnection)
    * [JobConnection](https://shopify.dev/docs/api/partner/2025-01/connections/jobconnection)
    * [MessageConnection](https://shopify.dev/docs/api/partner/2025-01/connections/messageconnection)
    * [TransactionConnection](https://shopify.dev/docs/api/partner/2025-01/connections/transactionconnection)

  * Enums

    * [AppEventTypes](https://shopify.dev/docs/api/partner/2025-01/enums/appeventtypes)
    * [AppPricingInterval](https://shopify.dev/docs/api/partner/2025-01/enums/apppricinginterval)
    * [ConversationStatus](https://shopify.dev/docs/api/partner/2025-01/enums/conversationstatus)
    * [Currency](https://shopify.dev/docs/api/partner/2025-01/enums/currency)
    * [JobStatus](https://shopify.dev/docs/api/partner/2025-01/enums/jobstatus)
    * [MessageSentVia](https://shopify.dev/docs/api/partner/2025-01/enums/messagesentvia)
    * [ReferralCategory](https://shopify.dev/docs/api/partner/2025-01/enums/referralcategory)
    * [TaxTransactionType](https://shopify.dev/docs/api/partner/2025-01/enums/taxtransactiontype)
    * [TransactionType](https://shopify.dev/docs/api/partner/2025-01/enums/transactiontype)

  * Input objects
    * [MoneyInput](https://shopify.dev/docs/api/partner/2025-01/input-objects/moneyinput)

  * Interfaces

    * [Actor](https://shopify.dev/docs/api/partner/2025-01/interfaces/actor)
    * [AppCharge](https://shopify.dev/docs/api/partner/2025-01/interfaces/appcharge)
    * [AppCreditEvent](https://shopify.dev/docs/api/partner/2025-01/interfaces/appcreditevent)
    * [AppEvent](https://shopify.dev/docs/api/partner/2025-01/interfaces/appevent)
    * [AppPurchaseOneTimeEvent](https://shopify.dev/docs/api/partner/2025-01/interfaces/apppurchaseonetimeevent)
    * [AppSubscriptionEvent](https://shopify.dev/docs/api/partner/2025-01/interfaces/appsubscriptionevent)
    * [AppUsageRecordEvent](https://shopify.dev/docs/api/partner/2025-01/interfaces/appusagerecordevent)
    * [Node](https://shopify.dev/docs/api/partner/2025-01/interfaces/node)
    * [Transaction](https://shopify.dev/docs/api/partner/2025-01/interfaces/transaction)

  * Objects

    * [AppEventEdge](https://shopify.dev/docs/api/partner/2025-01/objects/appeventedge)
    * [ConversationEdge](https://shopify.dev/docs/api/partner/2025-01/objects/conversationedge)
    * [JobEdge](https://shopify.dev/docs/api/partner/2025-01/objects/jobedge)
    * [MessageEdge](https://shopify.dev/docs/api/partner/2025-01/objects/messageedge)
    * [TransactionEdge](https://shopify.dev/docs/api/partner/2025-01/objects/transactionedge)
    * [UserError](https://shopify.dev/docs/api/partner/2025-01/objects/usererror)

  * Payloads
    * [AppCreditCreatePayload](https://shopify.dev/docs/api/partner/2025-01/payloads/appcreditcreatepayload)

  * Scalars

    * [Boolean](https://shopify.dev/docs/api/partner/2025-01/scalars/boolean)
    * [DateTime](https://shopify.dev/docs/api/partner/2025-01/scalars/datetime)
    * [Decimal](https://shopify.dev/docs/api/partner/2025-01/scalars/decimal)
    * [ID](https://shopify.dev/docs/api/partner/2025-01/scalars/id)
    * [Int](https://shopify.dev/docs/api/partner/2025-01/scalars/int)
    * [String](https://shopify.dev/docs/api/partner/2025-01/scalars/string)
    * [Url](https://shopify.dev/docs/api/partner/2025-01/scalars/url)

  * Unions
    * [MessageSender](https://shopify.dev/docs/api/partner/2025-01/unions/messagesender)