Get a Specific Invite Code

This endpoint retrieves a specific invite code by code.

info

This operation does not require authentication

HTTP Request

GET /api/v2/invite_code/{code}/

Parameters

Name	In	Type	Required	Description
code	path	string	true	The code identifying the invite

Example Request

JavaScript

const headers = {
  'Accept':'application/json',
  'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/invite_code/{code}/',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Bash

# You can also use wget
curl -X GET /api/v2/invite_code/{code}/ \
  -H 'Accept: application/json'
  -H 'Authorization: Bearer {access_token}'

Responses

Status	Meaning	Description	Schema
200	OK	Response status code	InviteCode

Example responses

200

{
    "id": "integer",
    "invited_by_username": "string",
    "role": "string",
    "tags": [{Tags}],
    "name": "string",
    "email": "string",
    "code": "string",
    "generated_at": "string",
    "sent_at": "string",
    "used_at": "string",
    "invited_by": "integer",
    "user": {User}
}