Skip to main content
GET
/
referrals
List referrals
curl --request GET \
  --url https://api.referralful.com/v1/referrals \
  --header 'Authorization: Basic <encoded-value>'
{
  "pagination": {
    "previous_page": 123,
    "current_page": 123,
    "next_page": 123,
    "count": 123,
    "limit": 123,
    "total_pages": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "object": "referral",
      "became_lead_at": "2023-11-07T05:31:56Z",
      "became_conversion_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "stripe_customer_id": "<string>",
      "affiliate_id": "<string>",
      "campaign_id": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Use your API secret as the username, with an empty password.

Query Parameters

conversion_state
enum<string>
Available options:
visitor,
lead,
conversion
affiliate_id
string
page
integer
default:1
limit
integer
default:25
Required range: x <= 100

Response

200 - application/json

OK

pagination
object
data
object[]