Referrals (1.0.0)

Everything about viewing referred accounts.

View Referral Accounts

Get all referral accounts

Parameters

Parameter	In	Type	Required	Description
page	query	integer(int32)	false	Page number
limit	query	integer(int32)	false	Number of records per page

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/referral/accounts/

Request samples

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/referral/accounts'

Response samples

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your referrals.",
"data": {"total": 2,
"per_page": 15,
"current_page": 1,
"last_page": 1,
"next_page_url": null,
"prev_page_url": null,
"from": 1,
"to": 2,
"data": [{"referral_rule_id": 1,
"refered_user_id": 24,
"date_referred": 1438260940,
"percentage_referral": 5
},
{"referral_rule_id": 2,
"refered_user_id": 25,
"date_referred": 1438260989,
"percentage_referral": 5
}
]
}
}