Getting Started
API Reference
Getting Started
API Reference
Help Center
Login
  1. Getting Started
  • Introduction
  • Getting Started
  • Authentication
  • Rate Limits
Getting Started
API Reference
Getting Started
API Reference
Help Center
Login
  1. Getting Started

Getting Started

1
Obtain Your API Key
1.
Log in to your ReferralStack dashboard
2.
Navigate to Settings → Integrations
3.
Click Copy API Key
4.
Copy and securely store your API key
2
Make Your First Request
Try fetching your affiliate list to verify your API key works:
Expected Response:
{
  "status": 200,
  "message": "Affiliates fetched successfully",
  "data": {
    "items": [
      {
        "id": "3f6a9c1e-8b44-4c6e-9d4f-2e6b8f4a1c92",
        "email": "john@example.com",
        "firstName": "John",
        "lastName": "Doe",
        "status": "active",
        "workspaceId": "5bb8cbe6-67dc-4b07-853e-7ca5454f8512",
        "createdAt": "2025-01-15T10:30:00.000Z",
        "updatedAt": "2025-01-15T10:30:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 25,
      "total": 1,
      "totalPages": 1
    }
  }
}
3
Explore the Documentation
Continue reading to learn about all available endpoints, request parameters, and response formats. Each endpoint includes code examples in multiple languages.
Modified at 2026-01-05 11:15:03
Previous
Introduction
Next
Authentication
Built with