Partners
Partner is a person/company who shares a unique affiliate link with their audience so they can get rewarded once people sign up on a paid plan through their link.
Create a partner
Create a new partner. Please note that partners are being created automatically when someone signs up within Partnero Partner portal.
POST https://api.partnero.com/v1/partners
Request example
{
"id": "partner_123",
"key": "ref_123",
"email": "john.doe@partnero.com",
"name": "John",
"surname": "Doe",
"password": "W6qtZMGyCD6Gj2ZrtrVa"
}
Request parameters
Parameters | Type | Required | Details |
---|---|---|---|
id | string | optional | ID of the partner. Not required, but must be unique if provided. If not provided, id is generated automatically. |
email | string | yes | Must be a unique email address. |
name | string | optional | Name of the partner. |
surname | string | optional | Surname of the partner. |
password | string | yes | The password must be at least 8 characters and contain at least 1 lowercase, 1 uppercase, and 1 number. |
key | string | optional | Key will be used to generate an unique referral link. If not provided, key is generated automatically. |
referring_partner | object[] | optional | |
referring_partner.id | string | optional | Referring partner ID. When assigning a referring partner, you have the option to choose by their id , key or email . |
referring_partner.key | string | optional | Referring partner key. When assigning a referring partner, you have the option to choose by their id , key or email . |
referring_partner.email | string | optional | Referring partner email address. When assigning a referring partner, you have the option to choose by their id , key or email . |
Response
{
"data": {
"email": "john.doe@partnero.com",
"created_at": "2025-04-30T16:44:13.000000Z",
"updated_at": "2025-04-30T16:44:13.000000Z",
"name": "John",
"id": "partner_123",
"surname": "Doe",
"tos": false,
"approved": true,
"status": "active",
"custom_fields": [],
"referrals_count": 0,
"referral_link": "https://partnero.com?aff=ref_123",
"referral_links": [
"https://partnero.com?aff=ref_123"
]
},
"status": 1
}
Response Code: 201 Created
Content-Type: application/json
Fetch a partner
Get the details about specific partner. You need to provide either an email address or a unique key of the partner.
GET https://api.partnero.com/v1/partners/{id}
Request example
GET https://api.partnero.com/v1/partners/partner_123
Request parameters
Parameters | Type | Required | Details |
---|---|---|---|
id | string | yes * | ID of the partner. |
Response
{
"data": {
"email": "john.doe@partnero.com",
"created_at": "2025-04-30T16:44:13.000000Z",
"updated_at": "2025-04-30T16:44:13.000000Z",
"name": "John",
"id": "partner_123",
"surname": "Doe",
"tos": false,
"approved": true,
"status": "active",
"referrals": {
"clicks": 0,
"signups": 0,
"revenue": [],
"sales_count": 0,
"paid_accounts": 0
},
"commissions": {
"paid": 0,
"pending": [],
"not_paid": []
},
"custom_field_values": [],
"custom_fields": [],
"referrals_count": 0,
"referral_link": "https://partnero.com?aff=ref_123",
"referral_links": [
"https://partnero.com?aff=ref_123"
]
},
"status": 1
}
Response Code: 200 OK
Content-Type: application/json
Get all partners
Get the list of Partners that belong to your program.
GET https://api.partnero.com/v1/partners
Request example
GET https://api.partnero.com/v1/partners
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": [
{
"email": "john.doe@partnero.com",
"created_at": "2025-04-30T16:44:13.000000Z",
"updated_at": "2025-04-30T16:44:13.000000Z",
"id": "partner_123",
"name": "John",
"surname": "Doe",
"approved": true,
"status": "active",
"custom_fields": []
},
...
],
"links": {
"first": "https://api.partnero.com/v1/partners?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.partnero.com/v1/partners",
"per_page": 10,
"to": 10
},
"status": 1
}
Response Code: 200 OK
Content-Type: application/json
Find a partner
Search for a partner.
GET https://api.partnero.com/v1/partners:search
Request example
GET https://api.partnero.com/v1/partners:search?email=john.doe@partnero.com
GET https://api.partnero.com/v1/partners:search?key=ref_123
GET https://api.partnero.com/v1/partners:search?id=partner_123
Available search query parameters
Parameters | Type | Required | Details |
---|---|---|---|
id | string | optional | ID of the partner. |
email | string | optional | Email address of the partner. |
key | string | optional | Any referral key that belongs to the partner. |
Response
{
"data": [
{
"email": "john.doe@partnero.com",
"created_at": "2025-04-30T16:44:13.000000Z",
"updated_at": "2025-04-30T16:44:13.000000Z",
"id": "partner_123",
"name": "John",
"surname": "Doe",
"approved": true,
"status": "active",
"custom_fields": []
}
],
"links": {
"first": "https://api.partnero.com/v1/partners:search?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.partnero.com/v1/partners:search",
"per_page": 10,
"to": 1
},
"status": 1
}
Response Code: 200 OK
Content-Type: application/json
Update a partner
Update an existing partner.
PUT https://api.partnero.com/v1/partners/{id}
Request example
PUT https://api.partnero.com/v1/partners/partner_123
{
"update": {
"name": "James",
"surname": "Wilson",
"email": "james.wilson@partnero.com",
"password": "W6qtZMGyCD6Gj2ZrtrVa"
}
}
Request parameters
Parameters | Type | Required | Details |
---|---|---|---|
id | string | yes * | Must provide either id or email . |
email | string | yes * | Must provide either id or email . |
update | object[] | optional | |
update.email | string | optional | Must be a unique email address. |
update.name | string | optional | |
update.surname | string | optional | |
update.password | string | optional | The password must be at least 8 characters and contain at least 1 lowercase, 1 uppercase, and 1 number. |
update.key | string | optional | Partner default referral link key. |
Response
{
"data": {
"email": "james.wilson@partnero.com",
"created_at": "2025-04-30T16:44:13.000000Z",
"updated_at": "2025-04-30T18:02:45.000000Z",
"name": "James",
"id": "partner_123",
"surname": "Wilson",
"tos": false,
"approved": true,
"status": "active",
"custom_fields": [],
"referrals_count": 0,
"referral_link": "https://partnero.com?aff=ref_123",
"referral_links": [
"https://partnero.com?aff=ref_123"
]
},
"status": 1
}
Response Code: 200 OK
Content-Type: application/json
Archive a partner
Archive an existing partner.
POST https://api.partnero.com/v1/partners/{id}/archive
Request example
POST https://api.partnero.com/v1/partners/partner_123/archive
Response
{
"status": 1
}
Response Code: 200 OK
Content-Type: application/json
Revoke archived partner
Revoke archived partner.
POST https://api.partnero.com/v1/partners/{id}/revoke-archive
Request example
POST https://api.partnero.com/v1/partners/partner_123/revoke-archive
Response
{
"status": 1
}
Response Code: 200 OK
Content-Type: application/json
Delete a partner
Delete an existing partner.
DELETE https://api.partnero.com/v1/partners/{id}
Request example
DELETE https://api.partnero.com/v1/partners/partner_123
Request parameters
Parameters | Type | Required | Details |
---|---|---|---|
id | string | yes * | Must provide either id or email . |
email | string | yes * | Must provide either email or key . |
Response
{
"status": 1
}
Response Code: 200 OK
Content-Type: application/json
Invite a partner
Invite a partner via email notification
POST https://api.partnero.com/v1/partners:invite
Request example
{
"email": "jane.smith@partnero.com",
"name": "Jane",
"surname": "Smith"
}
Available parameters
Parameters | Type | Required | Details |
---|---|---|---|
email | string | required | Email address of the partner. |
name | string | required | Name of the partner. |
surname | string | optional | Surname of the partner. |
Response
{
"status": 1
}
Response Code: 200 OK
Content-Type: application/json