GET group-invitation/…
Retrieves details for a specific invitation to a group. No specific permission is required for this API call, other than having knowledge of the invitation token.
Resource URL
https://www.drillster.com/api/2.1.1/group-invitation/{token}
The token is the unique code representing the group invitation.
Parameters
None, other than the invitation token in the URL.
Response
A 2.1.1 GroupInvitation object.
Example request
GET https://www.drillster.com/api/2.1.1/group-invitation/eFqr79Q4R3KiMs2a7vSNqQ
Response
{
"status": "ACCEPTED",
"user": {
"id": "x1MZEtQoRb19bU6v0bunOw",
"emailAddress": "jane.doe@example.com"
},
"group": {
"id": "bWBNGxnkf9dx2K4BGc2mndIEw0urEGKNs-9Zme3PgOM",
"name": "European geography",
"description": "Learn the countries and capitals of Europe",
"counts": {
"drillables": 20,
"tests": 6
}
}
}
Error responses
The following error situations are possible:
ID | Description |
---|---|
unknown_group_invitation |
The requested group invitation was not found. |
Last updated on