List referrals for admin review

GET/v1/referral/admin/referrals

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

itemsAdminReferralItem[] | nullrequired

Show properties

Array of AdminReferralItem

created_atstringrequired

fraud_bandstringrequired

fraud_reasonsstring[] | nullrequired

fraud_scoreinteger<int64>required

fraud_statusstringrequired

idstringrequired

referee_emailstringrequired

referee_namestringrequired

referral_codestringrequired

referrer_emailstringrequired

referrer_namestringrequired

statusstringrequired

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/referral/admin/referrals"

const response = await fetch("/v1/referral/admin/referrals", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/referral/admin/referrals",
)

Response

{
  "items": [
    {
      "created_at": "string",
      "fraud_band": "string",
      "fraud_reasons": [
        "string"
      ],
      "fraud_score": 0,
      "fraud_status": "string",
      "id": "string",
      "referee_email": "string",
      "referee_name": "string",
      "referral_code": "string",
      "referrer_email": "string",
      "referrer_name": "string",
      "status": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}