GET
/
referrals
cURL
curl --request GET \
  --url https://api-dev.withflock.com/referrals \
  --header 'Authorization: <api-key>'
{
  "total": 123,
  "limit": 123,
  "offset": 123,
  "data": [
    {
      "id": "<string>",
      "campaignId": "<string>",
      "refereeId": {},
      "referrerId": "<string>",
      "status": {},
      "suspectedFrauds": [
        {
          "message": "<string>",
          "type": "<string>"
        }
      ],
      "environment": "production",
      "organizationId": "<string>",
      "applicationId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
campaignId
string
required
​
status
enum<string>
Available options:
pending,
flagged,
accepted,
rejected
​
limit
object
​
offset
object

Response

200 - application/json

The response is of type object.