Unicat API Reference

Up - API Reference - Home


/api/account/accept_invite

Requires JWT.

Accept an invitation for the project.

The invitation was sent by email, and contains an invite link. This link contains the project gid to use in accepting the invitation.

Afterwards, you have access to the project.

Request

POST /api/account/accept_invite
Authorization: Bearer <JWT>

{
    "project": "<project gid>",
}

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "project": "218437b3-f3db-4f60-9d44-c96319aa3c57",
        "project_members": ["<user gid>", "<owner gid>", ],
    },
    "data": {
        "cc.projects": {
            "218437b3-f3db-4f60-9d44-c96319aa3c57": {
                "gid": "218437b3-f3db-4f60-9d44-c96319aa3c57",
                "name": "Project Name",
                "icon": "218437b3-f3db-4f60-9d44-c96319aa3c57.jpg",
                "owner": "<owner gid>",
                "status": "active"
            }
        },
        "cc.projects_members": [
            {
                "project_gid": "218437b3-f3db-4f60-9d44-c96319aa3c57",
                "user_gid": "b76f701d-3d34-4f39-8eeb-fafe294ab01e",
                "status": "active",
                "roles": [
                    "member"
                ],
                "options": {
                    "language": "en",
                    "timezone": "Europe/Amsterdam"
                }
            },
            {
                "project_gid": "218437b3-f3db-4f60-9d44-c96319aa3c57",
                "user_gid": "<owner gid>",
                "status": "active",
                "roles": [
                    "owner"
                ],
                "options": {}
            },
        ],
        "cc.users": {
            "<user gid>": {
                "gid": "<user gid>",
                "username": "user-name",
                "email": "<user email>",
                "name": "User Name",
                "avatar": "96ec02b2-fb8d-4fb4-b952-fad0c4b88a74.jpg",
                "status": "active",
                "options": {
                    "language": "en",
                    "timezone": "Europe/Amsterdam"
                }
            },
            "<owner gid>": {
                "gid": "<owner gid>",
                "username": "owner-name",
                "name": "Owner Name",
                "avatar": null
            },
            
        }
    }
}

result

project is the project gid for the project you are now a member of.
project_members is the list of members, i.e. you, the owner, and possibly others.

data

cc.projects is a dictionary with one entry for the project.
cc.projects_members is a list with metadata for the project members.
cc.users is a dictionary with entries for the members.

Error response

401 Unauthorized - missing or expired JWT
422 Unprocessable entity - acceptation failed