Apiary Powered Documentation
Sign in with Apiary account.
This is the public API documentation for Reditus.
All our API calls use JSON format.
PUT : To create resource POST : Update resource GET : Get a resource or list of resources DELETE : To delete resource
200 OK
- the request was successful (some API calls may return 201 instead).
201 Created
- the request was successful and a resource was created.
204 No Content
- the request was successful but there is no representation to return (i.e. the response is empty).
400 Bad Request
- the request could not be understood or was missing required parameters.
401 Unauthorized
- authentication failed or user doesn't have permissions for requested operation.
403 Forbidden
- access denied.
404 Not Found
- resource was not found.
405 Method Not Allowed
- requested method is not supported for resource.
Retrieve paginated list of partners.
name_eq | Filter by name |
---|---|
email_eq | Filter by email |
paypal_email_eq | Filter by PayPal email |
page | Page number |
per_page | Records to be displayed per page (max 50) |
Retrieve paginated list of partnerships.
state_eq | Filter by state (pending, accepted, declined) |
---|---|
created_at_lt | Created before (e.g. "2022-12-24%201 |
created_at_gt | Created after (e.g. "2021-11-23%201 |
page | Page number |
per_page | Records to be displayed per page (max 50) |
The payments API allows you to add payments for your referrals. If you want to track a one-off payment, just don't specify subscription_id
, interval
and interval_count
.
Payment amount (in cents)
Subscription interval ("month"/"year")
Number of intervals the payment is made (default: 1)
Retrieve paginated list of referrals.
state_eq | Filter by state |
---|---|
email_eq | Filter by email |
created_at_lt | Created before (e.g. "2022-12-24%201 |
created_at_gt | Created after (e.g. "2021-11-23%201 |
state_set_at_lt | State set at before (e.g. "2022-12-24%201 |
state_set_at_gt | State set at before (e.g. "2021-12-24%201 |
page | Page number |
per_page | Records to be displayed per page (max 50) |
The subscriptions API allows you manage referral subscriptions.
The tracking API allows you to track conversions for any partner.
URL parameter of the affiliate (i.e. https://company.com?red=john -> john)
Internal ID of the user/customer
Cookie set by the tracking script in the referral's browser. Used to match the exact click that converted.
URL parameter of the affiliate (i.e. https://company.com?red=john -> john)
Internal ID of the user/customer
Cookie set by the tracking script in the referral's browser. Used to match the exact click that converted.
URL parameter of the affiliate (i.e. https://company.com?red=john -> john)
Internal ID of the user/customer
Cookie set by the tracking script in the referral's browser. Used to match the exact click that converted.
The tracking API allows you to track conversions for any partner.
Cookie set by the tracking script in the referral's browser
Can replace gr_id
, in combination with uid
being used to mark the correct affiliate as the referee
Can replace gr_id
, in combination with pk
, being used to mark the correct affiliate as the referee