AlmondTill/G3N API

On this page

referredSignups

query · in the family Billing and the wallet

What it does

Your referred businesses and where each stands — every signup that used your referral code, with its standing (awaiting approval, approved, or not approved) and when it joined; earning begins after AlmondTill approves a referral, and you are told either way.

The caller group's OWN referral roster: every business that signed up with your referral code, NEWEST-first, with its code, its standing (pending | approved | denied — derived from the referred group's own record, the one source of truth), when it joined and when it was decided. The optional status filter narrows to one standing (pending | approved | denied — any other word refuses VALIDATION/INVALID; absent = every referred signup). SELF-group BY KEY CONSTRUCTION; a group that referred nobody answers. Earning begins at the next billing cycle AFTER approval — months that pass while pending never accrue; a denied referral never earns; the referred business's own discount rides from birth regardless; every decision also reaches your owners as a notice + a mail. Requires authentication. Template class A16_BILLING (hand-derived v96).

What happens

Reads only.

Who may call it

Capability area: Billing and the wallet — Your platform bill, token purchases and the usage and cost reads.

Arguments

NameTypeRequiredNotes
statusStringnoNo further notes.

Returns

ReferredSignup [ReferredSignup!]! — One referred signup on YOUR referral code and where it stands.

Example request

query ExampleReferredSignups($status: String) {
  referredSignups(status: $status) {
    referredOrgGroupId
    referredGroupCode
    standing
    createdAt
    decidedAt
  }
}

Variables:

{
  "status": "<status>"
}

Example response

{
  "data": {
    "referredSignups": [
      {
        "referredOrgGroupId": "01900000-0000-7000-8000-8aec69300000",
        "referredGroupCode": "BJ-001",
        "standing": "<standing>",
        "createdAt": "2027-01-31T00:00:00.000Z",
        "decidedAt": "2027-01-31T00:00:00.000Z"
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer