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.

Set up API key Endpoint docs

Playground

Get referral attribution detail API Playground

Returns one referral attribution and its reward records.

GETadmin or apiKey1 credit/requestreferrals.adminReferralDetailResponseDocReferrals

Endpoint

Choose one catalog endpoint for this request.

9 shown

Group

Method

Auth

Endpoint

GETadmin or apiKey1 credit/requestreferrals.adminReferralDetailResponseDocReferrals

GET /admin/referrals/{id}

Get referral attribution detail

Returns one referral attribution and its reward records.

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

View docs

Authentication

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

Path parameters

requiredstring

Referral attribution id

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": {
    "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,
        "credits_grant_key": "reward-1"
      }
    ]
  }
}

Endpoint details

Returns one referral attribution and its reward records.

Method: GET
Path: /admin/referrals/{id}
Authentication: admin or apiKey
Credit cost: 1 credit/request
Platform: Referrals
Parameters: 2 documented fields

Request parameters

x-api-key:headerid:path

Response schema fields

attributionattribution.click_idattribution.codeattribution.created_atattribution.errorattribution.expires_atattribution.first_paid_invoice_idattribution.idattribution.landing_pathattribution.qualified_atattribution.referred_user_idattribution.referrer_user_id

Sample response summary

{
  "code": 200,
  "msg": "ok",
  "data": {
    "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,
        "credits_grant_key": "reward-1"
      }
    ]
  }
}

cURL example

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

View endpoint docs Browse all endpoints Pricing List referral attributions Approve a referral held for review Reject a referral held for review Recover pending referral credit grants Get referral funnel stats