RefCampaign/docs
Référence APICampaigns

List campaigns

Returns every campaign owned by the authenticated merchant account.

GET
/api/v1/campaigns

Returns every campaign owned by the authenticated merchant account.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

limit?|

Page size, clamped to 100.

offset?|

Number of items to skip.

status?|

Filter by campaign status.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.refcampaign.com/api/v1/campaigns"
Empty
{
  "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"
  }
}

Export conversions as XLSX GET

Returns an Excel workbook of conversions matching the filter window.

Create a campaign POST

Creates a new affiliate campaign for the authenticated merchant account. Commission duration is controlled by commissionRecurring and recurringMonthsLimit. commissionRecurring=false means only the first attributed payment earns commission. commissionRecurring=true with recurringMonthsLimit=null means lifetime recurring commissions. commissionRecurring=true with recurringMonthsLimit=12 means recurring payments remain commissionable for 12 months. Limited windows start at the first attributed payment / initial conversion, not the first click.