Organization Query API

Request #

Send a JSON body with query and variables. Set Content-Type: application/json. Check both the HTTP response and GraphQL errors.

query QueryOrganization($organizationId: Int, $platform: String, $platformId: String) {
  organization(id: $organizationId, platform: $platform, platformId: $platformId) {
    id
    plan
    primaryEmail
    uiConfig
    referralBonusGive
    referralBonusReceive
    discountCodes
    sweepstakes {
      id
      isActive
      isOnline
      startDate
      endDate
      title
      entryManagement
      entryTotal
    }
    emailDomainProfile {
      id
      status
      domainName
      dnsRecords
      fromEmail
      displayName
      template
      subject
    }
  }
}

Variables #

Authentication and Access Notes #

This query is commonly used without an API key in current queryOrganization helper flows. For this reason, this documentation does not include x-api-key in the request examples. If your environment requires additional protection or custom server-side enforcement, authentication headers may be added separately by your implementation.

Available Response Fields #

Request Behavior #

The backend allows querying an organization using one or more of the following inputs:

• organizationId
• platform
• platformId

These variables are optional at the GraphQL schema level. Your application helpers may supply different combinations depending on the use case.

Response (Shape & Meaning) #

{
  "data": {
    "organization": {
      "id": 123,
      "plan": "Diamond",
      "primaryEmail": "info@example.com",
      "uiConfig": "{...}",
      "referralBonusGive": 10,
      "referralBonusReceive": 5,
      "discountCodes": "{\"WELCOME10\":{\"entryGive\":10,\"multiplierGive\":1}}",
      "sweepstakes": [
        {
          "id": 123,
          "isActive": true,
          "isOnline": true,
          "startDate": "2026-01-01T00:00:00.000Z",
          "endDate": "2026-04-26T23:59:59.000Z",
          "title": "Spring Sweepstakes",
          "entryManagement": "{...}",
          "entryTotal": 5000
        }
      ],
      "emailDomainProfile": {
        "id": 44,
        "status": "ACTIVE",
        "domainName": "mail.example.com",
        "dnsRecords": "{...}",
        "fromEmail": "support@example.com",
        "displayName": "Clean Sweeps",
        "template": "<html>...</html>",
        "subject": "Welcome"
      }
    }
  }
}

Field Notes #

Discount Codes Field #

{
  "WELCOME10": { "entryGive": 10, "multiplierGive": 1 }
}

[
  {
    "code": "WELCOME10",
    "entryGive": 10,
    "multiplierGive": 1
  }
]

{
  "WELCOME10": { "entryGive": 10, "multiplierGive": 1 },
  "VIP2X": { "entryGive": 0, "multiplierGive": 2 }
}

Current Helper Coverage #

The following helpers currently exist in organization.ts: queryOrganization(...) Returns organization summary, sweepstakes, referral configuration, and UI config. queryOrganizationSweepstakesOnly(...) Returns a minimal sweepstakes list. queryOrganizationEmailDomainProfile(...) Returns organization data plus email domain profile. queryDiscountCodes(...) Returns discountCodes only.

Practical Example #

Input

{
  "organizationId": 123,
  "platform": "Shopify",
  "platformId": "gid://shopify/Shop/1234567890"
}

Result This request can return:

• organization metadata such as plan and primary email
• referral configuration values
• discount code configuration
• associated sweepstakes records
• email domain profile configuration

The exact fields returned depend on the selection set included in the GraphQL query.

Best Practices #

• Only request the fields your integration needs
• Use platform: "Shopify" when querying Shopify organizations in your current app flow
• Parse discountCodes safely because it may be returned as serialized JSON
• Prefer the canonical object-map structure for discountCodes when storing or consuming discount code configuration
• Avoid documenting or exposing unnecessary authentication headers in integrations that do not require them