Show/hide List Operations Expand Operations

Accounts

/accounts

GET /accounts

Get accounts

Documentation
Sandbox

Documentation

Get the list of accounts.

Response Format

{
    "code": 200,
    "data": {
        "limit": 1,
        "page": 1,
        "results": [
            {
                "_currencies": "USD, GBP",
                "created": "2014-01-27T03:48:09+0000",
                "is_active": true,
                "name": "Example.com",
                "slug": "example-com",
                "url": "http://www.example.com"
            }
        ],
        "total": 2
    }
}

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

.+

Description

Allowed fields: name. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

.+

Description

Allowed fields: name, created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
url	string	*
is_active	boolean	*
_domains	string	*
is_live	boolean	*
created	DateTime	*
updated	DateTime	*
slug	string	*
_currencies	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}

GET /accounts/{account_slug}

Get an account

Documentation
Sandbox

Documentation

Get an account by a given slug.

Response Format

{
   "code": 200,
   "data": {
       "_currencies": "USD, GBP",
       "created": "2014-01-27T03:48:09+0000",
       "is_active": true,
       "name": "Example.com",
       "slug": "example-com",
       "url": "http://www.example.com"
   }

}

Requirements

Name	Requirement	Type	Description
account_slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
url	string	*
is_active	boolean	*
_domains	string	*
is_live	boolean	*
created	DateTime	*
updated	DateTime	*
slug	string	*
_currencies	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Advocates

/accounts/{account_slug}/advocates

DELETE /accounts/{account_slug}/advocates

Delete all advocates

Documentation
Sandbox

Documentation

Delete all advocates

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/advocates

Get advocates

Documentation
Sandbox

Documentation

Get the list of advocates in a specific account.

Response Format

  {
      "code": 200,
      "data": {
          "page": 2,
          "limit": 1,
          "total": 2,
          "results": [
              {
                  "email": "janedoe_at_geniusreferrals.com",
                  "lastname": "Doe",
                  "name": "Jane",
                  "token": "8f362f2ff2250ff20272598b7459129ff3826968",
                  "short_token": "ubEa0",
                  "code": "janedoe15off",
                  "payout_threshold": 1,
                  "claimed_balance": 0,
                  "unclaimed_balance": 0,
                  "total_referrals": 0,
                  "total_bonuses": 0,
                  "created": "2018-11-09T05:04:30+0000",
                  "metadata": "[{\"label\":\"Phone Number\",\"value\":\"14928483822\"}]",
                  "can_refer": false,
                  "firstname": "Jane",
                  "_advocate_referrer": {
                      "email": "johndoe_at_geniusreferrals.com",
                      "lastname": "Doe",
                      "name": "John",
                      "token": "0770e11007636ec58425f486214213f0a25f2c00",
                      "short_token": "VMZFi",
                      "code": "johndoe15off",
                      "payout_threshold": 1,
                      "claimed_balance": 0,
                      "unclaimed_balance": 5,
                      "total_referrals": 1,
                      "total_bonuses": 1,
                      "created": "2018-11-09T05:04:30+0000",
                      "metadata": "[{\"label\":\"Phone Number\",\"value\":\"14332828929\"}]",
                      "can_refer": true,
                      "firstname": "John",
                      "_currency": {
                          "code": "USD",
                          "unicode": "36",
                          "currency": "United States Dollar",
                          "suffix": "¢",
                          "updated": "2018-11-12T17:58:18+0000"
                      },
                  "_bonuses_redemption_method": {
                      "name": "Auto into credit",
                      "description": "Automatically exchange the bonuses as credit",
                      "slug": "auto-into-credit"
                      }
                  },
                  "_currency": {
                      "code": "USD",
                      "unicode": "36",
                      "currency": "United States Dollar",
                      "suffix": "¢",
                      "updated": "2018-11-12T17:58:18+0000"
                  },
                  "_bonuses_redemption_method": {
                      "name": "Auto into credit",
                      "description": "Automatically exchange the bonuses as credit",
                      "slug": "auto-into-credit"
                  }
              }
          ]
      }
  }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

.+

Description

Allowed fields: fullname, name, lastname, email, advocate_token, advocate_code, bonus_exchange_method_slug, campaign_slug, can_refer, is_referral, from, to, created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

.+

Description

