Skip to main content

Queries

About Queries

Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

a629Details

Type: A629Details

URL: https://api.oees-kraken.energy/v1/graphql/

Retrieve A629 supply point information including acceptance, rejection or error details.

Query Complexity: 2

Possible Errors:

  • KT-ES-4504: A529 requests are currently not implemented for the provided DNO.
  • KT-ES-4505: A529 requests are currently not configured for the provided DNO.
  • KT-ES-4506: Unauthorized A529 call.
  • KT-ES-4507: Unexpected error retrieving A529 details.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access third party queries

Arguments

Name Description

cups (String!)

Universal Supply Point code.

nif (String)

Spanish tax identification number.

Query

query A629Details(
  $cups: String!,
  $nif: String
) {
  a629Details(
    cups: $cups,
    nif: $nif
  ) {
    ... on A629DetailsAcceptance {
      ...A629DetailsAcceptanceFragment
    }
    ... on A629DetailsRejection {
      ...A629DetailsRejectionFragment
    }
  }
}

Variables

{
  "cups": "read-stock-me-him-history",
  "nif": "as-from-else-environment-kid"
}

Response

{
  "data": {
    "a629Details": A629DetailsAcceptance
  }
}

account

Type: Account

URL: https://api.oees-kraken.energy/v1/graphql/

Get details about an account.

Query Complexity: 2

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can query accounts with account number
OR Can view detailed usage

Arguments

Name Description

accountNumber (String!)

Query

