Up - API Reference - Home
Get initial user and project data from an invitation link.
The invite contains a user gid for the invitee and a project gid; this method checks the validity of the link and provides relevant information when it is valid.
POST /api/init_invite
{
"invitee": "<user-gid>",
"project": "<project-gid>"
}
{
"success": true,
"result": {
"invitee": "<user gid>",
"project": "<project gid>",
"project_members": ["<user gid>", "<owner gid>", "<member user gid>", …],
},
"data": {
"cc.users": {
"<user gid>": {
"gid": "<user gid>",
"username": "",
"email": "<invitee email>",
"name": "",
"avatar": null,
"status": "invited",
"options": {
"language": "en",
"timezone": "Europe/Amsterdam"
}
},
"<owner gid>": {
"gid": "<owner gid>",
"username": "owner-name",
"name": "Owner Name",
"avatar": "1ad71cbd-9b97-4ea7-94ef-bcdd86c6467c.jpg",
"status": "active",
},
…
},
"cc.projects": {
"<project gid>": {
"gid": "<project gid>",
"name": "Project Name",
"icon": "<project gid>.jpg",
"owner": "<owner gid>",
"status": "active"
}
},
"cc.projects_members": [
{
"project_gid": "<project gid>",
"user_gid": "<user gid>",
"status": "invited",
"roles": [
"member"
],
},
{
"project_gid": "<project gid>",
"user_gid": "<owner gid>",
"status": "active",
"roles": [
"owner"
],
},
…
]
}
}
invitee is the user gid for the invitee.
project is the project gid.
project_members is a list of active user-gids for the project.
cc.users is a dictionary with entries for the invitee, the owner, and members of the project.
cc.projects is a dictionary with metadata for the project.
cc.projects_members is a list with metadata for project-user membership.
400 Bad request - missing parameters (only the first is reported).
422 Unprocessable entity - invitee not active or invited, or project not active.
1004 Invite invalid - previously declined invite, or accepted but invitee was deactivated since.