Partner referral links
A referral link is a unique, trackable URL provided to partners to share with their audience. It allows the system to attribute sign-ups and purchases to the partner, ensuring they receive rewards or commissions when someone uses their link.
Get domains
Get the list of domains that you can use when creating a link.
GET https://api.partnero.com/v1/partner_referral_links:domains
Request parameters
Parameters | Type | Required | Details |
---|---|---|---|
limit | integer | no | A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10. |
page | integer | no | The default is 1. |
Response
{
"data": [
{
"id": null, // This will be null for default domain
"domain": "partnero.com",
"url": "https://partnero.com?aff=",
"is_additional": false
},
...
],
"status": 1
}
Response Code: 200 OK
Content-Type: application/json
Create a link
Create a new partner referral link.
The data payload should contain two data objects, partner
(with id or key or email) and link
.
POST https://api.partnero.com/v1/partner_referral_links
Request example
{
"partner": {
"id": "partner_123"
},
"key": "ref_456"
}
Request parameters
Parameters | Type | Required | Details |
---|---|---|---|
key | string | yes | Key will be used to generate an unique referral link. Key should be unique. |
domain_id | string | optional | The list of program domains are available with GET request on https://api.partnero.com/v1/links |
is_additional | bool | no * | Required when domain_id is present |
partner | object[] | yes | Partner data. |
partner.id | string | yes if partner.key or partner.email is not provided | |
partner.key | string | yes if partner.id or partner.email is not provided | |
partner.email | string | yes if partner.id or partner.key is not provided |
Response
{
"data": {
"id": "ref_456",
"key": "ref_456",
"url": "https://partnero.com?aff=ref_456",
"default": false,
"is_additional": false,
"direct_tracking": false,
"direct_tracking_redirect": false,
"direct_tracking_redirect_url": null
},
"status": 1
}
Response Code: 201 Created
Content-Type: application/json
Fetch a link
Get the details about specific partner link.
GET https://api.partnero.com/v1/partner_referral_links/{id}
Request example
GET https://api.partnero.com/v1/partner_referral_links/ref_456
Request parameters
Parameters | Type | Required | Details |
---|---|---|---|
id | string | yes | Link ID. |
Response
{
"data": {
"id": "ref_456",
"key": "ref_456",
"url": "https://partnero.com?aff=ref_456",
"default": false,
"is_additional": false,
"direct_tracking": false,
"direct_tracking_redirect": false,
"direct_tracking_redirect_url": null
},
"status": 1
}
Response Code: 200 OK
Content-Type: application/json
Get all links
Get the list of links that belong to a certain partner.
GET https://api.partnero.com/v1/partners/{id}/referral_links
Request example
GET https://api.partnero.com/v1/partners/partner_123/referral_links
Request parameters
Parameters | Type | Required | Details |
---|---|---|---|
limit | integer | no | A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 15. |
page | integer | no | The default is 1. |
Response
{
"data": [
{
"id": "ref_123",
"key": "ref_123",
"url": "https://partnero.com?aff=ref_123",
"default": true,
"is_additional": false,
"direct_tracking": false,
"direct_tracking_redirect": false,
"direct_tracking_redirect_url": null
},
{
"id": "ref_456",
"key": "ref_456",
"url": "https://partnero.com?aff=ref_456",
"default": false,
"is_additional": false,
"direct_tracking": false,
"direct_tracking_redirect": false,
"direct_tracking_redirect_url": null
},
...
],
"status": 1
}
Response Code: 200 OK
Content-Type: application/json
Search for a link
Search for links.
GET https://api.partnero.com/v1/partner_referral_links:search
Request example
GET https://api.partnero.com/v1/partner_referral_links:search?key=ref_456
Available search query parameters
Parameters | Type | Required | Details |
---|---|---|---|
id | string | optional | |
key | string | optional | |
partner | object[] | optional | Partner data. |
partner.id | string | yes if partner.key or partner.email is not provided | |
partner.key | string | yes if partner.id or partner.email is not provided | |
partner.email | string | yes if partner.id or partner.key is not provided |
Response
{
"data": [
{
"id": "ref_456",
"key": "ref_456",
"url": "https://partnero.com?aff=ref_456",
"default": false,
"is_additional": false,
"direct_tracking": false,
"direct_tracking_redirect": false,
"direct_tracking_redirect_url": null
}
],
"links": {
"first": "https://api.partnero.com/v1/partner_referral_links:search?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.partnero.com/v1/partner_referral_links:search",
"per_page": 10,
"to": 1
},
"status": 1
}
Response Code: 200 OK
Content-Type: application/json
Update a link
Update an existing link.
PUT https://api.partnero.com/v1/partner_referral_links/{id}
Request example
PUT https://api.partnero.com/v1/partner_referral_links/ref_456
{
"key": "ref_789"
}
Request parameters
Parameters | Type | Required | Details |
---|---|---|---|
key | string | yes | Link key to be updated. |
Response
{
"data": {
"id": "ref_789",
"key": "ref_789",
"url": "https://partnero.com?aff=ref_789",
"default": false,
"is_additional": false,
"direct_tracking": false,
"direct_tracking_redirect": false,
"direct_tracking_redirect_url": null
},
"status": 1
}
Response Code: 200 OK
Content-Type: application/json
Delete a link
Delete an existing link.
DELETE https://api.partnero.com/v1/partner_referral_links/{id}
Request example
DELETE https://api.partnero.com/v1/partner_referral_links/ref_789
Request parameters
Parameters | Type | Required | Details |
---|---|---|---|
id | string | yes |
Response
{
"status": 1
}
Response Code: 200 OK
Content-Type: application/json