NodiRefReferral links
/referral-links
This endpoint retrieves the referral links list based on the provided filters.
Request
Available filters
-
partner_id(optional): The ID of the partner associated with the link. -
project_id(optional): The ID of the project with the link. -
code(optional): The unique code of the referral link.
Available includes
-
partner-> The partner associated with the link -
project-> The project associated with the link -
clicks-> The clicks associated with the link -
referrals-> The referrals generated through this link -
rewardRuleSets-> The reward rule sets associated with this link
GET
/referral-linksAuthorization
AuthorizationRequiredBearer <token>In: header
Response Body
OK
TypeScript Definitions
Use the response body type in TypeScript.
curl -X GET "https://api.nodiref.com/referral-links" \
-H "Authorization: Bearer <token>"{
"success": true,
"data": [
{
"id": "9ef54e05-06b0-48ed-a51e-7fd873cf7a4a",
"partner_id": "9ef54e05-03e5-4427-8bea-d2db25b81f96",
"code": "03IKxxtzzC"
},
{
"id": "9ef54e0e-8266-4c7b-8351-040fa5ab865f",
"partner_id": "9ef54e0e-7eef-4c68-982b-c41cd87b9b0c",
"code": "091rgIQeFF"
},
{
"id": "9ef54f29-ed61-4a7b-85f6-75ecb8cc73ac",
"partner_id": "9ef54f29-ea2f-4ca0-bf86-ca7f2e731bec",
"code": "0AB9Ezdfi8"
},
{
"id": "9ef54e09-9f4c-4d9b-b721-0c03057a16fc",
"partner_id": "9ef54e09-9b7b-4c38-9074-6c556cc66f3d",
"code": "0d1ICvlOAL"
},
{
"id": "9ef54e0b-9a37-437b-b002-40ba9e68e393",
"partner_id": "9ef54e0b-937e-4a2b-bd2c-56f6708d6f06",
"code": "0de7cdsVo5"
},
{
"id": "9ef54e06-5088-4673-8ffe-99c7ee5510b9",
"partner_id": "9ef54e06-4d71-42d5-bea6-0d791c913215",
"code": "0fhf91pOFA"
},
{
"id": "9ef54f20-f0c5-4d11-875d-bb2507cbd042",
"partner_id": "9ef54f20-ecf7-4871-9027-125ce9a4aba4",
"code": "0gg3ib39V8"
},
{
"id": "9ef54f11-9409-4df0-b5c3-7e04ec298676",
"partner_id": "9ef54f11-881e-4866-957b-b82168041d54",
"code": "0ghvDCQ3mg"
},
{
"id": "9ef54f1b-f363-497a-a4cf-e51c4066e0e2",
"partner_id": "9ef54f1b-e670-47f5-a35a-2d089a16d1cd",
"code": "0MBG5OGtHa"
},
{
"id": "9ef54e0d-483c-4491-b502-7444cea18a7d",
"partner_id": "9ef54e0d-439a-434e-add7-8f31df69bcf2",
"code": "0ppWhT9ubw"
}
],
"pagination": {
"current_page": 1,
"first_page_url": "http://localhost:8000/api/referral-links?page=1",
"from": 1,
"last_page": 138,
"last_page_url": "http://localhost:8000/api/referral-links?page=138",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://localhost:8000/api/referral-links?page=1",
"label": "1",
"active": true
},
{
"url": "http://localhost:8000/api/referral-links?page=2",
"label": "2",
"active": false
},
{
"url": "http://localhost:8000/api/referral-links?page=3",
"label": "3",
"active": false
},
{
"url": "http://localhost:8000/api/referral-links?page=4",
"label": "4",
"active": false
},
{
"url": "http://localhost:8000/api/referral-links?page=5",
"label": "5",
"active": false
},
{
"url": "http://localhost:8000/api/referral-links?page=6",
"label": "6",
"active": false
},
{
"url": "http://localhost:8000/api/referral-links?page=7",
"label": "7",
"active": false
},
{
"url": "http://localhost:8000/api/referral-links?page=8",
"label": "8",
"active": false
},
{
"url": "http://localhost:8000/api/referral-links?page=9",
"label": "9",
"active": false
},
{
"url": "http://localhost:8000/api/referral-links?page=10",
"label": "10",
"active": false
},
{
"url": null,
"label": "...",
"active": false
},
{
"url": "http://localhost:8000/api/referral-links?page=137",
"label": "137",
"active": false
},
{
"url": "http://localhost:8000/api/referral-links?page=138",
"label": "138",
"active": false
},
{
"url": "http://localhost:8000/api/referral-links?page=2",
"label": "Next »",
"active": false
}
],
"next_page_url": "http://localhost:8000/api/referral-links?page=2",
"path": "http://localhost:8000/api/referral-links",
"per_page": 10,
"prev_page_url": null,
"to": 10,
"total": 1379
}
}