This API will provide list of all referrals along with their status that have been referred by a user.
GET https://altrecruit.peoplestrong.com/api/referrals/v1/refer/user/{username}
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| username | string | User name of referer |
Required |
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| offset | int64 | Records starting from |
Required |
| limit | int64 | No of records per page |
Required |
This request requires the use of one of following authorisation methods:
API key
OAuth2.
For OAuth 2 authorisation, the following scopes are required:
| Scope | Description |
|---|---|
| read | read records |
| write | modify records |
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK successful operation |
MyReferralResponse |
| 400 | Bad Request Bad Request |
|
| 401 | Unauthorized Unauthorized |
|
| 403 | Forbidden Forbidden |
|
| 404 | Not Found Not Found |
|
| 405 | Method Not Allowed Method Not Allowed |
|
| 426 | API rate limit exceeded |
|
| 429 | API rate limit exceeded |
|
| 500 | Internal Server Error Internal Server Error |
|
| default | successful operation |
© 2019 PeopleStrong