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.

Get all partners

Get the list of Partners that belong to your program.

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

Valid

Response Code: 200 OK
Response Headers:
    Content-Type: application/json

{
    "data": [
        {
            "email": "partner@partnero.com",
            "created_at": "2022-09-28T11:51:50.000000Z",
            "updated_at": "2022-09-28T11:51:50.000000Z",
            "key": "lphs8bcrfmgv",
            "name": "Partnero",
            "surname": "Partner",
            "approved": true,
            "status": "active"
        }
      ...
    ]
}

Invalid

Response Code: 404 Not Found

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

{
  "key": "PARTNER_KEY",
  "email": "partner@partnero.com",
  "password": "",
  "name": "Partnero",
  "surname": "Partner"
}

Request parameters

Parameters	Type	Required	Details
key	string	optional	Not required, but must be unique if provided. It not provided, key is generated automatically.
email	string	yes	Must be a unique email address.
password	string	yes	The password must be at least 8 characters and contain at least 1 lowercase, 1 uppercase, and 1 number.
name	string	optional
surname	string	optional

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

Request example

{
  "key": "PARTNER_KEY"
}

Request parameters

Parameters	Type	Required	Details
key	string	yes *	Must provide either key or email.
email	string	yes *	Must provide either email or key.

Update a partner

Update an existing partner.

PUT https://api.partnero.com/v1/partners

Request example

{
  "key": "PARTNER_KEY",
  "update": {
    "email": "jane@partnero.com",
    "name": "Jane",
    "surname": "Partner",
    "password": "AkPfEp1R"
  }
}

Request parameters

Parameters	Type	Required	Details
key	string	yes *	Must provide either key or email.
email	string	yes *	Must provide either key 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.

Delete a partner

Delete an existing partner.

DELETE https://api.partnero.com/v1/partners

Request example

{
  "key": "PARTNER_KEY"
}

Request parameters

Parameters	Type	Required	Details
key	string	yes *	Must provide either key or email.
email	string	yes *	Must provide either email or key.