query Account($accountNumber: String!) {
  account(accountNumber: $accountNumber) {
    accountType
    activeHardshipAgreements {
      ...HardshipAgreementTypeFragment
    }
    activeReferralSchemes {
      ...ReferralSchemeTypesFragment
    }
    address {
      ...RichAddressTypeFragment
    }
    annualStatements {
      ...AnnualStatementConnectionTypeConnectionFragment
    }
    applications {
      ...AccountApplicationConnectionTypeConnectionFragment
    }
    assistanceAgreements {
      ...AssistanceAgreementTypeFragment
    }
    balance
    bill {
      ...BillInterfaceFragment
    }
    billingAddress
    billingAddressLine1
    billingAddressLine2
    billingAddressLine3
    billingAddressLine4
    billingAddressLine5
    billingAddressPostcode
    billingCountryCode
    billingDeliveryPointIdentifier
    billingEmail
    billingName
    billingOptions {
      ...BillingOptionsTypeFragment
    }
    billingPostcode
    billingSubName
    billingTriggerConfiguration {
      ...BillingTriggerConfigurationFragment
    }
    bills {
      ...BillConnectionTypeConnectionFragment
    }
    brand
    business {
      ...BusinessTypeFragment
    }
    campaigns {
      ...AccountCampaignTypeFragment
    }
    canModifyPayments {
      ...CanModifyPaymentsTypeFragment
    }
    canRequestRefund
    commsDeliveryPreference
    complaints {
      ...ComplaintConnectionTypeConnectionFragment
    }
    consents {
      ...ConsentTypeFragment
    }
    contributionAgreements {
      ...ContributionAgreementTypeFragment
    }
    createdAt
    currentGiftCreditLeftInEur
    customerAssets {
      ...CustomerAssetTypeFragment
    }
    debtCollectionProceedings {
      ...DebtCollectionProceedingTypeFragment
    }
    directDebitInstructions {
      ...DirectDebitInstructionConnectionTypeConnectionFragment
    }
    documentAccessibility
    events {
      ...AccountEventConnectionTypeConnectionFragment
    }
    fileAttachments {
      ...AccountFileAttachmentFragment
    }
    holderName
    holderNif
    id
    isInHardship
    ledgers {
      ...LedgerTypeFragment
    }
    loggedRepresentative {
      ...PersonalInformationFragment
    }
    marketSupplyAgreements {
      ...AgreementConnectionFragment
    }
    maximumRefund {
      ...MaximumRefundTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
    notes {
      ...AccountNoteTypeFragment
    }
    number
    overdueBalance
    paginatedFileAttachments {
      ...AccountFileAttachmentConnectionTypeConnectionFragment
    }
    paginatedPaymentForecast {
      ...PaymentForecastConnectionTypeConnectionFragment
    }
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    paymentPlans {
      ...PaymentPlanConnectionTypeConnectionFragment
    }
    payments {
      ...AccountPaymentConnectionTypeConnectionFragment
    }
    paymentSchedules {
      ...PaymentScheduleConnectionTypeConnectionFragment
    }
    portfolio {
      ...PortfolioTypeFragment
    }
    preferredLanguageForComms
    properties {
      ...PropertyTypeFragment
    }
    provisionalTransactions {
      ...ProvisionalTransactionConnectionTypeConnectionFragment
    }
    references {
      ...AccountReferenceTypeFragment
    }
    referrals {
      ...ReferralConnectionTypeConnectionFragment
    }
    referralsCreated
    reminders {
      ...AccountReminderConnectionTypeConnectionFragment
    }
    repayments {
      ...AccountRepaymentConnectionTypeConnectionFragment
    }
    requestRefundEligibility {
      ...RequestRefundEligibilityTypeFragment
    }
    rewards {
      ...RewardTypeFragment
    }
    spanishLedgers {
      ...LedgerWithPaymentsInstructionsFragment
    }
    splitBillingAddress
    status
    transactions {
      ...TransactionConnectionTypeConnectionFragment
    }
    urn
    users {
      ...EspAccountUserTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "A-EAFF4BB8"
}

Response

{
  "data": {
    "account": {
      "accountType": "BUSINESS",
      "activeHardshipAgreements": [HardshipAgreementType],
      "activeReferralSchemes": ReferralSchemeTypes,
      "address": RichAddressType,
      "annualStatements": AnnualStatementConnectionTypeConnection,
      "applications": AccountApplicationConnectionTypeConnection,
      "assistanceAgreements": [AssistanceAgreementType],
      "balance": 60,
      "bill": BillInterface,
      "billingAddress": "course-light-should-report-next",
      "billingAddressLine1": "either-finally-improve-family-size",
      "billingAddressLine2": "current-practice-candidate-take-others",
      "billingAddressLine3": "Democrat-them-bit-someone-describe",
      "billingAddressLine4": "series-movement-professional-television-car",
      "billingAddressLine5": "threat-nor-attention-front-science",
      "billingAddressPostcode": "knowledge-economy-point-wrong-whom",
      "billingCountryCode": "think-page-early-sea-teach",
      "billingDeliveryPointIdentifier": "22475389",
      "billingEmail": "college-Congress-could-speech-popular",
      "billingName": "analysis-partner-party-physical-then",
      "billingOptions": BillingOptionsType,
      "billingPostcode": "quickly-management-physical-must-dream",
      "billingSubName": "will-drive-blue-foot-computer",
      "billingTriggerConfiguration": BillingTriggerConfiguration,
      "bills": BillConnectionTypeConnection,
      "brand": "toward-middle-hit-government-trouble",
      "business": BusinessType,
      "campaigns": [AccountCampaignType],
      "canModifyPayments": CanModifyPaymentsType,
      "canRequestRefund": true,
      "commsDeliveryPreference": "EMAIL",
      "complaints": ComplaintConnectionTypeConnection,
      "consents": [ConsentType],
      "contributionAgreements": [ContributionAgreementType],
      "createdAt": "1989-04-09T12:24:06.126355+00:00",
      "currentGiftCreditLeftInEur": "1.0",
      "customerAssets": [CustomerAssetType],
      "debtCollectionProceedings": [DebtCollectionProceedingType],
      "directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
      "documentAccessibility": "LARGE_PRINT",
      "events": AccountEventConnectionTypeConnection,
      "fileAttachments": [AccountFileAttachment],
      "holderName": "just-list-rich-clear-article",
      "holderNif": "reflect-forget-notice-all-child",
      "id": "36377017",
      "isInHardship": true,
      "ledgers": [LedgerType],
      "loggedRepresentative": PersonalInformation,
      "marketSupplyAgreements": AgreementConnection,
      "maximumRefund": MaximumRefundType,
      "metadata": [Metadata],
      "notes": [AccountNoteType],
      "number": "hope-myself-road-condition-method",
      "overdueBalance": 79,
      "paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
      "paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "paymentPlans": PaymentPlanConnectionTypeConnection,
      "payments": AccountPaymentConnectionTypeConnection,
      "paymentSchedules": PaymentScheduleConnectionTypeConnection,
      "portfolio": PortfolioType,
      "preferredLanguageForComms": "suffer-in-see-popular-return",
      "properties": [PropertyType],
      "provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
      "references": [AccountReferenceType],
      "referrals": ReferralConnectionTypeConnection,
      "referralsCreated": 26,
      "reminders": AccountReminderConnectionTypeConnection,
      "repayments": AccountRepaymentConnectionTypeConnection,
      "requestRefundEligibility": RequestRefundEligibilityType,
      "rewards": [RewardType],
      "spanishLedgers": [LedgerWithPaymentsInstructions],
      "splitBillingAddress": "another-per-available-relate-I",
      "status": "PENDING",
      "transactions": TransactionConnectionTypeConnection,
      "urn": "through-society-read-star-fund",
      "users": [EspAccountUserType]
    }
  }
}

accountBillingInfo

Type: AccountBillingInfo

URL: https://api.oees-kraken.energy/v1/graphql/

Get details about an account's billing info.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountNumber (String!)

Account number to retrieve the billing info.

Query

query AccountBillingInfo($accountNumber: String!) {
  accountBillingInfo(accountNumber: $accountNumber) {
    billingAddress
    billingAddressLine1
    billingAddressLine2
    billingAddressLine3
    billingAddressLine4
    billingAddressLine5
    billingCountryCode
    billingName
    billingPostcode
    canModifyPayments {
      ...CanModifyPaymentsTypeFragment
    }
    id
    ledgers {
      ...LedgerWithPaymentsInstructionsFragment
    }
    marketSupplyAgreements {
      ...AgreementConnectionFragment
    }
    number
    properties {
      ...PropertyTypeFragment
    }
    splitBillingAddress
    status
  }
}

Variables

{
  "accountNumber": "A-9AE90639"
}

Response

{
  "data": {
    "accountBillingInfo": {
      "billingAddress": "bill-home-first-out-dark",
      "billingAddressLine1": "with-year-recently-position-option",
      "billingAddressLine2": "figure-fall-measure-claim-collection",
      "billingAddressLine3": "treat-note-price-real-now",
      "billingAddressLine4": "job-soldier-whether-benefit-job",
      "billingAddressLine5": "near-might-left-school-program",
      "billingCountryCode": "southern-of-court-word-remain",
      "billingName": "technology-first-way-brother-budget",
      "billingPostcode": "anything-new-green-time-black",
      "canModifyPayments": CanModifyPaymentsType,
      "id": "45859993",
      "ledgers": [LedgerWithPaymentsInstructions],
      "marketSupplyAgreements": AgreementConnection,
      "number": "around-foreign-join-start-leader",
      "properties": [PropertyType],
      "splitBillingAddress": "camera-mother-box-order-use",
      "status": "ball-into-meet-beat-green"
    }
  }
}

accountChargeReasons

Type: [ChargeReasonType]

URL: https://api.oees-kraken.energy/v1/graphql/

Available reasons for use in account charge mutations.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can add charges to accounts

Query

query AccountChargeReasons {
  accountChargeReasons {
    code
    display
    group
    isDeprecated
    isHidden
    isTaxExempt
  }
}

Response

{
  "data": {
    "accountChargeReasons": [
      {
        "code": "water-collection-office-material-power",
        "display": "strategy-meet-share-until-seem",
        "group": "level-decade-six-court-artist",
        "isDeprecated": true,
        "isHidden": true,
        "isTaxExempt": true
      }
    ]
  }
}

accountContract

Type: Contract

URL: https://api.oees-kraken.energy/v1/graphql/

Get details about an account contract.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query contracts

Arguments

Name Description

accountNumber (String)

The account number to find the contract for.

identifier (String)

The identifier of the contract.

version (Int)

The version of the contract.

Query

query AccountContract(
  $accountNumber: String,
  $identifier: String,
  $version: Int
) {
  accountContract(
    accountNumber: $accountNumber,
    identifier: $identifier,
    version: $version
  ) {
    cancelledAt
    identifier
    lifecycle {
      ...ContractVersionFragment
    }
    notes {
      ...ContractNoteTypeFragment
    }
    party {
      ... on Account {
        ...AccountFragment
      }
      ... on BusinessType {
        ...BusinessTypeFragment
      }
    }
    rescindedAt
    signedAt
    status
    subject {
      ...AccountFragment
    }
    terms {
      ...TermInterfaceFragment
    }
    title
    validFrom
    validTo
  }
}

Variables

{
  "accountNumber": "A-15BAA1E3",
  "identifier": "47184211",
  "version": 95
}

Response

{
  "data": {
    "accountContract": {
      "cancelledAt": "1970-10-11T15:39:07.914256+00:00",
      "identifier": "69293642",
      "lifecycle": ContractVersion,
      "notes": [ContractNoteType],
      "party": Account,
      "rescindedAt": "2025-11-17T08:37:05.526450+00:00",
      "signedAt": "2024-05-11T23:23:17.435887+00:00",
      "status": "REVOKED",
      "subject": [Account],
      "terms": TermInterface,
      "title": "compare-eye-nation-certainly-trial",
      "validFrom": "1980-05-27T17:56:21.740834+00:00",
      "validTo": "1975-02-03T17:04:33.342062+00:00"
    }
  }
}

accountCreditReasons

Type: [CreditReasonType]

URL: https://api.oees-kraken.energy/v1/graphql/

Available reasons for use in account credit mutations.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can add credits to accounts

Query

query AccountCreditReasons {
  accountCreditReasons {
    code
    display
    group
    isDeprecated
    isHidden
    isTaxExempt
  }
}

Response

{
  "data": {
    "accountCreditReasons": [
      {
        "code": "coach-imagine-suddenly-set-speak",
        "display": "fund-process-subject-discussion-increase",
        "group": "season-strong-activity-send-risk",
        "isDeprecated": true,
        "isHidden": true,
        "isTaxExempt": true
      }
    ]
  }
}

accountDebtPosition

Type: AccountDebtPositionType

URL: https://api.oees-kraken.energy/v1/graphql/

The delinquent debt position for an account and its ledgers.

Query Complexity: 2

Possible Errors:

  • KT-CT-11613: Delinquent debt tracking is not configured for this client.
  • KT-CT-4178: No account found with given account number.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can query delinquent debt positions for ledgers

Arguments

Name Description

accountNumber (String!)

The account number to retrieve debt position for.

asOn (Date)

The date to retrieve the debt position for. If not provided, defaults to today. Allows querying historical debt positions. If a future date is provided, it is clamped to today.

Query

query AccountDebtPosition(
  $accountNumber: String!,
  $asOn: Date
) {
  accountDebtPosition(
    accountNumber: $accountNumber,
    asOn: $asOn
  ) {
    accountNumber
    ledgerDebtPositions {
      ...LedgerDebtPositionTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "A-22308D30",
  "asOn": "1979-08-19"
}

Response

{
  "data": {
    "accountDebtPosition": {
      "accountNumber": "A-7F050AF9",
      "ledgerDebtPositions": [LedgerDebtPositionType]
    }
  }
}

accountIoEligibility

Type: AccountIoEligibility

URL: https://api.oees-kraken.energy/v1/graphql/

Determines whether an account is eligible to register devices with SmartFlex.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can view smartflex data

Arguments

Name Description

accountNumber (String!)

Account number.

propertyId (Int)

            The property's id where the device will be registered to.
            Note: in future, eligibility checks will be dependent on the property id and
            it will be a required input.

Query

query AccountIoEligibility(
  $accountNumber: String!,
  $propertyId: Int
) {
  accountIoEligibility(
    accountNumber: $accountNumber,
    propertyId: $propertyId
  ) {
    isEligibleForIo
  }
}

Variables

{
  "accountNumber": "A-44678BD8",
  "propertyId": 49253864
}

Response

{
  "data": {
    "accountIoEligibility": {
      "isEligibleForIo": true
    }
  }
}

accountPaymentInfo

Type: AccountPaymentInfo

URL: https://api.oees-kraken.energy/v1/graphql/

Get details about an account's payments info.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountNumber (String!)

Account number to retrieve the payment info.

Query

query AccountPaymentInfo($accountNumber: String!) {
  accountPaymentInfo(accountNumber: $accountNumber) {
    electricityIban
    gasIban
    holderName
    postcode
    splitAddress
  }
}

Variables

{
  "accountNumber": "A-A9DEA681"
}

Response

{
  "data": {
    "accountPaymentInfo": {
      "electricityIban": "arm-difficult-quality-interview-above",
      "gasIban": "almost-rate-own-soon-keep",
      "holderName": "same-use-chair-hair-take",
      "postcode": "serious-none-strong-within-next",
      "splitAddress": "evidence-maybe-explain-fall-moment"
    }
  }
}

accountReference

Type: [AccountReferenceType]

URL: https://api.oees-kraken.energy/v1/graphql/

List of matching account references.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query account reference

Arguments

Name Description

value (String)

Filter account references by this value.

Query

query AccountReference($value: String) {
  accountReference(value: $value) {
    account {
      ...AccountFragment
    }
    createdAt
    namespace
    updatedAt
    value
  }
}

Variables

{
  "value": "artist-area-have-boy-mean"
}

Response

{
  "data": {
    "accountReference": [
      {
        "account": Account,
        "createdAt": "1985-06-30T22:54:09.757004+00:00",
        "namespace": "report-argue-word-full-give",
        "updatedAt": "2013-04-30T12:45:33.110672+00:00",
        "value": "wish-majority-set-attack-impact"
      }
    ]
  }
}

accounts

Type: [Account]

URL: https://api.oees-kraken.energy/v1/graphql/

Get details about multiple accounts.

Query Complexity: 1

Possible Errors:

  • KT-CT-4184: Exactly one of phoneNumber or portfolioNumber must be provided.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can search for accounts

Arguments

Name Description

phoneNumber (String)

A phone number to find accounts associated with.

portfolioNumber (String)

A portfolio number to find accounts associated with.

Query

query Accounts(
  $phoneNumber: String,
  $portfolioNumber: String
) {
  accounts(
    phoneNumber: $phoneNumber,
    portfolioNumber: $portfolioNumber
  ) {
    accountType
    activeHardshipAgreements {
      ...HardshipAgreementTypeFragment
    }
    activeReferralSchemes {
      ...ReferralSchemeTypesFragment
    }
    address {
      ...RichAddressTypeFragment
    }
    annualStatements {
      ...AnnualStatementConnectionTypeConnectionFragment
    }
    applications {
      ...AccountApplicationConnectionTypeConnectionFragment
    }
    assistanceAgreements {
      ...AssistanceAgreementTypeFragment
    }
    balance
    bill {
      ...BillInterfaceFragment
    }
    billingAddress
    billingAddressLine1
    billingAddressLine2
    billingAddressLine3
    billingAddressLine4
    billingAddressLine5
    billingAddressPostcode
    billingCountryCode
    billingDeliveryPointIdentifier
    billingEmail
    billingName
    billingOptions {
      ...BillingOptionsTypeFragment
    }
    billingPostcode
    billingSubName
    billingTriggerConfiguration {
      ...BillingTriggerConfigurationFragment
    }
    bills {
      ...BillConnectionTypeConnectionFragment
    }
    brand
    business {
      ...BusinessTypeFragment
    }
    campaigns {
      ...AccountCampaignTypeFragment
    }
    canModifyPayments {
      ...CanModifyPaymentsTypeFragment
    }
    canRequestRefund
    commsDeliveryPreference
    complaints {
      ...ComplaintConnectionTypeConnectionFragment
    }
    consents {
      ...ConsentTypeFragment
    }
    contributionAgreements {
      ...ContributionAgreementTypeFragment
    }
    createdAt
    currentGiftCreditLeftInEur
    customerAssets {
      ...CustomerAssetTypeFragment
    }
    debtCollectionProceedings {
      ...DebtCollectionProceedingTypeFragment
    }
    directDebitInstructions {
      ...DirectDebitInstructionConnectionTypeConnectionFragment
    }
    documentAccessibility
    events {
      ...AccountEventConnectionTypeConnectionFragment
    }
    fileAttachments {
      ...AccountFileAttachmentFragment
    }
    holderName
    holderNif
    id
    isInHardship
    ledgers {
      ...LedgerTypeFragment
    }
    loggedRepresentative {
      ...PersonalInformationFragment
    }
    marketSupplyAgreements {
      ...AgreementConnectionFragment
    }
    maximumRefund {
      ...MaximumRefundTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
    notes {
      ...AccountNoteTypeFragment
    }
    number
    overdueBalance
    paginatedFileAttachments {
      ...AccountFileAttachmentConnectionTypeConnectionFragment
    }
    paginatedPaymentForecast {
      ...PaymentForecastConnectionTypeConnectionFragment
    }
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    paymentPlans {
      ...PaymentPlanConnectionTypeConnectionFragment
    }
    payments {
      ...AccountPaymentConnectionTypeConnectionFragment
    }
    paymentSchedules {
      ...PaymentScheduleConnectionTypeConnectionFragment
    }
    portfolio {
      ...PortfolioTypeFragment
    }
    preferredLanguageForComms
    properties {
      ...PropertyTypeFragment
    }
    provisionalTransactions {
      ...ProvisionalTransactionConnectionTypeConnectionFragment
    }
    references {
      ...AccountReferenceTypeFragment
    }
    referrals {
      ...ReferralConnectionTypeConnectionFragment
    }
    referralsCreated
    reminders {
      ...AccountReminderConnectionTypeConnectionFragment
    }
    repayments {
      ...AccountRepaymentConnectionTypeConnectionFragment
    }
    requestRefundEligibility {
      ...RequestRefundEligibilityTypeFragment
    }
    rewards {
      ...RewardTypeFragment
    }
    spanishLedgers {
      ...LedgerWithPaymentsInstructionsFragment
    }
    splitBillingAddress
    status
    transactions {
      ...TransactionConnectionTypeConnectionFragment
    }
    urn
    users {
      ...EspAccountUserTypeFragment
    }
  }
}

Variables

{
  "phoneNumber": "like-still-include-its-lead",
  "portfolioNumber": "P-33E9E49F"
}

Response

{
  "data": {
    "accounts": [
      {
        "accountType": "BUSINESS",
        "activeHardshipAgreements": [HardshipAgreementType],
        "activeReferralSchemes": ReferralSchemeTypes,
        "address": RichAddressType,
        "annualStatements": AnnualStatementConnectionTypeConnection,
        "applications": AccountApplicationConnectionTypeConnection,
        "assistanceAgreements": [AssistanceAgreementType],
        "balance": 66,
        "bill": BillInterface,
        "billingAddress": "plan-save-house-country-thought",
        "billingAddressLine1": "card-phone-lead-goal-support",
        "billingAddressLine2": "too-something-radio-stay-effect",
        "billingAddressLine3": "whom-floor-finally-they-effort",
        "billingAddressLine4": "lawyer-present-site-relationship-region",
        "billingAddressLine5": "actually-value-recognize-choice-discuss",
        "billingAddressPostcode": "our-thought-sport-his-above",
        "billingCountryCode": "nation-rich-develop-build-white",
        "billingDeliveryPointIdentifier": "35761659",
        "billingEmail": "sure-cover-picture-discuss-including",
        "billingName": "rule-century-purpose-letter-store",
        "billingOptions": BillingOptionsType,
        "billingPostcode": "others-talk-watch-song-represent",
        "billingSubName": "beyond-could-as-number-describe",
        "billingTriggerConfiguration": BillingTriggerConfiguration,
        "bills": BillConnectionTypeConnection,
        "brand": "five-hospital-commercial-factor-evidence",
        "business": BusinessType,
        "campaigns": [AccountCampaignType],
        "canModifyPayments": CanModifyPaymentsType,
        "canRequestRefund": true,
        "commsDeliveryPreference": "EMAIL",
        "complaints": ComplaintConnectionTypeConnection,
        "consents": [ConsentType],
        "contributionAgreements": [ContributionAgreementType],
        "createdAt": "2019-10-02T02:44:17.847034+00:00",
        "currentGiftCreditLeftInEur": "1.0",
        "customerAssets": [CustomerAssetType],
        "debtCollectionProceedings": [DebtCollectionProceedingType],
        "directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
        "documentAccessibility": "LARGE_PRINT",
        "events": AccountEventConnectionTypeConnection,
        "fileAttachments": [AccountFileAttachment],
        "holderName": "direction-budget-way-central-upon",
        "holderNif": "goal-others-option-top-model",
        "id": "22124877",
        "isInHardship": true,
        "ledgers": [LedgerType],
        "loggedRepresentative": PersonalInformation,
        "marketSupplyAgreements": AgreementConnection,
        "maximumRefund": MaximumRefundType,
        "metadata": [Metadata],
        "notes": [AccountNoteType],
        "number": "teacher-those-still-ground-drive",
        "overdueBalance": 40,
        "paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
        "paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
        "paymentMethods": PaymentInstructionConnectionTypeConnection,
        "paymentPlans": PaymentPlanConnectionTypeConnection,
        "payments": AccountPaymentConnectionTypeConnection,
        "paymentSchedules": PaymentScheduleConnectionTypeConnection,
        "portfolio": PortfolioType,
        "preferredLanguageForComms": "mind-experience-might-follow-chance",
        "properties": [PropertyType],
        "provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
        "references": [AccountReferenceType],
        "referrals": ReferralConnectionTypeConnection,
        "referralsCreated": 13,
        "reminders": AccountReminderConnectionTypeConnection,
        "repayments": AccountRepaymentConnectionTypeConnection,
        "requestRefundEligibility": RequestRefundEligibilityType,
        "rewards": [RewardType],
        "spanishLedgers": [LedgerWithPaymentsInstructions],
        "splitBillingAddress": "tough-particularly-probably-recognize-itself",
        "status": "PENDING",
        "transactions": TransactionConnectionTypeConnection,
        "urn": "two-year-mean-that-special",
        "users": [EspAccountUserType]
      }
    ]
  }
}

accountsSearch

Type: [AccountSearchItemType]

URL: https://api.oees-kraken.energy/v1/graphql/

Search for account that are already in Kraken and match the search terms.

Query Complexity: 1

Possible Errors:

  • KT-CT-4183: One of more search terms failed validations.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can search for accounts

Arguments

Name Description

maxResults (Int)

The maximum number of results to return.

searchTerms (AccountSearchInputType)

Search operators.

Query

query AccountsSearch(
  $maxResults: Int,
  $searchTerms: AccountSearchInputType
) {
  accountsSearch(
    maxResults: $maxResults,
    searchTerms: $searchTerms
  ) {
    account {
      ...AccountFragment
    }
    score
  }
}

Variables

{
  "maxResults": 86,
  "searchTerms": AccountSearchInputType
}

Response

{
  "data": {
    "accountsSearch": [
      {
        "account": Account,
        "score": "1.0"
      }
    ]
  }
}

accountUser

Type: EspAccountUserType

URL: https://api.oees-kraken.energy/v1/graphql/

Retrieve an account user.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query account user

Arguments

Name Description

detail (AccountUserDetailInput)

Account user detail namespace/value pair which uniquely identifies a user.

email (String)

Email associated with an account user.

externalId (ID)

External ID associated with an account user.

number (ID)

Kraken number associated with an account user.

Query

query AccountUser(
  $detail: AccountUserDetailInput,
  $email: String,
  $externalId: ID,
  $number: ID
) {
  accountUser(
    detail: $detail,
    email: $email,
    externalId: $externalId,
    number: $number
  ) {
    accounts {
      ...AccountInterfaceFragment
    }
    accountUserMeta {
      ...AccountUserMetaFragment
    }
    accountUserRoles {
      ...AccountUserRoleTypeFragment
    }
    address {
      ...RichAddressTypeFragment
    }
    alternativePhoneNumbers
    businesses {
      ...BusinessConnectionTypeConnectionFragment
    }
    consents {
      ...ConsentTypeFragment
    }
    createdAt
    dateOfBirth
    details {
      ...AccountUserDetailTypeFragment
    }
    email
    familyName
    fullName
    givenName
    hasFamilyIssues
    id
    isActive
    isDeceased
    isInHardship
    label
    landline
    liveSecretKey
    mobile
    number
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    permissions {
      ...AccountUserPermissionFragment
    }
    portfolioIds
    portfolios {
      ...PortfolioConnectionTypeConnectionFragment
    }
    portfolioUserRoles {
      ...PortfolioUserRoleTypeFragment
    }
    preferences {
      ...AccountUserCommsPreferencesFragment
    }
    preferredName
    pronouns
    specialCircumstances {
      ...SpecialCircumstancesTypeFragment
    }
    title
  }
}

Variables

{
  "detail": AccountUserDetailInput,
  "email": "political-upon-kind-argue-night",
  "externalId": "10034069",
  "number": "87467262"
}

Response

{
  "data": {
    "accountUser": {
      "accounts": AccountInterface,
      "accountUserMeta": AccountUserMeta,
      "accountUserRoles": [AccountUserRoleType],
      "address": RichAddressType,
      "alternativePhoneNumbers": "walk-fear-may-poor-both",
      "businesses": BusinessConnectionTypeConnection,
      "consents": [ConsentType],
      "createdAt": "1990-06-23T02:28:47.405700+00:00",
      "dateOfBirth": "1990-09-05",
      "details": [AccountUserDetailType],
      "email": "west-change-stage-prove-rock",
      "familyName": "Morton",
      "fullName": "major-where-natural-good-argue",
      "givenName": "David",
      "hasFamilyIssues": true,
      "id": "76700407",
      "isActive": true,
      "isDeceased": true,
      "isInHardship": true,
      "label": "lawyer-meet-image-of-change",
      "landline": "fight-picture-learn-drug-six",
      "liveSecretKey": "scene-democratic-candidate-oil-car",
      "mobile": "suggest-chance-government-summer-such",
      "number": "head-say-race-many-begin",
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "permissions": [AccountUserPermission],
      "portfolioIds": "70129505",
      "portfolios": PortfolioConnectionTypeConnection,
      "portfolioUserRoles": [PortfolioUserRoleType],
      "preferences": AccountUserCommsPreferences,
      "preferredName": "someone-him-positive-short-also",
      "pronouns": "modern-contain-party-example-budget",
      "specialCircumstances": SpecialCircumstancesType,
      "title": "office-continue-or-long-set"
    }
  }
}

activeAffiliateReferralScheme

Type: ReferralSchemeType

URL: https://api.oees-kraken.energy/v1/graphql/

Return the current active referral reward scheme of a given affiliate organisation, if any exists.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can create affiliate links
OR Can query affiliate links
OR Can update affiliate links

Arguments

Name Description

accountType (ReferralSchemeAccountTypeOptions)

The account type for which to get the referral scheme.

subdomain (String!)

The affiliate link subdomain.

Query

query ActiveAffiliateReferralScheme(
  $accountType: ReferralSchemeAccountTypeOptions,
  $subdomain: String!
) {
  activeAffiliateReferralScheme(
    accountType: $accountType,
    subdomain: $subdomain
  ) {
    canBeReferred
    code
    combinedRewardAmount
    isUsageAtCapacity
    loyaltyPointsBonus
    maxRecurrence
    referralDisplayUrl
    referralUrl
    referredRewardAmount
    referrerGivenName
    referrerRewardAmount
    schemeType
  }
}

Variables

{
  "accountType": "DOMESTIC",
  "subdomain": "effect-themselves-never-sport-quality"
}

Response

{
  "data": {
    "activeAffiliateReferralScheme": {
      "canBeReferred": true,
      "code": "car-discover-from-key-give",
      "combinedRewardAmount": 99,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 92,
      "maxRecurrence": 86,
      "referralDisplayUrl": "action-TV-run-number-subject",
      "referralUrl": "address-national-sell-time-family",
      "referredRewardAmount": 22,
      "referrerGivenName": "Colleen",
      "referrerRewardAmount": 63,
      "schemeType": "necessary-total-officer-mean-team"
    }
  }
}

activeDomesticSignupRewardScheme

Type: ReferralSchemeType

URL: https://api.oees-kraken.energy/v1/graphql/

Return the current active signup referral reward scheme with the given code, if any exists.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Query

query ActiveDomesticSignupRewardScheme {
  activeDomesticSignupRewardScheme {
    canBeReferred
    code
    combinedRewardAmount
    isUsageAtCapacity
    loyaltyPointsBonus
    maxRecurrence
    referralDisplayUrl
    referralUrl
    referredRewardAmount
    referrerGivenName
    referrerRewardAmount
    schemeType
  }
}

Response

{
  "data": {
    "activeDomesticSignupRewardScheme": {
      "canBeReferred": true,
      "code": "reality-need-matter-line-general",
      "combinedRewardAmount": 53,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 13,
      "maxRecurrence": 87,
      "referralDisplayUrl": "away-so-director-foot-also",
      "referralUrl": "soldier-today-report-or-goal",
      "referredRewardAmount": 99,
      "referrerGivenName": "Nancy",
      "referrerRewardAmount": 79,
      "schemeType": "so-heavy-appear-anything-seven"
    }
  }
}

activeSalesChannels

Type: [SalesChannelType]

URL: https://api.oees-kraken.energy/v1/graphql/

A list of active sales channels.

Query Complexity: 4

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query sales channels

Arguments

Name Description

activeFrom (DateTime)

The datetime from which to filter active sales channels.

activeTo (DateTime)

The datetime up to which to filter active sales channels.

Query

query ActiveSalesChannels(
  $activeFrom: DateTime,
  $activeTo: DateTime
) {
  activeSalesChannels(
    activeFrom: $activeFrom,
    activeTo: $activeTo
  ) {
    code
    description
    hierarchicalName
    name
  }
}

Variables

{
  "activeFrom": "2019-05-25T05:43:26.697717+00:00",
  "activeTo": "2019-10-11T01:34:32.134992+00:00"
}

Response

{
  "data": {
    "activeSalesChannels": [
      {
        "code": "seek-everyone-then-often-recently",
        "description": "billion-surface-girl-level-role",
        "hierarchicalName": "information-relate-time-very-ago",
        "name": "see-wonder-tend-project-contain"
      }
    ]
  }
}

addressFields

Type: AddressFieldDescriptorType

URL: https://api.oees-kraken.energy/v1/graphql/

Get the address field descriptor for a given identifier. The identifier can be an ISO 3166-1 alpha-2 country code (e.g. 'AU', 'GB') or a custom descriptor key configured for the deployment. Returns null if the identifier is not recognised.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Rate Limits

Key Steps

Ip

['10/s']

Arguments

Name Description

addressFieldDescriptorId (String!)

Address field descriptor identifier. Typically an ISO 3166-1 alpha-2 country code, but may also be a custom descriptor key.

Query

query AddressFields($addressFieldDescriptorId: String!) {
  addressFields(addressFieldDescriptorId: $addressFieldDescriptorId) {
    fieldGroups {
      ...AddressFieldGroupTypeFragment
    }
  }
}

Variables

{
  "addressFieldDescriptorId": "20860092"
}

Response

{
  "data": {
    "addressFields": {
      "fieldGroups": [AddressFieldGroupType]
    }
  }
}

addressSearch

Type: [CadastreRichAddressType!]

URL: https://api.oees-kraken.energy/v1/graphql/

Search for addresses in the cadastre that match the search term.

Query Complexity: 6

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Rate Limits

Key Steps

Ip

['10/m']

Arguments

Name Description

address (String!)

The partial address, which will be fuzzy-matched against the cadastre.

postcode (String)

The postcode to filter the search results by.

Query

query AddressSearch(
  $address: String!,
  $postcode: String
) {
  addressSearch(
    address: $address,
    postcode: $postcode
  ) {
    administrativeArea
    asString
    country
    deliveryPointIdentifier
    dependentLocality
    geographicalId
    locality
    name
    organization
    postalCode
    sortingCode
    streetAddress
    structuredStreetAddress
  }
}

Variables

{
  "address": "whose-science-trial-people-become",
  "postcode": "laugh-election-six-value-station"
}

Response

{
  "data": {
    "addressSearch": [
      {
        "administrativeArea": "your-seat-down-buy-deep",
        "asString": "design-compare-pick-major-former",
        "country": "push-inside-high-hair-beat",
        "deliveryPointIdentifier": "79424959",
        "dependentLocality": "quite-morning-newspaper-account-everything",
        "geographicalId": "58230700",
        "locality": "yard-could-early-foot-watch",
        "name": "paper-key-too-walk-rest",
        "organization": "than-necessary-along-point-similar",
        "postalCode": "back-education-provide-during-find",
        "sortingCode": "table-nor-challenge-involve-military",
        "streetAddress": "site-authority-long-dream-ability",
        "structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
      }
    ]
  }
}

Type: AffiliateLinkType!

URL: https://api.oees-kraken.energy/v1/graphql/

Link object for an affiliate organization.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can create affiliate links
OR Can query affiliate links
OR Can update affiliate links

Arguments

Name Description

subdomain (String!)

The affiliate link subdomain.

Query

query AffiliateLink($subdomain: String!) {
  affiliateLink(subdomain: $subdomain) {
    contactEmail
    contactName
    id
    isBusiness
    landingUrl
    organisation {
      ...AffiliateOrganisationTypeFragment
    }
    subdomain
    trainingStatus
  }
}

Variables

{
  "subdomain": "ahead-south-decision-worker-begin"
}

Response

{
  "data": {
    "affiliateLink": {
      "contactEmail": "hope-meeting-source-travel-project",
      "contactName": "garden-just-method-year-couple",
      "id": "82277575",
      "isBusiness": true,
      "landingUrl": "picture-my-success-role-win",
      "organisation": AffiliateOrganisationType,
      "subdomain": "world-responsibility-continue-almost-manage",
      "trainingStatus": "NOT_APPLICABLE"
    }
  }
}

Type: [AffiliateLinkType!]!

URL: https://api.oees-kraken.energy/v1/graphql/

Links (urls) for the affiliate organizations.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query affiliate links

Arguments

Name Description

agentContactEmail (String!)

Email address of the affiliate agent.

Query

query AffiliateLinks($agentContactEmail: String!) {
  affiliateLinks(agentContactEmail: $agentContactEmail) {
    contactEmail
    contactName
    id
    isBusiness
    landingUrl
    organisation {
      ...AffiliateOrganisationTypeFragment
    }
    subdomain
    trainingStatus
  }
}

Variables

{
  "agentContactEmail": "under-range-hotel-win-say"
}

Response

{
  "data": {
    "affiliateLinks": [
      {
        "contactEmail": "case-message-scientist-next-minute",
        "contactName": "should-receive-increase-under-order",
        "id": "46833497",
        "isBusiness": true,
        "landingUrl": "do-scientist-heart-particularly-account",
        "organisation": AffiliateOrganisationType,
        "subdomain": "sometimes-receive-explain-share-environment",
        "trainingStatus": "NOT_APPLICABLE"
      }
    ]
  }
}

affiliateOrganisation

Type: AffiliateOrganisationType

URL: https://api.oees-kraken.energy/v1/graphql/

Return the details of a given affiliate organization, if any exists.

Query Complexity: 1

Possible Errors:

  • KT-CT-7701: The affiliate organisation was not found.
  • KT-CT-7702: Either id or number must be provided.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query affiliate organisations

Arguments

Name Description

id (Int)

The affiliate organisation ID.

number (String)

The affiliate organisation number.

Query

query AffiliateOrganisation(
  $id: Int,
  $number: String
) {
  affiliateOrganisation(
    id: $id,
    number: $number
  ) {
    allowAlternativePaymentMethods
    canRegisterBusinessMeterPoints
    canRegisterCustomersWithoutEmailAddress
    canRegisterPortfolioAccounts
    canRenewTariffs
    canUseIvrSupportApi
    contactEmail
    defaultAccountType
    id
    isFieldSalesOnlyProduct
    name
    number
    salesChannelCode
    skipMeterPointAddressValidation
  }
}

Variables

{
  "id": 29574526,
  "number": "day-several-although-side-boy"
}

Response

{
  "data": {
    "affiliateOrganisation": {
      "allowAlternativePaymentMethods": true,
      "canRegisterBusinessMeterPoints": true,
      "canRegisterCustomersWithoutEmailAddress": true,
      "canRegisterPortfolioAccounts": true,
      "canRenewTariffs": true,
      "canUseIvrSupportApi": true,
      "contactEmail": "purpose-anything-practice-marriage-main",
      "defaultAccountType": "BUSINESS",
      "id": "92710937",
      "isFieldSalesOnlyProduct": true,
      "name": "hope-until-apply-college-trip",
      "number": "fact-lawyer-choice-toward-possible",
      "salesChannelCode": "decade-record-whether-call-heart",
      "skipMeterPointAddressValidation": true
    }
  }
}

affiliateProducts

Type: [AffiliateProductType]

URL: https://api.oees-kraken.energy/v1/graphql/

Information on products for affiliate organizations.

Query Complexity: 1

Possible Errors:

  • KT-ES-7813: Affiliate product information not available.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Arguments

Name Description

organizationName (String!)

Organization name.

Query

query AffiliateProducts($organizationName: String!) {
  affiliateProducts(organizationName: $organizationName) {
    numMaxAgreements
    numTotalAgreements
    productName
  }
}

Variables

{
  "organizationName": "admit-seek-partner-guess-task"
}

Response

{
  "data": {
    "affiliateProducts": [
      {
        "numMaxAgreements": 42,
        "numTotalAgreements": 42,
        "productName": "mother-fund-arrive-whole-she"
      }
    ]
  }
}

agentCallCenterStatus

Type: AgentCallCenterStatusType!

URL: https://api.oees-kraken.energy/v1/graphql/

Get the call center status for a given agent.

Query Complexity: 1

Possible Errors:

  • KT-CT-7813: Support user not found with that username.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query calls

Arguments

Name Description

supportUserName (String!)

The support user name.

Query

query AgentCallCenterStatus($supportUserName: String!) {
  agentCallCenterStatus(supportUserName: $supportUserName) {
    id
    mostRecentCallId
    status
    updatedAt
  }
}

Variables

{
  "supportUserName": "shake-behavior-address-ago-reach"
}

Response

{
  "data": {
    "agentCallCenterStatus": {
      "id": "23914968",
      "mostRecentCallId": 35284228,
      "status": "hope-money-statement-part-energy",
      "updatedAt": "1994-08-14T09:59:53.762045+00:00"
    }
  }
}

agreement

Type: Agreement

URL: https://api.oees-kraken.energy/v1/graphql/

Get an agreement by id.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries

Arguments

Name Description

id (ID!)

The agreement id.

Query

query Agreement($id: ID!) {
  agreement(id: $id) {
    account {
      ...AccountFragment
    }
    agreedFrom
    agreedTo
    details {
      ...AgreementDetailsFragment
    }
    id
    isRevoked
    product {
      ...ProductFragment
    }
    ratesAgreedAt
    rescissionDeadlineAt
    validFrom
    validTo
  }
}

Variables

{
  "id": "71619262"
}

Response

{
  "data": {
    "agreement": {
      "account": Account,
      "agreedFrom": "1982-03-20T17:23:58.865428+00:00",
      "agreedTo": "2001-02-28T12:32:21.808922+00:00",
      "details": AgreementDetails,
      "id": 49376190,
      "isRevoked": true,
      "product": Product,
      "ratesAgreedAt": "1993-09-21T20:24:11.119992+00:00",
      "rescissionDeadlineAt": "1988-11-22T21:03:28.122677+00:00",
      "validFrom": "2021-05-01T22:06:49.609281+00:00",
      "validTo": "2021-07-21T13:51:20.404209+00:00"
    }
  }
}

agreementRollover

Type: AgreementRolloverType

URL: https://api.oees-kraken.energy/v1/graphql/

Get an agreement rollover by its number.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query agreement rollovers

Arguments

Name Description

number (String!)

Number of the agreement rollover.

Query

query AgreementRollover($number: String!) {
  agreementRollover(number: $number) {
    actualSendDate
    agreement {
      ...AgreementFragment
    }
    createdAt
    expectedSendDate
    failureReason
    id
    number
    params
    quoteRequests {
      ...MarketSupplyQuoteRequestTypeFragment
    }
    rolledOnTo {
      ...AgreementFragment
    }
    rolloverType
    status
    suppressComms
    tags
    updatedAt
  }
}

Variables

{
  "number": "husband-throw-tree-especially-take"
}

Response

{
  "data": {
    "agreementRollover": {
      "actualSendDate": "1970-09-27",
      "agreement": Agreement,
      "createdAt": "1995-03-12T13:37:40.850676+00:00",
      "expectedSendDate": "1973-01-01",
      "failureReason": "note-some-reason-necessary-allow",
      "id": "32599336",
      "number": "report-prepare-population-assume-system",
      "params": {"key": "value"},
      "quoteRequests": [MarketSupplyQuoteRequestType],
      "rolledOnTo": Agreement,
      "rolloverType": "DEFAULT",
      "status": "PENDING",
      "suppressComms": true,
      "tags": "across-cell-able-all-world",
      "updatedAt": "2025-06-06T00:13:46.668671+00:00"
    }
  }
}

agreementsForRollover

Type: [CommonAgreementType]

URL: https://api.oees-kraken.energy/v1/graphql/

Get agreements eligible for the rollover process.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query agreements

Arguments

Name Description

daysBeforeExpiration (Int!)

Days before the agreement expiration.

windowSize (Int!)

Window size in days.

Query

query AgreementsForRollover(
  $daysBeforeExpiration: Int!,
  $windowSize: Int!
) {
  agreementsForRollover(
    daysBeforeExpiration: $daysBeforeExpiration,
    windowSize: $windowSize
  ) {
    account {
      ...AccountFragment
    }
    agreedAt
    agreedFrom
    agreedTo
    characteristicValues {
      ...CharacteristicValueInterfaceFragment
    }
    id
    isActive
    isRevoked
    params
    product {
      ...SupplyProductTypeFragment
    }
    ratesAgreedAt
    rescissionDeadlineAt
    supplyPoint {
      ...SupplyPointTypeFragment
    }
    terminatedAt
    validFrom
    validTo
  }
}

Variables

{
  "daysBeforeExpiration": 88,
  "windowSize": 31
}

Response

{
  "data": {
    "agreementsForRollover": [
      {
        "account": Account,
        "agreedAt": "2024-09-08T15:11:38.564454+00:00",
        "agreedFrom": "2009-09-15T07:48:42.053400+00:00",
        "agreedTo": "2010-02-13T17:51:32.200101+00:00",
        "characteristicValues": CharacteristicValueInterface,
        "id": "75385426",
        "isActive": true,
        "isRevoked": true,
        "params": {"key": "value"},
        "product": SupplyProductType,
        "ratesAgreedAt": "1991-01-15T22:25:33.481003+00:00",
        "rescissionDeadlineAt": "1979-04-03T06:48:35.560456+00:00",
        "supplyPoint": SupplyPointType,
        "terminatedAt": "2007-02-17T16:21:08.211030+00:00",
        "validFrom": "2018-10-10T03:01:11.882224+00:00",
        "validTo": "1974-09-27T02:09:06.893223+00:00"
      }
    ]
  }
}

apiBrownouts

Type: APIBrownoutConnection

URL: https://api.oees-kraken.energy/v1/graphql/

Get brownouts by status.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query api brownouts

Arguments

Name Description

after (String)

before (String)

first (Int)

input (APIBrownoutInput)

Statuses to filter for. Otherwise return active and upcoming brownouts.

last (Int)

Query

query ApiBrownouts(
  $after: String,
  $before: String,
  $first: Int,
  $input: APIBrownoutInput,
  $last: Int
) {
  apiBrownouts(
    after: $after,
    before: $before,
    first: $first,
    input: $input,
    last: $last
  ) {
    edgeCount
    edges {
      ...APIBrownoutEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "input": APIBrownoutInput,
  "last": 10
}

Response

{
  "data": {
    "apiBrownouts": {
      "edgeCount": 28,
      "edges": [APIBrownoutEdge],
      "pageInfo": PageInfo,
      "totalCount": 22
    }
  }
}

apiExceptions

Type: APIExceptionConnectionTypeConnection

URL: https://api.oees-kraken.energy/v1/graphql/

Get a connection containing API Exceptions.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query api exceptions

Arguments

Name Description

after (String)

before (String)

first (Int)

input (APIExceptionQueryInput)

Fields to filter for. Otherwise don't filter at all.

last (Int)

Query

query ApiExceptions(
  $after: String,
  $before: String,
  $first: Int,
  $input: APIExceptionQueryInput,
  $last: Int
) {
  apiExceptions(
    after: $after,
    before: $before,
    first: $first,
    input: $input,
    last: $last
  ) {
    edgeCount
    edges {
      ...APIExceptionConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "input": APIExceptionQueryInput,
  "last": 10
}

Response

{
  "data": {
    "apiExceptions": {
      "edgeCount": 89,
      "edges": [APIExceptionConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 39
    }
  }
}

appSessions

Type: AppSessionConnectionTypeConnection!

URL: https://api.oees-kraken.energy/v1/graphql/

App sessions recorded at the specified postcode or for the specified affiliate link subdomain.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query affiliate app sessions

Arguments

Name Description

after (String)

before (String)

first (Int)

last (Int)

postcode (String)

The postcode of the address at which the app session was recorded.

subdomain (String)

The affiliate link subdomain to filter app sessions by.

Query

query AppSessions(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $postcode: String,
  $subdomain: String
) {
  appSessions(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    postcode: $postcode,
    subdomain: $subdomain
  ) {
    edgeCount
    edges {
      ...AppSessionConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10,
  "postcode": "begin-reason-can-seat-last",
  "subdomain": "without-word-whole-east-common"
}

Response

{
  "data": {
    "appSessions": {
      "edgeCount": 99,
      "edges": [AppSessionConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 31
    }
  }
}

authorizedApplications

Type: [AuthorizedApplication]

URL: https://api.oees-kraken.energy/v1/graphql/

Get all the confidential-client applications the current user has authorized.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Query

query AuthorizedApplications {
  authorizedApplications {
    clientId
    name
  }
}

Response

{
  "data": {
    "authorizedApplications": [
      {
        "clientId": "66983556",
        "name": "avoid-more-community-art-music"
      }
    ]
  }
}

availableOfferings

Type: [OfferingType]

URL: https://api.oees-kraken.energy/v1/graphql/

Get a list of actively available offerings from the catalog.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query catalog offerings

Query

query AvailableOfferings {
  availableOfferings {
    customerDescription
    customerName
    groups {
      ...GroupTypeFragment
    }
    identifier
    internalName
    isActive
    isAmendable
    isDraft
    isExpired
    isFirstDraft
    isLatestVersion
    isSellable
    lifecycle {
      ...LifecycleTypeFragment
    }
    offeringComponents {
      ...OfferingComponentTypeFragment
    }
    productComponents {
      ...ProductComponentTypeFragment
    }
    tags {
      ...TagTypeFragment
    }
    termTemplateComponents {
      ...TermTemplateComponentTypeFragment
    }
  }
}

Response

{
  "data": {
    "availableOfferings": [
      {
        "customerDescription": "analysis-young-news-one-local",
        "customerName": "indicate-option-both-represent-teach",
        "groups": [GroupType],
        "identifier": "77627262",
        "internalName": "option-owner-yourself-seven-clearly",
        "isActive": true,
        "isAmendable": true,
        "isDraft": true,
        "isExpired": true,
        "isFirstDraft": true,
        "isLatestVersion": true,
        "isSellable": true,
        "lifecycle": LifecycleType,
        "offeringComponents": [OfferingComponentType],
        "productComponents": [ProductComponentType],
        "tags": [TagType],
        "termTemplateComponents": [TermTemplateComponentType]
      }
    ]
  }
}

availableProducts

Type: [SupplyProductType]

URL: https://api.oees-kraken.energy/v1/graphql/

Get available products for the given market.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query available products

Arguments

Name Description

marketName (String!)

Products available for the target market.

Query

query AvailableProducts($marketName: String!) {
  availableProducts(marketName: $marketName) {
    availabilityStatus
    availableFrom
    availableTo
    brandCode
    code
    description
    displayName
    endsAt
    fullName
    id
    isHidden
    marketName
    notes
    params
    tags {
      ...SupplyProductTagTypeFragment
    }
    term
    termsAndConditionsTypes {
      ...TermsAndConditionsTypeFragment
    }
    termsContractType
  }
}

Variables

{
  "marketName": "official-take-training-maintain-food"
}

Response

{
  "data": {
    "availableProducts": [
      {
        "availabilityStatus": "EVERYONE",
        "availableFrom": "2006-06-16T12:20:36.922849+00:00",
        "availableTo": "1994-02-20T11:00:10.390213+00:00",
        "brandCode": "answer-thank-as-past-inside",
        "code": "hit-foreign-bed-chair-story",
        "description": "write-newspaper-note-key-individual",
        "displayName": "never-situation-score-from-find",
        "endsAt": "1972-05-12T17:19:21.495964+00:00",
        "fullName": "up-beyond-business-little-reduce",
        "id": "56831529",
        "isHidden": true,
        "marketName": "every-yes-high-business-mind",
        "notes": "mouth-room-measure-become-garden",
        "params": {"key": "value"},
        "tags": [SupplyProductTagType],
        "term": 16,
        "termsAndConditionsTypes": [TermsAndConditionsType],
        "termsContractType": "focus-better-better-during-drug"
      }
    ]
  }
}

availableProductSwitchDates

Type: [Date]

URL: https://api.oees-kraken.energy/v1/graphql/

Get available dates for product switch.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can switch product

Arguments

Name Description

agreementId (Int!)

Agreement ID.

maxRange (Int)

The maximum number of days to look for available dates.

Query

query AvailableProductSwitchDates(
  $agreementId: Int!,
  $maxRange: Int
) {
  availableProductSwitchDates(
    agreementId: $agreementId,
    maxRange: $maxRange
  )
}

Variables

{
  "agreementId": 55237656,
  "maxRange": 6
}

Response

{
  "data": {
    "availableProductSwitchDates": "1979-05-25"
  }
}

backendScreen

Type: BackendScreenType

URL: https://api.oees-kraken.energy/v1/graphql/

Get mobile screen details to render.

Query Complexity: 1

Possible Errors:

  • KT-CT-8001: No backend screen available.
  • KT-CT-8005: Backend screen does not support parameters.
  • KT-CT-8006: Error applying parameters to backend screen.
  • KT-CT-8008: Incorrect or missing data necessary to build the screen.
  • KT-CT-8009: Error translating screen content.
  • KT-CT-8010: Invalid step ID.
  • KT-CT-8011: Cannot rewind past a previous irreversible step.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

maxVersionSupported (Int)

The maximum version of backend screens supported by the client.

params ([BackendScreenParamInputType])

List of key-value pairs (strings) to pass as parameters to the screen.

screenId (ID!)

The ID of the screen to return.

Query

query BackendScreen(
  $maxVersionSupported: Int,
  $params: [BackendScreenParamInputType],
  $screenId: ID!
) {
  backendScreen(
    maxVersionSupported: $maxVersionSupported,
    params: $params,
    screenId: $screenId
  ) {
    ... on ComponentListType {
      ...ComponentListTypeFragment
    }
    ... on Dashboard {
      ...DashboardFragment
    }
    ... on FormScreenType {
      ...FormScreenTypeFragment
    }
    ... on GenericBackendScreen {
      ...GenericBackendScreenFragment
    }
  }
}

Variables

{
  "maxVersionSupported": 8,
  "params": BackendScreenParamInputType,
  "screenId": "12090860"
}

Response

{
  "data": {
    "backendScreen": ComponentListType
  }
}

backendScreenEventIds

Type: [String]

URL: https://api.oees-kraken.energy/v1/graphql/

Get all registered backend screen event IDs.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Query

query BackendScreenEventIds {
  backendScreenEventIds
}

Response

{
  "data": {
    "backendScreenEventIds": "worry-range-fight-performance-save"
  }
}

backendScreenIds

Type: [String]

URL: https://api.oees-kraken.energy/v1/graphql/

Get all registered backend screen IDs.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Query

query BackendScreenIds {
  backendScreenIds
}

Response

{
  "data": {
    "backendScreenIds": "store-certainly-two-see-turn"
  }
}

bankDetailsValidation

Type: BankDetailsValidationResult

URL: https://api.oees-kraken.energy/v1/graphql/

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Rate Limits

Key Steps

Ip

['65/m']

Arguments

Name Description

iban (NonEmptyString!)

The IBAN of the bank account.

Query

query BankDetailsValidation($iban: NonEmptyString!) {
  bankDetailsValidation(iban: $iban) {
    areValid
    message
  }
}

Variables

{
  "iban": "audience-view-single-computer-short"
}

Response

{
  "data": {
    "bankDetailsValidation": {
      "areValid": true,
      "message": "remember-job-quite-enjoy-claim"
    }
  }
}

billingTriggerConfigurations

Type: BillingTriggerConfigurationsConnection

URL: https://api.oees-kraken.energy/v1/graphql/

Query billing trigger configurations for a specific target. By default returns only active configurations. Specify effective_from/effective_to for time range filtering. Use include_children=true on parent target to get configurations for all child targets.

Query Complexity: 1

Possible Errors:

  • KT-CT-9706: Invalid billing trigger target input.
  • KT-CT-9707: includeChildren cannot be used with effectiveFrom or effectiveTo parameters.
  • KT-CT-9708: Both effectiveFrom and effectiveTo must be provided to filter by period.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query billing information

Arguments

Name Description

after (String)

before (String)

effectiveFrom (DateTime)

Start of the time range to query configurations for.

effectiveTo (DateTime)

End of the time range to query configurations for.

first (Int)

includeChildren (Boolean)

Include all child targets of the specified target.

last (Int)

target (TargetInput!)

The target to query configurations for.

Query

query BillingTriggerConfigurations(
  $after: String,
  $before: String,
  $effectiveFrom: DateTime,
  $effectiveTo: DateTime,
  $first: Int,
  $includeChildren: Boolean,
  $last: Int,
  $target: TargetInput!
) {
  billingTriggerConfigurations(
    after: $after,
    before: $before,
    effectiveFrom: $effectiveFrom,
    effectiveTo: $effectiveTo,
    first: $first,
    includeChildren: $includeChildren,
    last: $last,
    target: $target
  ) {
    edgeCount
    edges {
      ...BillingTriggerConfigurationsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "effectiveFrom": "1992-11-18T05:17:16.865218+00:00",
  "effectiveTo": "2018-02-14T00:37:41.717939+00:00",
  "first": 10,
  "includeChildren": true,
  "last": 10,
  "target": TargetInput
}

Response

{
  "data": {
    "billingTriggerConfigurations": {
      "edgeCount": 24,
      "edges": [BillingTriggerConfigurationsEdge],
      "pageInfo": PageInfo,
      "totalCount": 23
    }
  }
}

buildEnrollmentPayload

Type: BuildEnrollmentPayload

URL: https://api.oees-kraken.energy/v1/graphql/

Build the complete EnrollmentInput JSON for an opportunity. Core derives market and switch type from products and funnel fields. Supports single fuel and dual fuel.

Query Complexity: 1

Possible Errors:

  • KT-CT-8906: Opportunity not found.
  • KT-CT-8922: The opportunity does not have an accepted offer.
  • KT-CT-8923: The opportunity does not have a linked offer group.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can instigate enrollment

Arguments

Name Description

input (BuildEnrollmentPayloadInput!)

Input fields for building enrollment payload.

Query

query BuildEnrollmentPayload($input: BuildEnrollmentPayloadInput!) {
  buildEnrollmentPayload(input: $input) {
    enrollmentInput
  }
}

Variables

Response

{
  "data": {
    "buildEnrollmentPayload": {
      "enrollmentInput": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
    }
  }
}

business

Type: BusinessType

URL: https://api.oees-kraken.energy/v1/graphql/

Get details about a business.

Query Complexity: 1

Possible Errors:

  • KT-CT-11101: The viewer is not authorized to execute the query/mutation. Check the ownership/permissions of provided data.
  • KT-CT-11107: Unauthorized.
  • KT-CT-1605: Invalid input.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query businesses

Arguments

Name Description

details ([BusinessDetailInput])

List of business detail key-value pairs to filter by.

displayableNumber (String)

Kraken-generated, human-readable number for display purposes.

id (ID)

The business ID.

Query

query Business(
  $details: [BusinessDetailInput],
  $displayableNumber: String,
  $id: ID
) {
  business(
    details: $details,
    displayableNumber: $displayableNumber,
    id: $id
  ) {
    billingAddress {
      ...RichAddressTypeFragment
    }
    businessType
    details {
      ...BusinessDetailTypeFragment
    }
    displayableNumber
    id
    legalAddress {
      ...RichAddressTypeFragment
    }
    linkedAccountNumbers
    name
    number
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    sectors
    segmentName
  }
}

Variables

{
  "details": BusinessDetailInput,
  "displayableNumber": "dream-let-past-under-particular",
  "id": "47817255"
}

Response

{
  "data": {
    "business": {
      "billingAddress": RichAddressType,
      "businessType": "SOLE_TRADER",
      "details": [BusinessDetailType],
      "displayableNumber": "nor-claim-west-floor-myself",
      "id": "93477601",
      "legalAddress": RichAddressType,
      "linkedAccountNumbers": "47832379",
      "name": "drive-specific-coach-thank-allow",
      "number": "candidate-under-appear-sure-large",
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "sectors": None,
      "segmentName": "certain-democratic-church-nation-same"
    }
  }
}

businessAccountReferralRewardScheme

Type: ReferralSchemeType

URL: https://api.oees-kraken.energy/v1/graphql/

Return a business referral reward scheme for the given account referral code.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

code (String!)

Friend referral code.

Query

query BusinessAccountReferralRewardScheme($code: String!) {
  businessAccountReferralRewardScheme(code: $code) {
    canBeReferred
    code
    combinedRewardAmount
    isUsageAtCapacity
    loyaltyPointsBonus
    maxRecurrence
    referralDisplayUrl
    referralUrl
    referredRewardAmount
    referrerGivenName
    referrerRewardAmount
    schemeType
  }
}

Variables

{
  "code": "scene-responsibility-he-answer-million"
}

Response

{
  "data": {
    "businessAccountReferralRewardScheme": {
      "canBeReferred": true,
      "code": "range-up-return-lose-appear",
      "combinedRewardAmount": 60,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 81,
      "maxRecurrence": 100,
      "referralDisplayUrl": "indicate-staff-adult-wind-analysis",
      "referralUrl": "ahead-Democrat-data-late-reflect",
      "referredRewardAmount": 29,
      "referrerGivenName": "Regina",
      "referrerRewardAmount": 26,
      "schemeType": "next-condition-still-stock-he"
    }
  }
}

businessContract

Type: Contract

URL: https://api.oees-kraken.energy/v1/graphql/

Get details about an account contract.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query contracts

Arguments

Name Description

accountNumber (String)

The account number to find the business contract for.

identifier (String)

The identifier of the contract.

version (Int)

The version of the contract.

Query

query BusinessContract(
  $accountNumber: String,
  $identifier: String,
  $version: Int
) {
  businessContract(
    accountNumber: $accountNumber,
    identifier: $identifier,
    version: $version
  ) {
    cancelledAt
    identifier
    lifecycle {
      ...ContractVersionFragment
    }
    notes {
      ...ContractNoteTypeFragment
    }
    party {
      ... on Account {
        ...AccountFragment
      }
      ... on BusinessType {
        ...BusinessTypeFragment
      }
    }
    rescindedAt
    signedAt
    status
    subject {
      ...AccountFragment
    }
    terms {
      ...TermInterfaceFragment
    }
    title
    validFrom
    validTo
  }
}

Variables

{
  "accountNumber": "A-A93B1A08",
  "identifier": "38840206",
  "version": 94
}

Response

{
  "data": {
    "businessContract": {
      "cancelledAt": "1977-08-24T05:56:37.969504+00:00",
      "identifier": "23430504",
      "lifecycle": ContractVersion,
      "notes": [ContractNoteType],
      "party": Account,
      "rescindedAt": "1987-09-24T01:47:00.436358+00:00",
      "signedAt": "2000-10-03T22:53:55.804483+00:00",
      "status": "REVOKED",
      "subject": [Account],
      "terms": TermInterface,
      "title": "phone-two-produce-age-long",
      "validFrom": "1970-09-26T22:47:01.945125+00:00",
      "validTo": "1988-01-17T22:56:24.966129+00:00"
    }
  }
}

call

Type: CallInterface!

URL: https://api.oees-kraken.energy/v1/graphql/

Get a call using an integer or UUID identifier.

Query Complexity: 2

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query calls

Arguments

Name Description

id (ID!)

Identifier for the call, as an integer or a UUID.

Query

query Call($id: ID!) {
  call(id: $id) {
    account {
      ...AccountFragment
    }
    id
    metadata {
      ...CallMetadataItemTypeFragment
    }
  }
}

Variables

{
  "id": "58174914"
}

Response

{
  "data": {
    "call": {
      "account": Account,
      "id": "56408520",
      "metadata": [CallMetadataItemType]
    }
  }
}

callTag

Type: CallTagType!

URL: https://api.oees-kraken.energy/v1/graphql/

Get the call tag for a given ID.

Query Complexity: 2

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query calls

Arguments

Name Description

id (ID!)

The call tag ID.

Query

query CallTag($id: ID!) {
  callTag(id: $id) {
    id
    isActive
    name
  }
}

Variables

{
  "id": "65223022"
}

Response

{
  "data": {
    "callTag": {
      "id": "29216288",
      "isActive": true,
      "name": "region-board-would-price-there"
    }
  }
}

callTags

Type: CallTagConnectionTypeConnection!

URL: https://api.oees-kraken.energy/v1/graphql/

Get call tags.

Query Complexity: 2

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query calls

Arguments

Name Description

after (String)

before (String)

first (Int)

isActive (Boolean)

Filter by active status.

last (Int)

name (String)

Filter by call tag name.

Query

query CallTags(
  $after: String,
  $before: String,
  $first: Int,
  $isActive: Boolean,
  $last: Int,
  $name: String
) {
  callTags(
    after: $after,
    before: $before,
    first: $first,
    isActive: $isActive,
    last: $last,
    name: $name
  ) {
    edgeCount
    edges {
      ...CallTagConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "isActive": true,
  "last": 10,
  "name": "stay-year-coach-audience-again"
}

Response

{
  "data": {
    "callTags": {
      "edgeCount": 65,
      "edges": [CallTagConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 57
    }
  }
}

campaigns

Type: AccountCampaignConnectionTypeConnection

URL: https://api.oees-kraken.energy/v1/graphql/

The campaigns associated with this account.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query account campaigns

Arguments

Name Description

accountNumber (String!)

The account number.

after (String)

before (String)

first (Int)

last (Int)

Query

query Campaigns(
  $accountNumber: String!,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  campaigns(
    accountNumber: $accountNumber,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edgeCount
    edges {
      ...AccountCampaignConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "accountNumber": "A-A4DC4797",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "campaigns": {
      "edgeCount": 1,
      "edges": [AccountCampaignConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 86
    }
  }
}

canRescindAgreement

Type: Boolean

URL: https://api.oees-kraken.energy/v1/graphql/

Check if an agreement can be rescinded.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query agreement rescissions

Arguments

Name Description

agreementId (Int!)

The ID of the agreement to check.

Query

query CanRescindAgreement($agreementId: Int!) {
  canRescindAgreement(agreementId: $agreementId)
}

Variables

{
  "agreementId": 91409947
}

Response

{
  "data": {
    "canRescindAgreement": true
  }
}

chargePointVariants

Type: [ChargePointVariantType]

URL: https://api.oees-kraken.energy/v1/graphql/

All charge points variants.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Deprecated

The 'chargePointVariants' field is deprecated.

Please use 'flexSupportedDevices' instead.

- Marked as deprecated on 2026-04-15.
- Scheduled for removal on or after 2026-10-15.

Query

query ChargePointVariants {
  chargePointVariants {
    make
    models {
      ...ChargePointVariantModelTypeFragment
    }
  }
}

Response

{
  "data": {
    "chargePointVariants": [
      {
        "make": "care-social-fight-live-article",
        "models": [ChargePointVariantModelType]
      }
    ]
  }
}

collectionProcessDetails

Type: CollectionProcessDetailsType

URL: https://api.oees-kraken.energy/v1/graphql/

Collection process record details.

Query Complexity: 1

Possible Errors:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-11206: Unable to retrieve disconnection related data for collection process.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

collectionProcessRecordNumber (String!)

The collection process record number.

Query

query CollectionProcessDetails($collectionProcessRecordNumber: String!) {
  collectionProcessDetails(collectionProcessRecordNumber: $collectionProcessRecordNumber) {
    associatedItems {
      ...CollectionProcessRecordAssociatedItemTypeFragment
    }
    collectionProcessRecordNumber
    collectionProcessType
    completionType
    isActive
    isComplete
    isPaused
    pausedDays
    targetObjectIdentifier
  }
}

Variables

{
  "collectionProcessRecordNumber": "change-a-other-already-bring"
}

Response

{
  "data": {
    "collectionProcessDetails": {
      "associatedItems": [CollectionProcessRecordAssociatedItemType],
      "collectionProcessRecordNumber": "home-whole-model-old-film",
      "collectionProcessType": "ACCOUNT",
      "completionType": "according-against-most-work-PM",
      "isActive": true,
      "isComplete": true,
      "isPaused": true,
      "pausedDays": 36,
      "targetObjectIdentifier": "94263078"
    }
  }
}

complaint

Type: ComplaintType

URL: https://api.oees-kraken.energy/v1/graphql/

Get a complaint.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query complaints

Arguments

Name Description

complaintId (Int!)

Query

query Complaint($complaintId: Int!) {
  complaint(complaintId: $complaintId) {
    assigneeId
    contacts {
      ...ComplaintContactConnectionTypeConnectionFragment
    }
    creationDate
    id
    isOfficial
    resolutionDate
    subtype
    type
  }
}

Variables

{
  "complaintId": 58839967
}

Response

{
  "data": {
    "complaint": {
      "assigneeId": "10736848",
      "contacts": ComplaintContactConnectionTypeConnection,
      "creationDate": "1982-01-11",
      "id": "67564604",
      "isOfficial": true,
      "resolutionDate": "1982-01-20",
      "subtype": "laugh-shoulder-these-tend-must",
      "type": "establish-alone-summer-best-believe"
    }
  }
}

completedDispatches

Type: [UpsideDispatchType]

URL: https://api.oees-kraken.energy/v1/graphql/

All completed device dispatches 12 hours behind, in reverse time order.

Query Complexity: 3

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can access third party queries
OR Can view ev data

Rate Limits

Key Steps

User

['300/h']

Arguments

Name Description

accountNumber (String!)

Query

query CompletedDispatches($accountNumber: String!) {
  completedDispatches(accountNumber: $accountNumber) {
    delta
    end
    meta {
      ...UpsideDispatchMetaTypeFragment
    }
    start
  }
}

Variables

{
  "accountNumber": "A-F9D876C2"
}

Response

{
  "data": {
    "completedDispatches": [
      {
        "delta": "1.0",
        "end": "1972-09-18T11:58:20.594377+00:00",
        "meta": UpsideDispatchMetaType,
        "start": "2022-11-06T20:27:27.632171+00:00"
      }
    ]
  }
}

consentTypes

Type: [ConsentTypeType]

URL: https://api.oees-kraken.energy/v1/graphql/

A list of the consent types available.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Query

query ConsentTypes {
  consentTypes {
    code
    defaultValue
    description
    name
  }
}

Response

{
  "data": {
    "consentTypes": [
      {
        "code": "majority-born-major-consider-board",
        "defaultValue": "ACCEPTED",
        "description": "let-consumer-front-letter-movement",
        "name": "report-same-either-read-thousand"
      }
    ]
  }
}

contractCreationJourney

Type: ContractCreationJourneyType

URL: https://api.oees-kraken.energy/v1/graphql/

Get details about a contract creation journey.

Query Complexity: 1

Possible Errors:

  • KT-CT-10017: The contract journey could not be found.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query contracts AND Can query contract journeys

Arguments

Name Description

number (String!)

The number of the contract journey.

Query

query ContractCreationJourney($number: String!) {
  contractCreationJourney(number: $number) {
    context {
      ...ContractCreationContextFragment
    }
    contractDetails {
      ...ContractDetailsFragment
    }
    journeyType
    notes {
      ...ContractNoteTypeFragment
    }
    number
    orderReference
    requestedAt
    status
  }
}

Variables

{
  "number": "tough-low-produce-mission-computer"
}

Response

{
  "data": {
    "contractCreationJourney": {
      "context": ContractCreationContext,
      "contractDetails": ContractDetails,
      "journeyType": "CONTRACT_CREATION",
      "notes": [ContractNoteType],
      "number": "bit-home-building-society-record",
      "orderReference": "effect-production-community-rather-blood",
      "requestedAt": "1975-08-15T15:05:04.704407+00:00",
      "status": "IN_PROGRESS"
    }
  }
}

contractNoteReasons

Type: [ContractNoteReasonType]

URL: https://api.oees-kraken.energy/v1/graphql/

Get a list of contract note reasons, optionally filtered by activity types.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query contract note reasons

Arguments

Name Description

activityTypes ([ContractActivityTypeOptions])

Filter reasons applicable to any of the given contract activity types.

Query

query ContractNoteReasons($activityTypes: [ContractActivityTypeOptions]) {
  contractNoteReasons(activityTypes: $activityTypes) {
    activityTypes
    description
    slug
  }
}

Variables

{
  "activityTypes": "ALL_ACTIVITY_TYPES"
}

Response

{
  "data": {
    "contractNoteReasons": [
      {
        "activityTypes": "ALL_ACTIVITY_TYPES",
        "description": "minute-at-old-beautiful-own",
        "slug": "life-line-high-list-himself"
      }
    ]
  }
}

contracts

Type: [Contract]

URL: https://api.oees-kraken.energy/v1/graphql/

Get a list of contracts filtered by party or subject.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query contracts

Arguments

Name Description

filters (ContractFiltersInput!)

Filters to apply when querying contracts. At least one filter must be provided.

Query

query Contracts($filters: ContractFiltersInput!) {
  contracts(filters: $filters) {
    cancelledAt
    identifier
    lifecycle {
      ...ContractVersionFragment
    }
    notes {
      ...ContractNoteTypeFragment
    }
    party {
      ... on Account {
        ...AccountFragment
      }
      ... on BusinessType {
        ...BusinessTypeFragment
      }
    }
    rescindedAt
    signedAt
    status
    subject {
      ...AccountFragment
    }
    terms {
      ...TermInterfaceFragment
    }
    title
    validFrom
    validTo
  }
}

Variables

{
  "filters": ContractFiltersInput
}

Response

{
  "data": {
    "contracts": [
      {
        "cancelledAt": "1991-03-22T00:38:47.465651+00:00",
        "identifier": "93945663",
        "lifecycle": ContractVersion,
        "notes": [ContractNoteType],
        "party": Account,
        "rescindedAt": "2009-08-10T19:34:22.422947+00:00",
        "signedAt": "1973-11-25T08:23:08.059268+00:00",
        "status": "REVOKED",
        "subject": [Account],
        "terms": TermInterface,
        "title": "staff-manage-thank-beat-home",
        "validFrom": "1998-08-15T11:52:35.266910+00:00",
        "validTo": "1988-08-18T19:25:42.801809+00:00"
      }
    ]
  }
}

contributionSchemes

Type: [ContributionSchemeType]

URL: https://api.oees-kraken.energy/v1/graphql/

Get contribution schemes.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Query

query ContributionSchemes {
  contributionSchemes {
    acceptingContributions
    code
    displayName
    id
    taxable
  }
}

Response

{
  "data": {
    "contributionSchemes": [
      {
        "acceptingContributions": true,
        "code": "summer-several-mean-a-security",
        "displayName": "teach-compare-few-image-media",
        "id": "92647842",
        "taxable": true
      }
    ]
  }
}

costOfCharge

Type: [CostOfChargeType]

URL: https://api.oees-kraken.energy/v1/graphql/

Aggregated cost of charge for an EV device.

Query Complexity: 1

Possible Errors:

  • KT-CT-4326: Could not get consumption cost data.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries

Deprecated

The 'costOfCharge' field is deprecated.

Use `cost` field on `SmartFlexChargingSession` instead.

- Marked as deprecated on 2025-05-13.
- Scheduled for removal on or after 2026-01-16.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/605/

Arguments

Name Description

accountNumber (String!)

frequency (DataFrequency!)

Frequency by day, week, month or year.

reportDate (Date)

The date up to which data should be relative to.

startDate (Date)

The start date of the results required. Overrides report date (end date) if provided.

Query

query CostOfCharge(
  $accountNumber: String!,
  $frequency: DataFrequency!,
  $startDate: Date
) {
  costOfCharge(
    accountNumber: $accountNumber,
    frequency: $frequency,
    startDate: $startDate
  ) {
    costOfChargeId
    isSmartCharge
    krakenflexDeviceId
    reportDate
    totalConsumption
    totalCostExclTax
    totalCostInclTax
  }
}

Variables

{
  "accountNumber": "A-B3BF51AE",
  "frequency": "DAILY",
  "startDate": "2021-06-04"
}

Response

{
  "data": {
    "costOfCharge": [
      {
        "costOfChargeId": "67317074",
        "isSmartCharge": true,
        "krakenflexDeviceId": "52702088",
        "reportDate": "1997-10-08",
        "totalConsumption": 439.82,
        "totalCostExclTax": 400.85,
        "totalCostInclTax": 642.3
      }
    ]
  }
}

cupsRegion

Type: String

URL: https://api.oees-kraken.energy/v1/graphql/

Gets the region where a CUPS is physically located.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Arguments

Name Description

cups (String!)

The CUPS to obtain information for.

Query

query CupsRegion($cups: String!) {
  cupsRegion(cups: $cups)
}

Variables

{
  "cups": "now-reveal-political-bill-she"
}

Response

{
  "data": {
    "cupsRegion": "nation-choice-various-Democrat-sea"
  }
}

cupsValidationToContractAtrBased

Type: CupsValidationToContract

URL: https://api.oees-kraken.energy/v1/graphql/

Get confirmation if cups is valid to make a contract.

Query Complexity: 6

Possible Errors:

  • KT-ES-7802: The request to Chipiron was not fulfilled correctly.
  • KT-ES-7812: Product ID does not exist.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Arguments

Name Description

cupsAndProductInput (CupsValidationToContractInput!)

Input arguments validate in chipiron.

Query

query CupsValidationToContractAtrBased($cupsAndProductInput: CupsValidationToContractInput!) {
  cupsValidationToContractAtrBased(cupsAndProductInput: $cupsAndProductInput) {
    availableContractElectricity
    availableContractGas
    electricityProductId
    gasProductId
    spanishValidationMessage
    validationMessage
  }
}

Variables

{
  "cupsAndProductInput": CupsValidationToContractInput
}

Response

{
  "data": {
    "cupsValidationToContractAtrBased": {
      "availableContractElectricity": true,
      "availableContractGas": true,
      "electricityProductId": "56108985",
      "gasProductId": "83601123",
      "spanishValidationMessage": "police-billion-other-position-manage",
      "validationMessage": "very-also-produce-best-manage"
    }
  }
}

cupsValidationToContractAtrBasedV2

Type: CupsValidationToContract

URL: https://api.oees-kraken.energy/v1/graphql/

Get confirmation if cups is valid to contract the products.

Query Complexity: 1

Possible Errors:

  • KT-ES-7802: The request to Chipiron was not fulfilled correctly.
  • KT-ES-7812: Product ID does not exist.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Deprecated

The 'cupsValidationToContractAtrBasedV2' field is deprecated.

Never used. Use 'cupsValidationToContractAtrBased' instead.

- Marked as deprecated on 2024-05-27.
- Scheduled for removal on or after 2024-07-01.

Arguments

Name Description

input (CupsValidationToContractInput!)

Electricity and gas cups and products to contract.

Query

query CupsValidationToContractAtrBasedV2($input: CupsValidationToContractInput!) {
  cupsValidationToContractAtrBasedV2(input: $input) {
    availableContractElectricity
    availableContractGas
    electricityProductId
    gasProductId
    spanishValidationMessage
    validationMessage
  }
}

Variables

Response

{
  "data": {
    "cupsValidationToContractAtrBasedV2": {
      "availableContractElectricity": true,
      "availableContractGas": true,
      "electricityProductId": "31085225",
      "gasProductId": "65168309",
      "spanishValidationMessage": "technology-goal-food-control-opportunity",
      "validationMessage": "degree-perhaps-much-board-choose"
    }
  }
}

customerAsset

Type: CustomerAssetType

URL: https://api.oees-kraken.energy/v1/graphql/

Get customer asset by ID.

Query Complexity: 2

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query customer assets

Arguments

Name Description

customerAssetId (String!)

Customer asset ID.

Query

query CustomerAsset($customerAssetId: String!) {
  customerAsset(customerAssetId: $customerAssetId) {
    accountNumber
    activeFrom
    activeTo
    id
    name
    physicalId
    type
  }
}

Variables

{
  "customerAssetId": "26250094"
}

Response

{
  "data": {
    "customerAsset": {
      "accountNumber": "A-174FF975",
      "activeFrom": "1981-06-03T01:05:45.790981+00:00",
      "activeTo": "2008-09-06T05:48:33.582296+00:00",
      "id": "28416127",
      "name": "minute-piece-old-step-race",
      "physicalId": "70868508",
      "type": "say-news-boy-next-east"
    }
  }
}

customerFeedbackForms

Type: CustomerFeedbackFormConnectionTypeConnection

URL: https://api.oees-kraken.energy/v1/graphql/

Returns all active customer feedback forms for the account's brand.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can submit customer feedback

Arguments

Name Description

accountNumber (String!)

The account number.

after (String)

before (String)

feedbackSource (CustomerFeedbackSourceChoices)

Feedback sources currently supported.

first (Int)

last (Int)

Query

query CustomerFeedbackForms(
  $accountNumber: String!,
  $after: String,
  $before: String,
  $feedbackSource: CustomerFeedbackSourceChoices,
  $first: Int,
  $last: Int
) {
  customerFeedbackForms(
    accountNumber: $accountNumber,
    after: $after,
    before: $before,
    feedbackSource: $feedbackSource,
    first: $first,
    last: $last
  ) {
    edgeCount
    edges {
      ...CustomerFeedbackFormConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "accountNumber": "A-B83727E3",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "feedbackSource": "FEEDBACK_SOURCE_PHONE_CALL_FOLLOW_UP",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "customerFeedbackForms": {
      "edgeCount": 54,
      "edges": [CustomerFeedbackFormConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 54
    }
  }
}

dailyWholesalePrices

Type: [DailyWholesalePrice]

URL: https://api.oees-kraken.energy/v1/graphql/

Get the daily wholesale prices per hour for the given dates.

Query Complexity: 2

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access third party queries

Deprecated

The 'dailyWholesalePrices' field is deprecated.

Migrated to OE Backend API.

- Marked as deprecated on 2025-10-27.
- Scheduled for removal on or after 2025-11-10.

Arguments

Name Description

end (Date)

The end date until which to get the daily wholesale prices.

start (Date)

The start date from which to get the daily wholesale prices.

Query

query DailyWholesalePrices(
  $end: Date,
  $start: Date
) {
  dailyWholesalePrices(
    end: $end,
    start: $start
  ) {
    date
    hour
    price
  }
}

Variables

{
  "end": "2003-11-10",
  "start": "1979-05-12"
}

Response

{
  "data": {
    "dailyWholesalePrices": [
      {
        "date": "1988-07-08",
        "hour": 2,
        "price": "1.0"
      }
    ]
  }
}

dashboardScreen

Type: Dashboard

URL: https://api.oees-kraken.energy/v1/graphql/

Get a dashboard screen to render in the form of a json list of sections containing cards or grouped cards each with an order attribute.

Query Complexity: 1

Possible Errors:

  • KT-CT-3820: Received both ledger ID and number.
  • KT-CT-8001: No backend screen available.
  • KT-CT-8005: Backend screen does not support parameters.
  • KT-CT-8006: Error applying parameters to backend screen.
  • KT-CT-8008: Incorrect or missing data necessary to build the screen.
  • KT-CT-8009: Error translating screen content.
  • KT-CT-8010: Invalid step ID.
  • KT-CT-8011: Cannot rewind past a previous irreversible step.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountNumber (String!)

The account number of the user.

dashboardId (ID!)

The ID of the dashboard type screen to return.

ledgerId (String)

The ledger id associated to the account.

ledgerNumber (String)

The ledger number associated to the account.

maxVersionSupported (Int!)

The maximum version of dahshboard type screens supported by the client.

params ([BackendScreenParamInputType])

List of key-value pairs (strings) to pass as parameters to the screen.

propertyId (String)

The property id associated to the account.

Query

query DashboardScreen(
  $accountNumber: String!,
  $dashboardId: ID!,
  $ledgerNumber: String,
  $maxVersionSupported: Int!,
  $params: [BackendScreenParamInputType],
  $propertyId: String
) {
  dashboardScreen(
    accountNumber: $accountNumber,
    dashboardId: $dashboardId,
    ledgerNumber: $ledgerNumber,
    maxVersionSupported: $maxVersionSupported,
    params: $params,
    propertyId: $propertyId
  ) {
    dashboardItems {
      ...SectionTypeFragment
    }
    id
    serialisedDashboardItems
    typename
  }
}

Variables

{
  "accountNumber": "A-EDADDD45",
  "dashboardId": "53054036",
  "ledgerNumber": "sense-color-happy-tax-take",
  "maxVersionSupported": 85,
  "params": BackendScreenParamInputType,
  "propertyId": "88187951"
}

Response

{
  "data": {
    "dashboardScreen": {
      "dashboardItems": [SectionType],
      "id": "15638774",
      "serialisedDashboardItems": "tonight-social-unit-industry-they",
      "typename": "choose-only-personal-loss-especially"
    }
  }
}

defaultPaymentInstruction

Type: PaymentInstructionType

URL: https://api.oees-kraken.energy/v1/graphql/

Get the default payment instruction for the account's main ledger.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Deprecated

The 'defaultPaymentInstruction' field is deprecated.

Please use 'usablePaymentInstructions' on the Ledger type to get all usable instructions, or 'paymentPreferenceAtTime' on the Ledger type to get a specific one. Both require explicitly requesting a ledger.

- Marked as deprecated on 2026-01-28.
- Scheduled for removal on or after 2026-07-28.

Arguments

Name Description

accountNumber (String!)

The account number.

instructionType (PaymentType)

Provide an option to get either a CARD or DIRECT_DEBIT instruction.

Query

query DefaultPaymentInstruction(
  $accountNumber: String!,
  $instructionType: PaymentType
) {
  defaultPaymentInstruction(
    accountNumber: $accountNumber,
    instructionType: $instructionType
  ) {
    accountHolder
    accountType
    bankCode
    cardExpiryMonth
    cardExpiryYear
    cardNumber
    cardPaymentNetwork
    cardType
    iban
    id
    instructionType
    maskedAccountIdentifier
    owners {
      ...PaymentInstructionOwnerTypeFragment
    }
    sortCode
    status
    supplementaryLedger {
      ...SupplementaryLedgerTypeFragment
    }
    validFrom
    vendor
  }
}

Variables

{
  "accountNumber": "A-C8358F26",
  "instructionType": "BPAY"
}

Response

{
  "data": {
    "defaultPaymentInstruction": {
      "accountHolder": "politics-measure-nothing-senior-may",
      "accountType": "lot-send-the-sense-successful",
      "bankCode": "remember-word-economic-catch-collection",
      "cardExpiryMonth": 90,
      "cardExpiryYear": 13,
      "cardNumber": "scene-alone-success-step-partner",
      "cardPaymentNetwork": "send-rise-your-energy-every",
      "cardType": "high-budget-because-throughout-help",
      "iban": "itself-culture-money-child-realize",
      "id": "48814458",
      "instructionType": "deal-type-glass-especially-determine",
      "maskedAccountIdentifier": "57185337",
      "owners": [PaymentInstructionOwnerType],
      "sortCode": "city-score-wish-bit-young",
      "status": "culture-dog-plant-among-forward",
      "supplementaryLedger": SupplementaryLedgerType,
      "validFrom": "2019-06-09T18:18:11.244542+00:00",
      "vendor": "help-half-particularly-religious-series"
    }
  }
}

defaultRawScore

Type: Int

URL: https://api.oees-kraken.energy/v1/graphql/

Get default raw score for a customer feedback form.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can submit customer feedback

Arguments

Name Description

formId (Int!)

Query

query DefaultRawScore($formId: Int!) {
  defaultRawScore(formId: $formId)
}

Variables

{
  "formId": 72780809
}

Response

{
  "data": {
    "defaultRawScore": 43
  }
}

depositAgreements

Type: [DepositAgreementOutput]

URL: https://api.oees-kraken.energy/v1/graphql/

Get deposit agreements for a given account.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can use deposit system

Arguments

Name Description

accountNumber (String!)

Query

query DepositAgreements($accountNumber: String!) {
  depositAgreements(accountNumber: $accountNumber) {
    acceptedAt
    collectionDate
    currentEligibilityStatus {
      ...CurrentEligibilityStatusOutputFragment
    }
    depositAmount
    depositKey
    dueDate
    fulfilledAt
    returnStrategy
  }
}

Variables

{
  "accountNumber": "A-B0DD4AA8"
}

Response

{
  "data": {
    "depositAgreements": [
      {
        "acceptedAt": "2008-07-08T14:21:56.434173+00:00",
        "collectionDate": "1988-10-01",
        "currentEligibilityStatus": CurrentEligibilityStatusOutput,
        "depositAmount": 100,
        "depositKey": "miss-this-beat-close-understand",
        "dueDate": "1971-06-28",
        "fulfilledAt": "1981-07-12T13:09:11.815156+00:00",
        "returnStrategy": "those-red-rock-it-finally"
      }
    ]
  }
}

devices

Type: [SmartFlexDeviceInterface!]

URL: https://api.oees-kraken.energy/v1/graphql/

A list of devices registered to an account.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can query devices

Arguments

Name Description

accountNumber (String!)

The account number, e.g. A-12345678.

deviceId (String)

Only list the device with this ID.

integrationDeviceId (String)

Only list the device with this integration device ID.

propertyId (ID)

Only list devices registered to this property.

Query

query Devices(
  $accountNumber: String!,
  $deviceId: String,
  $integrationDeviceId: String,
  $propertyId: ID
) {
  devices(
    accountNumber: $accountNumber,
    deviceId: $deviceId,
    integrationDeviceId: $integrationDeviceId,
    propertyId: $propertyId
  ) {
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    deviceType
    id
    integrationDeviceId
    name
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    propertyId
    provider
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
  }
}

Variables

{
  "accountNumber": "A-67A2A614",
  "deviceId": "34850947",
  "integrationDeviceId": "24326332",
  "propertyId": "60419645"
}

Response

{
  "data": {
    "devices": [
      {
        "alerts": SmartFlexDeviceAlertInterface,
        "deviceType": "BATTERIES",
        "id": "80612124",
        "integrationDeviceId": "80412099",
        "name": "across-partner-at-civil-data",
        "onboardingWizard": SmartFlexOnboardingWizard,
        "preferences": SmartFlexDevicePreferencesInterface,
        "preferenceSetting": FlexDevicePreferenceSettingInterface,
        "propertyId": "52508791",
        "provider": "BYD",
        "reAuthenticationState": DeviceReAuthenticationInterface,
        "status": SmartFlexDeviceStatusInterface
      }
    ]
  }
}

domesticAccountReferralRewardScheme

Type: ReferralSchemeType

URL: https://api.oees-kraken.energy/v1/graphql/

Return a domestic referral reward scheme for the given account referral code.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

code (String!)

Friend referral code.

Query

query DomesticAccountReferralRewardScheme($code: String!) {
  domesticAccountReferralRewardScheme(code: $code) {
    canBeReferred
    code
    combinedRewardAmount
    isUsageAtCapacity
    loyaltyPointsBonus
    maxRecurrence
    referralDisplayUrl
    referralUrl
    referredRewardAmount
    referrerGivenName
    referrerRewardAmount
    schemeType
  }
}

Variables

{
  "code": "sound-energy-hot-fish-still"
}

Response

{
  "data": {
    "domesticAccountReferralRewardScheme": {
      "canBeReferred": true,
      "code": "customer-race-leave-choice-help",
      "combinedRewardAmount": 41,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 44,
      "maxRecurrence": 31,
      "referralDisplayUrl": "many-human-what-above-letter",
      "referralUrl": "poor-plant-loss-area-hotel",
      "referredRewardAmount": 78,
      "referrerGivenName": "Heather",
      "referrerRewardAmount": 87,
      "schemeType": "little-remain-explain-me-discussion"
    }
  }
}

domesticJoiningRewardScheme

Type: ReferralSchemeType

URL: https://api.oees-kraken.energy/v1/graphql/

Return a joining reward scheme with the given code, if it's active. A joining reward can be a signup reward or a promotional reward.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

code (String!)

Reward code for the scheme.

Query

query DomesticJoiningRewardScheme($code: String!) {
  domesticJoiningRewardScheme(code: $code) {
    canBeReferred
    code
    combinedRewardAmount
    isUsageAtCapacity
    loyaltyPointsBonus
    maxRecurrence
    referralDisplayUrl
    referralUrl
    referredRewardAmount
    referrerGivenName
    referrerRewardAmount
    schemeType
  }
}

Variables

{
  "code": "poor-few-positive-late-environment"
}

Response

{
  "data": {
    "domesticJoiningRewardScheme": {
      "canBeReferred": true,
      "code": "must-rise-suffer-according-north",
      "combinedRewardAmount": 62,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 2,
      "maxRecurrence": 38,
      "referralDisplayUrl": "play-score-enter-never-baby",
      "referralUrl": "toward-hospital-now-with-although",
      "referredRewardAmount": 26,
      "referrerGivenName": "Heather",
      "referrerRewardAmount": 98,
      "schemeType": "describe-food-main-mention-report"
    }
  }
}

domesticSignupRewardScheme

Type: ReferralSchemeType

URL: https://api.oees-kraken.energy/v1/graphql/

Return a signup referral reward scheme with the given code, if it's active.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

code (String!)

Reward code for the scheme.

Query

query DomesticSignupRewardScheme($code: String!) {
  domesticSignupRewardScheme(code: $code) {
    canBeReferred
    code
    combinedRewardAmount
    isUsageAtCapacity
    loyaltyPointsBonus
    maxRecurrence
    referralDisplayUrl
    referralUrl
    referredRewardAmount
    referrerGivenName
    referrerRewardAmount
    schemeType
  }
}

Variables

{
  "code": "enjoy-claim-identify-that-tend"
}

Response

{
  "data": {
    "domesticSignupRewardScheme": {
      "canBeReferred": true,
      "code": "speech-difficult-image-land-resource",
      "combinedRewardAmount": 50,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 8,
      "maxRecurrence": 1,
      "referralDisplayUrl": "real-table-culture-recently-there",
      "referralUrl": "statement-approach-condition-amount-strong",
      "referredRewardAmount": 33,
      "referrerGivenName": "Jamie",
      "referrerRewardAmount": 53,
      "schemeType": "tonight-money-off-eight-well"
    }
  }
}

electricitySupplyPoint

Type: ElectricitySupplyPoint

URL: https://api.oees-kraken.energy/v1/graphql/

Get information about a supply point by its ID.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries

Arguments

Name Description

id (ID!)

The ID of the supply point to obtain information for.

Query

query ElectricitySupplyPoint($id: ID!) {
  electricitySupplyPoint(id: $id) {
    activeAgreement {
      ...AgreementFragment
    }
    agreements {
      ...AgreementFragment
    }
    atrTariffs {
      ...ATRTariffFragment
    }
    cups
    id
    networkOperator {
      ...NetworkOperatorFragment
    }
    selfConsumption
    selfConsumptionCode
    status
    supplierChangeInProgress
    supplyPeriods {
      ...SupplyPeriodConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "id": "29513637"
}

Response

{
  "data": {
    "electricitySupplyPoint": {
      "activeAgreement": Agreement,
      "agreements": [Agreement],
      "atrTariffs": [ATRTariff],
      "cups": "support-responsibility-sport-arrive-never",
      "id": "33497231",
      "networkOperator": NetworkOperator,
      "selfConsumption": "foreign-thank-reach-west-similar",
      "selfConsumptionCode": "able-white-four-media-position",
      "status": "ago-speech-side-lot-available",
      "supplierChangeInProgress": true,
      "supplyPeriods": SupplyPeriodConnectionTypeConnection
    }
  }
}

electricVehicles

Type: [ElectricVehicleType]

URL: https://api.oees-kraken.energy/v1/graphql/

All electric vehicle types and their details.

Query Complexity: 1

Possible Errors:

  • KT-CT-4343: Unable to fetch electric vehicles list for make.
  • KT-CT-4344: Make is not supported by provider.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Deprecated

The 'electricVehicles' field is deprecated.

Please use 'flexSupportedDevices' instead.

- Marked as deprecated on 2026-04-15.
- Scheduled for removal on or after 2026-10-15.

Arguments

Name Description

isIntegrationLive (Boolean)

Only return vehicles that are currently integrated.

make (String)

Only return vehicle types for the specified make.

supportedProvider (ProviderChoices)

Only return vehicle types supported by the specified provider, e.g. Tesla.

Query

query ElectricVehicles(
  $isIntegrationLive: Boolean,
  $make: String,
  $supportedProvider: ProviderChoices
) {
  electricVehicles(
    isIntegrationLive: $isIntegrationLive,
    make: $make,
    supportedProvider: $supportedProvider
  ) {
    make
    models {
      ...ElectricVehicleModelTypeFragment
    }
  }
}

Variables

{
  "isIntegrationLive": true,
  "make": "to-especially-million-still-society",
  "supportedProvider": "BYD"
}

Response

{
  "data": {
    "electricVehicles": [
      {
        "make": "yourself-fact-night-customer-floor",
        "models": [ElectricVehicleModelType]
      }
    ]
  }
}

eligibilityToJoinLoyaltyPointsProgram

Type: LoyaltyPointsProgramEligibilityType

URL: https://api.oees-kraken.energy/v1/graphql/

Check if an account is eligible to join the loyalty points program.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query loyalty enrollment eligibility

Arguments

Name Description

input (LoyaltyPointsProgramEligibilityInput!)

Query

query EligibilityToJoinLoyaltyPointsProgram($input: LoyaltyPointsProgramEligibilityInput!) {
  eligibilityToJoinLoyaltyPointsProgram(input: $input) {
    isEligible
    primaryIneligibilityReason
  }
}

Variables

Response

{
  "data": {
    "eligibilityToJoinLoyaltyPointsProgram": {
      "isEligible": true,
      "primaryIneligibilityReason": "road-fact-western-field-north"
    }
  }
}

eligibleDeviceTypes

Type: [KrakenFlexDeviceTypes]

URL: https://api.oees-kraken.energy/v1/graphql/

A list of device types that are eligible for registration.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can view smartflex data

Arguments

Name Description

accountNumber (String!)

The account number, e.g. A-12345678.

propertyId (Int)

            The property's id where the device will be registered to.
            Note: in future, eligible device types will be dependent on the property id and
            it will be a required input.

Query

query EligibleDeviceTypes(
  $accountNumber: String!,
  $propertyId: Int
) {
  eligibleDeviceTypes(
    accountNumber: $accountNumber,
    propertyId: $propertyId
  )
}

Variables

{
  "accountNumber": "A-5415107A",
  "propertyId": 24950991
}

Response

{
  "data": {
    "eligibleDeviceTypes": "BATTERIES"
  }
}

embeddedNetwork

Type: EmbeddedNetworkType

URL: https://api.oees-kraken.energy/v1/graphql/

Get details about an embedded network.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query embedded network

Arguments

Name Description

id (ID!)

Query

query EmbeddedNetwork($id: ID!) {
  embeddedNetwork(id: $id) {
    embeddedProperties {
      ...EmbeddedPropertyTypeFragment
    }
    id
    name
  }
}

Variables

{
  "id": "11651003"
}

Response

{
  "data": {
    "embeddedNetwork": {
      "embeddedProperties": [EmbeddedPropertyType],
      "id": "47639107",
      "name": "start-vote-serve-my-cup"
    }
  }
}

energyMixData

Type: EnergyMixDataType

URL: https://api.oees-kraken.energy/v1/graphql/

The current energy generation mix.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Deprecated

The 'energyMixData' field is deprecated.

This is no longer being used.

- Marked as deprecated on 2026-05-05.
- Scheduled for removal on or after 2026-06-01.

Query

query EnergyMixData {
  energyMixData {
    carbonIntensityIndex
  }
}

Response

{
  "data": {
    "energyMixData": {
      "carbonIntensityIndex": "marriage-human-page-right-while"
    }
  }
}

estimateMeterReadings

Type: MeterReadingEstimationReadingConnection

URL: https://api.oees-kraken.energy/v1/graphql/

Estimated meter readings.

Query Complexity: 3

Possible Errors:

  • KT-CT-13605: No Algorithm configuration found for the provided use case configuration.
  • KT-CT-6426: No supply point found for identifier provided.
  • KT-CT-6427: Missing meter readings.
  • KT-CT-6428: Meter Readings invalid.
  • KT-CT-6429: Granularity is invalid.
  • KT-CT-6430: Multiple metadata found for the provided meter and register combination.
  • KT-CT-6431: No metadata found for the provided meter and register combination.
  • KT-CT-6432: Extrapolate forward estimation is not configured for this territory.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can estimate meter readings

Arguments

Name Description

after (String)

before (String)

deviceId (ID)

The meter id to perform estimation on.

first (Int)

last (Int)

marketIdentifier (ID!)

This is the unique identifier used by the market to identify the supply point.

periodEnd (DateTime!)

The end of the period estimated.

periodStart (DateTime!)

The start of the period estimated.

registerId (ID)

The meter's register identifier.

Query

query EstimateMeterReadings(
  $after: String,
  $before: String,
  $deviceId: ID,
  $first: Int,
  $last: Int,
  $marketIdentifier: ID!,
  $periodEnd: DateTime!,
  $periodStart: DateTime!,
  $registerId: ID
) {
  estimateMeterReadings(
    after: $after,
    before: $before,
    deviceId: $deviceId,
    first: $first,
    last: $last,
    marketIdentifier: $marketIdentifier,
    periodEnd: $periodEnd,
    periodStart: $periodStart,
    registerId: $registerId
  ) {
    edgeCount
    edges {
      ...MeterReadingEstimationReadingEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "deviceId": "59869840",
  "first": 10,
  "last": 10,
  "marketIdentifier": "20068150",
  "periodEnd": "1996-04-10T14:15:11.451686+00:00",
  "periodStart": "1996-11-02T03:04:09.911469+00:00",
  "registerId": "18014641"
}

Response

{
  "data": {
    "estimateMeterReadings": {
      "edgeCount": 3,
      "edges": [MeterReadingEstimationReadingEdge],
      "pageInfo": PageInfo,
      "totalCount": 43
    }
  }
}

externalAccountEvents

Type: ExternalAccountEventConnectionTypeConnection

URL: https://api.oees-kraken.energy/v1/graphql/

Get a list of audit account events, of type external, for a given account.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query external account events

Arguments

Name Description

accountNumber (String!)

Account number to filter by.

after (String)

before (String)

first (Int)

last (Int)

Query

query ExternalAccountEvents(
  $accountNumber: String!,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  externalAccountEvents(
    accountNumber: $accountNumber,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edgeCount
    edges {
      ...ExternalAccountEventConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "accountNumber": "A-F43FC8DD",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "externalAccountEvents": {
      "edgeCount": 62,
      "edges": [ExternalAccountEventConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 89
    }
  }
}

flexPlannedDispatches

Type: [SmartFlexDispatch]

URL: https://api.oees-kraken.energy/v1/graphql/

All planned device dispatches in time order.

Query Complexity: 3

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can view smartflex data

Rate Limits

Key Steps

User

['5/m']

Arguments

Name Description

deviceId (String!)

The SmartFlex device ID to get the planned dispatches for.

Query

query FlexPlannedDispatches($deviceId: String!) {
  flexPlannedDispatches(deviceId: $deviceId) {
    end
    energyAddedKwh
    start
    type
  }
}

Variables

{
  "deviceId": "11420819"
}

Response

{
  "data": {
    "flexPlannedDispatches": [
      {
        "end": "1983-11-29T04:56:11.124022+00:00",
        "energyAddedKwh": "1.0",
        "start": "1977-01-31T14:16:48.939258+00:00",
        "type": "SMART"
      }
    ]
  }
}

flexSupportedDevices

Type: FlexSupportedDevices

URL: https://api.oees-kraken.energy/v1/graphql/

Devices capable of being registered with SmartFlex.

Query Complexity: 1

Possible Errors:

  • KT-CT-4342: One of `deviceType` or `supportedDeviceType` must be provided.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Rate Limits

Key Steps

Ip

['10/m']

Arguments

Name Description

deviceType (KrakenFlexDeviceTypes)

The device type to get the supported devices for. Deprecated: use supportedDeviceType instead, which also includes charge points. Exactly one of deviceType or supportedDeviceType must be provided.

supportedDeviceType (FlexSupportedDeviceTypes)

The device type to get the supported devices for, including charge points. Exactly one of deviceType or supportedDeviceType must be provided.

Query

query FlexSupportedDevices($supportedDeviceType: FlexSupportedDeviceTypes) {
  flexSupportedDevices(supportedDeviceType: $supportedDeviceType) {
    deviceType
    supportedDeviceType
    supportedMakes {
      ...FlexSupportedMakeFragment
    }
  }
}

Variables

{
  "supportedDeviceType": "CHARGE_POINTS"
}

Response

{
  "data": {
    "flexSupportedDevices": {
      "deviceType": "BATTERIES",
      "supportedDeviceType": "CHARGE_POINTS",
      "supportedMakes": [FlexSupportedMake]
    }
  }
}

fraudMeterPointChecks

Type: FraudMeterPointCheckType

URL: https://api.oees-kraken.energy/v1/graphql/

Check if a given meter point ID is in suspicious meter point IDs list.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

meterPointId (String!)

The meter point ID.

Query

query FraudMeterPointChecks($meterPointId: String!) {
  fraudMeterPointChecks(meterPointId: $meterPointId) {
    isInSuspiciousList
    meterPointId
  }
}

Variables

{
  "meterPointId": "62961573"
}

Response

{
  "data": {
    "fraudMeterPointChecks": {
      "isInSuspiciousList": true,
      "meterPointId": "22904430"
    }
  }
}

fraudRiskLevel

Type: FinancialRiskLevelType

URL: https://api.oees-kraken.energy/v1/graphql/

Check if a given ID and type have a financial risk level.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

identifierType (String!)

The type of object the ID represents.

identifierValue (String!)

The ID to be checked.

Query

query FraudRiskLevel(
  $identifierType: String!,
  $identifierValue: String!
) {
  fraudRiskLevel(
    identifierType: $identifierType,
    identifierValue: $identifierValue
  ) {
    identifierType
    identifierValue
    isInRiskList
    riskLevel
  }
}

Variables

{
  "identifierType": "discuss-feel-have-this-every",
  "identifierValue": "result-check-much-paper-local"
}

Response

{
  "data": {
    "fraudRiskLevel": {
      "identifierType": "in-resource-activity-personal-fear",
      "identifierValue": "16937795",
      "isInRiskList": true,
      "riskLevel": "1.0"
    }
  }
}

gasSupplyPoint

Type: GasSupplyPoint

URL: https://api.oees-kraken.energy/v1/graphql/

Get information about a supply point by its ID.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries

Arguments

Name Description

id (ID!)

The ID of the supply point to obtain information for.

Query

query GasSupplyPoint($id: ID!) {
  gasSupplyPoint(id: $id) {
    activeAgreement {
      ...AgreementFragment
    }
    agreements {
      ...AgreementFragment
    }
    atrTariffs {
      ...ATRTariffFragment
    }
    cups
    id
    networkOperator {
      ...NetworkOperatorFragment
    }
    status
    supplyPeriods {
      ...SupplyPeriodConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "id": "69221096"
}

Response

{
  "data": {
    "gasSupplyPoint": {
      "activeAgreement": Agreement,
      "agreements": [Agreement],
      "atrTariffs": [ATRTariff],
      "cups": "five-picture-collection-guy-attack",
      "id": "92152567",
      "networkOperator": NetworkOperator,
      "status": "recently-house-my-reflect-sense",
      "supplyPeriods": SupplyPeriodConnectionTypeConnection
    }
  }
}

getOnSiteJobsCheckResults

Type: OnSiteJobsCheckResultsType

URL: https://api.oees-kraken.energy/v1/graphql/

Get check results for creating requests and appointments.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

jobType (String)

Job type for appointment checks.

supplyPointIdentifierToMarketNameMapping ([SupplyPointIdentifierToMarketNameMappingInput])

Supply point identifier to market name mapping. If this is provided, supplyPointInternalIds cannot be provided. Either one of them must be provided.

supplyPointInternalIds ([Int])

List of internal IDs of supply points. If this is provided, supplyPointIdentifierToMarketNameMapping cannot be provided. Either one of them must be provided.

Query

query GetOnSiteJobsCheckResults(
  $jobType: String,
  $supplyPointIdentifierToMarketNameMapping: [SupplyPointIdentifierToMarketNameMappingInput],
  $supplyPointInternalIds: [Int]
) {
  getOnSiteJobsCheckResults(
    jobType: $jobType,
    supplyPointIdentifierToMarketNameMapping: $supplyPointIdentifierToMarketNameMapping,
    supplyPointInternalIds: $supplyPointInternalIds
  ) {
    canCreateRequest
    hasRequestWarnings
    requestCheckResults {
      ...CheckResultTypeFragment
    }
  }
}

Variables

{
  "jobType": "she-happen-maintain-pattern-indicate",
  "supplyPointIdentifierToMarketNameMapping": SupplyPointIdentifierToMarketNameMappingInput,
  "supplyPointInternalIds": 14
}

Response

{
  "data": {
    "getOnSiteJobsCheckResults": {
      "canCreateRequest": true,
      "hasRequestWarnings": true,
      "requestCheckResults": [CheckResultType]
    }
  }
}

getOnSiteJobsRequestById

Type: OnSiteJobsRequestType

URL: https://api.oees-kraken.energy/v1/graphql/

Get a specific request by ID.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

requestId (UUID)

The ID of the request to return.

Query

query GetOnSiteJobsRequestById($requestId: UUID) {
  getOnSiteJobsRequestById(requestId: $requestId) {
    account
    agent
    assets {
      ...OnSiteJobsAssetConnectionTypeConnectionFragment
    }
    comment
    createdBy
    externalReference
    id
    isEmergency
    marketSupplyPoints {
      ...SupplyPointConnectionTypeConnectionFragment
    }
    overallActionsStatus
    property {
      ...PropertyTypeFragment
    }
    reason
    requestActions {
      ...OnSiteJobsRequestActionConnectionTypeConnectionFragment
    }
    status
    subReason
  }
}

Variables

{
  "requestId": "2bf780d2-ecb1-4d26-94c2-1acac09f6134"
}

Response

{
  "data": {
    "getOnSiteJobsRequestById": {
      "account": "tough-play-again-lawyer-step",
      "agent": "available-grow-social-place-community",
      "assets": OnSiteJobsAssetConnectionTypeConnection,
      "comment": "say-indicate-left-way-loss",
      "createdBy": 83,
      "externalReference": "half-run-on-cause-door",
      "id": "caa46694-f596-4ee7-b055-88f253908f12",
      "isEmergency": true,
      "marketSupplyPoints": SupplyPointConnectionTypeConnection,
      "overallActionsStatus": "SKIPPED",
      "property": PropertyType,
      "reason": "top-most-play-mouth-walk",
      "requestActions": OnSiteJobsRequestActionConnectionTypeConnection,
      "status": "COMPLETED",
      "subReason": "key-oil-try-charge-approach"
    }
  }
}

getOnSiteJobsRequests

Type: OnSiteJobsRequestConnectionTypeConnection

URL: https://api.oees-kraken.energy/v1/graphql/

Filter On-Site Jobs Requests.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountNumbers ([NonEmptyString!])

A list of account numbers to filter requests by.

after (String)

before (String)

first (Int)

last (Int)

statuses ([OnSiteJobsRequestStatus])

A list of statuses to filter requests by.

supplyPointInternalIds ([Int])

List of internal IDs of supply points to filter requests by. If this is provided, supplyPointsToMarketNamesMapping cannot be provided.

supplyPointsToMarketNamesMapping ([SupplyPointIdentifierToMarketNameMappingInput])

A list of supply point identifiers to filter requests by. If this is provided, supplyPointInternalIds cannot be provided.

Query

query GetOnSiteJobsRequests(
  $accountNumbers: [NonEmptyString!],
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $statuses: [OnSiteJobsRequestStatus],
  $supplyPointInternalIds: [Int],
  $supplyPointsToMarketNamesMapping: [SupplyPointIdentifierToMarketNameMappingInput]
) {
  getOnSiteJobsRequests(
    accountNumbers: $accountNumbers,
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    statuses: $statuses,
    supplyPointInternalIds: $supplyPointInternalIds,
    supplyPointsToMarketNamesMapping: $supplyPointsToMarketNamesMapping
  ) {
    edgeCount
    edges {
      ...OnSiteJobsRequestConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "accountNumbers": "upon-cultural-make-walk-culture",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10,
  "statuses": "COMPLETED",
  "supplyPointInternalIds": 52,
  "supplyPointsToMarketNamesMapping": SupplyPointIdentifierToMarketNameMappingInput
}

Response

{
  "data": {
    "getOnSiteJobsRequests": {
      "edgeCount": 81,
      "edges": [OnSiteJobsRequestConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 45
    }
  }
}

goodsProducts

Type: GoodsProductConnectionTypeConnection

URL: https://api.oees-kraken.energy/v1/graphql/

List Goods products given a market.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

after (String)

before (String)

code ([String])

Code of the products to filter by.

first (Int)

last (Int)

marketName (String!)

Market name of the products to list.

productType ([String])

Types of the products to filter by.

Query

query GoodsProducts(
  $after: String,
  $before: String,
  $code: [String],
  $first: Int,
  $last: Int,
  $marketName: String!,
  $productType: [String]
) {
  goodsProducts(
    after: $after,
    before: $before,
    code: $code,
    first: $first,
    last: $last,
    marketName: $marketName,
    productType: $productType
  ) {
    edgeCount
    edges {
      ...GoodsProductConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "code": "local-theory-statement-indeed-television",
  "first": 10,
  "last": 10,
  "marketName": "sit-bag-stuff-somebody-owner",
  "productType": "democratic-want-hour-media-better"
}

Response

{
  "data": {
    "goodsProducts": {
      "edgeCount": 22,
      "edges": [GoodsProductConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 26
    }
  }
}

goodsPurchases

Type: [GoodsPurchase]

URL: https://api.oees-kraken.energy/v1/graphql/

List purchases for an account.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountNumber (String!)

The account number.

Query

query GoodsPurchases($accountNumber: String!) {
  goodsPurchases(accountNumber: $accountNumber) {
    clientParams
    code
    goodsGrants {
      ...GoodsGrantFragment
    }
    goodsSaleItems {
      ...GoodsSaleItemFragment
    }
    ledgerNumber
    marketName
    marketParams
  }
}

Variables

{
  "accountNumber": "A-8F6EA204"
}

Response

{
  "data": {
    "goodsPurchases": [
      {
        "clientParams": {"key": "value"},
        "code": "range-finally-type-sign-plan",
        "goodsGrants": [GoodsGrant],
        "goodsSaleItems": [GoodsSaleItem],
        "ledgerNumber": "early-impact-always-right-head",
        "marketName": "focus-important-later-hot-campaign",
        "marketParams": {"key": "value"}
      }
    ]
  }
}

goodsQuotes

Type: [GoodsQuote]

URL: https://api.oees-kraken.energy/v1/graphql/

List quotes given an account number or retrieve a Goods quote given a quote code.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountNumber (String)

The account number.

quoteCode (String)

The quote code.

Query

query GoodsQuotes(
  $accountNumber: String,
  $quoteCode: String
) {
  goodsQuotes(
    accountNumber: $accountNumber,
    quoteCode: $quoteCode
  ) {
    code
    goodsQuotedProducts {
      ...GoodsQuotedProductFragment
    }
    hasQuoteExpired
    id
    quotedAt
    totalNetAmount
  }
}

Variables

{
  "accountNumber": "A-AEE5C4F4",
  "quoteCode": "involve-region-hand-talk-shoulder"
}

Response

{
  "data": {
    "goodsQuotes": [
      {
        "code": "matter-alone-serious-free-worker",
        "goodsQuotedProducts": [GoodsQuotedProduct],
        "hasQuoteExpired": true,
        "id": "92262135",
        "quotedAt": "2022-07-27T20:38:42.169766+00:00",
        "totalNetAmount": 23
      }
    ]
  }
}

inboundCallAverageWaitTime

Type: InboundCallAverageWaitTimeType

URL: https://api.oees-kraken.energy/v1/graphql/

Get the average wait time for an inbound call.

Query Complexity: 2

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query calls

Query

query InboundCallAverageWaitTime {
  inboundCallAverageWaitTime {
    recent
    yesterday
  }
}

Response

{
  "data": {
    "inboundCallAverageWaitTime": {
      "recent": 72,
      "yesterday": 98
    }
  }
}

inkCommsTemplate

Type: String!

URL: https://api.oees-kraken.energy/v1/graphql/

Fetch the content of a given comms template name.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query ink messages

Arguments

Name Description

templateIdentifier (String!)

The identifier of the comms template.

Query

query InkCommsTemplate($templateIdentifier: String!) {
  inkCommsTemplate(templateIdentifier: $templateIdentifier)
}

Variables

{
  "templateIdentifier": "88378511"
}

Response

{
  "data": {
    "inkCommsTemplate": "road-stuff-material-community-happy"
  }
}

inkConversation

Type: InkConversation!

URL: https://api.oees-kraken.energy/v1/graphql/

Get the Ink conversation for a given account.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can query ink conversations

Arguments

Name Description

accountNumber (String)

The account number.

conversationRelayId (String)

The conversation's relay id.

Query

query InkConversation(
  $accountNumber: String,
  $conversationRelayId: String
) {
  inkConversation(
    accountNumber: $accountNumber,
    conversationRelayId: $conversationRelayId
  ) {
    accountNumber
    accountUsers {
      ...EspAccountUserTypeFragment
    }
    buckets {
      ...InkBucketFragment
    }
    contactChannelIdentities {
      ...InkContactChannelIdentitiesFragment
    }
    events {
      ...InkConversationEventsConnectionFragment
    }
    id
    lastMessageAt
    status
    tags {
      ...InkTagFragment
    }
  }
}

Variables

{
  "accountNumber": "A-0D59A07D",
  "conversationRelayId": "59837239"
}

Response

{
  "data": {
    "inkConversation": {
      "accountNumber": "A-AEF1C37B",
      "accountUsers": [EspAccountUserType],
      "buckets": [InkBucket],
      "contactChannelIdentities": InkContactChannelIdentities,
      "events": InkConversationEventsConnection,
      "id": "14081001",
      "lastMessageAt": "1979-05-30T04:44:43.368802+00:00",
      "status": "OPEN",
      "tags": [InkTag]
    }
  }
}

inkLiveChatConversations

Type: InkConversationsConnection!

URL: https://api.oees-kraken.energy/v1/graphql/

Returns a list of paginated conversations associated with the user.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query ink conversations

Arguments

Name Description

after (String)

before (String)

first (Int)

last (Int)

status (String)

Filter by conversation's status.

Query

query InkLiveChatConversations(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $status: String
) {
  inkLiveChatConversations(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    status: $status
  ) {
    edges {
      ...InkConversationsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10,
  "status": "consumer-grow-ready-like-phone"
}

Response

{
  "data": {
    "inkLiveChatConversations": {
      "edges": [InkConversationsEdge],
      "pageInfo": PageInfo
    }
  }
}

inkMessage

Type: InkMessage!

URL: https://api.oees-kraken.energy/v1/graphql/

Get the content for a given message.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query ink messages

Arguments

Name Description

messageRelayId (String!)

The message's relay id.

Query

query InkMessage($messageRelayId: String!) {
  inkMessage(messageRelayId: $messageRelayId) {
    ... on InkEmail {
      ...InkEmailFragment
    }
    ... on InkGenericMessage {
      ...InkGenericMessageFragment
    }
    ... on InkLine {
      ...InkLineFragment
    }
    ... on InkLiveChatMessage {
      ...InkLiveChatMessageFragment
    }
    ... on InkPost {
      ...InkPostFragment
    }
    ... on InkSMS {
      ...InkSMSFragment
    }
    ... on InkTwilioWhatsApp {
      ...InkTwilioWhatsAppFragment
    }
    ... on InkWhatsApp {
      ...InkWhatsAppFragment
    }
  }
}

Variables

{
  "messageRelayId": "82489372"
}

Response

{
  "data": {
    "inkMessage": InkEmail
  }
}

inkMessageAttributes

Type: InkMessageAttributes!

URL: https://api.oees-kraken.energy/v1/graphql/

Get attributes of a message at time of query.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query ink messages

Arguments

Name Description

vendor (String!)

The message's vendor.

vendorId (String!)

The message's vendor id.

Query

query InkMessageAttributes(
  $vendor: String!,
  $vendorId: String!
) {
  inkMessageAttributes(
    vendor: $vendor,
    vendorId: $vendorId
  ) {
    accounts
    accountType
    buckets
    conversationId
    hourOccurredAt
    hoursWaiting
    isAssignedToUserBucket
    isFirstFromContact
    isNewThread
    opsTeam
    recentlyReceivedAutoReplies
    replyToCommsSms
    weekDayOccurredAt
  }
}

Variables

{
  "vendor": "court-fly-such-sea-investment",
  "vendorId": "68919326"
}

Response

{
  "data": {
    "inkMessageAttributes": {
      "accounts": "final-every-news-laugh-point",
      "accountType": "single-really-mouth-of-difference",
      "buckets": "all-marriage-forward-course-born",
      "conversationId": 50176943,
      "hourOccurredAt": 81,
      "hoursWaiting": 36,
      "isAssignedToUserBucket": true,
      "isFirstFromContact": true,
      "isNewThread": true,
      "opsTeam": "reduce-card-last-wish-forget",
      "recentlyReceivedAutoReplies": "song-start-artist-fight-less",
      "replyToCommsSms": "city-often-decide-fall-open",
      "weekDayOccurredAt": 74
    }
  }
}

inkMessageTextContent

Type: String!

URL: https://api.oees-kraken.energy/v1/graphql/

Fetch the text content of a given message.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query ink message text content

Arguments

Name Description

messageId (ID!)

The message's id or relay id.

Query

query InkMessageTextContent($messageId: ID!) {
  inkMessageTextContent(messageId: $messageId)
}

Variables

{
  "messageId": "73055681"
}

Response

{
  "data": {
    "inkMessageTextContent": "expert-exactly-necessary-week-three"
  }
}

internalCompanies

Type: InternalCompanyConnectionTypeConnection

URL: https://api.oees-kraken.energy/v1/graphql/

Get all internal companies.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query internal companies

Arguments

Name Description

after (String)

before (String)

first (Int)

last (Int)

Query

query InternalCompanies(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  internalCompanies(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edgeCount
    edges {
      ...InternalCompanyConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "internalCompanies": {
      "edgeCount": 21,
      "edges": [InternalCompanyConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 23
    }
  }
}

internalCompany

Type: InternalCompanyType

URL: https://api.oees-kraken.energy/v1/graphql/

Get an internal company by a set of criteria. Criteria will be added as needed, check documentation for the criteria object to see what is currently supported.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query internal companies

Arguments

Name Description

criteria (SearchCriteriaInput!)

Criteria to identify the internal company.

Query

query InternalCompany($criteria: SearchCriteriaInput!) {
  internalCompany(criteria: $criteria) {
    displayableNumber
    id
    legalAddress {
      ...RichAddressTypeFragment
    }
    name
    primaryRegistrationNumber
    primaryTaxIdentifierNumber
    secondaryRegistrationNumber
  }
}

Variables

{
  "criteria": SearchCriteriaInput
}

Response

{
  "data": {
    "internalCompany": {
      "displayableNumber": "money-order-western-year-few",
      "id": "63312980",
      "legalAddress": RichAddressType,
      "name": "huge-training-include-no-spend",
      "primaryRegistrationNumber": "form-unit-sing-explain-provide",
      "primaryTaxIdentifierNumber": "plant-away-dream-possible-seem",
      "secondaryRegistrationNumber": "car-how-wide-plant-by"
    }
  }
}

isCustomerEligibleToGiveFeedbackFollowingCall

Type: Boolean

URL: https://api.oees-kraken.energy/v1/graphql/

Check if customer is eligible to give feedback following a phone call.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can check customer feedback eligibility

Arguments

Name Description

accountNumber (String!)

Number of the account.

accountUserNumber (String!)

Number of the account user.

callId (Int!)

ID of the voice call.

Query

query IsCustomerEligibleToGiveFeedbackFollowingCall(
  $accountNumber: String!,
  $accountUserNumber: String!,
  $callId: Int!
) {
  isCustomerEligibleToGiveFeedbackFollowingCall(
    accountNumber: $accountNumber,
    accountUserNumber: $accountUserNumber,
    callId: $callId
  )
}

Variables

{
  "accountNumber": "A-65C81FB3",
  "accountUserNumber": "U-DCE081A9",
  "callId": 17060240
}

Response

{
  "data": {
    "isCustomerEligibleToGiveFeedbackFollowingCall": true
  }
}

isCustomerEligibleToGiveFeedbackFollowingEmail

Type: Boolean

URL: https://api.oees-kraken.energy/v1/graphql/

Check if customer is eligible to give feedback following an email conversation.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can check customer feedback eligibility

Arguments

Name Description

accountNumber (String!)

Number of the account.

accountUserNumber (String!)

Number of the account user.

conversationClosedAt (DateTime!)

Datetime when the conversation was closed.

inkConversationId (Int!)

ID of the Ink conversation.

Query

query IsCustomerEligibleToGiveFeedbackFollowingEmail(
  $accountNumber: String!,
  $accountUserNumber: String!,
  $conversationClosedAt: DateTime!,
  $inkConversationId: Int!
) {
  isCustomerEligibleToGiveFeedbackFollowingEmail(
    accountNumber: $accountNumber,
    accountUserNumber: $accountUserNumber,
    conversationClosedAt: $conversationClosedAt,
    inkConversationId: $inkConversationId
  )
}

Variables

{
  "accountNumber": "A-1B7C6FC0",
  "accountUserNumber": "U-8453957E",
  "conversationClosedAt": "1977-06-08T21:35:14.164194+00:00",
  "inkConversationId": 62995117
}

Response

{
  "data": {
    "isCustomerEligibleToGiveFeedbackFollowingEmail": true
  }
}

isPasswordResetTokenValid

Type: Boolean

URL: https://api.oees-kraken.energy/v1/graphql/

Check validity of a password reset token.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Arguments

Name Description

token (String!)

Password reset token to check.

userId (String!)

Base64 encoded user id.

Query

query IsPasswordResetTokenValid(
  $token: String!,
  $userId: String!
) {
  isPasswordResetTokenValid(
    token: $token,
    userId: $userId
  )
}

Variables

{
  "token": "tough-factor-city-doctor-once",
  "userId": "91294694"
}

Response

{
  "data": {
    "isPasswordResetTokenValid": true
  }
}

joinSupplierProcess

Type: JoinSupplierProcessType

URL: https://api.oees-kraken.energy/v1/graphql/

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query lifecycle processes

Arguments

Name Description

number (String!)

The join supplier process number, e.g. JS-12345678.

Query

query JoinSupplierProcess($number: String!) {
  joinSupplierProcess(number: $number) {
    contractIdentifiers
    currentProcessData {
      ...JoinSupplierProcessDataTypeFragment
    }
    id
    ledgerAssignments {
      ...JoinSupplierLedgerAssignmentConnectionTypeConnectionFragment
    }
    number
    stage
    status
    subtype
    supplyPoints {
      ...SupplyPointConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "number": "window-model-individual-leave-nor"
}

Response

{
  "data": {
    "joinSupplierProcess": {
      "contractIdentifiers": "example-PM-message-speak-top",
      "currentProcessData": JoinSupplierProcessDataType,
      "id": "27545594",
      "ledgerAssignments": JoinSupplierLedgerAssignmentConnectionTypeConnection,
      "number": "plant-child-act-education-nature",
      "stage": "responsibility-get-lose-speak-cost",
      "status": "PENDING",
      "subtype": "discussion-power-series-continue-decision",
      "supplyPoints": SupplyPointConnectionTypeConnection
    }
  }
}

krakenVersion

Type: KrakenVersionType

URL: https://api.oees-kraken.energy/v1/graphql/

The current version of kraken.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Rate Limits

Key Steps

Ip

['100/m']

Query

query KrakenVersion {
  krakenVersion {
    isPinned
    number
    SHA
  }
}

Response

{
  "data": {
    "krakenVersion": {
      "isPinned": true,
      "number": "push-them-not-professional-scene",
      "SHA": "by-another-free-east-lead"
    }
  }
}

leadBlocklistValidations

Type: LeadBlockListValidationOutput

URL: https://api.oees-kraken.energy/v1/graphql/

Run a blocklist validation out of some dynamic client entry types.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query leads

Arguments

Name Description

blockListEntries (LeadBlockListValidationInput)

List of client-configured black list entry types.

Query

query LeadBlocklistValidations($blockListEntries: LeadBlockListValidationInput) {
  leadBlocklistValidations(blockListEntries: $blockListEntries) {
    blockListHits
    valid
  }
}

Variables

{
  "blockListEntries": LeadBlockListValidationInput
}

Response

{
  "data": {
    "leadBlocklistValidations": {
      "blockListHits": "enter-Republican-bring-beautiful-experience",
      "valid": true
    }
  }
}

leadByNumber

Type: LeadOutput

URL: https://api.oees-kraken.energy/v1/graphql/

Get lead details by number.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query leads

Arguments

Name Description

number (String)

Lead number.

Query

query LeadByNumber($number: String) {
  leadByNumber(number: $number) {
    accountNumber
    billingAddress {
      ...AddressOutputFragment
    }
    billingName
    billingRichAddress {
      ...RichAddressTypeFragment
    }
    brand
    consents {
      ...ConsentOutputFragment
    }
    email
    extraDetailItems {
      ...ExtraDetailFragment
    }
    familyName
    funnel {
      ...SalesFunnelFragment
    }
    givenName
    leadId
    leadType
    nationalId
    number
    phoneNumber
    stage
  }
}

Variables

{
  "number": "anyone-picture-specific-write-he"
}

Response

{
  "data": {
    "leadByNumber": {
      "accountNumber": "A-C36D4BD9",
      "billingAddress": AddressOutput,
      "billingName": "value-dream-either-couple-fund",
      "billingRichAddress": RichAddressType,
      "brand": "television-process-follow-true-back",
      "consents": [ConsentOutput],
      "email": "suddenly-hour-leader-per-leg",
      "extraDetailItems": [ExtraDetail],
      "familyName": "Gray",
      "funnel": SalesFunnel,
      "givenName": "Michael",
      "leadId": "59802222",
      "leadType": "thought-stuff-own-possible-seek",
      "nationalId": "98936202",
      "number": "support-around-identify-wall-someone",
      "phoneNumber": "husband-fight-crime-pass-sure",
      "stage": "ahead-although-leader-idea-nation"
    }
  }
}

leads

Type: LeadsConnection

URL: https://api.oees-kraken.energy/v1/graphql/

Fetch all leads for this Kraken, with optional filtering.

Query Complexity: 3

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query leads

Arguments

Name Description

after (String)

before (String)

first (Int)

input (LeadsQueryInput)

Input fields for retrieving leads.

last (Int)

offset (Int)

Query

query Leads(
  $after: String,
  $before: String,
  $first: Int,
  $input: LeadsQueryInput,
  $last: Int,
  $offset: Int
) {
  leads(
    after: $after,
    before: $before,
    first: $first,
    input: $input,
    last: $last,
    offset: $offset
  ) {
    edgeCount
    edges {
      ...LeadsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "input": LeadsQueryInput,
  "last": 10,
  "offset": 61
}

Response

{
  "data": {
    "leads": {
      "edgeCount": 33,
      "edges": [LeadsEdge],
      "pageInfo": PageInfo,
      "totalCount": 4
    }
  }
}

leaveSupplierProcess

Type: LeaveSupplierProcessType

URL: https://api.oees-kraken.energy/v1/graphql/

Details associated with a LeaveSupplier process.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access third party queries
OR Can query lifecycle processes

Arguments

Name Description

leaveSupplierProcessId (ID)

The leave supplier process ID.

number (String)

The leave supplier process number, e.g. LS-12345678.

Query

query LeaveSupplierProcess($number: String) {
  leaveSupplierProcess(number: $number) {
    id
    number
    processData {
      ...LeaveSupplierProcessDataTypeFragment
    }
    stage
    status
    subtype
    supplyEndDate
    supplyPoints {
      ...SupplyPointConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "number": "out-seat-true-range-cause"
}

Response

{
  "data": {
    "leaveSupplierProcess": {
      "id": "90308900",
      "number": "reduce-six-pick-former-history",
      "processData": LeaveSupplierProcessDataType,
      "stage": "admit-life-while-administration-strong",
      "status": "PENDING",
      "subtype": "very-eat-if-structure-parent",
      "supplyEndDate": "1978-09-02",
      "supplyPoints": SupplyPointConnectionTypeConnection
    }
  }
}

legacyOrderDetails

Type: LegacyOrderDetailsType

URL: https://api.oees-kraken.energy/v1/graphql/

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

identifier (String!)

Order identifier.

Query

query LegacyOrderDetails($identifier: String!) {
  legacyOrderDetails(identifier: $identifier) {
    order {
      ...LegacyOrderTypeFragment
    }
    resources {
      ...LegacyOrderResourceFragment
    }
    status
  }
}

Variables

{
  "identifier": "20334882"
}

Response

{
  "data": {
    "legacyOrderDetails": {
      "order": LegacyOrderType,
      "resources": [LegacyOrderResource],
      "status": "PENDING"
    }
  }
}

lifecycleProcesses

Type: LifecycleProcessesType

URL: https://api.oees-kraken.energy/v1/graphql/

Get all lifecycle processes associated with an account.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query lifecycle processes

Arguments

Name Description

accountNumber (String!)

The account number, e.g. A-12345678.

onlyActive (Boolean)

A flag to filter out only active/current processes.

sortOrder (LifecycleProcessesSortOrder)

The chronological order in which the lifecycle processes are sorted.

Query

query LifecycleProcesses(
  $accountNumber: String!,
  $onlyActive: Boolean,
  $sortOrder: LifecycleProcessesSortOrder
) {
  lifecycleProcesses(
    accountNumber: $accountNumber,
    onlyActive: $onlyActive,
    sortOrder: $sortOrder
  ) {
    joinSupplierProcesses {
      ...JoinSupplierProcessConnectionTypeConnectionFragment
    }
    leavePropertyProcesses {
      ...LeavePropertyProcessConnectionTypeConnectionFragment
    }
    leaveSupplierProcesses {
      ...LeaveSupplierProcessConnectionTypeConnectionFragment
    }
    occupyPropertyProcesses {
      ...OccupyPropertyProcessConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "accountNumber": "A-03034C24",
  "onlyActive": true,
  "sortOrder": "ASC"
}

Response

{
  "data": {
    "lifecycleProcesses": {
      "joinSupplierProcesses": JoinSupplierProcessConnectionTypeConnection,
      "leavePropertyProcesses": LeavePropertyProcessConnectionTypeConnection,
      "leaveSupplierProcesses": LeaveSupplierProcessConnectionTypeConnection,
      "occupyPropertyProcesses": OccupyPropertyProcessConnectionTypeConnection
    }
  }
}

livePaymentAdequacyCalculation

Type: LivePaymentAdequacyCalculation

URL: https://api.oees-kraken.energy/v1/graphql/

Get payment adequacy data with an up to date calculation.

Query Complexity: 6

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

ledgerNumber (String!)

Kraken ledger number.

Query

query LivePaymentAdequacyCalculation($ledgerNumber: String!) {
  livePaymentAdequacyCalculation(ledgerNumber: $ledgerNumber) {
    averageMonthlyCharge
    balanceAdjustment
    consumption {
      ...ConsumptionBreakdownConnectionTypeConnectionFragment
    }
    currentBalance
    existingMonthlyAmount
    reviewedOn
    suggestedNewMonthlyAmount
    targetBalance
  }
}

Variables

{
  "ledgerNumber": "Democrat-service-indicate-upon-office"
}

Response

{
  "data": {
    "livePaymentAdequacyCalculation": {
      "averageMonthlyCharge": 46,
      "balanceAdjustment": 48,
      "consumption": ConsumptionBreakdownConnectionTypeConnection,
      "currentBalance": 9,
      "existingMonthlyAmount": 93,
      "reviewedOn": "2014-03-30",
      "suggestedNewMonthlyAmount": 26,
      "targetBalance": 13
    }
  }
}

loyaltyCards

Type: [LoyaltyCardType]

URL: https://api.oees-kraken.energy/v1/graphql/

Get all loyalty cards for the given account user.

Query Complexity: 1

Possible Errors:

  • KT-CT-5412: No account user exists with the given id.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountUserId (String!)

Account user id.

Query

query LoyaltyCards($accountUserId: String!) {
  loyaltyCards(accountUserId: $accountUserId) {
    id
    number
    scheme
    status
  }
}

Variables

{
  "accountUserId": "27122927"
}

Response

{
  "data": {
    "loyaltyCards": [
      {
        "id": "90898261",
        "number": "us-everybody-word-relationship-see",
        "scheme": "foreign-enough-green-direction-lawyer",
        "status": "despite-everybody-act-meeting-team"
      }
    ]
  }
}

loyaltyPointLedgerEntry

Type: LoyaltyPointLedgerEntryType

URL: https://api.oees-kraken.energy/v1/graphql/

Resolve a loyalty point ledger entry.

Query Complexity: 1

Possible Errors:

  • KT-CT-9215: Loyalty points balance query disabled.
  • KT-CT-9223: Loyalty points ledger entry not found.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query loyalty points ledger entry

Arguments

Name Description

input (LoyaltyPointLedgerEntryInput!)

Query

query LoyaltyPointLedgerEntry($input: LoyaltyPointLedgerEntryInput!) {
  loyaltyPointLedgerEntry(input: $input) {
    accountNumber
    balanceBroughtForward
    balanceCarriedForward
    id
    idempotencyKey
    ledgerType
    postedAt
    reasonCode
    value
  }
}

Variables

Response

{
  "data": {
    "loyaltyPointLedgerEntry": {
      "accountNumber": "A-417E9F69",
      "balanceBroughtForward": "various-want-type-off-fight",
      "balanceCarriedForward": "red-product-go-thus-nature",
      "id": "45963002",
      "idempotencyKey": "6083cfd9-16f0-4ef0-a828-49b3f2eda252",
      "ledgerType": "course-large-officer-culture-for",
      "postedAt": "1994-10-14T00:50:41.230706+00:00",
      "reasonCode": "stock-feel-member-audience-network",
      "value": "campaign-focus-hit-training-prove"
    }
  }
}

loyaltyPointLedgers

Type: [LoyaltyPointLedgerEntryType]

URL: https://api.oees-kraken.energy/v1/graphql/

Get the Loyalty Point ledger entries for the passed user.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query loyalty points ledger entry

Arguments

Name Description

input (LoyaltyPointLedgersInput)

The input object for retrieving a loyalty point ledger entry.

Query

query LoyaltyPointLedgers($input: LoyaltyPointLedgersInput) {
  loyaltyPointLedgers(input: $input) {
    accountNumber
    balanceBroughtForward
    balanceCarriedForward
    id
    idempotencyKey
    ledgerType
    postedAt
    reasonCode
    value
  }
}

Variables

Response

{
  "data": {
    "loyaltyPointLedgers": [
      {
        "accountNumber": "A-D1A6E955",
        "balanceBroughtForward": "certainly-either-east-represent-happy",
        "balanceCarriedForward": "pay-security-feeling-measure-suddenly",
        "id": "56199314",
        "idempotencyKey": "263f312c-0156-4521-bd21-072fa52c45ea",
        "ledgerType": "live-service-affect-young-pretty",
        "postedAt": "2022-03-25T08:52:03.919102+00:00",
        "reasonCode": "same-student-daughter-range-rest",
        "value": "head-late-interesting-material-message"
      }
    ]
  }
}

loyaltyPointsBalance

Type: AccountLoyaltyPointsType

URL: https://api.oees-kraken.energy/v1/graphql/

Get the loyalty points balance for an account.

Query Complexity: 1

Possible Errors:

  • KT-CT-9215: Loyalty points balance query disabled.
  • KT-CT-9216: Unauthorized.
  • KT-CT-9217: Unauthorized.
  • KT-CT-9218: Unauthorized.
  • KT-CT-9222: Loyalty points balance query requires either accountNumber field (deprecated) or input object (preferred) with account number and optional account user id.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query loyalty points balance

Arguments

Name Description

accountNumber (String)

The account number.

input (LoyaltyPointsBalanceInput)

Query

query LoyaltyPointsBalance($input: LoyaltyPointsBalanceInput) {
  loyaltyPointsBalance(input: $input) {
    loyaltyPoints
    totalMonetaryAmount
  }
}

Variables

Response

{
  "data": {
    "loyaltyPointsBalance": {
      "loyaltyPoints": 28,
      "totalMonetaryAmount": 24
    }
  }
}

message

Type: Message!

URL: https://api.oees-kraken.energy/v1/graphql/

Get the details of a transactional message with a given external ID.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

messageId (ID!)

The ID of the transactional message.

Query

query Message($messageId: ID!) {
  message(messageId: $messageId) {
    account {
      ...AccountFragment
    }
    accountUser {
      ...EspAccountUserTypeFragment
    }
    channel
    dispatchedAt
    failedAt
    id
  }
}

Variables

{
  "messageId": "23370571"
}

Response

{
  "data": {
    "message": {
      "account": Account,
      "accountUser": EspAccountUserType,
      "channel": "EMAIL",
      "dispatchedAt": "2011-04-13T01:20:19.899339+00:00",
      "failedAt": "2014-05-03T12:42:21.735654+00:00",
      "id": "39507593"
    }
  }
}

metadata

Type: [Metadata]

URL: https://api.oees-kraken.energy/v1/graphql/

Metadata for a linked object.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can query metadata

Arguments

Name Description

identifier (String!)

linkedObjectType (LinkedObjectType)

Query

query Metadata(
  $identifier: String!,
  $linkedObjectType: LinkedObjectType
) {
  metadata(
    identifier: $identifier,
    linkedObjectType: $linkedObjectType
  ) {
    key
    value
  }
}

Variables

{
  "identifier": "34143160",
  "linkedObjectType": "ACCOUNT"
}

Response

{
  "data": {
    "metadata": [
      {
        "key": "his-reason-green-our-center",
        "value": {"key": "value"}
      }
    ]
  }
}

metadataForKey

Type: Metadata

URL: https://api.oees-kraken.energy/v1/graphql/

Metadata for a linked object with key.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can query metadata

Arguments

Name Description

identifier (String!)

key (String!)

linkedObjectType (LinkedObjectType)

Query

query MetadataForKey(
  $identifier: String!,
  $key: String!,
  $linkedObjectType: LinkedObjectType
) {
  metadataForKey(
    identifier: $identifier,
    key: $key,
    linkedObjectType: $linkedObjectType
  ) {
    key
    value
  }
}

Variables

{
  "identifier": "99263965",
  "key": "city-sometimes-do-nearly-power",
  "linkedObjectType": "ACCOUNT"
}

Response

{
  "data": {
    "metadataForKey": {
      "key": "tell-star-sound-bad-none",
      "value": {"key": "value"}
    }
  }
}

mfaDevices

Type: [MfaDevice]

URL: https://api.oees-kraken.energy/v1/graphql/

Get all MFA devices for the current user.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Query

query MfaDevices {
  mfaDevices {
    deviceType
    isConfirmed
  }
}

Response

{
  "data": {
    "mfaDevices": [
      {
        "deviceType": "man-upon-although-detail-avoid",
        "isConfirmed": true
      }
    ]
  }
}

node

Type: Node

URL: https://api.oees-kraken.energy/v1/graphql/

Represents an individual object/resource in the API.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

id (ID!)

The ID of the object

Query

query Node($id: ID!) {
  node(id: $id) {
    id
  }
}

Variables

{
  "id": "21328129"
}

Response

{
  "data": {
    "node": {
      "id": "52857172"
    }
  }
}

ocppConnection

Type: OCPPConnectionType

URL: https://api.oees-kraken.energy/v1/graphql/

To confirm whether a device is connected to OCPP.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountNumber (String!)

Query

query OcppConnection($accountNumber: String!) {
  ocppConnection(accountNumber: $accountNumber) {
    isConnected
  }
}

Variables

{
  "accountNumber": "A-04664020"
}

Response

{
  "data": {
    "ocppConnection": {
      "isConnected": true
    }
  }
}

ocppDetails

Type: OCPPDetailsType

URL: https://api.oees-kraken.energy/v1/graphql/

The user specific generated OCPP details.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountNumber (String!)

Query

query OcppDetails($accountNumber: String!) {
  ocppDetails(accountNumber: $accountNumber) {
    url
    username
  }
}

Variables

{
  "accountNumber": "A-8BB3DDF6"
}

Response

{
  "data": {
    "ocppDetails": {
      "url": "consider-whether-dog-government-station",
      "username": "of-which-specific-cold-laugh"
    }
  }
}

ocuCollectivePurchaseCanContract

Type: Boolean

URL: https://api.oees-kraken.energy/v1/graphql/

Resolves whether an OCU collective purchase customer can contract or not.

Query Complexity: 1

Possible Errors:

  • KT-ES-7810: Customer has reached its max amount of agreements for the OCU collective purchase product.
  • KT-ES-7811: Customer isn't allowed to contract OCU collective purchase product.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Arguments

Name Description

customerId (String!)

OCU customer id to check.

Query

query OcuCollectivePurchaseCanContract($customerId: String!) {
  ocuCollectivePurchaseCanContract(customerId: $customerId)
}

Variables

{
  "customerId": "25088382"
}

Response

{
  "data": {
    "ocuCollectivePurchaseCanContract": true
  }
}

offerForQuoting

Type: OfferType

URL: https://api.oees-kraken.energy/v1/graphql/

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can create quoting offer group

Arguments

Name Description

identifier (ID)

The identifier of the offer to query.

Query

query OfferForQuoting($identifier: ID) {
  offerForQuoting(identifier: $identifier) {
    acceptedAt
    createdBy {
      ...ActorTypeFragment
    }
    description
    identifier
    quote {
      ...QuoteType_Fragment
    }
    rejectedAt
    validFrom
    validTo
  }
}

Variables

{
  "identifier": "13781840"
}

Response

{
  "data": {
    "offerForQuoting": {
      "acceptedAt": "1975-10-08T14:44:37.798860+00:00",
      "createdBy": ActorType,
      "description": "move-six-rest-exist-toward",
      "identifier": "40162421",
      "quote": QuoteType_,
      "rejectedAt": "2011-10-16T03:26:35.703146+00:00",
      "validFrom": "1993-06-10T00:44:26.298405+00:00",
      "validTo": "1974-03-06T07:06:01.909402+00:00"
    }
  }
}

offerGroupForQuoting

Type: OfferGroupType

URL: https://api.oees-kraken.energy/v1/graphql/

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can create quoting offer group

Arguments

Name Description

identifier (ID)

The identifier of the offer group to query.

Query

query OfferGroupForQuoting($identifier: ID) {
  offerGroupForQuoting(identifier: $identifier) {
    createdAt
    createdBy {
      ...ActorTypeFragment
    }
    identifier
    offers {
      ...OfferTypeFragment
    }
  }
}

Variables

{
  "identifier": "55614172"
}

Response

{
  "data": {
    "offerGroupForQuoting": {
      "createdAt": "1996-04-05T19:00:43.651862+00:00",
      "createdBy": ActorType,
      "identifier": "70624360",
      "offers": [OfferType]
    }
  }
}

offering

Type: OfferingType

URL: https://api.oees-kraken.energy/v1/graphql/

Get details about a product offering.

Query Complexity: 1

Possible Errors:

  • KT-CT-12001: Product catalogue offering with given identifier not found.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query catalog offerings

Arguments

Name Description

identifier (String)

The identifier of the offering to query.

Query

query Offering($identifier: String) {
  offering(identifier: $identifier) {
    customerDescription
    customerName
    groups {
      ...GroupTypeFragment
    }
    identifier
    internalName
    isActive
    isAmendable
    isDraft
    isExpired
    isFirstDraft
    isLatestVersion
    isSellable
    lifecycle {
      ...LifecycleTypeFragment
    }
    offeringComponents {
      ...OfferingComponentTypeFragment
    }
    productComponents {
      ...ProductComponentTypeFragment
    }
    tags {
      ...TagTypeFragment
    }
    termTemplateComponents {
      ...TermTemplateComponentTypeFragment
    }
  }
}

Variables

{
  "identifier": "85087081"
}

Response

{
  "data": {
    "offering": {
      "customerDescription": "policy-it-here-week-beautiful",
      "customerName": "thing-product-however-bit-suddenly",
      "groups": [GroupType],
      "identifier": "57393686",
      "internalName": "go-live-truth-day-democratic",
      "isActive": true,
      "isAmendable": true,
      "isDraft": true,
      "isExpired": true,
      "isFirstDraft": true,
      "isLatestVersion": true,
      "isSellable": true,
      "lifecycle": LifecycleType,
      "offeringComponents": [OfferingComponentType],
      "productComponents": [ProductComponentType],
      "tags": [TagType],
      "termTemplateComponents": [TermTemplateComponentType]
    }
  }
}

onboardingReferralCurrentlyAllowed

Type: OnboardingReferralAllowedType

URL: https://api.oees-kraken.energy/v1/graphql/

Gives a prediction on whether a referral will be valid.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Arguments

Name Description

referralCode (String!)

Referral code to be checked.

Query

query OnboardingReferralCurrentlyAllowed($referralCode: String!) {
  onboardingReferralCurrentlyAllowed(referralCode: $referralCode) {
    referralValid
  }
}

Variables

{
  "referralCode": "something-southern-break-state-of"
}

Response

{
  "data": {
    "onboardingReferralCurrentlyAllowed": {
      "referralValid": true
    }
  }
}

opportunities

Type: OpportunitiesConnection

URL: https://api.oees-kraken.energy/v1/graphql/

Fetch all opportunities for this Kraken, with optional filtering.

Query Complexity: 3

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query leads

Arguments

Name Description

after (String)

before (String)

first (Int)

input (OpportunitiesQueryInput)

Input fields for retrieving opportunities.

last (Int)

offset (Int)

Query

query Opportunities(
  $after: String,
  $before: String,
  $first: Int,
  $input: OpportunitiesQueryInput,
  $last: Int,
  $offset: Int
) {
  opportunities(
    after: $after,
    before: $before,
    first: $first,
    input: $input,
    last: $last,
    offset: $offset
  ) {
    edgeCount
    edges {
      ...OpportunitiesEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "input": OpportunitiesQueryInput,
  "last": 10,
  "offset": 92
}

Response

{
  "data": {
    "opportunities": {
      "edgeCount": 24,
      "edges": [OpportunitiesEdge],
      "pageInfo": PageInfo,
      "totalCount": 63
    }
  }
}

opportunityByNumber

Type: OpportunityOutput

URL: https://api.oees-kraken.energy/v1/graphql/

Get opportunity details by number.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query leads

Arguments

Name Description

number (String)

Opportunity number identifier.

Query

query OpportunityByNumber($number: String) {
  opportunityByNumber(number: $number) {
    assignedToAffiliateNumber
    assignedToTeamIdentifier
    assignedToUserIdentifier
    attachments {
      ...OpportunityAttachmentFragment
    }
    consents {
      ...ConsentOutputFragment
    }
    email
    extraDetailItems {
      ...ExtraDetailFragment
    }
    funnel {
      ...SalesFunnelFragment
    }
    leadNumber
    leadType
    name
    notes
    number
    offerGroupId
    opportunityAddress {
      ...AddressOutputFragment
    }
    opportunityRichAddress {
      ...RichAddressTypeFragment
    }
    phoneNumber
    productOffering {
      ...OfferingTypeFragment
    }
    productOfferingId
    salesChannel
    stage
    supplyPoints {
      ...LeadSupplyPointTypeFragment
    }
  }
}

Variables

{
  "number": "total-edge-financial-state-since"
}

Response

{
  "data": {
    "opportunityByNumber": {
      "assignedToAffiliateNumber": "while-short-cell-process-wide",
      "assignedToTeamIdentifier": "42007437",
      "assignedToUserIdentifier": "22849584",
      "attachments": [OpportunityAttachment],
      "consents": [ConsentOutput],
      "email": "notice-federal-mission-focus-official",
      "extraDetailItems": [ExtraDetail],
      "funnel": SalesFunnel,
      "leadNumber": "ground-model-measure-political-debate",
      "leadType": "than-forget-town-case-wind",
      "name": "strong-sport-woman-example-ahead",
      "notes": "story-image-such-surface-may",
      "number": "official-rate-PM-fast-human",
      "offerGroupId": "54358086",
      "opportunityAddress": AddressOutput,
      "opportunityRichAddress": RichAddressType,
      "phoneNumber": "education-bag-wait-situation-firm",
      "productOffering": OfferingType,
      "productOfferingId": "98045837",
      "salesChannel": "growth-art-himself-that-catch",
      "stage": "training-that-future-different-enter",
      "supplyPoints": [LeadSupplyPointType]
    }
  }
}

opportunityProductSummary

Type: [OpportunityProductSummary!]!

URL: https://api.oees-kraken.energy/v1/graphql/

Return summaries of all products in opportunity's accepted offer. Supports multi-product offerings like dual fuel.

Query Complexity: 2

Possible Errors:

  • KT-CT-8906: Opportunity not found.
  • KT-CT-8922: The opportunity does not have an accepted offer.
  • KT-CT-8923: The opportunity does not have a linked offer group.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query leads

Arguments

Name Description

number (String)

Opportunity number.

Query

query OpportunityProductSummary($number: String) {
  opportunityProductSummary(number: $number) {
    market
    productCharacteristics
    productCode
    productIdentifier
    productOfferingIdentifier
  }
}

Variables

{
  "number": "wear-like-war-single-letter"
}

Response

{
  "data": {
    "opportunityProductSummary": [
      {
        "market": "enough-letter-lawyer-month-seek",
        "productCharacteristics": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
        "productCode": "performance-other-PM-color-company",
        "productIdentifier": "86014982",
        "productOfferingIdentifier": "71357987"
      }
    ]
  }
}

opportunityValueByKey

Type: String

URL: https://api.oees-kraken.energy/v1/graphql/

Get the value of a given key that is stored in an opportunity's related JSONFields.

Query Complexity: 2

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query leads

Arguments

Name Description

key (String)

The key the a funnel-specific value you wish to obtain.

opportunityId (ID)

The identifier of the opportunity to query.

Query

query OpportunityValueByKey(
  $key: String,
  $opportunityId: ID
) {
  opportunityValueByKey(
    key: $key,
    opportunityId: $opportunityId
  )
}

Variables

{
  "key": "need-performance-age-Democrat-section",
  "opportunityId": "60142383"
}

Response

{
  "data": {
    "opportunityValueByKey": "risk-practice-large-foot-best"
  }
}

p0Details

Type: P0Details

URL: https://api.oees-kraken.energy/v1/graphql/

Retrieve P0 supply point information including acceptance, rejection, or error details.

Query Complexity: 2

Possible Errors:

  • KT-ES-4501: Unexpected error retrieving P0 details.
  • KT-ES-4502: P0 requests are currently not supported for the provided DNO.
  • KT-ES-4503: The DNO sent a malformed P0 response that could not be processed.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access third party queries

Arguments

Name Description

cups (String!)

Universal Supply Point code.

nif (String)

Spanish tax identification number (optional).

Query

query P0Details(
  $cups: String!,
  $nif: String
) {
  p0Details(
    cups: $cups,
    nif: $nif
  ) {
    ... on P0DetailsAcceptance {
      ...P0DetailsAcceptanceFragment
    }
    ... on P0DetailsRejection {
      ...P0DetailsRejectionFragment
    }
  }
}

Variables

{
  "cups": "mind-half-reduce-four-during",
  "nif": "doctor-early-hospital-already-employee"
}

Response

{
  "data": {
    "p0Details": P0DetailsAcceptance
  }
}

p0Validation

Type: NifCupsCorrelationValidation

URL: https://api.oees-kraken.energy/v1/graphql/

Call to P0 endpoint crosschecking that a customer with a given NIF is the current owner of the given cups.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access third party queries

Arguments

Name Description

cups (String!)

Universal Supply Point code.

nif (String!)

Spanish tax identification number.

Query

query P0Validation(
  $cups: String!,
  $nif: String!
) {
  p0Validation(
    cups: $cups,
    nif: $nif
  ) {
    nifCupsCorrelate
    validResponse
  }
}

Variables

{
  "cups": "rise-material-main-include-benefit",
  "nif": "article-gas-happen-within-enough"
}

Response

{
  "data": {
    "p0Validation": {
      "nifCupsCorrelate": true,
      "validResponse": true
    }
  }
}

partnerUser

Type: PartnerUserType

URL: https://api.oees-kraken.energy/v1/graphql/

Return the details of a given partner user, if any exists.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query partner users

Arguments

Name Description

email (String)

The partner user email address.

number (String)

The partner user number.

Query

query PartnerUser(
  $email: String,
  $number: String
) {
  partnerUser(
    email: $email,
    number: $number
  ) {
    createdAt
    email
    familyName
    givenName
    id
    lastLogin
    name
    number
    organisation {
      ...AffiliateOrganisationTypeFragment
    }
    permissions {
      ...PartnerUserPermissionFragment
    }
  }
}

Variables

{
  "email": "investment-him-within-seem-practice",
  "number": "hard-no-knowledge-like-sea"
}

Response

{
  "data": {
    "partnerUser": {
      "createdAt": "1990-10-10T12:29:10.033405+00:00",
      "email": "form-still-study-color-knowledge",
      "familyName": "King",
      "givenName": "Jennifer",
      "id": "39711063",
      "lastLogin": "2011-12-25T14:25:59.327432+00:00",
      "name": "city-professor-able-catch-cut",
      "number": "nice-anyone-serious-can-line",
      "organisation": AffiliateOrganisationType,
      "permissions": [PartnerUserPermission]
    }
  }
}

partnerViewer

Type: PartnerViewerType

URL: https://api.oees-kraken.energy/v1/graphql/

The currently authenticated partner user.

This field requires the Authorization header to be set.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Query

query PartnerViewer {
  partnerViewer {
    email
    name
    number
    permissions {
      ...PartnerViewerPermissionFragment
    }
  }
}

Response

{
  "data": {
    "partnerViewer": {
      "email": "benefit-home-here-section-page",
      "name": "card-meeting-fast-offer-room",
      "number": "free-thousand-represent-official-beat",
      "permissions": [PartnerViewerPermission]
    }
  }
}

passwordValidatorHelpTexts

Type: [String]

URL: https://api.oees-kraken.energy/v1/graphql/

The help text of all configured password validators as plain-text or html. Defaults to plain-text.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Arguments

Name Description

asHtml (Boolean)

Return the results as html instead of plain-text. Defaults to False.

Query

query PasswordValidatorHelpTexts($asHtml: Boolean) {
  passwordValidatorHelpTexts(asHtml: $asHtml)
}

Variables

{
  "asHtml": true
}

Response

{
  "data": {
    "passwordValidatorHelpTexts": "short-practice-tree-cover-sign"
  }
}

paymentFingerprintChecks

Type: PaymentFingerPrintCheckType

URL: https://api.oees-kraken.energy/v1/graphql/

Check if a given payment fingerprint already exists and/or is risk-listed.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

fingerprint (String!)

Fingerprint.

Query

query PaymentFingerprintChecks($fingerprint: String!) {
  paymentFingerprintChecks(fingerprint: $fingerprint) {
    fingerprint
    isFound
    isRiskListed
  }
}

Variables

{
  "fingerprint": "voice-keep-will-admit-specific"
}

Response

{
  "data": {
    "paymentFingerprintChecks": {
      "fingerprint": "smile-until-story-bit-piece",
      "isFound": true,
      "isRiskListed": true
    }
  }
}

paymentRequests

Type: PaymentRequestsType

URL: https://api.oees-kraken.energy/v1/graphql/

Get all payment requests for the given ledger.

Query Complexity: 6

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

ledgerNumber (String!)

Kraken ledger number.

Query

query PaymentRequests($ledgerNumber: String!) {
  paymentRequests(ledgerNumber: $ledgerNumber) {
    paymentRequest {
      ...PaymentRequestConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "ledgerNumber": "again-two-nearly-stage-our"
}

Response

{
  "data": {
    "paymentRequests": {
      "paymentRequest": PaymentRequestConnectionTypeConnection
    }
  }
}

plannedDispatches

Type: [UpsideDispatchType]

URL: https://api.oees-kraken.energy/v1/graphql/

All planned device dispatches 24 hours ahead, (usually) in time order.

Query Complexity: 3

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Rate Limits

Key Steps

User

['300/h']

Deprecated

The 'plannedDispatches' field is deprecated.

Please use 'flexPlannedDispatches' instead.

- Marked as deprecated on 2025-05-27.
- Scheduled for removal on or after 2026-01-16.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/604/

Arguments

Name Description

accountNumber (String!)

Query

query PlannedDispatches($accountNumber: String!) {
  plannedDispatches(accountNumber: $accountNumber) {
    delta
    end
    meta {
      ...UpsideDispatchMetaTypeFragment
    }
    start
  }
}

Variables

{
  "accountNumber": "A-00DDF4A2"
}

Response

{
  "data": {
    "plannedDispatches": [
      {
        "delta": "1.0",
        "end": "1984-10-06T23:26:39.538661+00:00",
        "meta": UpsideDispatchMetaType,
        "start": "2021-09-06T22:02:21.371560+00:00"
      }
    ]
  }
}

portfolio

Type: PortfolioType

URL: https://api.oees-kraken.energy/v1/graphql/

Get details about a portfolio, using its portfolio number.

Query Complexity: 2

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can query portfolios

Arguments

Name Description

portfolioNumber (String!)

Portfolio number to be retrieved.

Query

query Portfolio($portfolioNumber: String!) {
  portfolio(portfolioNumber: $portfolioNumber) {
    accounts {
      ...AccountConnectionTypeConnectionFragment
    }
    ancestors {
      ...PortfolioConnectionTypeConnectionFragment
    }
    billingName
    brand
    collectiveBilling
    createdAt
    depth
    descendants {
      ...PortfolioConnectionTypeConnectionFragment
    }
    id
    leadAccountNumber
    name
    number
    operationsTeam {
      ...OperationsTeamTypeFragment
    }
    parent {
      ...PortfolioTypeFragment
    }
    updatedAt
  }
}

Variables

{
  "portfolioNumber": "P-AEAAD41D"
}

Response

{
  "data": {
    "portfolio": {
      "accounts": AccountConnectionTypeConnection,
      "ancestors": PortfolioConnectionTypeConnection,
      "billingName": "standard-age-country-common-truth",
      "brand": "building-grow-production-produce-final",
      "collectiveBilling": true,
      "createdAt": "2003-09-05T07:29:58.969806+00:00",
      "depth": 28,
      "descendants": PortfolioConnectionTypeConnection,
      "id": "10015422",
      "leadAccountNumber": "A-6D24DA0A",
      "name": "anything-do-instead-doctor-center",
      "number": "above-level-man-we-challenge",
      "operationsTeam": OperationsTeamType,
      "parent": PortfolioType,
      "updatedAt": "2020-02-13T16:36:00.467637+00:00"
    }
  }
}

portfolioByReference

Type: PortfolioType

URL: https://api.oees-kraken.energy/v1/graphql/

Get details about a portfolio, using its reference.

Query Complexity: 2

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can query portfolios

Arguments

Name Description

portfolioReference (PortfolioReferenceInput!)

Portfolio reference namespace-value pair to filter by.

Query

query PortfolioByReference($portfolioReference: PortfolioReferenceInput!) {
  portfolioByReference(portfolioReference: $portfolioReference) {
    accounts {
      ...AccountConnectionTypeConnectionFragment
    }
    ancestors {
      ...PortfolioConnectionTypeConnectionFragment
    }
    billingName
    brand
    collectiveBilling
    createdAt
    depth
    descendants {
      ...PortfolioConnectionTypeConnectionFragment
    }
    id
    leadAccountNumber
    name
    number
    operationsTeam {
      ...OperationsTeamTypeFragment
    }
    parent {
      ...PortfolioTypeFragment
    }
    updatedAt
  }
}

Variables

{
  "portfolioReference": PortfolioReferenceInput
}

Response

{
  "data": {
    "portfolioByReference": {
      "accounts": AccountConnectionTypeConnection,
      "ancestors": PortfolioConnectionTypeConnection,
      "billingName": "less-single-reason-onto-parent",
      "brand": "professional-indicate-stop-town-seat",
      "collectiveBilling": true,
      "createdAt": "1991-01-22T12:58:47.402580+00:00",
      "depth": 62,
      "descendants": PortfolioConnectionTypeConnection,
      "id": "76331376",
      "leadAccountNumber": "A-BB8B255E",
      "name": "according-forward-beyond-friend-and",
      "number": "system-thus-cost-quite-drug",
      "operationsTeam": OperationsTeamType,
      "parent": PortfolioType,
      "updatedAt": "2010-07-16T04:10:05.182846+00:00"
    }
  }
}

possibleErrors

Type: PossibleErrorsOutputType

URL: https://api.oees-kraken.energy/v1/graphql/

Possible errors of the requested query/mutation.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Rate Limits

Key Steps

Ip

['10/m']

Arguments

Name Description

input (PossibleErrorsInputType!)

Query or Mutation for which to get the possible errors list.

Query

query PossibleErrors($input: PossibleErrorsInputType!) {
  possibleErrors(input: $input) {
    authErrors
    name
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    type
  }
}

Variables

Response

{
  "data": {
    "possibleErrors": {
      "authErrors": true,
      "name": "campaign-young-option-always-now",
      "possibleErrors": [PossibleErrorType],
      "type": "query"
    }
  }
}

printBatch

Type: PrintBatchType!

URL: https://api.oees-kraken.energy/v1/graphql/

Get print batch details, including messages in the batch.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query print batches

Arguments

Name Description

batchId (ID)

The print batch ID.

printBatchId (Int)

The print batch ID.

Query

query PrintBatch($batchId: ID) {
  printBatch(batchId: $batchId) {
    id
    messages {
      ...PrintMessageTypeConnectionFragment
    }
    status
  }
}

Variables

{
  "batchId": "51992132"
}

Response

{
  "data": {
    "printBatch": {
      "id": "74861583",
      "messages": PrintMessageTypeConnection,
      "status": "OPEN"
    }
  }
}

productsWithEstimates

Type: ProductWithEstimates

URL: https://api.oees-kraken.energy/v1/graphql/

Get all products providing an estimate, either CUPS or annualConsumption.

Query Complexity: 1

Possible Errors:

  • KT-ES-7802: The request to Chipiron was not fulfilled correctly.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Arguments

Name Description

brand (String)

The market brand code.

date (Date)

The date when product must be available.

electricityAnnualConsumption (Int)

Estimated electricity annual consumption.

electricityCups (String)

Supply point electricity CUPS.

gasAnnualConsumption (Int)

Estimated gas annual consumption.

gasCups (String)

Supply point gas CUPS.

isHidden (Boolean)

Get products based on its hidden attribute.

organizationName (String)

The organization from which filter the products.

Query

query ProductsWithEstimates(
  $brand: String,
  $date: Date,
  $electricityAnnualConsumption: Int,
  $electricityCups: String,
  $gasAnnualConsumption: Int,
  $gasCups: String,
  $isHidden: Boolean,
  $organizationName: String
) {
  productsWithEstimates(
    brand: $brand,
    date: $date,
    electricityAnnualConsumption: $electricityAnnualConsumption,
    electricityCups: $electricityCups,
    gasAnnualConsumption: $gasAnnualConsumption,
    gasCups: $gasCups,
    isHidden: $isHidden,
    organizationName: $organizationName
  ) {
    dualFuel {
      ...DualFuelProductQuoteFragment
    }
    singleFuel {
      ...SingleFuelProductQuoteFragment
    }
  }
}

Variables

{
  "brand": "scientist-true-training-need-toward",
  "date": "1999-11-10",
  "electricityAnnualConsumption": 49,
  "electricityCups": "west-miss-difference-talk-everybody",
  "gasAnnualConsumption": 41,
  "gasCups": "office-end-out-bar-many",
  "isHidden": true,
  "organizationName": "war-why-short-head-nearly"
}

Response

{
  "data": {
    "productsWithEstimates": {
      "dualFuel": [DualFuelProductQuote],
      "singleFuel": [SingleFuelProductQuote]
    }
  }
}

productsWithoutEstimates

Type: [ProductWithoutEstimates]

URL: https://api.oees-kraken.energy/v1/graphql/

Get all active non-hidden products without providing any estimate.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Arguments

Name Description

brand (String)

The market brand code.

date (Date)

The date when product must be available.

isHidden (Boolean)

Get products based on its hidden attribute, only for organizations.

organizationName (String)

The organization from which filter the products.

Query

query ProductsWithoutEstimates(
  $brand: String,
  $date: Date,
  $isHidden: Boolean,
  $organizationName: String
) {
  productsWithoutEstimates(
    brand: $brand,
    date: $date,
    isHidden: $isHidden,
    organizationName: $organizationName
  ) {
    availableFrom
    availableTo
    brand {
      ...BrandFragment
    }
    code
    currentAgreementCount
    description
    displayName
    dualFuelDescription
    fullName
    id
    isHidden
    marketName
    notes
    params {
      ...ProductParamsFragment
    }
    prices {
      ...ProductPricesFragment
    }
    term
  }
}

Variables

{
  "brand": "office-must-our-various-local",
  "date": "2022-05-05",
  "isHidden": true,
  "organizationName": "fish-standard-military-develop-treatment"
}

Response

{
  "data": {
    "productsWithoutEstimates": [
      {
        "availableFrom": "2021-09-07T22:17:01.377542+00:00",
        "availableTo": "1990-01-11T22:11:01.054980+00:00",
        "brand": Brand,
        "code": "music-memory-commercial-throw-play",
        "currentAgreementCount": 98,
        "description": "course-daughter-music-nothing-increase",
        "displayName": "wife-improve-quite-ahead-standard",
        "dualFuelDescription": "call-time-network-community-brother",
        "fullName": "statement-better-people-condition-base",
        "id": "21837233",
        "isHidden": true,
        "marketName": "cause-actually-impact-spend-everyone",
        "notes": "generation-today-just-player-major",
        "params": ProductParams,
        "prices": ProductPrices,
        "term": 60
      }
    ]
  }
}

propertiesSearch

Type: [PropertySearchResult!]!

URL: https://api.oees-kraken.energy/v1/graphql/

Search for properties that are already in Kraken and match the search term.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query property

Arguments

Name Description

searchTerm (String!)

The search term. It can be an address or a meter point identifier.

Query

query PropertiesSearch($searchTerm: String!) {
  propertiesSearch(searchTerm: $searchTerm) {
    property {
      ...PropertyTypeFragment
    }
    score
  }
}

Variables

{
  "searchTerm": "over-level-such-energy-from"
}

Response

{
  "data": {
    "propertiesSearch": [
      {
        "property": PropertyType,
        "score": "1.0"
      }
    ]
  }
}

property

Type: PropertyType

URL: https://api.oees-kraken.energy/v1/graphql/

A property with the given ID. Usually associated with supply points.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

id (ID!)

The property ID.

Query

query Property($id: ID!) {
  property(id: $id) {
    address
    ancestors {
      ...PropertyConnectionFragment
    }
    coordinates {
      ...CoordinatesTypeFragment
    }
    descendants {
      ...PropertyConnectionFragment
    }
    electricitySupplyPoints {
      ...ElectricitySupplyPointFragment
    }
    embeddedNetwork {
      ...EmbeddedNetworkTypeFragment
    }
    gasSupplyPoints {
      ...GasSupplyPointFragment
    }
    id
    label
    measurements {
      ...MeasurementConnectionFragment
    }
    occupancyPeriods {
      ...OccupancyPeriodTypeFragment
    }
    parent {
      ...PropertyInterfaceFragment
    }
    postcode
    richAddress {
      ...PropertyRichAddressTypeFragment
    }
    splitAddress
  }
}

Variables

{
  "id": "18520814"
}

Response

{
  "data": {
    "property": {
      "address": "lead-raise-hold-hour-attention",
      "ancestors": PropertyConnection,
      "coordinates": CoordinatesType,
      "descendants": PropertyConnection,
      "electricitySupplyPoints": [ElectricitySupplyPoint],
      "embeddedNetwork": EmbeddedNetworkType,
      "gasSupplyPoints": [GasSupplyPoint],
      "id": "28379170",
      "label": "employee-protect-chair-cost-him",
      "measurements": MeasurementConnection,
      "occupancyPeriods": [OccupancyPeriodType],
      "parent": PropertyInterface,
      "postcode": "by-easy-color-factor-per",
      "richAddress": PropertyRichAddressType,
      "splitAddress": "campaign-training-until-herself-direction"
    }
  }
}

propertySearch

Type: [PropertyType]

URL: https://api.oees-kraken.energy/v1/graphql/

Search for properties that are already in Kraken and match the search term.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query property

Deprecated

The 'propertySearch' field is deprecated.

This query is being deprecated in favour of `propertiesSearch`. The latter returns not only the matched properties but the level of confidence in the results through the `score` field.

- Marked as deprecated on 2023-05-23.
- Scheduled for removal on or after 2024-01-01.

Arguments

Name Description

searchTerm (String!)

The search term. It can be an address or a meter point identifier.

Query

query PropertySearch($searchTerm: String!) {
  propertySearch(searchTerm: $searchTerm) {
    address
    ancestors {
      ...PropertyConnectionFragment
    }
    coordinates {
      ...CoordinatesTypeFragment
    }
    descendants {
      ...PropertyConnectionFragment
    }
    electricitySupplyPoints {
      ...ElectricitySupplyPointFragment
    }
    embeddedNetwork {
      ...EmbeddedNetworkTypeFragment
    }
    gasSupplyPoints {
      ...GasSupplyPointFragment
    }
    id
    label
    measurements {
      ...MeasurementConnectionFragment
    }
    occupancyPeriods {
      ...OccupancyPeriodTypeFragment
    }
    parent {
      ...PropertyInterfaceFragment
    }
    postcode
    richAddress {
      ...PropertyRichAddressTypeFragment
    }
    splitAddress
  }
}

Variables

{
  "searchTerm": "big-reach-high-ahead-happen"
}

Response

{
  "data": {
    "propertySearch": [
      {
        "address": "hit-catch-seek-describe-letter",
        "ancestors": PropertyConnection,
        "coordinates": CoordinatesType,
        "descendants": PropertyConnection,
        "electricitySupplyPoints": [ElectricitySupplyPoint],
        "embeddedNetwork": EmbeddedNetworkType,
        "gasSupplyPoints": [GasSupplyPoint],
        "id": "39552822",
        "label": "morning-leave-machine-hot-affect",
        "measurements": MeasurementConnection,
        "occupancyPeriods": [OccupancyPeriodType],
        "parent": PropertyInterface,
        "postcode": "buy-community-doctor-five-we",
        "richAddress": PropertyRichAddressType,
        "splitAddress": "table-individual-catch-point-evening"
      }
    ]
  }
}

providerVirtualKeyDetails

Type: ProviderVirtualKeyDetailsType

URL: https://api.oees-kraken.energy/v1/graphql/

Virtual key details (e.g. certificate public key) for the provider (if available).

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

deviceType (KrakenFlexDeviceTypes!)

The device type to get the virtual key details for (as providers may support multiple).

provider (ProviderChoices!)

The provider to get the virtual key details for.

Query

query ProviderVirtualKeyDetails(
  $deviceType: KrakenFlexDeviceTypes!,
  $provider: ProviderChoices!
) {
  providerVirtualKeyDetails(
    deviceType: $deviceType,
    provider: $provider
  ) {
    virtualKeyName
    virtualKeyUri
  }
}

Variables

{
  "deviceType": "BATTERIES",
  "provider": "BYD"
}

Response

{
  "data": {
    "providerVirtualKeyDetails": {
      "virtualKeyName": "ground-decide-garden-wrong-executive",
      "virtualKeyUri": "fact-against-guy-manager-set"
    }
  }
}

provinces

Type: [Province]

URL: https://api.oees-kraken.energy/v1/graphql/

Spanish provinces.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Query

query Provinces {
  provinces {
    label
    value
  }
}

Response

{
  "data": {
    "provinces": [
      {
        "label": "over-discussion-write-nice-national",
        "value": "Congress-machine-near-court-continue"
      }
    ]
  }
}

queryComplexity

Type: QueryComplexityOutputType

URL: https://api.oees-kraken.energy/v1/graphql/

Get the complexity of a query.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access third party queries

Arguments

Name Description

input (QueryComplexityInputType!)

Query and relevant variables required to calculate the complexity.

Query

query QueryComplexity($input: QueryComplexityInputType!) {
  queryComplexity(input: $input) {
    complexityValue
  }
}

Variables

Response

{
  "data": {
    "queryComplexity": {
      "complexityValue": 73
    }
  }
}

question

Type: String

URL: https://api.oees-kraken.energy/v1/graphql/

Get the customer feedback survey question.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can submit customer feedback

Arguments

Name Description

formId (Int!)

Query

query Question($formId: Int!) {
  question(formId: $formId)
}

Variables

{
  "formId": 10733489
}

Response

{
  "data": {
    "question": "fly-measure-season-seat-cultural"
  }
}

quoteConfigurationByNumber

Type: QuoteConfigurationType

URL: https://api.oees-kraken.energy/v1/graphql/

Get a quote configuration by its number.

Query Complexity: 2

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query quote configuration

Arguments

Name Description

number (String)

Unique number identifying the quote configuration.

Query

query QuoteConfigurationByNumber($number: String) {
  quoteConfigurationByNumber(number: $number) {
    contractEnd
    contractStart
    createdBy
    expiresAt
    extraDetailsItems {
      ...QuoteConfigurationExtraDetailItemTypeFragment
    }
    extraQuotingParams {
      ...ExtraQuotingParamsTypeFragment
    }
    number
    opportunityNumber
    status
    terms {
      ...QuoteTermInterfaceFragment
    }
  }
}

Variables

{
  "number": "subject-station-the-difference-position"
}

Response

{
  "data": {
    "quoteConfigurationByNumber": {
      "contractEnd": "1983-09-01T17:51:42.479710+00:00",
      "contractStart": "2010-07-10T04:57:25.995336+00:00",
      "createdBy": "occur-travel-pattern-interest-successful",
      "expiresAt": "2001-12-07T23:09:41.751163+00:00",
      "extraDetailsItems": [QuoteConfigurationExtraDetailItemType],
      "extraQuotingParams": ExtraQuotingParamsType,
      "number": "her-professor-result-set-type",
      "opportunityNumber": "compare-himself-choice-turn-boy",
      "status": "DRAFT",
      "terms": QuoteTermInterface
    }
  }
}

quoteRequest

Type: QuoteRequest

URL: https://api.oees-kraken.energy/v1/graphql/

The quote request with a list of quoted supply points and their products.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Rate Limits

Key Steps

Ip

['10/m']

Arguments

Name Description

code (String!)

The quote request code.

Query

query QuoteRequest($code: String!) {
  quoteRequest(code: $code) {
    code
    id
    quotedSupplyPoints {
      ...QuotedSupplyPointFragment
    }
  }
}

Variables

{
  "code": "more-my-professional-coach-discuss"
}

Response

{
  "data": {
    "quoteRequest": {
      "code": "at-food-arrive-by-century",
      "id": "81843153",
      "quotedSupplyPoints": [QuotedSupplyPoint]
    }
  }
}

quotingParamDefinitionsForProductOffering

Type: QuotedOfferingParamsType

URL: https://api.oees-kraken.energy/v1/graphql/

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can create quoting offer group

Arguments

Name Description

productOfferingIdentifier (ID)

The identifier of the product offering.

Query

query QuotingParamDefinitionsForProductOffering($productOfferingIdentifier: ID) {
  quotingParamDefinitionsForProductOffering(productOfferingIdentifier: $productOfferingIdentifier) {
    offeringComponents {
      ...QuotedOfferingParamsTypeFragment
    }
    offeringIdentifier
    productComponents {
      ...QuotedProductComponentTypeFragment
    }
  }
}

Variables

{
  "productOfferingIdentifier": "63306504"
}

Response

{
  "data": {
    "quotingParamDefinitionsForProductOffering": {
      "offeringComponents": [QuotedOfferingParamsType],
      "offeringIdentifier": "62613631",
      "productComponents": [QuotedProductComponentType]
    }
  }
}

rateGroupTouScheme

Type: TimeOfUseSchemeType

URL: https://api.oees-kraken.energy/v1/graphql/

Get the time of use scheme definition and available time slots for a rate group within a product specification.

Query Complexity: 1

Possible Errors:

  • KT-CT-12010: Unable to find the product's specification.
  • KT-CT-12049: Rate specification not found in the given product specification.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query catalog offerings

Arguments

Name Description

rateGroupCode (String!)

The rate group code (rate specification code).

specificationIdentifier (String!)

The identifier of the product specification.

Query

query RateGroupTouScheme(
  $rateGroupCode: String!,
  $specificationIdentifier: String!
) {
  rateGroupTouScheme(
    rateGroupCode: $rateGroupCode,
    specificationIdentifier: $specificationIdentifier
  ) {
    name
    timeslots {
      ...TimeSlotWithActivationRuleTypeFragment
    }
    timezone
  }
}

Variables

{
  "rateGroupCode": "born-somebody-wife-all-thing",
  "specificationIdentifier": "92096792"
}

Response

{
  "data": {
    "rateGroupTouScheme": {
      "name": "north-environment-herself-amount-loss",
      "timeslots": [TimeSlotWithActivationRuleType],
      "timezone": "whom-ball-serve-those-tend"
    }
  }
}

rateLimitInfo

Type: CombinedRateLimitInformation

URL: https://api.oees-kraken.energy/v1/graphql/

Combined information about points-allowance rate limiting and request-specific rate limiting.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Rate Limits

Key Steps

Ip

['10/m']

Query

query RateLimitInfo {
  rateLimitInfo {
    fieldSpecificRateLimits {
      ...FieldSpecificRateLimitInformationConnectionTypeConnectionFragment
    }
    pointsAllowanceRateLimit {
      ...PointsAllowanceRateLimitInformationFragment
    }
  }
}

Response

{
  "data": {
    "rateLimitInfo": {
      "fieldSpecificRateLimits": FieldSpecificRateLimitInformationConnectionTypeConnection,
      "pointsAllowanceRateLimit": PointsAllowanceRateLimitInformation
    }
  }
}

registeredKrakenflexDevice

Type: KrakenFlexDeviceType

URL: https://api.oees-kraken.energy/v1/graphql/

A device registered with KrakenFlex for a given account.

Query Complexity: 2

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Rate Limits

Key Steps

User

['300/h']

Deprecated

The 'registeredKrakenflexDevice' field is deprecated.

Please use 'devices' instead.

- Marked as deprecated on 2024-04-23.
- Scheduled for removal on or after 2026-03-01.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/677/

Arguments

Name Description

accountNumber (String!)

Query

query RegisteredKrakenflexDevice($accountNumber: String!) {
  registeredKrakenflexDevice(accountNumber: $accountNumber) {
    chargePointMake
    chargePointModel
    chargePointPowerInKw
    createdAt
    hasToken
    krakenflexDeviceId
    provider
    stateOfChargeLimit {
      ...StateOfChargeLimitFragment
    }
    status
    suspended
    testDispatchFailureReason
    vehicleBatterySizeInKwh
    vehicleMake
    vehicleModel
  }
}

Variables

{
  "accountNumber": "A-C4621132"
}

Response

{
  "data": {
    "registeredKrakenflexDevice": {
      "chargePointMake": "deep-per-ability-security-down",
      "chargePointModel": "response-daughter-line-entire-city",
      "chargePointPowerInKw": "1.0",
      "createdAt": "2011-11-16T06:41:15.590303+00:00",
      "hasToken": true,
      "krakenflexDeviceId": "47071566",
      "provider": "BYD",
      "stateOfChargeLimit": StateOfChargeLimit,
      "status": "head-per-admit-sister-short",
      "suspended": true,
      "testDispatchFailureReason": "NONE",
      "vehicleBatterySizeInKwh": "1.0",
      "vehicleMake": "then-say-fast-federal-wife",
      "vehicleModel": "list-grow-development-throughout-tend"
    }
  }
}

returnSchedule

Type: [DepositReturnScheduleOutput]

URL: https://api.oees-kraken.energy/v1/graphql/

Get deposit agreement related return schedules for a given account.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can use deposit system

Arguments

Name Description

accountNumber (String!)

Query

query ReturnSchedule($accountNumber: String!) {
  returnSchedule(accountNumber: $accountNumber) {
    amount
    dueDate
    status
  }
}

Variables

{
  "accountNumber": "A-4FDBB125"
}

Response

{
  "data": {
    "returnSchedule": [
      {
        "amount": 79,
        "dueDate": "1970-06-20",
        "status": "politics-heavy-animal-play-music"
      }
    ]
  }
}

routingAttributes

Type: [RoutingAttributeType]!

URL: https://api.oees-kraken.energy/v1/graphql/

Get routing attributes available for call routing configuration.

Query Complexity: 2

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query calls

Arguments

Name Description

category (String)

Filter by category (LANGUAGE, OPERATIONS_GROUP, SKILL).

search (String)

Filter by friendly name (case-insensitive).

Query

query RoutingAttributes(
  $category: String,
  $search: String
) {
  routingAttributes(
    category: $category,
    search: $search
  ) {
    category
    friendlyName
    isActive
    ref
    subcategory
  }
}

Variables

{
  "category": "child-place-lose-west-yes",
  "search": "hour-between-would-language-early"
}

Response

{
  "data": {
    "routingAttributes": [
      {
        "category": "painting-cold-very-knowledge-wind",
        "friendlyName": "policy-court-think-involve-just",
        "isActive": true,
        "ref": "avoid-product-child-study-item",
        "subcategory": "couple-hospital-between-job-site"
      }
    ]
  }
}

salesFunnelByCode

Type: SalesFunnel

URL: https://api.oees-kraken.energy/v1/graphql/

Get the sales funnel by input.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query sales funnels

Arguments

Name Description

input (SalesFunnelInput!)

Input fields for retrieving the sales funnel.

Query

query SalesFunnelByCode($input: SalesFunnelInput!) {
  salesFunnelByCode(input: $input) {
    code
    collections {
      ...CollectionFragment
    }
    funnelType
    name
    rules {
      ...SalesFunnelRuleFragment
    }
    stages {
      ...SalesFunnelStageFragment
    }
    status
  }
}

Variables

{
  "input": SalesFunnelInput
}

Response

{
  "data": {
    "salesFunnelByCode": {
      "code": "state-will-serious-official-exist",
      "collections": [Collection],
      "funnelType": "LEAD",
      "name": "couple-analysis-series-economy-many",
      "rules": [SalesFunnelRule],
      "stages": [SalesFunnelStage],
      "status": "DRAFT"
    }
  }
}

salesFunnels

Type: [SalesFunnel]

URL: https://api.oees-kraken.energy/v1/graphql/

Get all sales funnels.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query sales funnels

Arguments

Name Description

input (SalesFunnelsInput)

Input fields for retrieving the sales funnels.

Query

query SalesFunnels($input: SalesFunnelsInput) {
  salesFunnels(input: $input) {
    code
    collections {
      ...CollectionFragment
    }
    funnelType
    name
    rules {
      ...SalesFunnelRuleFragment
    }
    stages {
      ...SalesFunnelStageFragment
    }
    status
  }
}

Variables

{
  "input": SalesFunnelsInput
}

Response

{
  "data": {
    "salesFunnels": [
      {
        "code": "beautiful-start-smile-center-base",
        "collections": [Collection],
        "funnelType": "LEAD",
        "name": "consumer-make-institution-American-three",
        "rules": [SalesFunnelRule],
        "stages": [SalesFunnelStage],
        "status": "DRAFT"
      }
    ]
  }
}

searchLead

Type: LeadIdType

URL: https://api.oees-kraken.energy/v1/graphql/

Search and return the identifiers of a lead.

Query Complexity: 2

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query leads

Arguments

Name Description

filters (SearchLeadFilters!)

Filters to search for leads. All passed filters will be checked against the lead.

Query

query SearchLead($filters: SearchLeadFilters!) {
  searchLead(filters: $filters) {
    number
  }
}

Variables

{
  "filters": SearchLeadFilters
}

Response

{
  "data": {
    "searchLead": {
      "number": "together-main-dark-cold-development"
    }
  }
}

simpleQuoteLevels

Type: [QuoteEstimatimation]

URL: https://api.oees-kraken.energy/v1/graphql/

Get quote estimation list.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Deprecated

The 'simpleQuoteLevels' field is deprecated.

Migrated to OE Backend API.

- Marked as deprecated on 2025-10-27.
- Scheduled for removal on or after 2025-11-10.

Query

query SimpleQuoteLevels {
  simpleQuoteLevels {
    annualConsumption
    consumptionDetails
    consumptionLevel
    estimates {
      ...EstimationTypeFragment
    }
  }
}

Response

{
  "data": {
    "simpleQuoteLevels": [
      {
        "annualConsumption": 47,
        "consumptionDetails": "hold-record-recognize-party-hundred",
        "consumptionLevel": "so-result-team-traditional-quite",
        "estimates": EstimationType
      }
    ]
  }
}

sipsData

Type: SIPSData

URL: https://api.oees-kraken.energy/v1/graphql/

Get SIPS (Sistema Información Puntos Suministro) data for a given CUPS.

Query Complexity: 5

Possible Errors:

  • KT-ES-7820: SIPS data not available for the given supply point.
  • KT-ES-7821: An unexpected error occurred while attempting to retrieve SIPS data.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access third party queries

Arguments

Name Description

cups (String!)

The CUPS identifier to retrieve SIPS data for.

market (String!)

The market type: 'electricity' or 'gas'.

Query

query SipsData(
  $cups: String!,
  $market: String!
) {
  sipsData(
    cups: $cups,
    market: $market
  ) {
    ... on SIPSElectricityData {
      ...SIPSElectricityDataFragment
    }
    ... on SIPSGasData {
      ...SIPSGasDataFragment
    }
  }
}

Variables

{
  "cups": "area-enter-arm-defense-Democrat",
  "market": "perhaps-crime-already-film-sense"
}

Response

{
  "data": {
    "sipsData": SIPSElectricityData
  }
}

siteworksRequests

Type: CoreSiteworksRequestConnectionTypeConnection

URL: https://api.oees-kraken.energy/v1/graphql/

A query to get a subset of Requests.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Deprecated

The 'siteworksRequests' field is deprecated.

Please use getOnSiteJobsRequests instead.

- Marked as deprecated on 2026-03-01.
- Scheduled for removal on or after 2026-09-01.

Arguments

Name Description

after (String)

before (String)

createdAfter (DateTime)

Only requests created after this datetime will be included.

first (Int)

ids ([UUID])

A list of request IDs. If provided, only these requests will be returned.

last (Int)

statuses ([RequestStatus])

Only requests with a status in this list will be included.

Query

query SiteworksRequests(
  $after: String,
  $before: String,
  $createdAfter: DateTime,
  $first: Int,
  $ids: [UUID],
  $last: Int,
  $statuses: [RequestStatus]
) {
  siteworksRequests(
    after: $after,
    before: $before,
    createdAfter: $createdAfter,
    first: $first,
    ids: $ids,
    last: $last,
    statuses: $statuses
  ) {
    edgeCount
    edges {
      ...CoreSiteworksRequestConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "createdAfter": "2005-02-16T12:35:33.459561+00:00",
  "first": 10,
  "ids": "cfcf87cb-f98d-4693-aac0-ac2e87cb82f1",
  "last": 10,
  "statuses": "APPROVAL_PENDING"
}

Response

{
  "data": {
    "siteworksRequests": {
      "edgeCount": 4,
      "edges": [CoreSiteworksRequestConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 97
    }
  }
}

smartFlexDeviceSupplyPoint

Type: SmartFlexDeviceSupplyPointType

URL: https://api.oees-kraken.energy/v1/graphql/

The supply point linked to the SmartFlex device.

Query Complexity: 2

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can view smartflex data

Rate Limits

Key Steps

User

['850/m']

Arguments

Name Description

smartFlexDeviceId (String)

The SmartFlex device ID to get the supply point details for.

Query

query SmartFlexDeviceSupplyPoint($smartFlexDeviceId: String) {
  smartFlexDeviceSupplyPoint(smartFlexDeviceId: $smartFlexDeviceId) {
    importSupplyPointId
    smartFlexDeviceId
  }
}

Variables

{
  "smartFlexDeviceId": "29490403"
}

Response

{
  "data": {
    "smartFlexDeviceSupplyPoint": {
      "importSupplyPointId": "70426275",
      "smartFlexDeviceId": "31138107"
    }
  }
}

smartFlexOnboardingWizards

Type: [SmartFlexOnboardingWizard!]

URL: https://api.oees-kraken.energy/v1/graphql/

A list of wizards for onboarding devices for an account and property.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountNumber (String!)

The account number, e.g. A-12345678.

includeCancelled (Boolean)

Include cancelled wizards.

includeCompleted (Boolean)

Include completed wizards.

isResumable (Boolean)

Filters for onboarding wizards that can be resumed. List limits to one resumable wizard.

propertyId (Int)

Only list wizards for this property.

wizardId (ID)

To get a specific wizard by ID, if it exists.

Query

query SmartFlexOnboardingWizards(
  $accountNumber: String!,
  $includeCancelled: Boolean,
  $includeCompleted: Boolean,
  $isResumable: Boolean,
  $propertyId: Int,
  $wizardId: ID
) {
  smartFlexOnboardingWizards(
    accountNumber: $accountNumber,
    includeCancelled: $includeCancelled,
    includeCompleted: $includeCompleted,
    isResumable: $isResumable,
    propertyId: $propertyId,
    wizardId: $wizardId
  ) {
    backendScreen {
      ... on ComponentListType {
        ...ComponentListTypeFragment
      }
      ... on Dashboard {
        ...DashboardFragment
      }
      ... on FormScreenType {
        ...FormScreenTypeFragment
      }
      ... on GenericBackendScreen {
        ...GenericBackendScreenFragment
      }
    }
    completedSteps {
      ...SmartFlexOnboardingStepInterfaceFragment
    }
    currentStep {
      ...SmartFlexOnboardingStepInterfaceFragment
    }
    deviceType
    displayName
    id
    resumable {
      ...SmartFlexResumableFragment
    }
  }
}

Variables

{
  "accountNumber": "A-DD32FD44",
  "includeCancelled": true,
  "includeCompleted": true,
  "isResumable": true,
  "propertyId": 16627180,
  "wizardId": "95800183"
}

Response

{
  "data": {
    "smartFlexOnboardingWizards": [
      {
        "backendScreen": ComponentListType,
        "completedSteps": SmartFlexOnboardingStepInterface,
        "currentStep": SmartFlexOnboardingStepInterface,
        "deviceType": "BATTERIES",
        "displayName": "themselves-present-should-difference-natural",
        "id": "70720082",
        "resumable": SmartFlexResumable
      }
    ]
  }
}

solarSimulatorQuote

Type: SolarSimulationQuote

URL: https://api.oees-kraken.energy/v1/graphql/

Get solar simulator response data.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Deprecated

The 'solarSimulatorQuote' field is deprecated.

Migrated to OE Backend API.

- Marked as deprecated on 2025-10-27.
- Scheduled for removal on or after 2025-11-10.

Arguments

Name Description

consumption (Int!)

High-range monthly consumption in EUR.

roofSize (Float!)

Roof size in square meters.

Query

query SolarSimulatorQuote(
  $consumption: Int!,
  $roofSize: Float!
) {
  solarSimulatorQuote(
    consumption: $consumption,
    roofSize: $roofSize
  ) {
    batteryPrice
    cashPaymentPrice
    cashPaymentPriceWithBattery
    cashPrice
    chargerPrice
    co2Emissions {
      ...SolarSimulationCO2SavingsFragment
    }
    financedPrices {
      ...SolarSimulationFinancedPricesFragment
    }
    financePaymentPrices
    financePaymentPricesWithBattery
    governmentSubsidiesMultiplier
    message
    numberOfPanels
    panelPower
    panelPowerUnit
    postInstalationMonthlySpending
    postInstallationMultipliers {
      ...SolarSimulationPostInstallationMultipliersFragment
    }
    priceUnit
    totalPower
    totalPowerUnit
    twentyFiveYearSavings
    twentyFiveYearSavingsMultipliers {
      ...SolarSimulationTwentyFiveYearSavingsMultipliersFragment
    }
    twentyFiveYearSavingsWithBattery
  }
}

Variables

{
  "consumption": 32,
  "roofSize": 434.29
}

Response

{
  "data": {
    "solarSimulatorQuote": {
      "batteryPrice": 663.18,
      "cashPaymentPrice": 375.7,
      "cashPaymentPriceWithBattery": 536.7,
      "cashPrice": 364.55,
      "chargerPrice": 992.4,
      "co2Emissions": SolarSimulationCO2Savings,
      "financedPrices": SolarSimulationFinancedPrices,
      "financePaymentPrices": NO_EXAMPLE_AVAILABLE,
      "financePaymentPricesWithBattery": NO_EXAMPLE_AVAILABLE,
      "governmentSubsidiesMultiplier": 829.45,
      "message": "section-determine-number-wind-real",
      "numberOfPanels": 36,
      "panelPower": 173.47,
      "panelPowerUnit": "practice-thus-according-old-myself",
      "postInstalationMonthlySpending": 570.5,
      "postInstallationMultipliers": SolarSimulationPostInstallationMultipliers,
      "priceUnit": "organization-team-physical-born-result",
      "totalPower": 284.81,
      "totalPowerUnit": "which-and-sound-create-player",
      "twentyFiveYearSavings": 644.9,
      "twentyFiveYearSavingsMultipliers": SolarSimulationTwentyFiveYearSavingsMultipliers,
      "twentyFiveYearSavingsWithBattery": 989.58
    }
  }
}

solarTariff

Type: SpecialTariff

URL: https://api.oees-kraken.energy/v1/graphql/

Send information about the current solar tariff.

Query Complexity: 1

Possible Errors:

  • KT-ES-7802: The request to Chipiron was not fulfilled correctly.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Query

query SolarTariff {
  solarTariff {
    code
    description
    displayName
    id
    marketName
    params {
      ...ProductParamsFragment
    }
    prices {
      ...ProductPricesWithExcessFragment
    }
  }
}

Response

{
  "data": {
    "solarTariff": {
      "code": "take-answer-raise-wife-under",
      "description": "law-common-ten-well-common",
      "displayName": "cell-worker-door-buy-education",
      "id": 16509190,
      "marketName": "compare-approach-throughout-recognize-another",
      "params": ProductParams,
      "prices": ProductPricesWithExcess
    }
  }
}

standardisedAddressInfo

Type: StandardAddressInfo

URL: https://api.oees-kraken.energy/v1/graphql/

Get standardised address information from the postcode.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Arguments

Name Description

postcode (String)

Postcode used to retrieve standard address info.

Query

query StandardisedAddressInfo($postcode: String) {
  standardisedAddressInfo(postcode: $postcode) {
    postcode
    provinceCode
    provinceName
    streetDetails {
      ...StreetDetailsFragment
    }
  }
}

Variables

{
  "postcode": "cell-accept-production-usually-all"
}

Response

{
  "data": {
    "standardisedAddressInfo": {
      "postcode": "actually-conference-always-and-long",
      "provinceCode": "wear-last-establish-lot-such",
      "provinceName": "total-social-no-party-development",
      "streetDetails": [StreetDetails]
    }
  }
}

streetTypes

Type: [StreetType]

URL: https://api.oees-kraken.energy/v1/graphql/

Street types.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

(No)

Query

query StreetTypes {
  streetTypes {
    label
    value
  }
}

Response

{
  "data": {
    "streetTypes": [
      {
        "label": "shake-including-against-simply-resource",
        "value": "just-rich-hotel-challenge-concern"
      }
    ]
  }
}

supplyPoint

Type: SupplyPointType

URL: https://api.oees-kraken.energy/v1/graphql/

Get a supply point by its market specific id.

Query Complexity: 1

Possible Errors:

  • KT-CT-4719: No supply point found for identifier provided.
  • KT-CT-4722: Supply point readings API not configured.
  • KT-CT-4723: Invalid market name provided.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

externalIdentifier (String!)

The market specific supply point id.

marketName (String!)

The name of the market in which this supply point exists.

Query

query SupplyPoint(
  $externalIdentifier: String!,
  $marketName: String!
) {
  supplyPoint(
    externalIdentifier: $externalIdentifier,
    marketName: $marketName
  ) {
    devices {
      ...DevicesConnectionFragment
    }
    externalIdentifier
    id
    marketName
    property {
      ...PropertyTypeFragment
    }
    readings {
      ...ReadingsFragment
    }
  }
}

Variables

{
  "externalIdentifier": "33512521",
  "marketName": "at-stock-material-about-garden"
}

Response

{
  "data": {
    "supplyPoint": {
      "devices": DevicesConnection,
      "externalIdentifier": "13943394",
      "id": "79153215",
      "marketName": "first-property-society-candidate-pattern",
      "property": PropertyType,
      "readings": Readings
    }
  }
}

supplyPoints

Type: SupplyPointConnectionTypeConnection

URL: https://api.oees-kraken.energy/v1/graphql/

Get list of supply points.

Query Complexity: 2

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountNumber (String)

Filter meter points by account.

after (String)

before (String)

first (Int)

last (Int)

portfolioNumber (String)

Filter meter points by portfolio.

Query

query SupplyPoints(
  $accountNumber: String,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $portfolioNumber: String
) {
  supplyPoints(
    accountNumber: $accountNumber,
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    portfolioNumber: $portfolioNumber
  ) {
    edgeCount
    edges {
      ...SupplyPointConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "accountNumber": "A-6C0C8E9D",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10,
  "portfolioNumber": "P-EF2595A5"
}

Response

{
  "data": {
    "supplyPoints": {
      "edgeCount": 45,
      "edges": [SupplyPointConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 27
    }
  }
}

taskResult

Type: TaskResult

URL: https://api.oees-kraken.energy/v1/graphql/

Get the status of a background task.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries

Arguments

Name Description

accountNumber (String!)

taskId (String!)

Query

query TaskResult(
  $accountNumber: String!,
  $taskId: String!
) {
  taskResult(
    accountNumber: $accountNumber,
    taskId: $taskId
  ) {
    error
    result
    status
  }
}

Variables

{
  "accountNumber": "A-7BECBB9A",
  "taskId": "54911819"
}

Response

{
  "data": {
    "taskResult": {
      "error": "civil-increase-kid-college-gun",
      "result": {"key": "value"},
      "status": "STARTED"
    }
  }
}

termsAndConditionsForProduct

Type: [TermsAndConditionsType]

URL: https://api.oees-kraken.energy/v1/graphql/

Get the active terms and conditions for a market supply product.

Query Complexity: 1

Possible Errors:

  • KT-CT-8501: No active terms and conditions found for product.

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

productCode (String!)

The product code of the market supply product.

Query

query TermsAndConditionsForProduct($productCode: String!) {
  termsAndConditionsForProduct(productCode: $productCode) {
    brandCode
    effectiveFrom
    html
    markdown
    name
    pdfUrl
    version
  }
}

Variables

{
  "productCode": "similar-enter-whose-who-government"
}

Response

{
  "data": {
    "termsAndConditionsForProduct": [
      {
        "brandCode": "great-process-close-office-every",
        "effectiveFrom": "1979-11-12T19:49:34.107460+00:00",
        "html": "month-energy-each-plan-deal",
        "markdown": "purpose-quickly-pressure-protect-fire",
        "name": "commercial-hard-about-actually-out",
        "pdfUrl": "sense-work-record-want-wrong",
        "version": "town-race-worry-base-offer"
      }
    ]
  }
}

thirdPartyViewer

Type: ThirdPartyOrganizationType

URL: https://api.oees-kraken.energy/v1/graphql/

The currently authenticated third party.

This field requires the Authorization header to be set.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Query

query ThirdPartyViewer {
  thirdPartyViewer {
    name
    permissions {
      ...ThirdPartyPermissionFragment
    }
  }
}

Response

{
  "data": {
    "thirdPartyViewer": {
      "name": "become-billion-Congress-guess-this",
      "permissions": [ThirdPartyPermission]
    }
  }
}

trigger

Type: Trigger!

URL: https://api.oees-kraken.energy/v1/graphql/

Get the details of a published trigger with a given ID.

Query Complexity: 3

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

triggerId (ID!)

The ID of the trigger.

Query

query Trigger($triggerId: ID!) {
  trigger(triggerId: $triggerId) {
    accounts {
      ...AccountConnectionTypeConnectionFragment
    }
    accountsLinkedAt
    createdAt
    id
    messages {
      ...MessageConnectionFragment
    }
    processingStatus
    triggerTypeCode
  }
}

Variables

{
  "triggerId": "39569885"
}

Response

{
  "data": {
    "trigger": {
      "accounts": AccountConnectionTypeConnection,
      "accountsLinkedAt": "2024-03-27T12:05:28.377294+00:00",
      "createdAt": "1993-03-21T13:42:47.961987+00:00",
      "id": "83488931",
      "messages": MessageConnection,
      "processingStatus": "UNPROCESSED",
      "triggerTypeCode": "education-hospital-pressure-add-risk"
    }
  }
}

validateReferralCode

Type: ReferralClaimCodeType

URL: https://api.oees-kraken.energy/v1/graphql/

Validate referral claim code.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Rate Limits

Key Steps

Ip

['5/m']

Arguments

Name Description

value (String!)

Referral claim code value.

Query

query ValidateReferralCode($value: String!) {
  validateReferralCode(value: $value) {
    accountReferral {
      ...ReferralTypeFragment
    }
    createdAt
    id
    isValid
    referralScheme {
      ...ReferralSchemeTypeFragment
    }
    value
  }
}

Variables

{
  "value": "would-protect-generation-serve-remain"
}

Response

{
  "data": {
    "validateReferralCode": {
      "accountReferral": ReferralType,
      "createdAt": "2025-09-28T19:49:40.708324+00:00",
      "id": 19651198,
      "isValid": true,
      "referralScheme": ReferralSchemeType,
      "value": "group-thus-blood-land-break"
    }
  }
}

vehicleChargingPreferences

Type: VehicleChargingPreferencesType

URL: https://api.oees-kraken.energy/v1/graphql/

Vehicle charging preference details.

Query Complexity: 3

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries

Rate Limits

Key Steps

User

['300/h']

Deprecated

The 'vehicleChargingPreferences' field is deprecated.

Please use 'devices.preferences' instead.

- Marked as deprecated on 2024-04-23.
- Scheduled for removal on or after 2026-03-01.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/675/

Arguments

Name Description

accountNumber (String!)

Query

query VehicleChargingPreferences($accountNumber: String!) {
  vehicleChargingPreferences(accountNumber: $accountNumber) {
    maximumSocPercentage
    minimumSocPercentage
    weekdayTargetSoc
    weekdayTargetTime
    weekendTargetSoc
    weekendTargetTime
  }
}

Variables

{
  "accountNumber": "A-E1EEC353"
}

Response

{
  "data": {
    "vehicleChargingPreferences": {
      "maximumSocPercentage": 100,
      "minimumSocPercentage": 37,
      "weekdayTargetSoc": 87,
      "weekdayTargetTime": "loss-least-country-statement-hear",
      "weekendTargetSoc": 96,
      "weekendTargetTime": "country-cell-five-college-blood"
    }
  }
}

verificationStatus

Type: EmailVerificationStatus

URL: https://api.oees-kraken.energy/v1/graphql/

Check the verification status of a given email address.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

email (String!)

The email address to be checked.

Query

query VerificationStatus($email: String!) {
  verificationStatus(email: $email) {
    email
    status
  }
}

Variables

{
  "email": "plant-red-decide-personal-skin"
}

Response

{
  "data": {
    "verificationStatus": {
      "email": "likely-take-instead-outside-rise",
      "status": "NOT_SENT"
    }
  }
}

viewer

Type: EspAccountUserType

URL: https://api.oees-kraken.energy/v1/graphql/

The currently authenticated user.

This field requires the Authorization header to be set.

Query Complexity: 1

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can access customer queries
OR Can view account number
OR Can view account type
OR Can view account user permissions
OR Can view sensitive customer information

Query

query Viewer {
  viewer {
    accounts {
      ...AccountInterfaceFragment
    }
    accountUserMeta {
      ...AccountUserMetaFragment
    }
    accountUserRoles {
      ...AccountUserRoleTypeFragment
    }
    address {
      ...RichAddressTypeFragment
    }
    alternativePhoneNumbers
    businesses {
      ...BusinessConnectionTypeConnectionFragment
    }
    consents {
      ...ConsentTypeFragment
    }
    createdAt
    dateOfBirth
    details {
      ...AccountUserDetailTypeFragment
    }
    email
    familyName
    fullName
    givenName
    hasFamilyIssues
    id
    isActive
    isDeceased
    isInHardship
    label
    landline
    liveSecretKey
    mobile
    number
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    permissions {
      ...AccountUserPermissionFragment
    }
    portfolioIds
    portfolios {
      ...PortfolioConnectionTypeConnectionFragment
    }
    portfolioUserRoles {
      ...PortfolioUserRoleTypeFragment
    }
    preferences {
      ...AccountUserCommsPreferencesFragment
    }
    preferredName
    pronouns
    specialCircumstances {
      ...SpecialCircumstancesTypeFragment
    }
    title
  }
}

Response

{
  "data": {
    "viewer": {
      "accounts": AccountInterface,
      "accountUserMeta": AccountUserMeta,
      "accountUserRoles": [AccountUserRoleType],
      "address": RichAddressType,
      "alternativePhoneNumbers": "such-simple-subject-be-alone",
      "businesses": BusinessConnectionTypeConnection,
      "consents": [ConsentType],
      "createdAt": "1970-04-17T08:13:19.031626+00:00",
      "dateOfBirth": "2011-12-22",
      "details": [AccountUserDetailType],
      "email": "detail-five-painting-benefit-explain",
      "familyName": "Baker",
      "fullName": "player-small-back-I-worry",
      "givenName": "Theodore",
      "hasFamilyIssues": true,
      "id": "53206009",
      "isActive": true,
      "isDeceased": true,
      "isInHardship": true,
      "label": "compare-world-among-sound-admit",
      "landline": "never-would-catch-professional-year",
      "liveSecretKey": "movie-law-enough-free-bit",
      "mobile": "information-point-item-already-peace",
      "number": "wind-themselves-must-account-boy",
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "permissions": [AccountUserPermission],
      "portfolioIds": "62088725",
      "portfolios": PortfolioConnectionTypeConnection,
      "portfolioUserRoles": [PortfolioUserRoleType],
      "preferences": AccountUserCommsPreferences,
      "preferredName": "dog-would-who-long-race",
      "pronouns": "house-lay-why-so-think",
      "specialCircumstances": SpecialCircumstancesType,
      "title": "loss-magazine-choice-behavior-window"
    }
  }
}

voiceCampaign

Type: VoiceCampaignType!

URL: https://api.oees-kraken.energy/v1/graphql/

Get the voice campaign for a given ID.

Query Complexity: 2

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query voice campaigns

Arguments

Name Description

campaignId (String!)

The campaign ID.

Query

query VoiceCampaign($campaignId: String!) {
  voiceCampaign(campaignId: $campaignId) {
    campaignItems {
      ...VoiceCampaignItemConnectionTypeConnectionFragment
    }
    campaignType
    customOutboundPhoneNumber
    description
    id
    name
    preventDuplicateRecords
    status
    tags {
      ...CallTagConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "campaignId": "97756647"
}

Response

{
  "data": {
    "voiceCampaign": {
      "campaignItems": VoiceCampaignItemConnectionTypeConnection,
      "campaignType": "PREVIEW",
      "customOutboundPhoneNumber": "rise-most-several-similar-simply",
      "description": "consumer-talk-wear-mission-admit",
      "id": "68374448",
      "name": "nothing-minute-before-leader-Democrat",
      "preventDuplicateRecords": true,
      "status": "ACTIVE",
      "tags": CallTagConnectionTypeConnection
    }
  }
}

voiceCampaigns

Type: VoiceCampaignConnectionTypeConnection!

URL: https://api.oees-kraken.energy/v1/graphql/

Get voice campaigns.

Query Complexity: 2

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query voice campaigns

Arguments

Name Description

after (String)

before (String)

campaignType (TypeOfVoiceCampaign)

Filter by campaign type.

first (Int)

last (Int)

name (String)

Filter by campaign name.

status (CampaignStatus)

Filter by campaign status.

Query

query VoiceCampaigns(
  $after: String,
  $before: String,
  $campaignType: TypeOfVoiceCampaign,
  $first: Int,
  $last: Int,
  $name: String,
  $status: CampaignStatus
) {
  voiceCampaigns(
    after: $after,
    before: $before,
    campaignType: $campaignType,
    first: $first,
    last: $last,
    name: $name,
    status: $status
  ) {
    edgeCount
    edges {
      ...VoiceCampaignConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "campaignType": "PREVIEW",
  "first": 10,
  "last": 10,
  "name": "happy-book-do-usually-wonder",
  "status": "ACTIVE"
}

Response

{
  "data": {
    "voiceCampaigns": {
      "edgeCount": 22,
      "edges": [VoiceCampaignConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 63
    }
  }
}

vouchersBalanceDetail

Type: VouchersBalanceDetail

URL: https://api.oees-kraken.energy/v1/graphql/

Query the detail of vouchers balance for an account.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountNumber (ID!)

The account number.

Query

query VouchersBalanceDetail($accountNumber: ID!) {
  vouchersBalanceDetail(accountNumber: $accountNumber) {
    redeemableInFuture
    redeemableToday
  }
}

Variables

{
  "accountNumber": "A-D6DED222"
}

Response

{
  "data": {
    "vouchersBalanceDetail": {
      "redeemableInFuture": 37,
      "redeemableToday": 26
    }
  }
}

vouchersForAccount

Type: VoucherPurchaseConnectionTypeConnection

URL: https://api.oees-kraken.energy/v1/graphql/

Query the voucher purchases for an account.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Arguments

Name Description

accountNumber (ID!)

The account number.

after (String)

availableBeforeDate (Date)

An optional date to limit the response to vouchers that are available before the particular date (exclusive).

availableFromDate (Date)

An optional date to limit the response to vouchers that are available from the particular date (inclusive) onwards.

before (String)

excludeByDisplayName ([String])

An optional list of display names to exclude from the results (case-insensitive).

excludeRefunded (Boolean)

Whether to exclude refunded vouchers from the response. By default, refunded vouchers will be included in the response.

first (Int)

last (Int)

purchasedBeforeDate (Date)

An optional date to limit the response to vouchers that have been purchased before the particular date (exclusive).

purchasedFromDate (Date)

An optional date to limit the response to vouchers that have been purchased from the particular date (inclusive) onwards.

redeemableOnly (Boolean!)

Whether to only return vouchers that can be redeemable.

Query

query VouchersForAccount(
  $accountNumber: ID!,
  $after: String,
  $availableBeforeDate: Date,
  $availableFromDate: Date,
  $before: String,
  $excludeByDisplayName: [String],
  $excludeRefunded: Boolean,
  $first: Int,
  $last: Int,
  $purchasedBeforeDate: Date,
  $purchasedFromDate: Date,
  $redeemableOnly: Boolean!
) {
  vouchersForAccount(
    accountNumber: $accountNumber,
    after: $after,
    availableBeforeDate: $availableBeforeDate,
    availableFromDate: $availableFromDate,
    before: $before,
    excludeByDisplayName: $excludeByDisplayName,
    excludeRefunded: $excludeRefunded,
    first: $first,
    last: $last,
    purchasedBeforeDate: $purchasedBeforeDate,
    purchasedFromDate: $purchasedFromDate,
    redeemableOnly: $redeemableOnly
  ) {
    edgeCount
    edges {
      ...VoucherPurchaseConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "accountNumber": "A-2726BAE9",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "availableBeforeDate": "2002-02-22",
  "availableFromDate": "2021-11-18",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "excludeByDisplayName": "social-nor-law-feel-avoid",
  "excludeRefunded": true,
  "first": 10,
  "last": 10,
  "purchasedBeforeDate": "2019-06-16",
  "purchasedFromDate": "1997-04-25",
  "redeemableOnly": true
}

Response

{
  "data": {
    "vouchersForAccount": {
      "edgeCount": 47,
      "edges": [VoucherPurchaseConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 60
    }
  }
}

workSchedule

Type: WorkScheduleType!

URL: https://api.oees-kraken.energy/v1/graphql/

Get the work schedule with the given identifier.

Query Complexity: 1

Possible Errors:

Allowed Viewers:

Viewer type Allowed?
Customer
Third party

Required Permissions:

Can query work schedules

Arguments

Name Description

identifier (String!)

The identifier of the work schedule (also known as the 'slug').

Query

query WorkSchedule($identifier: String!) {
  workSchedule(identifier: $identifier) {
    identifier
    isOpen
    isPublicHoliday
    name
    openOrClosedReason
  }
}

Variables

{
  "identifier": "75514544"
}

Response

{
  "data": {
    "workSchedule": {
      "identifier": "58508007",
      "isOpen": true,
      "isPublicHoliday": true,
      "name": "adult-truth-real-sound-authority",
      "openOrClosedReason": "CLOSED_DUE_TO_PUBLIC_HOLIDAY"
    }
  }
}

In this section