GetApiV22ReferralsJsonResponse

CompanyReferralAffiliateE-commerceMarketing

Properties

Name	Type	Description
referrals	string	Array of referred customers and referral timestamps.
referral_email	string	Email address of referred customer.
referral_timestamp	string	UNIX timestamp when referral purchase was made.
referring_email	string	Email address of advocate who made the referral.
review_period_over	string	Whether the review period for this referred purchase is over.
external_reference_id	string	An ID that can be used to track this referred purchase externally.
campaignID	string	Campaign ID that is associated to the referral.
period_from	string	UNIX timestamp of start of query period.
period_to	string	UNIX timestamp of end of query period of the results returned.
message	string	A message indicating the outcome of the API call.
reason	string	Further information provided about the response.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/referralcandy/main/json-schema/referralcandy-get-api-v22-referrals-json-response-schema.json",
  "title": "GetApiV22ReferralsJsonResponse",
  "x-generated": "2026-10-27",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/referralcandy-openapi-generated.yml#/components/schemas/GetApiV22ReferralsJsonResponse",
  "type": "object",
  "properties": {
    "referrals": {
      "type": "string",
      "description": "Array of referred customers and referral timestamps."
    },
    "referral_email": {
      "type": "string",
      "description": "Email address of referred customer."
    },
    "referral_timestamp": {
      "type": "string",
      "description": "UNIX timestamp when referral purchase was made."
    },
    "referring_email": {
      "type": "string",
      "description": "Email address of advocate who made the referral."
    },
    "review_period_over": {
      "type": "string",
      "description": "Whether the review period for this referred purchase is over."
    },
    "external_reference_id": {
      "type": "string",
      "description": "An ID that can be used to track this referred purchase externally."
    },
    "campaignID": {
      "type": "string",
      "description": "Campaign ID that is associated to the referral."
    },
    "period_from": {
      "type": "string",
      "description": "UNIX timestamp of start of query period."
    },
    "period_to": {
      "type": "string",
      "description": "UNIX timestamp of end of query period of the results returned."
    },
    "message": {
      "type": "string",
      "description": "A message indicating the outcome of the API call."
    },
    "reason": {
      "type": "string",
      "description": "Further information provided about the response."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/referralcandy-get-api-v22-referrals-json-response"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.