SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
Affiliates

GEThttps://app.softsolz.uk/api/v1/services/affiliates/affiliates

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Query Params

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Number of partners to skip (default 0).

Response

Response Body · array of objects

idstringPartner id.
contact_idstring | nullCRM contact this partner is linked to, or null.
namestringPartner name.
emailstring | nullPartner email address, lower-cased.
codestringReferral code, upper-cased. Customers and your systems quote it to credit a sale.
commission_typestringWhether the partner earns a percentage of each sale or a fixed amount per sale.
commission_percentnumber | nullPercentage of each sale, when commission_type is percent.
commission_amount_centsinteger | nullFixed amount per sale in minor units, when commission_type is amount.
currencystringCurrency the partner earns and is paid in (ISO 4217).
statusstringOnly active partners can earn new commission.
programme_idstring | nullPartner programme this partner belongs to, or null.
tier_idstring | nullTier the partner has reached in their programme, or null.
tier_namestring | nullName of the tier the partner has reached. Filled in on reads, null in the reply to a create or update.
cookie_daysinteger | nullHow many days a referral link click keeps crediting this partner. Null uses the programme setting.
recurring_monthsinteger | nullHow many billing periods of a subscription earn commission. 0 means the first sale only, a negative number means every period, null uses the programme setting.
portal_enabledbooleanWhether the partner has been invited to their own partner portal.
notesstring | nullPrivate notes about the partner.
lifetime_revenue_centsintegerTotal sales credited to this partner, in minor units.
lifetime_commission_centsintegerTotal commission credited to this partner, in minor units.
click_countintegerClicks on all of this partner referral links.
conversion_countintegerSales credited to this partner.
created_atstringWhen the partner was added.
updated_atstringWhen the partner was last changed.
earnedobjectCommission this partner has earned so far, by status, in minor units.

Request

curl --request GET \
  --url https://app.softsolz.uk/api/v1/services/affiliates/affiliates \
  --header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": [
    {
      "id": "12",
      "contact_id": null,
      "name": "Acme Media",
      "email": "partners@acmemedia.example",
      "code": "ACMEMEDIA",
      "commission_type": "percent",
      "commission_percent": 15,
      "commission_amount_cents": null,
      "currency": "GBP",
      "status": "active",
      "programme_id": null,
      "tier_id": null,
      "tier_name": null,
      "cookie_days": 60,
      "recurring_months": 12,
      "portal_enabled": false,
      "notes": "Runs a newsletter for small agencies.",
      "lifetime_revenue_cents": 250000,
      "lifetime_commission_cents": 37500,
      "click_count": 148,
      "conversion_count": 3,
      "created_at": "2026-09-01T09:00:00.000Z",
      "updated_at": "2026-09-14T16:20:00.000Z",
      "earned": {
        "pending": 37500,
        "approved": 12000,
        "paid": 48000
      }
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  }
}