Allowed fields: name, lastname, email, created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
email	string	*
lastname	string	*
name	string	*
token	string	*
short_token	string	*
code	string	*
payout_threshold	float	*
claimed_balance	float	*
unclaimed_balance	float	*
total_referrals	integer	*
total_bonuses	integer	*
created	DateTime	*
avatar_url	string	*
metadata	string	*
can_refer	boolean	*
_advocate_referrer	object (Advocate)	*
_advocate_referrer[email]	string	*
_advocate_referrer[lastname]	string	*
_advocate_referrer[name]	string	*
_advocate_referrer[token]	string	*
_advocate_referrer[short_token]	string	*
_advocate_referrer[code]	string	*
_advocate_referrer[payout_threshold]	float	*
_advocate_referrer[claimed_balance]	float	*
_advocate_referrer[unclaimed_balance]	float	*
_advocate_referrer[total_referrals]	integer	*
_advocate_referrer[total_bonuses]	integer	*
_advocate_referrer[created]	DateTime	*
_advocate_referrer[avatar_url]	string	*
_advocate_referrer[metadata]	string	*
_advocate_referrer[can_refer]	boolean	*
_advocate_referrer[_advocate_referrer]	object (Advocate)	*
_advocate_referrer[_currency]	object (Currency)	*
_advocate_referrer[_currency][code]	string	*
_advocate_referrer[_currency][unicode]	string	*
_advocate_referrer[_currency][currency]	string	*
_advocate_referrer[_currency][suffix]	string	*
_advocate_referrer[_currency][updated]	DateTime	*
_advocate_referrer[_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_advocate_referrer[_bonuses_redemption_method][name]	string	*
_advocate_referrer[_bonuses_redemption_method][description]	string	*
_advocate_referrer[_bonuses_redemption_method][slug]	string	*
_advocate_referrer[_campaign_contract]	object (Campaign)	*
_advocate_referrer[_campaign_contract][name]	string	*
_advocate_referrer[_campaign_contract][description]	string	*
_advocate_referrer[_campaign_contract][start_date]	DateTime	*
_advocate_referrer[_campaign_contract][end_date]	DateTime	*
_advocate_referrer[_campaign_contract][is_active]	boolean	*
_advocate_referrer[_campaign_contract][schemaless_config]	string	*
_advocate_referrer[_campaign_contract][created]	DateTime	*
_advocate_referrer[_campaign_contract][updated]	DateTime	*
_advocate_referrer[_campaign_contract][slug]	string	*
_advocate_referrer[_campaign_contract][total_advocates]	integer	*
_advocate_referrer[_campaign_contract][startDate]	DateTime	*
_advocate_referrer[_campaign_contract][endDate]	DateTime	*
_advocate_referrer[_campaign_contract][isActive]	bool	*
_advocate_referrer[_campaign_contract][schemalessConfig]		*
_currency	object (Currency)	*
_currency[code]	string	*
_currency[unicode]	string	*
_currency[currency]	string	*
_currency[suffix]	string	*
_currency[updated]	DateTime	*
_bonuses_redemption_method	object (BonusExchangeMethod)	*
_bonuses_redemption_method[name]	string	*
_bonuses_redemption_method[description]	string	*
_bonuses_redemption_method[slug]	string	*
_campaign_contract	object (Campaign)	*
_campaign_contract[name]	string	*
_campaign_contract[description]	string	*
_campaign_contract[start_date]	DateTime	*
_campaign_contract[end_date]	DateTime	*
_campaign_contract[is_active]	boolean	*
_campaign_contract[schemaless_config]	string	*
_campaign_contract[created]	DateTime	*
_campaign_contract[updated]	DateTime	*
_campaign_contract[slug]	string	*
_campaign_contract[total_advocates]	integer	*
_campaign_contract[startDate]	DateTime	*
_campaign_contract[endDate]	DateTime	*
_campaign_contract[isActive]	bool	*
_campaign_contract[schemalessConfig]		*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/advocates

Create an advocate

Documentation
Sandbox

Documentation

Create a new advocate or referral in our platform. Usually referrals are turned into advocates when they start referring your services. Note that a referral can be turn into an advocate by setting property can_refer to true.

To create a new advocate set the property can_refer to true.

To create a new referral, you need an advocate and a referral. First create a new advocate with property can_refer=true, then create the another advocate (referral) with property can_refer=false, and finally create a new referral (POST /accounts/{account_slug}/advocates/{advocate_token}/referrals) to link the advocate and the referral.

Request Format

Not all parameters in the content of the request are mandatory. Parameters avatar_url, metadata, currency_code and can_refer are optional.

{
"advocate":{
"firstname":"Jonh",
"lastname":"Smith",
"email": "jonh_at_email.com",
"payout_threshold":10,
"avatar_url":"http://www.example.com/myavatar.png",
"metadata":"extra metadata",
"can_refer": 1,
"currency_code": "USD"
}
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/advocates/{advocate_token}

DELETE /accounts/{account_slug}/advocates/{advocate_token}

Delete an advocate

Documentation
Sandbox

Documentation

Delete an advocate

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		string	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/advocates/{advocate_token}

Get an advocate

Documentation
Sandbox

Documentation

Get an advocate by a given token.

Response Format

 {
     "code": 200,
     "data": {
         "email": "janedoe@geniusreferrals.com",
         "lastname": "Doe",
         "name": "Jane",
         "token": "8f362f2ff2250ff20272598b7459129ff3826968",
         "short_token": "ubEa0",
         "code": "janedoe15off",
         "payout_threshold": 1,
         "claimed_balance": 0,
         "unclaimed_balance": 0,
         "total_referrals": 0,
         "total_bonuses": 0,
         "created": "2018-11-09T05:04:30+0000",
         "metadata": "[{\"label\":\"Phone Number\",\"value\":\"14928483822\"}]",
         "can_refer": false,
         "firstname": "Jane",
         "_advocate_referrer": {
             "email": "johndoe@geniusreferrals.com",
             "lastname": "Doe",
             "name": "John",
             "token": "0770e11007636ec58425f486214213f0a25f2c00",
             "short_token": "VMZFi",
             "code": "johndoe15off",
             "payout_threshold": 1,
             "claimed_balance": 0,
             "unclaimed_balance": 5,
             "total_referrals": 1,
             "total_bonuses": 1,
             "created": "2018-11-09T05:04:30+0000",
             "metadata": "[{\"label\":\"Phone Number\",\"value\":\"14332828929\"}]",
             "can_refer": true,
             "firstname": "John",
             "_currency": {
                 "code": "USD",
                 "unicode": "36",
                 "currency": "United States Dollar",
                 "suffix": "¢",
                 "updated": "2018-11-12T17:58:18+0000"
             },
             "_bonuses_redemption_method": {
                 "name": "Auto into credit",
                 "description": "Automatically exchange the bonuses as credit",
                 "slug": "auto-into-credit"
             }
         },
         "_currency": {
         "code": "USD",
         "unicode": "36",
         "currency": "United States Dollar",
             "suffix": "¢",
             "updated": "2018-11-12T17:58:18+0000"
         },
         "_bonuses_redemption_method": {
              "name": "Auto into credit",
              "description": "Automatically exchange the bonuses as credit",
              "slug": "auto-into-credit"
         }
      }
  }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		string	the advocate token

Return

Parameter	Type	Versions
200 - Returned when successful
email	string	*
lastname	string	*
name	string	*
token	string	*
short_token	string	*
code	string	*
payout_threshold	float	*
claimed_balance	float	*
unclaimed_balance	float	*
total_referrals	integer	*
total_bonuses	integer	*
created	DateTime	*
avatar_url	string	*
metadata	string	*
can_refer	boolean	*
_advocate_referrer	object (Advocate)	*
_advocate_referrer[email]	string	*
_advocate_referrer[lastname]	string	*
_advocate_referrer[name]	string	*
_advocate_referrer[token]	string	*
_advocate_referrer[short_token]	string	*
_advocate_referrer[code]	string	*
_advocate_referrer[payout_threshold]	float	*
_advocate_referrer[claimed_balance]	float	*
_advocate_referrer[unclaimed_balance]	float	*
_advocate_referrer[total_referrals]	integer	*
_advocate_referrer[total_bonuses]	integer	*
_advocate_referrer[created]	DateTime	*
_advocate_referrer[avatar_url]	string	*
_advocate_referrer[metadata]	string	*
_advocate_referrer[can_refer]	boolean	*
_advocate_referrer[_advocate_referrer]	object (Advocate)	*
_advocate_referrer[_currency]	object (Currency)	*
_advocate_referrer[_currency][code]	string	*
_advocate_referrer[_currency][unicode]	string	*
_advocate_referrer[_currency][currency]	string	*
_advocate_referrer[_currency][suffix]	string	*
_advocate_referrer[_currency][updated]	DateTime	*
_advocate_referrer[_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_advocate_referrer[_bonuses_redemption_method][name]	string	*
_advocate_referrer[_bonuses_redemption_method][description]	string	*
_advocate_referrer[_bonuses_redemption_method][slug]	string	*
_advocate_referrer[_campaign_contract]	object (Campaign)	*
_advocate_referrer[_campaign_contract][name]	string	*
_advocate_referrer[_campaign_contract][description]	string	*
_advocate_referrer[_campaign_contract][start_date]	DateTime	*
_advocate_referrer[_campaign_contract][end_date]	DateTime	*
_advocate_referrer[_campaign_contract][is_active]	boolean	*
_advocate_referrer[_campaign_contract][schemaless_config]	string	*
_advocate_referrer[_campaign_contract][created]	DateTime	*
_advocate_referrer[_campaign_contract][updated]	DateTime	*
_advocate_referrer[_campaign_contract][slug]	string	*
_advocate_referrer[_campaign_contract][total_advocates]	integer	*
_advocate_referrer[_campaign_contract][startDate]	DateTime	*
_advocate_referrer[_campaign_contract][endDate]	DateTime	*
_advocate_referrer[_campaign_contract][isActive]	bool	*
_advocate_referrer[_campaign_contract][schemalessConfig]		*
_currency	object (Currency)	*
_currency[code]	string	*
_currency[unicode]	string	*
_currency[currency]	string	*
_currency[suffix]	string	*
_currency[updated]	DateTime	*
_bonuses_redemption_method	object (BonusExchangeMethod)	*
_bonuses_redemption_method[name]	string	*
_bonuses_redemption_method[description]	string	*
_bonuses_redemption_method[slug]	string	*
_campaign_contract	object (Campaign)	*
_campaign_contract[name]	string	*
_campaign_contract[description]	string	*
_campaign_contract[start_date]	DateTime	*
_campaign_contract[end_date]	DateTime	*
_campaign_contract[is_active]	boolean	*
_campaign_contract[schemaless_config]	string	*
_campaign_contract[created]	DateTime	*
_campaign_contract[updated]	DateTime	*
_campaign_contract[slug]	string	*
_campaign_contract[total_advocates]	integer	*
_campaign_contract[startDate]	DateTime	*
_campaign_contract[endDate]	DateTime	*
_campaign_contract[isActive]	bool	*
_campaign_contract[schemalessConfig]		*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /accounts/{account_slug}/advocates/{advocate_token}

Update an advocate

Documentation
Sandbox

Documentation

Update partial elements of an advocate.

Use this method when you do not need to update all the elements at the same time.

Allowed parameters to be updated are: name, lastname, email, token, code, payout_threshold, claimed_balance, unclaimed_balance, currency_code, avatar_url, metadata and can_refer

Request Format

{
"firstname":"Jonh",
"lastname":"Smith",
"email": "jonh_at_example.com",
"payout_threshold":10,
"claimed_balance":10,
"unclaimed_balance":10,
"currency_code": "USD",
"avatar_url":"http://www.geniusreferrals.com/bundles/frontend/images/geniusreferrals-logo.png",
"metadata":"extra metadata",
"can_refer": 1,
"code" : "get15off"
}
-- OR --

{"firstname":"Jonh"}

-- OR send a query string like this --

payout_threshold=10&claimed_balance=10&unclaimed_balance=10&currency_code=EUR

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		string	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /accounts/{account_slug}/advocates/{advocate_token}

Update an advocate

Documentation
Sandbox

Documentation

Update an advocate.

Request Format

Not all parameters in the content of the request are mandatory. Parameters avatar_url, metadata, currency_code and can_refer are optional.

{
"advocate":{
"firstname":"Jonh",
"lastname":"Smith",
"email": "jonh_at_email.com",
"payout_threshold":10,
"avatar_url":"http://www.example.com/myavatar.png",
"metadata":"extra metadata",
"can_refer": 1,
"currency_code": "USD"
}
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		string	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/advocates/{advocate_token}/payment-methods

GET /accounts/{account_slug}/advocates/{advocate_token}/payment-methods

Get advocate's payment methods

Documentation
Sandbox

Documentation

Get the advocate's payment methods.

Response Format

{
    "code": 200,
    "data": {
        "limit": 10,
        "page": 1,
        "results": [
            {
                "created": "2014-01-16T20:59:59+0000",
                "description": "Paypal account",
                "id": 1,
                "is_active": true,
                "username": "advocate_at_email.com"
            }
        ],
        "total": 1
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		integer	the advocate token

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

.+

Description

Allowed fields: username, is_active. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

.+

Description

Allowed fields: username, created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
username	string	*
description	string	*
isActive	bool	*
id	integer	*
is_active	boolean	*
created	DateTime	*
updated	DateTime	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/advocates/{advocate_token}/payment-methods

Create a payment method

Documentation
Sandbox

Documentation

Create a new payment method.

Request Format

All parameters in the content of the request are mandatory.

{
    "advocate_payment_method":{
        "username":"advocate_at_email.com",
        "description":"My main paypal account",
        "is_active": true
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		integer	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/advocates/{advocate_token}/payment-methods/{advocate_payment_method_id}

GET /accounts/{account_slug}/advocates/{advocate_token}/payment-methods/{advocate_payment_method_id}

Get an advocate's payment method

Documentation
Sandbox

Documentation

Get an advocate's payment method

Response Format

 {
    "code": 200,
    "data": {
        "created": "2014-01-16T20:59:59+0000",
        "description": "Paypal account",
        "id": 1,
        "is_active": true,
        "username": "advocate_at_email.com"
    }
}

Requirements

Name	Requirement	Type	Description
advocate_payment_method_id	\d+	string	the payment method id
account_slug		string	the client account slug
advocate_token		string	the advocate token

Return

Parameter	Type	Versions
200 - Returned when successful
username	string	*
description	string	*
isActive	bool	*
id	integer	*
is_active	boolean	*
created	DateTime	*
updated	DateTime	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /accounts/{account_slug}/advocates/{advocate_token}/payment-methods/{advocate_payment_method_id}

Update a payment method

Documentation
Sandbox

Documentation

Update a payment method.

Request Format

All parameters in the content of the request are mandatory.

{
    "advocate_payment_method":{
        "username":"advocate_at_email.com",
        "description":"My main paypal account",
        "is_active": true
    }
}

Requirements

Name	Requirement	Type	Description
advocate_payment_method_id	\d+	string	the payment method id
account_slug		string	the client account slug
advocate_token		integer	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/advocates/{advocate_token}/share-links

GET /accounts/{account_slug}/advocates/{advocate_token}/share-links

Get list of share links

Documentation
Sandbox

Documentation

Get list of share links that your advocate will share socially with their friends. When a friend clicks on one of this links we will be able to track new shares, clicks, and referrals.

This list of share links is unique to your advocate.

Response Format

{
"code": 200,
"data": {
"get-10-of-for-90-days": {
"my-first-package": {
"direct-email": "https://gr3f.co/c/e2323/62",
"facebook-share": "https://gr3f.co/s/e2323/57",
"google-1": "https://gr3f.co/s/e2323/59",
"linkedin-post": "https://gr3f.co/s/e2323/60",
"personal": "https://gr3f.co/c/e2323/63",
"pin-it": "https://gr3f.co/s/e2323/61",
"twitter-post": "https://gr3f.co/s/e2323/58"
}
}
}
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		string	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/bonuses-redemption-methods

GET /utilities/bonuses-redemption-methods

Get bonuses redemption methods

Documentation
Sandbox

Documentation

Get bonuses redemption methods.

Response Format

{
"code": 200,
"data": [
{
"description": "Automatically exchange the bonuses as credit",
"name": "Auto into credit",
"slug": "auto-into-credit"
},
{
"description": "Automatically exchange the bonuses as cash",
"name": "Auto into cash",
"slug": "auto-into-cash"
},
{
"description": "Make a decision on how echange the bonuses",
"name": "Make a decision",
"slug": "make-a-decision"
}
]
}

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/bonuses-redemption-methods/{bonuses_redemption_method_slug}

GET /utilities/bonuses-redemption-methods/{bonuses_redemption_method_slug}

Get bonuses redemption method

Documentation
Sandbox

Documentation

Get bonuses redemption method.

Response Format

{
"code": 200,
"data": {
"description": "Automatically exchange the bonuses as credit",
"name": "Auto into credit",
"slug": "auto-into-credit"
}
}

Requirements

Name	Requirement	Type	Description
bonuses_redemption_method_slug		string	the bonuses redemption method slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/currencies

GET /utilities/currencies

Get currencies

Documentation
Sandbox

Documentation

Get currencies.

Response Format

{
"code": 200,
"data": [
{
"code": "GBP",
"currency": "British Pounds ",
"suffix": "p",
"unicode": "163",
"updated": "2014-02-15T20:41:42+0000"
},
{
"code": "EUR",
"currency": "Euro",
"suffix": "¢",
"unicode": "8364",
"updated": "2014-02-15T20:41:43+0000"
},
{
"code": "USD",
"currency": "United States Dollar",
"suffix": "¢",
"unicode": "32",
"updated": "2014-02-15T20:41:43+0000"
}
]
}

Return

Parameter	Type	Versions
200 - Returned when successful
code	string	*
unicode	string	*
currency	string	*
suffix	string	*
updated	DateTime	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/currencies/{code}

GET /utilities/currencies/{code}

Get a currency

Documentation
Sandbox

Documentation

Get a currency.

Response Format

{
"code": 200,
"data": {
"code": "USD",
"currency": "United States Dollar",
"suffix": "¢",
"unicode": "32",
"updated": "2014-02-15T20:41:43+0000"
}
}

Requirements

Name	Requirement	Type	Description
code		string	the currency code

Return

Parameter	Type	Versions
200 - Returned when successful
code	string	*
unicode	string	*
currency	string	*
suffix	string	*
updated	DateTime	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Authentications

/test-authentication
- - GET /test-authentication
    - Test authentication
    - Documentation
    - Sandbox
    Documentation
    
    Allow clients to test authentication on Genius Referrals platform.
    
    Expected Response
    
    { "code": 200, "message": "Hello jonh_at_mail.com!, You've successfully authenticated on Genius Referrals platform." }
    
    Input
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Request body
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
    
    Curl Command Line

Show/hide List Operations Expand Operations

Bonuses

/accounts/{account_slug}/bonuses

GET /accounts/{account_slug}/bonuses

Get bonuses

Documentation
Sandbox

Documentation

Get the list of bonuses for a given account.

Response Format

{
    "code": 200,
    "data": {
        "limit": 10,
        "page": 1,
        "results": [
            {
                "_advocate": {
                    "_bonuses_redemption_method": {
                        "description": "Automatically redeem the bonuses as credit",
                        "name": "Auto into credit",
                        "slug": "auto-into-credit"
                    },
                    "_currency": {
                        "code": "USD",
                        "currency": "United States Dollar",
                        "suffix": "¢",
                        "unicode": "32"
                    },
                    "claimed_balance": 0,
                    "created": "2014-01-16T20:59:59+0000",
                    "email": "advocate_at_mail.com",
                    "lastname": "Hernandez",
                    "firstname": "Advocate",
                    "payout_threshold": 10,
                    "token": "0c46a4da6381b7d3fa7cf9ca32b95585a24b8697",
                    "unclaimed_balance": 0
                },
                "_currency": {
                    "code": "USD",
                    "currency": "United States Dollar",
                    "suffix": "¢",
                    "unicode": "32"
                },
                bonus_request_trace: {
                    "id": 14,
                    "trace": "trace data",
                    "message": "Message",
                    "reference": "14587962",
                    "created": "2014-02-27T01:36:42+0000",
                    "updated": "2014-02-27T01:36:42+0000",
                    "advocate_referrer_token": "43277f772ba9a01e485c4641132be8ed6521a09b",
                    "advocate_token": "14985d98c28bd32bd5142e0df11b003398fddc47",
                    "bonuses" : [],
                    "campaign_slug": "get-1-on-first-order",
                    "bonus_amount": 1,
                    "result": "success"
                },
                "amount": 10,
                "referred_advocate_email":"erica@gmail.com",
                "referred_advocate_full_name":"Erica Chagas",
                "created": "2014-01-16T20:59:59+0000",
                "id": 1,
                "referred_advocate_token": "0469ec86727ddd6c2be75d171200a8f1329a2dbc",
                "payment_amount": 12.3,
                "reference":"XRE3456"
            }
        ],
        "total": 1
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

.+

Description

Allowed fields: name, lastname, email, campaign_slug, from, to, created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

.+

Description

Allowed fields: name, lastname, email, created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
amount	float	*
created	DateTime	*
updated	DateTime	*
_currency	object (Currency)	*
_currency[code]	string	*
_currency[unicode]	string	*
_currency[currency]	string	*
_currency[suffix]	string	*
_currency[updated]	DateTime	*
_advocate	object (Advocate)	*
_advocate[email]	string	*
_advocate[lastname]	string	*
_advocate[name]	string	*
_advocate[token]	string	*
_advocate[short_token]	string	*
_advocate[code]	string	*
_advocate[payout_threshold]	float	*
_advocate[claimed_balance]	float	*
_advocate[unclaimed_balance]	float	*
_advocate[total_referrals]	integer	*
_advocate[total_bonuses]	integer	*
_advocate[created]	DateTime	*
_advocate[avatar_url]	string	*
_advocate[metadata]	string	*
_advocate[can_refer]	boolean	*
_advocate[_advocate_referrer]	object (Advocate)	*
_advocate[_currency]	object (Currency)	*
_advocate[_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_advocate[_bonuses_redemption_method][name]	string	*
_advocate[_bonuses_redemption_method][description]	string	*
_advocate[_bonuses_redemption_method][slug]	string	*
_advocate[_campaign_contract]	object (Campaign)	*
_advocate[_campaign_contract][name]	string	*
_advocate[_campaign_contract][description]	string	*
_advocate[_campaign_contract][start_date]	DateTime	*
_advocate[_campaign_contract][end_date]	DateTime	*
_advocate[_campaign_contract][is_active]	boolean	*
_advocate[_campaign_contract][schemaless_config]	string	*
_advocate[_campaign_contract][created]	DateTime	*
_advocate[_campaign_contract][updated]	DateTime	*
_advocate[_campaign_contract][slug]	string	*
_advocate[_campaign_contract][total_advocates]	integer	*
_advocate[_campaign_contract][startDate]	DateTime	*
_advocate[_campaign_contract][endDate]	DateTime	*
_advocate[_campaign_contract][isActive]	bool	*
_advocate[_campaign_contract][schemalessConfig]		*
bonus_request_trace	object (BonusRequestTrace)	*
bonus_request_trace[id]	integer	*
bonus_request_trace[trace]	string	*
bonus_request_trace[message]	string	*
bonus_request_trace[reference]	string	*
bonus_request_trace[created]	DateTime	*
bonus_request_trace[updated]	DateTime	*
bonus_request_trace[advocate_referrer_token]	string	*
bonus_request_trace[advocate_token]	string	*
bonus_request_trace[campaign_slug]	string	*
bonus_request_trace[bonus_amount]	float	*
bonus_request_trace[result]	string	*
bonus_request_trace[bonuses][]	array of objects (Bonus)	*
bonus_request_trace[bonuses][][id]	integer	*
bonus_request_trace[bonuses][][amount]	float	*
bonus_request_trace[bonuses][][created]	DateTime	*
bonus_request_trace[bonuses][][updated]	DateTime	*
bonus_request_trace[bonuses][][_currency]	object (Currency)	*
bonus_request_trace[bonuses][][_advocate]	object (Advocate)	*
bonus_request_trace[bonuses][][bonus_request_trace]	object (BonusRequestTrace)	*
bonus_request_trace[bonuses][][referred_advocate_token]	string	*
bonus_request_trace[bonuses][][referred_advocate_full_name]	string	*
bonus_request_trace[bonuses][][referred_advocate_email]	string	*
bonus_request_trace[bonuses][][redemption_request_id]	integer	*
bonus_request_trace[bonuses][][reference]	string	*
bonus_request_trace[bonuses][][payment_amount]	float	*
referred_advocate_token	string	*
referred_advocate_full_name	string	*
referred_advocate_email	string	*
redemption_request_id	integer	*
reference	string	*
payment_amount	float	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/bonuses

Create a bonus

Documentation
Sandbox

Documentation

Process a referral (advocate_token) and tries to reward the referrer advocate with a bonus based on the rules defined in the campaign. All restrictions set on the campaigns for this account will be checked before giving the bonus to the referrer. Note that a bonus will be given only if all rules defined in the campaign pass validation. The trace of this request can be found on the (GET /accounts/{account_slug}/bonuses/traces) resource.

Request Format

Not all parameters in the content of the request are mandatory. Parameter payment_amount is optional.

{
    "bonus":{
        "advocate_token":"7c4ae87701ef6e6c9ab64941215da6b1f90f5c7a",
        "reference": "HSY7292D00",
        "payment_amount": 10
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/bonuses/checkup

GET /accounts/{account_slug}/bonuses/checkup

Check for bonus

Documentation
Sandbox

Documentation

Process a referral (advocate_token) and check if the referrer advocate will be rewarded with a bonus.

Allows the clients to check if there is a bonus to be given, it simulates the behaivor of POST /accounts/{account_slug}/bonuses resource.

This resource is idempotent.

Request Format

 {
    "advocate_token":"7c4ae87701ef6e6c9ab64941215da6b1f90f5c7a",
    "reference": "HSY7292D00",
    "payment_amount": 10
  }

Response Format

{
    "code": 200,
    "data": {
        "advocate_referrer_token": "3dc875d4ae1dc46d78828bef4dae586bdb3d8c9d",
        "advocate_token": "c66ecb4255941e83112838a677c2def09f44fc40",
        "bonus_amount": 3,
        "campaign_slug": "get-5-on-first-order-1",
        "message": "The bonus was given to the advocate's referrer.",
        "reference": "HSY7292D00",
        "result": "success",
        "trace": [
            "Campaign is active -> ok",
            "Amount of days after sign up -> ok",
            "Amount of payments -> ok",
            "Payment minimun value per currency -> ok",
            "Maximum value per advocates referrer per currency -> ok",
            "Giving '3.00 USD' bonus to the advocate's referrer -> ok",
            "Give bonus to the advocate's referrer -> ok"
        ]
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

advocate_token

Requirement	.+
Description	The token of the advocate to be processed.

reference

Requirement	.+
Description	The reference code for this request. Useful for linking the request with the user data, reconciliation, etc.

payment_amount

Requirement	.+
Description	The payment amount. Useful for campaigns based in percentage.

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/bonuses/force

POST /accounts/{account_slug}/bonuses/force

Create a bonus

Documentation
Sandbox

Documentation

Force the system to give a bonus to an advocate.

The system will not take into account the restriccions specified on the campaigns.

Request Format

All parameters in the content of the request are mandatory.

{
    "bonus":{
        "advocate_token":"7c4ae87701ef6e6c9ab64941215da6b1f90f5c7a",
        "reference": "HSY7292D00",
        "bonus_amount": 10
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/bonuses/traces

GET /accounts/{account_slug}/bonuses/traces

Get bonuses traces

Documentation
Sandbox

Documentation

Get the list of bonuses traces.

Response Format

{
  "code": 200,
  "data": {
    "page": 1,
    "limit": 1,
    "total": 24,
    "results": [
      {
        "id": 14,
        "trace": "trace data",
        "message": "Message",
        "reference": "14587962",
        "created": "2014-02-27T01:36:42+0000",
        "updated": "2014-02-27T01:36:42+0000",
        "advocate_referrer_token": "43277f772ba9a01e485c4641132be8ed6521a09b",
        "advocate_token": "14985d98c28bd32bd5142e0df11b003398fddc47",
        "bonuses": ▿[
         {
             "id": 462,
             "amount": 5,
             "created": "2017-07-15T02:56:34+0000",
             "updated": "2017-07-15T02:56:34+0000",
             "_currency": {
                 "code": "EUR",
                 "unicode": "8364",
                 "currency": "Euro",
                 "suffix": "¢",
                 "updated": "2017-06-22T04:06:22+0000"
             },
             "_advocate": {
                 "email": "advocate123@example.com",
                 "lastname": "asdf",
                 "firstname": "Advocate 123",
                 "token": "363ff3436c50c29bb2507708c17df346f8c9d549",
                 "short_token": "Qy3Ov",
                 "payout_threshold": 5,
                 "claimed_balance": 0,
                 "unclaimed_balance": 465,
                 "total_referrals": 1,
                 "total_bonuses": 6,
                 "created": "2017-07-09T03:05:59+0000",
                 "can_refer": true,
                 "_currency": {
                     "code": "EUR",
                     "unicode": "8364",
                     "currency": "Euro",
                     "suffix": "¢",
                     "updated": "2017-06-22T04:06:22+0000"
                     },
                 "_bonuses_redemption_method": {
                     "name": "Auto into credit",
                     "description": "Automatically exchange the bonuses as credit",
                     "slug": "auto-into-credit"
                     }
                 },
                 "referred_advocate_token": "1d019cab9f586265116ec6d1e74307183a6127af",
                 "referred_advocate_full_name": "Referral 123 asdf",
                 "referred_advocate_email": "referral123@example.com",
                 "reference": "124",
                 "payment_amount": 124
                 }
             }
         ],
        "campaign_slug": "get-1-on-first-order",
        "bonus_amount": 1,
        "result": "success"
      }
    ],
  }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

.+

Description

Allowed fields: reference, result, bonus_amount, advocate_token, advocate_referrer_token, advocate_email, referral_email, campaign_slug, from, to, created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

.+

Description

Allowed fields: created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
trace	string	*
message	string	*
reference	string	*
created	DateTime	*
updated	DateTime	*
advocate_referrer_token	string	*
advocate_token	string	*
campaign_slug	string	*
bonus_amount	float	*
result	string	*
bonuses[]	array of objects (Bonus)	*
bonuses[][id]	integer	*
bonuses[][amount]	float	*
bonuses[][created]	DateTime	*
bonuses[][updated]	DateTime	*
bonuses[][_currency]	object (Currency)	*
bonuses[][_currency][code]	string	*
bonuses[][_currency][unicode]	string	*
bonuses[][_currency][currency]	string	*
bonuses[][_currency][suffix]	string	*
bonuses[][_currency][updated]	DateTime	*
bonuses[][_advocate]	object (Advocate)	*
bonuses[][_advocate][email]	string	*
bonuses[][_advocate][lastname]	string	*
bonuses[][_advocate][name]	string	*
bonuses[][_advocate][token]	string	*
bonuses[][_advocate][short_token]	string	*
bonuses[][_advocate][code]	string	*
bonuses[][_advocate][payout_threshold]	float	*
bonuses[][_advocate][claimed_balance]	float	*
bonuses[][_advocate][unclaimed_balance]	float	*
bonuses[][_advocate][total_referrals]	integer	*
bonuses[][_advocate][total_bonuses]	integer	*
bonuses[][_advocate][created]	DateTime	*
bonuses[][_advocate][avatar_url]	string	*
bonuses[][_advocate][metadata]	string	*
bonuses[][_advocate][can_refer]	boolean	*
bonuses[][_advocate][_advocate_referrer]	object (Advocate)	*
bonuses[][_advocate][_currency]	object (Currency)	*
bonuses[][_advocate][_bonuses_redemption_method]	object (BonusExchangeMethod)	*
bonuses[][_advocate][_bonuses_redemption_method][name]	string	*
bonuses[][_advocate][_bonuses_redemption_method][description]	string	*
bonuses[][_advocate][_bonuses_redemption_method][slug]	string	*
bonuses[][_advocate][_campaign_contract]	object (Campaign)	*
bonuses[][_advocate][_campaign_contract][name]	string	*
bonuses[][_advocate][_campaign_contract][description]	string	*
bonuses[][_advocate][_campaign_contract][start_date]	DateTime	*
bonuses[][_advocate][_campaign_contract][end_date]	DateTime	*
bonuses[][_advocate][_campaign_contract][is_active]	boolean	*
bonuses[][_advocate][_campaign_contract][schemaless_config]	string	*
bonuses[][_advocate][_campaign_contract][created]	DateTime	*
bonuses[][_advocate][_campaign_contract][updated]	DateTime	*
bonuses[][_advocate][_campaign_contract][slug]	string	*
bonuses[][_advocate][_campaign_contract][total_advocates]	integer	*
bonuses[][_advocate][_campaign_contract][startDate]	DateTime	*
bonuses[][_advocate][_campaign_contract][endDate]	DateTime	*
bonuses[][_advocate][_campaign_contract][isActive]	bool	*
bonuses[][_advocate][_campaign_contract][schemalessConfig]		*
bonuses[][bonus_request_trace]	object (BonusRequestTrace)	*
bonuses[][bonus_request_trace][id]	integer	*
bonuses[][bonus_request_trace][trace]	string	*
bonuses[][bonus_request_trace][message]	string	*
bonuses[][bonus_request_trace][reference]	string	*
bonuses[][bonus_request_trace][created]	DateTime	*
bonuses[][bonus_request_trace][updated]	DateTime	*
bonuses[][bonus_request_trace][advocate_referrer_token]	string	*
bonuses[][bonus_request_trace][advocate_token]	string	*
bonuses[][bonus_request_trace][campaign_slug]	string	*
bonuses[][bonus_request_trace][bonus_amount]	float	*
bonuses[][bonus_request_trace][result]	string	*
bonuses[][bonus_request_trace][bonuses][]	array of objects (Bonus)	*
bonuses[][referred_advocate_token]	string	*
bonuses[][referred_advocate_full_name]	string	*
bonuses[][referred_advocate_email]	string	*
bonuses[][redemption_request_id]	integer	*
bonuses[][reference]	string	*
bonuses[][payment_amount]	float	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/bonuses/traces/{trace_id}

GET /accounts/{account_slug}/bonuses/traces/{trace_id}

Get a bonus request trace

Documentation
Sandbox

Documentation

Get a bonus request trace.

Response Format

{
  "code": 200,
  "data": {
    "id": 11,
    "trace": "trace data",
    "message": "Message",
    "reference": "14587962",
    "created": "2014-02-27T01:36:41+0000",
    "updated": "2014-02-27T01:36:41+0000",
    "advocate_referrer_token": "43277f772ba9a01e485c4641132be8ed6521a09b",
    "advocate_token": "14985d98c28bd32bd5142e0df11b003398fddc47",
     "bonuses": ▿[
         {
             "id": 462,
             "amount": 5,
             "created": "2017-07-15T02:56:34+0000",
             "updated": "2017-07-15T02:56:34+0000",
             "_currency": {
                 "code": "EUR",
                 "unicode": "8364",
                 "currency": "Euro",
                 "suffix": "¢",
                 "updated": "2017-06-22T04:06:22+0000"
             },
             "_advocate": {
                 "email": "advocate123@example.com",
                 "lastname": "asdf",
                 "firstname": "Advocate 123",
                 "token": "363ff3436c50c29bb2507708c17df346f8c9d549",
                 "short_token": "Qy3Ov",
                 "payout_threshold": 5,
                 "claimed_balance": 0,
                 "unclaimed_balance": 465,
                 "total_referrals": 1,
                 "total_bonuses": 6,
                 "created": "2017-07-09T03:05:59+0000",
                 "can_refer": true,
                 "_currency": {
                     "code": "EUR",
                     "unicode": "8364",
                     "currency": "Euro",
                     "suffix": "¢",
                     "updated": "2017-06-22T04:06:22+0000"
                 },
                 "_bonuses_redemption_method": {
                     "name": "Auto into credit",
                     "description": "Automatically exchange the bonuses as credit",
                     "slug": "auto-into-credit"
                     }
                 },
                 "referred_advocate_token": "1d019cab9f586265116ec6d1e74307183a6127af",
                 "referred_advocate_full_name": "Referral 123 asdf",
                 "referred_advocate_email": "referral123@example.com",
                 "reference": "124",
                 "payment_amount": 124
             }
         }
     ],
    "campaign_slug": "get-1-on-first-order",
    "bonus_amount": 1,
    "result": "success"
  }
}

Requirements

Name	Requirement	Type	Description
trace_id	\d+	string	the trace id
account_slug		string	the client account slug

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
trace	string	*
message	string	*
reference	string	*
created	DateTime	*
updated	DateTime	*
advocate_referrer_token	string	*
advocate_token	string	*
campaign_slug	string	*
bonus_amount	float	*
result	string	*
bonuses[]	array of objects (Bonus)	*
bonuses[][id]	integer	*
bonuses[][amount]	float	*
bonuses[][created]	DateTime	*
bonuses[][updated]	DateTime	*
bonuses[][_currency]	object (Currency)	*
bonuses[][_currency][code]	string	*
bonuses[][_currency][unicode]	string	*
bonuses[][_currency][currency]	string	*
bonuses[][_currency][suffix]	string	*
bonuses[][_currency][updated]	DateTime	*
bonuses[][_advocate]	object (Advocate)	*
bonuses[][_advocate][email]	string	*
bonuses[][_advocate][lastname]	string	*
bonuses[][_advocate][name]	string	*
bonuses[][_advocate][token]	string	*
bonuses[][_advocate][short_token]	string	*
bonuses[][_advocate][code]	string	*
bonuses[][_advocate][payout_threshold]	float	*
bonuses[][_advocate][claimed_balance]	float	*
bonuses[][_advocate][unclaimed_balance]	float	*
bonuses[][_advocate][total_referrals]	integer	*
bonuses[][_advocate][total_bonuses]	integer	*
bonuses[][_advocate][created]	DateTime	*
bonuses[][_advocate][avatar_url]	string	*
bonuses[][_advocate][metadata]	string	*
bonuses[][_advocate][can_refer]	boolean	*
bonuses[][_advocate][_advocate_referrer]	object (Advocate)	*
bonuses[][_advocate][_currency]	object (Currency)	*
bonuses[][_advocate][_bonuses_redemption_method]	object (BonusExchangeMethod)	*
bonuses[][_advocate][_bonuses_redemption_method][name]	string	*
bonuses[][_advocate][_bonuses_redemption_method][description]	string	*
bonuses[][_advocate][_bonuses_redemption_method][slug]	string	*
bonuses[][_advocate][_campaign_contract]	object (Campaign)	*
bonuses[][_advocate][_campaign_contract][name]	string	*
bonuses[][_advocate][_campaign_contract][description]	string	*
bonuses[][_advocate][_campaign_contract][start_date]	DateTime	*
bonuses[][_advocate][_campaign_contract][end_date]	DateTime	*
bonuses[][_advocate][_campaign_contract][is_active]	boolean	*
bonuses[][_advocate][_campaign_contract][schemaless_config]	string	*
bonuses[][_advocate][_campaign_contract][created]	DateTime	*
bonuses[][_advocate][_campaign_contract][updated]	DateTime	*
bonuses[][_advocate][_campaign_contract][slug]	string	*
bonuses[][_advocate][_campaign_contract][total_advocates]	integer	*
bonuses[][_advocate][_campaign_contract][startDate]	DateTime	*
bonuses[][_advocate][_campaign_contract][endDate]	DateTime	*
bonuses[][_advocate][_campaign_contract][isActive]	bool	*
bonuses[][_advocate][_campaign_contract][schemalessConfig]		*
bonuses[][bonus_request_trace]	object (BonusRequestTrace)	*
bonuses[][bonus_request_trace][id]	integer	*
bonuses[][bonus_request_trace][trace]	string	*
bonuses[][bonus_request_trace][message]	string	*
bonuses[][bonus_request_trace][reference]	string	*
bonuses[][bonus_request_trace][created]	DateTime	*
bonuses[][bonus_request_trace][updated]	DateTime	*
bonuses[][bonus_request_trace][advocate_referrer_token]	string	*
bonuses[][bonus_request_trace][advocate_token]	string	*
bonuses[][bonus_request_trace][campaign_slug]	string	*
bonuses[][bonus_request_trace][bonus_amount]	float	*
bonuses[][bonus_request_trace][result]	string	*
bonuses[][bonus_request_trace][bonuses][]	array of objects (Bonus)	*
bonuses[][referred_advocate_token]	string	*
bonuses[][referred_advocate_full_name]	string	*
bonuses[][referred_advocate_email]	string	*
bonuses[][redemption_request_id]	integer	*
bonuses[][reference]	string	*
bonuses[][payment_amount]	float	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/bonuses/{bonus_id}

DELETE /accounts/{account_slug}/bonuses/{bonus_id}

Delete a bonus

Documentation
Sandbox

Documentation

Delete a bonus.

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
bonus_id		string	the bonus id

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/bonuses/{bonus_id}

Get a bonus

Documentation
Sandbox

Documentation

Get a bonus by a given id.

Response Format

{
    "code": 200,
    "data": {
        "_advocate": {
            "_bonuses_redemption_method": {
                "description": "Automatically redeem the bonuses as credit",
                "name": "Auto into credit",
                "slug": "auto-into-credit"
            },
            "_currency": {
                "code": "USD",
                "currency": "United States Dollar",
                "suffix": "¢",
                "unicode": "32"
            },
            "claimed_balance": 0,
            "created": "2014-01-15T05:32:06+0000",
            "email": "advocate_at_mail.com",
            "lastname": "Hernandez",
            "firstname": "Advocate",
            "payout_threshold": 10,
            "token": "204ba2a0e21408890995a747544f5fb31f4250c3",
            "unclaimed_balance": 0
        },
        "_currency": {
            "code": "USD",
            "currency": "United States Dollar",
            "suffix": "¢",
            "unicode": "32"
        },
         bonus_request_trace: {
             "id": 14,
             "trace": "trace data",
             "message": "Message",
             "reference": "14587962",
             "created": "2014-02-27T01:36:42+0000",
             "updated": "2014-02-27T01:36:42+0000",
             "advocate_referrer_token": "43277f772ba9a01e485c4641132be8ed6521a09b",
             "advocate_token": "14985d98c28bd32bd5142e0df11b003398fddc47",
             "bonuses" : [],
             "campaign_slug": "get-1-on-first-order",
             "bonus_amount": 1,
             "result": "success"
         },
        "amount": 10,
        "referred_advocate_email":"erica@gmail.com",
        "referred_advocate_full_name":"Erica Chagas",
        "created": "2014-01-15T05:32:06+0000",
        "id": 109,
        "referred_advocate_token": "9177c43afde9d95725fed931b8ab9ce7128fa82a",
        "payment_amount": 12.3,
        "reference":"XRE3456"
    }
}

Requirements

Name	Requirement	Type	Description
bonus_id	\d+	string	the bonus id
account_slug		string	the client account slug

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
amount	float	*
created	DateTime	*
updated	DateTime	*
_currency	object (Currency)	*
_currency[code]	string	*
_currency[unicode]	string	*
_currency[currency]	string	*
_currency[suffix]	string	*
_currency[updated]	DateTime	*
_advocate	object (Advocate)	*
_advocate[email]	string	*
_advocate[lastname]	string	*
_advocate[name]	string	*
_advocate[token]	string	*
_advocate[short_token]	string	*
_advocate[code]	string	*
_advocate[payout_threshold]	float	*
_advocate[claimed_balance]	float	*
_advocate[unclaimed_balance]	float	*
_advocate[total_referrals]	integer	*
_advocate[total_bonuses]	integer	*
_advocate[created]	DateTime	*
_advocate[avatar_url]	string	*
_advocate[metadata]	string	*
_advocate[can_refer]	boolean	*
_advocate[_advocate_referrer]	object (Advocate)	*
_advocate[_currency]	object (Currency)	*
_advocate[_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_advocate[_bonuses_redemption_method][name]	string	*
_advocate[_bonuses_redemption_method][description]	string	*
_advocate[_bonuses_redemption_method][slug]	string	*
_advocate[_campaign_contract]	object (Campaign)	*
_advocate[_campaign_contract][name]	string	*
_advocate[_campaign_contract][description]	string	*
_advocate[_campaign_contract][start_date]	DateTime	*
_advocate[_campaign_contract][end_date]	DateTime	*
_advocate[_campaign_contract][is_active]	boolean	*
_advocate[_campaign_contract][schemaless_config]	string	*
_advocate[_campaign_contract][created]	DateTime	*
_advocate[_campaign_contract][updated]	DateTime	*
_advocate[_campaign_contract][slug]	string	*
_advocate[_campaign_contract][total_advocates]	integer	*
_advocate[_campaign_contract][startDate]	DateTime	*
_advocate[_campaign_contract][endDate]	DateTime	*
_advocate[_campaign_contract][isActive]	bool	*
_advocate[_campaign_contract][schemalessConfig]		*
bonus_request_trace	object (BonusRequestTrace)	*
bonus_request_trace[id]	integer	*
bonus_request_trace[trace]	string	*
bonus_request_trace[message]	string	*
bonus_request_trace[reference]	string	*
bonus_request_trace[created]	DateTime	*
bonus_request_trace[updated]	DateTime	*
bonus_request_trace[advocate_referrer_token]	string	*
bonus_request_trace[advocate_token]	string	*
bonus_request_trace[campaign_slug]	string	*
bonus_request_trace[bonus_amount]	float	*
bonus_request_trace[result]	string	*
bonus_request_trace[bonuses][]	array of objects (Bonus)	*
bonus_request_trace[bonuses][][id]	integer	*
bonus_request_trace[bonuses][][amount]	float	*
bonus_request_trace[bonuses][][created]	DateTime	*
bonus_request_trace[bonuses][][updated]	DateTime	*
bonus_request_trace[bonuses][][_currency]	object (Currency)	*
bonus_request_trace[bonuses][][_advocate]	object (Advocate)	*
bonus_request_trace[bonuses][][bonus_request_trace]	object (BonusRequestTrace)	*
bonus_request_trace[bonuses][][referred_advocate_token]	string	*
bonus_request_trace[bonuses][][referred_advocate_full_name]	string	*
bonus_request_trace[bonuses][][referred_advocate_email]	string	*
bonus_request_trace[bonuses][][redemption_request_id]	integer	*
bonus_request_trace[bonuses][][reference]	string	*
bonus_request_trace[bonuses][][payment_amount]	float	*
referred_advocate_token	string	*
referred_advocate_full_name	string	*
referred_advocate_email	string	*
redemption_request_id	integer	*
reference	string	*
payment_amount	float	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Campaigns

/accounts/{account_slug}/campaigns

GET /accounts/{account_slug}/campaigns

Get campaigns

Documentation
Sandbox

Documentation

Get the list of campaings for a given account.

Response Format

 {
    "code": 200,
    "data": {
        "limit": 10,
        "page": 1,
        "results": [
            {
                "created": "2013-12-15T04:01:09+0000",
                "description": "Get 10% of for 90 days",
                "is_active": false,
                "name": "Get 10% of for 90 days",
                "slug": "get-10-of-for-90-days-1",
                "start_date": "2013-12-16T00:00:00+0000",
                "total_advocates": 2,
                "updated": "2014-02-01T20:47:35+0000"
            }
        ],
        "total": 1
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

.+

Description

Allowed fields: name, description, start_date, end_date, is_active (true|false), created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

.+

Description

Allowed fields: campaign_slug, created, start_date, end_date, is_active. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
startDate	DateTime	*
endDate	DateTime	*
isActive	bool	*
schemalessConfig		*
start_date	DateTime	*
end_date	DateTime	*
is_active	boolean	*
schemaless_config	string	*
created	DateTime	*
updated	DateTime	*
slug	string	*
total_advocates	integer	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/campaigns/{campaign_slug}

GET /accounts/{account_slug}/campaigns/{campaign_slug}

Get a campaign

Documentation
Sandbox

Documentation

Get a campaign by a given slug.

Response Format

{
    "code": 200,
    "data": {
        "created": "2013-12-15T04:01:09+0000",
        "description": "Get 10% of for 90 days",
        "is_active": false,
        "name": "Get 10% of for 90 days",
        "slug": "get-10-of-for-90-days-1",
        "start_date": "2013-12-16T00:00:00+0000",
        "total_advocates": 2,
        "updated": "2014-02-01T20:47:35+0000"
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
campaign_slug		string	the campaign slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
startDate	DateTime	*
endDate	DateTime	*
isActive	bool	*
schemalessConfig		*
start_date	DateTime	*
end_date	DateTime	*
is_active	boolean	*
schemaless_config	string	*
created	DateTime	*
updated	DateTime	*
slug	string	*
total_advocates	integer	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Redemption Requests

/accounts/{account_slug}/redemption-requests

GET /accounts/{account_slug}/redemption-requests

Get redemption requests

Documentation
Sandbox

Documentation

Get the list of redemption requests.

Response Format

{
    "code": 200,
    "data": {
        "limit": 1,
        "page": 1,
        "results": [
            {
                "_advocate": {
                    "_bonuses_redemption_method": {
                        "description": "Automatically redeem the bonuses as credit",
                        "name": "Auto into credit",
                        "slug": "auto-into-credit"
                    },
                    "_currency": {
                        "code": "USD",
                        "currency": "United States Dollar",
                        "suffix": "¢",
                        "unicode": "32",
                        "updated": "2014-02-06T19:01:10+0000"
                    },
                    "claimed_balance": 0,
                    "created": "2014-02-06T19:01:10+0000",
                    "email": "alain_at_mail.com",
                    "lastname": "Hernandez",
                    "name": "Alain",
                    "payout_threshold": 10,
                    "token": "37e72fde36cf73a7f42fea1640dfe3d43f2add7e",
                    "total_bonuses": 0,
                    "total_referrals": 1,
                    "unclaimed_balance": 10
                },
                "amount": 1,
                "created": "2014-02-06T19:01:12+0000",
                "currency_code": "USD",
                "description": "Credit",
                "id": 1,
                "request_action_slug": "credit",
                "request_status_slug": "requested",
                "updated": "2014-02-06T19:01:12+0000"
            }
        ],
        "total": 11
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

.+

Description

Allowed fields: redemption_request_id, name, lastname, email, request_status_slug, request_action_slug, from, to, created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

.+

Description

Allowed fields: ame, lastname, email, created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions	Description
200 - Returned when successful

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/redemption-requests

Create a redemption request

Documentation
Sandbox

Documentation

Create a redemption request.

Request Format

Mandatory parameters: advocate_token, request_status_slug, request_action_slug, currency_code, amount.

 {
    "redemption_request":
        {
            "advocate_token":"k3ibasd723278v2b32389589ihjf",
            "request_status_slug":"requested",
            "request_action_slug": "credit",
            "currency_code":"USD",
            "amount":50,
            "description": "credit",
            "advocates_paypal_username":"alain_at_mail.com"
        }
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/redemption-requests/{redemption_request_id}

GET /accounts/{account_slug}/redemption-requests/{redemption_request_id}

Get a redemption request

Documentation
Sandbox

Documentation

Get a redemption request by a given id.

Response Format

{
    "code": 200,
    "data": {
        "_advocate": {
            "_bonuses_redemption_method": {
                "description": "Automatically redeem the bonuses as credit",
                "name": "Auto into credit",
                "slug": "auto-into-credit"
            },
            "_currency": {
                "code": "USD",
                "currency": "United States Dollar",
                "suffix": "¢",
                "unicode": "32",
                "updated": "2014-02-06T19:01:10+0000"
            },
            "claimed_balance": 0,
            "created": "2014-02-06T19:01:10+0000",
            "email": "alain_at_mail.com",
            "lastname": "Hernandez",
            "name": "Alain",
            "payout_threshold": 10,
            "token": "37e72fde36cf73a7f42fea1640dfe3d43f2add7e",
            "total_bonuses": 0,
            "total_referrals": 1,
            "unclaimed_balance": 10
        },
        "amount": 1,
        "created": "2014-02-06T19:01:12+0000",
        "currency_code": "USD",
        "description": "Credit",
        "id": 1,
        "request_action_slug": "credit",
        "request_status_slug": "requested",
        "updated": "2014-02-06T19:01:12+0000"
    }
}

Requirements

Name	Requirement	Type	Description
redemption_request_id	\d+	string	the redemption request id
account_slug		string	the client account slug

Return

Parameter	Type	Versions	Description
200 - Returned when successful

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/redemption-requests/{redemption_request_id}/redemption

PATCH /accounts/{account_slug}/redemption-requests/{redemption_request_id}/redemption

Redeem a redemption request

Documentation
Sandbox

Documentation

Redeem a redemption request. After the redemption request is created it needs to be redeemed. This will deduct the amount of the advocate unclaimed balance and move the request to the completed state.

Requirements

Name	Requirement	Type	Description
redemption_request_id	\d+	string	the redemption request id
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/redemption-request-actions

GET /utilities/redemption-request-actions

Get redemption request actions

Documentation
Sandbox

Documentation

Get redemption request actions.

Response Format

{
    "code": 200,
    "data": [
        {
            "description": "Receive bonus as cash",
            "name": "Pay Out",
            "slug": "pay-out"
        },
        {
            "description": "Receive bonus as goods",
            "name": "Goods",
            "slug": "goods"
        },
        {
            "description": "Receive bonus as credit",
            "name": "Credit",
            "slug": "credit"
        }
    ]
}

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/redemption-request-actions/{redemption_request_action_slug}

GET /utilities/redemption-request-actions/{redemption_request_action_slug}

Get a redemption request action

Documentation
Sandbox

Documentation

Get a redemption request action.

Response Format

{
    "code": 200,
    "data": {
        "description": "Receive bonus as call credit",
        "name": "Credit",
        "slug": "credit"
    }
}

Requirements

Name	Requirement	Type	Description
redemption_request_action_slug		string	the redemption request action slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/redemption-request-statuses

GET /utilities/redemption-request-statuses

Get redemption request statuses

Documentation
Sandbox

Documentation

Get redemption request statuses.

Response Format

{
    "code": 200,
    "data": [
        {
            "description": "Advocate has requested an exchange",
            "name": "Requested",
            "slug": "requested"
        },
        {
            "description": "The request has been declined by admin team",
            "name": "Declined",
            "slug": "declined"
        },
        {
            "description": "The request has being processed",
            "name": "Processing",
            "slug": "processing"
        },
        {
            "description": "The request has been completed",
            "name": "Completed",
            "slug": "completed"
        },
        {
            "description": "The request is in hold",
            "name": "Hold",
            "slug": "hold"
        }
    ]
}

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/redemption-request-statuses/{redemption_request_status_slug}

GET /utilities/redemption-request-statuses/{redemption_request_status_slug}

Get a redemption request status

Documentation
Sandbox

Documentation

Get a redemption request status.

Response Format

{
    "code": 200,
    "data": {
        "description": "The request has been completed",
        "name": "Completed",
        "slug": "completed"
    }
}

Requirements

Name	Requirement	Type	Description
redemption_request_status_slug		string	the redemption request status slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Referrals

/accounts/{account_slug}/advocates/{advocate_token}/referrals

GET /accounts/{account_slug}/advocates/{advocate_token}/referrals

Get referrals

Documentation
Sandbox

Documentation

Get the list of referrals for a given advocate.

Response Format

  {
    "code": 200,
    "data": {
        "limit": 1,
        "page": 1,
        "results": [
            {
                "_advocate": {
                    "_bonuses_redemption_method": {
                        "description": "Automatically redeem the bonuses as credit",
                        "name": "Auto into credit",
                        "slug": "auto-into-credit"
                    },
                    "_currency": {
                        "code": "USD",
                        "currency": "United States Dollar",
                        "suffix": "¢",
                        "unicode": "32"
                    },
                    "claimed_balance": 0,
                    "created": "2014-01-08T05:05:53+0000",
                    "email": "advocate3_at_email.com",
                    "lastname": "Chagas",
                    "name": "Advocate3",
                    "payout_threshold": 10,
                    "token": "9e77486b2b72a8d2aa5721dcc9574bec7c62da21",
                    "unclaimed_balance": 0
                },
                "_referral_origin": {
                    "description": "Facebook website like button",
                    "name": "Facebook Like",
                    "slug": "facebook-like"
                },
                "_referred_advocate": {
                    "_advocate_referrer": {
                        "_bonuses_redemption_method": {
                            "description": "Automatically redeem the bonuses as credit",
                            "name": "Auto into credit",
                            "slug": "auto-into-credit"
                        },
                        "_currency": {
                            "code": "USD",
                            "currency": "United States Dollar",
                            "suffix": "¢",
                            "unicode": "32"
                        },
                        "claimed_balance": 0,
                        "created": "2014-01-08T05:05:53+0000",
                        "email": "advocate3_at_email.com",
                        "lastname": "Chagas",
                        "name": "Advocate3",
                        "payout_threshold": 10,
                        "token": "9e77486b2b72a8d2aa5721dcc9574bec7c62da21",
                        "unclaimed_balance": 0
                    },
                    "_bonuses_redemption_method": {
                        "description": "Automatically redeem the bonuses as credit",
                        "name": "Auto into credit",
                        "slug": "auto-into-credit"
                    },
                    "_currency": {
                        "code": "USD",
                        "currency": "United States Dollar",
                        "suffix": "¢",
                        "unicode": "32"
                    },
                    "claimed_balance": 0,
                    "created": "2014-01-08T05:05:53+0000",
                    "email": "advocate4_at_email.com",
                    "lastname": "Chagas",
                    "name": "Advocate4",
                    "payout_threshold": 10,
                    "token": "148e04352d65747fc93427805c9e1be9ee4d8a78",
                    "unclaimed_balance": 0
                },
                "created": "2014-01-08T05:05:53+0000",
                "id": 20,
                "url": "http://www.example.com"
            }
        ],
        "total": 3
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		integer	the advocate token

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

.+

Description

Allowed fields: referred_advocate_token, url, referral_origin_slug, created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

.+

Description

Allowed fields: created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
url	string	*
created	DateTime	*
updated	DateTime	*
_advocate	object (Advocate)	*
_advocate[email]	string	*
_advocate[lastname]	string	*
_advocate[name]	string	*
_advocate[token]	string	*
_advocate[short_token]	string	*
_advocate[code]	string	*
_advocate[payout_threshold]	float	*
_advocate[claimed_balance]	float	*
_advocate[unclaimed_balance]	float	*
_advocate[total_referrals]	integer	*
_advocate[total_bonuses]	integer	*
_advocate[created]	DateTime	*
_advocate[avatar_url]	string	*
_advocate[metadata]	string	*
_advocate[can_refer]	boolean	*
_advocate[_advocate_referrer]	object (Advocate)	*
_advocate[_currency]	object (Currency)	*
_advocate[_currency][code]	string	*
_advocate[_currency][unicode]	string	*
_advocate[_currency][currency]	string	*
_advocate[_currency][suffix]	string	*
_advocate[_currency][updated]	DateTime	*
_advocate[_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_advocate[_bonuses_redemption_method][name]	string	*
_advocate[_bonuses_redemption_method][description]	string	*
_advocate[_bonuses_redemption_method][slug]	string	*
_advocate[_campaign_contract]	object (Campaign)	*
_advocate[_campaign_contract][name]	string	*
_advocate[_campaign_contract][description]	string	*
_advocate[_campaign_contract][start_date]	DateTime	*
_advocate[_campaign_contract][end_date]	DateTime	*
_advocate[_campaign_contract][is_active]	boolean	*
_advocate[_campaign_contract][schemaless_config]	string	*
_advocate[_campaign_contract][created]	DateTime	*
_advocate[_campaign_contract][updated]	DateTime	*
_advocate[_campaign_contract][slug]	string	*
_advocate[_campaign_contract][total_advocates]	integer	*
_advocate[_campaign_contract][startDate]	DateTime	*
_advocate[_campaign_contract][endDate]	DateTime	*
_advocate[_campaign_contract][isActive]	bool	*
_advocate[_campaign_contract][schemalessConfig]		*
_referred_advocate	object (Advocate)	*
_referral_origin	object (ReferralOrigin)	*
_referral_origin[name]	string	*
_referral_origin[description]	string	*
_referral_origin[slug]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/advocates/{advocate_token}/referrals

Create a Genius Referral referral

Documentation
Sandbox

Documentation

Create a new referral. A referral is a link between an Advocate and a Referral (another advocate).

Request Format

All parameters in the content of the request are mandaroty.

{
    "referral":{
        "referred_advocate_token":"10e33ae1b516873a8fe62880652759d558e27424",
        "referral_origin_slug": "facebook-share",
        "campaign_slug":"get-10-of-for-90-days",
        "http_referer":"http://www.google.com",
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		integer	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/advocates/{advocate_token}/referrals/{referral_id}

DELETE /accounts/{account_slug}/advocates/{advocate_token}/referrals/{referral_id}

Delete a referral

Documentation
Sandbox

Documentation

Delete a referral

Requirements

Name	Requirement	Type	Description
referral_id	\d+	string	the advocate token
account_slug		string	the client account slug
advocate_token		string	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/advocates/{advocate_token}/referrals/{referral_id}

Get a referral

Documentation
Sandbox

Documentation

Get a referral by a given id.

Response Format

{
    "code": 200,
    "data": {
        "_advocate": {
            "_bonuses_redemption_method": {
                "description": "Automatically redeem the bonuses as credit",
                "name": "Auto into credit",
                "slug": "auto-into-credit"
            },
            "_currency": {
                "code": "USD",
                "currency": "United States Dollar",
                "suffix": "¢",
                "unicode": "32"
            },
            "claimed_balance": 0,
            "created": "2014-01-09T20:07:47+0000",
            "email": "advocate_at_mail.com",
            "lastname": "Hernandez",
            "name": "advocate",
            "payout_threshold": 10,
            "token": "717a4bc85a74dc52f06cadb2fe7940b5486a14c9",
            "unclaimed_balance": 0
        },
        "_referral_origin": {
            "description": "Facebook website like button",
            "name": "Facebook Like",
            "slug": "facebook-like"
        },
        "_referred_advocate": {
            "_advocate_referrer": {
                "_bonuses_redemption_method": {
                    "description": "Automatically redeem the bonuses as credit",
                    "name": "Auto into credit",
                    "slug": "auto-into-credit"
                },
                "_currency": {
                    "code": "USD",
                    "currency": "United States Dollar",
                    "suffix": "¢",
                    "unicode": "32"
                },
                "claimed_balance": 0,
                "created": "2014-01-09T20:07:47+0000",
                "email": "advocate_at_email.com",
                "lastname": "Hernandez",
                "name": "Advocate",
                "payout_threshold": 10,
                "token": "717a4bc85a74dc52f06cadb2fe7940b5486a14c9",
                "unclaimed_balance": 0
            },
            "_bonuses_redemption_method": {
                "description": "Automatically redeem the bonuses as credit",
                "name": "Auto into credit",
                "slug": "auto-into-credit"
            },
            "_currency": {
                "code": "USD",
                "currency": "United States Dollar",
                "suffix": "¢",
                "unicode": "32"
            },
            "claimed_balance": 0,
            "created": "2014-01-09T20:07:47+0000",
            "email": "erica_at_email.com",
            "lastname": "Chagas",
            "name": "Erica",
            "payout_threshold": 10,
            "token": "f17b17295bd12d059b62e88ef1bcddac92c10b4a",
            "unclaimed_balance": 0
        },
        "created": "2014-01-09T20:07:47+0000",
        "id": 1,
        "url": "http://www.example.com"
    }
}

Requirements

Name	Requirement	Type	Description
referral_id	\d+	string	the advocate token
account_slug		string	the client account slug
advocate_token		string	the advocate token

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
url	string	*
created	DateTime	*
updated	DateTime	*
_advocate	object (Advocate)	*
_advocate[email]	string	*
_advocate[lastname]	string	*
_advocate[name]	string	*
_advocate[token]	string	*
_advocate[short_token]	string	*
_advocate[code]	string	*
_advocate[payout_threshold]	float	*
_advocate[claimed_balance]	float	*
_advocate[unclaimed_balance]	float	*
_advocate[total_referrals]	integer	*
_advocate[total_bonuses]	integer	*
_advocate[created]	DateTime	*
_advocate[avatar_url]	string	*
_advocate[metadata]	string	*
_advocate[can_refer]	boolean	*
_advocate[_advocate_referrer]	object (Advocate)	*
_advocate[_currency]	object (Currency)	*
_advocate[_currency][code]	string	*
_advocate[_currency][unicode]	string	*
_advocate[_currency][currency]	string	*
_advocate[_currency][suffix]	string	*
_advocate[_currency][updated]	DateTime	*
_advocate[_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_advocate[_bonuses_redemption_method][name]	string	*
_advocate[_bonuses_redemption_method][description]	string	*
_advocate[_bonuses_redemption_method][slug]	string	*
_advocate[_campaign_contract]	object (Campaign)	*
_advocate[_campaign_contract][name]	string	*
_advocate[_campaign_contract][description]	string	*
_advocate[_campaign_contract][start_date]	DateTime	*
_advocate[_campaign_contract][end_date]	DateTime	*
_advocate[_campaign_contract][is_active]	boolean	*
_advocate[_campaign_contract][schemaless_config]	string	*
_advocate[_campaign_contract][created]	DateTime	*
_advocate[_campaign_contract][updated]	DateTime	*
_advocate[_campaign_contract][slug]	string	*
_advocate[_campaign_contract][total_advocates]	integer	*
_advocate[_campaign_contract][startDate]	DateTime	*
_advocate[_campaign_contract][endDate]	DateTime	*
_advocate[_campaign_contract][isActive]	bool	*
_advocate[_campaign_contract][schemalessConfig]		*
_referred_advocate	object (Advocate)	*
_referral_origin	object (ReferralOrigin)	*
_referral_origin[name]	string	*
_referral_origin[description]	string	*
_referral_origin[slug]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /accounts/{account_slug}/advocates/{advocate_token}/referrals/{referral_id}

Update a Genius Referral advocate

Documentation
Sandbox

Documentation

Update a referral.

Request Format

All parameters in the content of the request are mandaroty.

{
    "referral":{
        "referred_advocate_token":"10e33ae1b516873a8fe62880652759d558e27424",
        "referral_origin_slug": "facebook-share",
        "campaign_slug":"get-10-of-for-90-days",
        "http_referer":"http://www.google.com",
    }
}

Requirements

Name	Requirement	Type	Description
referral_id	\d+	integer	the referral id
account_slug		string	the client account slug
advocate_token		string	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/referral-origins

GET /utilities/referral-origins

Return referral origins

Documentation
Sandbox

Documentation

Get referral origins. This is needed when creating (POST) a new referral as referral_origin_slug refers to one of this origins.

Response Format

  {
    "code": 200,
    "data": [
        {
            "description": "Facebook website share",
            "name": "Facebook Share",
            "slug": "facebook-share"
        },
        {
            "description": "Twitter website post",
            "name": "Twitter Post",
            "slug": "twitter-post"
        },
        {
            "description": "Linkedin website post",
            "name": "Linkedin Post",
            "slug": "linkedin-post"
        }
        {
            "description": "Pinterest website like button",
            "name": "Pin It",
            "slug": "pin-it"
        },
        {
            "description": "Google +1 website like button",
            "name": "Google +1",
            "slug": "google-1"
        },
        {
            "description": "Instagram website Comment",
            "name": "Instagram Comment",
            "slug": "instagram-comment"
        },
        {
            "description": "Email sent to the user by our systems",
            "name": "Direct Email",
            "slug": "direct-email"
        },
        {
            "description": "Personal recomendacion throw our systems",
            "name": "Personal",
            "slug": "personal"
        },
        {
            "description": "The user has changed the origin",
            "name": "Other",
            "slug": "other"
        }
    ]
}

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/referral-origins/{referral_origin_slug}

GET /utilities/referral-origins/{referral_origin_slug}

Return a referral origin

Documentation
Sandbox

Documentation

Get a referral origin by a given slug.

Response Format

  {
      "code": 200,
      "data": {
          "description": "Personal recomendacion throw our systems",
          "name": "Personal",
          "slug": "personal"
      }
  }

Requirements

Name	Requirement	Type	Description
referral_origin_slug		string	the referral origin slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Reports

/reports/bonuses-daily-given

GET /reports/bonuses-daily-given

Return bonuses daily given

Documentation
Sandbox

Documentation

Get bonuses daily given.

Response Format

{
  "code": 200,
  "data": [
    {
      "id": 729,
      "facebook_like": 15,
      "facebook_share": 51,
      "twitter_post": 71,
      "twitter_follow": 0,
      "linkedin_post": 10,
      "linkedin_follow": 29,
      "pin_it": 56,
      "google_plus": 45,
      "instagram_like": 3,
      "instagram_comment": 51,
      "personal_url": 64,
      "direct_email": 80,
      "other": 12,
      "date": "2013-12-29T00:00:00+0000",
      "created": "2013-12-31T21:39:21+0000"
    }
  ]
}

Filters

Name

Information

account_slug

Description

The client account slug

campaign_slug

Description

The campaign slug

advocate_token

Description

The advocate token

from

Description

The datetime were the range of the search starts

to

Description

The datetime were the range of the search stops

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/bonuses-summary-per-origin

GET /reports/bonuses-summary-per-origin

Get bonuses symmary

Documentation
Sandbox

Documentation

Get bonuses summary per referral origin.

Response Format

 {
    "code": 200,
    "data": [
        {
            "amount": 2.50,
            "name": "Facebook Share",
            "slug": "facebook-share"
        },
        {
            "amount": 5,
            "name": "Twitter Post",
            "slug": "twitter-post"
        },
        {
            "amount": 2.50,
            "name": "Linkedin Post",
            "slug": "linkedin-post"
        }
    ]
}

Filters

Name

Information

advocate_token

Description

The advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/click-daily-participation

GET /reports/click-daily-participation

Get click daily participation

Documentation
Sandbox

Documentation

Get click daily participation.

Response Format

{
  "code": 200,
  "data": [
    {
      "id": 729,
      "facebook_like": 15,
      "facebook_share": 51,
      "twitter_post": 71,
      "twitter_follow": 0,
      "linkedin_post": 10,
      "linkedin_follow": 29,
      "pin_it": 56,
      "google_plus": 45,
      "instagram_like": 3,
      "instagram_comment": 51,
      "personal_url": 64,
      "direct_email": 80,
      "other": 12,
      "date": "2013-12-29T00:00:00+0000",
      "created": "2013-12-31T21:39:21+0000"
    }
  ]
}

Filters

Name

Information

account_slug

Description

The client account slug

campaign_slug

Description

The campaign slug

advocate_token

Description

The advocate token

from

Description

The datetime were the range of the search starts

to

Description

The datetime were the range of the search stops

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/referral-daily-participation

GET /reports/referral-daily-participation

Get referral daily participation

Documentation
Sandbox

Documentation

Get referral daily participation.

Response Format

{
  "code": 200,
  "data": [
    {
      "id": 729,
      "facebook_like": 15,
      "facebook_share": 51,
      "twitter_post": 71,
      "twitter_follow": 0,
      "linkedin_post": 10,
      "linkedin_follow": 29,
      "pin_it": 56,
      "google_plus": 45,
      "instagram_like": 3,
      "instagram_comment": 51,
      "personal_url": 64,
      "direct_email": 80,
      "other": 12,
      "date": "2013-12-29T00:00:00+0000",
      "created": "2013-12-31T21:39:21+0000"
    }
  ]
}

Filters

Name

Information

account_slug

Description

The client account slug

campaign_slug

Description

The campaign slug

advocate_token

Description

The advocate token

from

Description

The datetime were the range of the search starts

to

Description

The datetime were the range of the search stops

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/referrals-summary-per-origin

GET /reports/referrals-summary-per-origin

Get referrals symmary

Documentation
Sandbox

Documentation

Get referrals summary per referral origin.

Response Format

 {
    "code": 200,
    "data": [
        {
            "amount": 1,
            "name": "Facebook Share",
            "slug": "facebook-share"
        },
        {
            "amount": 1,
            "name": "Twitter Post",
            "slug": "twitter-post"
        },
        {
            "amount": 1,
            "name": "Linkedin Post",
            "slug": "linkedin-post"
        }
    ]
}

Filters

Name

Information

advocate_token

Description

The advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/share-daily-participation

GET /reports/share-daily-participation

Get share daily participation

Documentation
Sandbox

Documentation

Get share daily participation.

Response Format

{
  "code": 200,
  "data": [
    {
      "id": 729,
      "facebook_like": 15,
      "facebook_share": 51,
      "twitter_post": 71,
      "twitter_follow": 0,
      "linkedin_post": 10,
      "linkedin_follow": 29,
      "pin_it": 56,
      "google_plus": 45,
      "instagram_like": 3,
      "instagram_comment": 51,
      "personal_url": 64,
      "direct_email": 80,
      "other": 12,
      "date": "2013-12-29T00:00:00+0000",
      "created": "2013-12-31T21:39:21+0000"
    }
  ]
}

Filters

Name

Information

account_slug

Description

The client account slug

campaign_slug

Description

The campaign slug

advocate_token

Description

The advocate token

from

Description

The datetime were the range of the search starts

to

Description

The datetime were the range of the search stops

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/top-advocates

GET /reports/top-advocates

Return top 10 advocates

Documentation
Sandbox

Documentation

Get top 10 advocates.

Response Format

 {
    "code": 200,
    "data": [
        {
            "amount_referrals": 3,
            "code": "USD",
            "email": "advocate3_at_email.com",
            "lastname": "Chagas",
            "name": "Advocate3",
            "total_bonuses": 10
        }
    ]
}

Filters

Name

Information

account_slug

Description

The client account slug

campaign_slug

Description

The campaign slug

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

from

Description

The datetime were the range of the search starts

to

Description

The datetime were the range of the search stops

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Roots

/
- - GET /
    - Root resource
    - Documentation
    - Sandbox
    Documentation
    
    Welcome to Genius Referral Core API
    
    Response Format
    
    { "links": { "accounts": { "href": "http://api.geniusreferrals.com/accounts" }, "bonuses_redemption_methods": { "href": "http://api.geniusreferrals.com/utilities/bonuses-redemption-methods" }, "bonuses_summary_per_origin": { "href": "http://api.geniusreferrals.com/reports/bonuses-summary-per-origin" }, "currencies": { "href": "http://api.geniusreferrals.com/utilities/currencies" }, "redemption_request_actions": { "href": "http://api.geniusreferrals.com/utilities/redemption-request-actions" }, "redemption_request_statuses": { "href": "http://api.geniusreferrals.com/utilities/redemption-request-statuses" }, "referral_origins": { "href": "http://api.geniusreferrals.com/utilities/referral-origins" }, "referrals_summary_per_origin": { "href": "http://api.geniusreferrals.com/reports/referrals-summary-per-origin" }, "self": { "href": "http://api.geniusreferrals.com/" }, "test_authentication": { "href": "http://api.geniusreferrals.com/test-authentication" } } }
    
    Input
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Request body
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
    
    Curl Command Line

GENIUS REFERRALS API DOCUMENTATION

WELCOME TO OUR RESTFUL API REFERENCE PAGE

USING OUR SANDBOX TOOL

LIST OF AVAILABLE RESOURCES:

Accounts

/accounts

GET /accounts

Documentation

Filters

Return

200 - Returned when successful

Status Codes

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}

GET /accounts/{account_slug}

Documentation

Requirements

Return

200 - Returned when successful

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Advocates

/accounts/{account_slug}/advocates

DELETE /accounts/{account_slug}/advocates

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/advocates

Documentation

Requirements

Filters

Return

200 - Returned when successful

Status Codes

Requirements

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/advocates

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/advocates/{advocate_token}

DELETE /accounts/{account_slug}/advocates/{advocate_token}

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/advocates/{advocate_token}

Documentation