Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Playground

List referral attributions API Playground

Lists referral attributions with their reward records for support and operational review.

GETadmin or apiKey1 credit/requestreferrals.adminReferralsListResponseDocReferrals

Endpoint

Choose one catalog endpoint for this request.

9 shown
GETadmin or apiKey1 credit/requestreferrals.adminReferralsListResponseDocReferrals
GET /admin/referrals

List referral attributions

Lists referral attributions with their reward records for support and operational review.

Admin session required. Sign in with an Admin account before running this endpoint.

Sign in
View docs

Authentication

Admin session required. Sign in with an Admin account before running this endpoint.

Sign in

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs
Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "ok",
  "data": {
    "items": [
      {
        "attribution": {
          "id": "attr-1",
          "code": "A1B2C3D4E5F6",
          "referrer_user_id": "user-referrer",
          "referred_user_id": "user-referred",
          "status": "rewarded"
        },
        "rewards": [
          {
            "id": "reward-1",
            "role": "referrer",
            "credits": 10000
          }
        ]
      }
    ]
  }
}

Endpoint details

Lists referral attributions with their reward records for support and operational review.

Method
GET
Path
/admin/referrals
Authentication
admin or apiKey
Credit cost
1 credit/request
Platform
Referrals
Parameters
6 documented fields

Request parameters

x-api-key:headeruser_id:querystatus:querycampaign:querypending_grant:querylimit:query

Response schema fields

itemsitems[].attributionitems[].attribution.click_iditems[].attribution.codeitems[].attribution.created_atitems[].attribution.erroritems[].attribution.expires_atitems[].attribution.first_paid_invoice_iditems[].attribution.iditems[].attribution.landing_pathitems[].attribution.qualified_atitems[].attribution.referred_user_id

Sample response summary

{
  "code": 200,
  "msg": "ok",
  "data": {
    "items": [
      {
        "attribution": {
          "id": "attr-1",
          "code": "A1B2C3D4E5F6",
          "referrer_user_id": "user-referrer",
          "referred_user_id": "user-referred",
          "status": "rewarded"
        },
        "rewards": [
          {
            "id": "reward-1",
            "role": "referrer",
            "credits": 10000
          }
        ]
      }
    ]
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/admin/referrals" \
  -H "Authorization: Token <token>"