Partner API
Referrals

List partner referrals

Retrieve a paginated list of partner referrals with optional filtering

get/{partnerId}/referrals

Request

  • Base URL: https://us-central1-sutra-prod.cloudfunctions.net/partnerApi/v0
  • URL: https://us-central1-sutra-prod.cloudfunctions.net/partnerApi/v0/{partnerId}/referrals
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

partnerIdstring required
Example:partner123

Partner identifier

Query parameters

limitinteger
Example:10

Number of items to return (default 10, max 100)

start_afterstring
Example:item123

ID to start after for pagination

updated_at_minstring date-time
Example:2024-03-20T00:00:00Z

Filter by minimum updated timestamp (ISO 8601)

updated_at_maxstring date-time
Example:2024-03-21T23:59:59Z

Filter by maximum updated timestamp (ISO 8601)

idsstring
Example:id1,id2,id3

Comma-separated list of IDs to fetch

Response

Successful response

Example response

{
  "items": [
    {
      "id": "referral123",
      "referred_user_id": "client123",
      "referring_user_id": "client456",
      "referral_date": "2024-03-20T12:00:00Z",
      "referred_user_reward": {
        "type": "amount",
        "value": 10
      },
      "referring_user_reward": {
        "type": "amount",
        "value": 10
      },
      "updated_at": "2024-03-20T12:00:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "nextStartAfterId": "item123"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.