RefCampaignDocs

Get an affiliate

Each participation returns revenueTotals and commissionTotals as arrays of ISO currency codes and exact major-unit amount strings. Legacy monetary scalars are absent.

GET
/api/v1/affiliates/{id}

Each participation returns revenueTotals and commissionTotals as arrays of ISO currency codes and exact major-unit amount strings. Legacy monetary scalars are absent.

Authorization

bearerAuth
AuthorizationBearer <token>

API key issued from the merchant dashboard (prefix rc_live_ / rc_test_). Sent as Authorization: Bearer <token>. Used by the SDK and any direct server-to-server integration.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.refcampaign.com/api/v1/affiliates/string"
{
  "success": true,
  "data": {
    "id": "string",
    "email": "user@example.com",
    "participations": [
      {
        "id": "string",
        "status": "string",
        "totalClicks": 0,
        "totalConversions": 0,
        "revenueTotals": [
          {
            "currency": "str",
            "amount": "string"
          }
        ],
        "commissionTotals": [
          {
            "currency": "str",
            "amount": "string"
          }
        ],
        "joinedAt": "2019-08-24T14:15:22Z",
        "campaign": {
          "id": "string",
          "name": "string",
          "status": "string"
        }
      }
    ]
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}