referrals

Embed

<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-referrals"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/79148596-35d1-49cf-93b7-7743fa285670/social-card.svg?v=3e7ae33eec8b" alt="referrals" width="600" height="315"></a>

GEThttps://hermetica.15.204.158.166.sslip.io/v1/referral-programs

Referral programs with click, conversion and reward counts

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/referral-programs" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "name": "string",
      "status": "active",
      "destinationUrl": "string",
      "rewardEvent": "referral_rewarded",
      "conversionsPerReward": 1,
      "rewardNote": "string",
      "cookieDays": 30,
      "id": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "stats": {
        "links": 0,
        "clicks": 0,
        "conversions": 0,
        "rewards": 0
      }
    }
  ]
}

Schema

itemsobject[]required

Show child parameters

namestringrequired

statusstringrequired

active | paused = active

destinationUrlstringrequired

rewardEventstringrequired

= referral_rewarded

conversionsPerRewardintegerrequired

= 1

rewardNotestringrequired

cookieDaysintegerrequired

= 30

idstringrequired

createdAtstringrequired

statsobjectrequired

Show child parameters

linksintegerrequired

clicksintegerrequired

conversionsintegerrequired

rewardsintegerrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/referral-programs

POSThttps://hermetica.15.204.158.166.sslip.io/v1/referral-programs

Request body

application/json

namestringrequired

statusstring

active | paused = active

destinationUrlstringrequired

rewardEventstring

= referral_rewarded

conversionsPerRewardinteger

= 1

rewardNotestring

cookieDaysinteger

= 30

{
  "name": "string",
  "status": "active",
  "destinationUrl": "string",
  "rewardEvent": "referral_rewarded",
  "conversionsPerReward": 1,
  "rewardNote": "string",
  "cookieDays": 30
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/referral-programs" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","status":"active","destinationUrl":"string","rewardEvent":"referral_rewarded","conversionsPerReward":1,"rewardNote":"string","cookieDays":30}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "name": "string",
  "status": "active",
  "destinationUrl": "string",
  "rewardEvent": "referral_rewarded",
  "conversionsPerReward": 1,
  "rewardNote": "string",
  "cookieDays": 30,
  "id": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "stats": {
    "links": 0,
    "clicks": 0,
    "conversions": 0,
    "rewards": 0
  }
}

Schema

namestringrequired

statusstringrequired

active | paused = active

destinationUrlstringrequired

rewardEventstringrequired

= referral_rewarded

conversionsPerRewardintegerrequired

= 1

rewardNotestringrequired

cookieDaysintegerrequired

= 30

idstringrequired

createdAtstringrequired

statsobjectrequired

Show child parameters

linksintegerrequired

clicksintegerrequired

conversionsintegerrequired

rewardsintegerrequired

4XX Default Response

Same as 4XX · GET /v1/referral-programs

5XX Default Response

Same as 4XX · GET /v1/referral-programs

PATCHhttps://hermetica.15.204.158.166.sslip.io/v1/referral-programs/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

statusstring

active | paused = active

destinationUrlstring

rewardEventstring

= referral_rewarded

conversionsPerRewardinteger

= 1

rewardNotestring

cookieDaysinteger

= 30

{
  "name": "string",
  "status": "active",
  "destinationUrl": "string",
  "rewardEvent": "referral_rewarded",
  "conversionsPerReward": 1,
  "rewardNote": "string",
  "cookieDays": 30
}

Code samples

cURL

curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/referral-programs/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","status":"active","destinationUrl":"string","rewardEvent":"referral_rewarded","conversionsPerReward":1,"rewardNote":"string","cookieDays":30}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/referral-programs

4XX Default Response

Same as 4XX · GET /v1/referral-programs

5XX Default Response

Same as 4XX · GET /v1/referral-programs

GEThttps://hermetica.15.204.158.166.sslip.io/v1/referral-programs/{id}/links

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/referral-programs/{id}/links" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "programId": "string",
      "profileId": "string",
      "code": "string",
      "url": "string",
      "clicks": 0,
      "conversions": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

programIdstringrequired

profileIdstringrequired

codestringrequired

urlstringrequired

clicksintegerrequired

conversionsintegerrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/referral-programs

5XX Default Response

Same as 4XX · GET /v1/referral-programs

POSThttps://hermetica.15.204.158.166.sslip.io/v1/referral-programs/{id}/links

Get (or create) a contact's personal referral link

Parameters

idstringpathrequired

Request body

application/json

profileIdstringrequired

{
  "profileId": "string"
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/referral-programs/{id}/links" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "programId": "string",
  "profileId": "string",
  "code": "string",
  "url": "string",
  "clicks": 0,
  "conversions": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

programIdstringrequired

profileIdstringrequired

codestringrequired

urlstringrequired

clicksintegerrequired

conversionsintegerrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/referral-programs

5XX Default Response

Same as 4XX · GET /v1/referral-programs

POSThttps://hermetica.15.204.158.166.sslip.io/v1/referrals/convert

Report that someone who arrived through a referral link has converted; earns the referrer a reward when the threshold is met

Request body

application/json

codestringrequired

emailstringrequired

valueMinorinteger

currencystring

{
  "code": "string",
  "email": "string",
  "valueMinor": 0,
  "currency": "string"
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/referrals/convert" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"code":"string","email":"string","valueMinor":0,"currency":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "conversionId": "string",
  "duplicate": true,
  "rewarded": true
}

Schema

conversionIdstringrequired

duplicatebooleanrequired

rewardedbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/referral-programs

5XX Default Response

Same as 4XX · GET /v1/referral-programs

GEThttps://hermetica.15.204.158.166.sslip.io/r/{ws}/{code}

Referral link click

Parameters

wsstringpathrequired

codestringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/r/{ws}/{code}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

302 Default Response

"string"

4XX Default Response

Same as 4XX · GET /v1/referral-programs

5XX Default Response

Same as 4XX · GET /v1/referral-programs

Updated Nov 2, 2026

Was this page helpful?