v1
latestSwagger 2.02026-07-1771241.1 KBReferrals
Returns the referrals of an user.
get/users/{userId}/referrals
Path parameters
userIdstring required
ID of the user
Query parameters
typestring required
Type of referrals: CONTACTS or T1 or T2
limitinteger
Limit of elements to return. Defaults to 10
offsetinteger
Number of elements to skip before collecting elements to return
Headers
Authorizationstring required
Insert your access token
X-Account-Metadatastring
Insert your metadata token
Response
OK
Example response
{
"active": 11,
"referrals": [
{
"active": true,
"city": "New York",
"country": "US",
"email": "jdoe@gmail.com",
"id": "did:ethr:0x4B73C58370AEfcEf86A6021afCDe5673511376B2",
"phoneNumber": "+12099216581",
"profilePictureUrl": "https://somecdn.com/p1.jpg",
"username": "jdoe",
"verified": true
}
],
"total": 11
}