Retrieve the invitation code of a user
Retrieve a the invitation code belonging to a user for inviting other users.
HTTP Request
GET/api/users/:id/invite_code
Authorization
Authorization
- Required: Yes
- Permission: Staff with UserInviteCodePermission(UserRead) or Admin
- Permission Code: 1222
- Authentication: Token-based (Authorization: Token <your_api_key>)
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | Integer | Yes | Unique ID of the user to retrieve |
Example Requests
- 🐍 Python
- 🌐 Curl
1import requests
2
3api = requests.Session()
4api.headers.update({'Authorization': 'Token XXXXXXXXXXXXXXXXXXXXXX'})
5response = api.get('http://www.example.com/api/users/2/invite_code')
6print(response.json())1curl "http://www.example.com/api/users/2/invite_code" -H "Authorization: Token XXXXXXXXXXXXXXXXXXXXXX"Response Fields
| Field | Type | Description |
|---|---|---|
| invite_code | String | Invitation code of the user(nullable) |
Example Response
{
"invite_code": "zcdRed23a"
}