Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/members/get

Requires JWT.

Get user and membership info for one or more members.

Request

You get members info either by specifying the gid in member or members.

If you provide both member and members parameters, we use parameter matching to guess what you meant. The first action that matches the parameters is performed, the rest is ignored. Parameter matching happens in the order given below:

POST /api/p/<project gid>/members/get
Authorization: Bearer <JWT>

{
    "member": "<member gid>"
}

or

POST /api/p/<project gid>/members/get
Authorization: Bearer <JWT>

{
    "members": ["<member gid>", …]
}

Success response

If you request a single member, you'll get a single result.

Authorization: <JWT>

{
    "success": true,
    "result": {
        "user": "b76f701d-3d34-4f39-8eeb-fafe294ab01e",
    },
    "data": {
        "cc.users": {
            "b76f701d-3d34-4f39-8eeb-fafe294ab01e": {
                "gid": "b76f701d-3d34-4f39-8eeb-fafe294ab01e",
                "name": "Unicat",
                "avatar": "96ec02b2-fb8d-4fb4-b952-fad0c4b88a74.jpg",
                "username": "unicat"
            },
        },
        "cc.projects_members": [
            {
                "project_gid": "<project gid>",
                "user_gid": "b76f701d-3d34-4f39-8eeb-fafe294ab01e",
                "status": "invited",
                "roles": [
                    "member"
                ],
                "options": {
                    "language": "en",
                    "timezone": "Europe/Amsterdam"
                }
            }
        ]
    }
}

If you requested multiple members, you'll get a list of results.

Authorization: <JWT>

{
    "success": true,
    "result": {
        "users": [
            "b76f701d-3d34-4f39-8eeb-fafe294ab01e",
            …
        ]
    },
    "data": {
        "cc.users": {
            "b76f701d-3d34-4f39-8eeb-fafe294ab01e": {
                "gid": "b76f701d-3d34-4f39-8eeb-fafe294ab01e",
                "name": "Unicat",
                "avatar": "96ec02b2-fb8d-4fb4-b952-fad0c4b88a74.jpg",
                "username": "unicat"
            },
            …
        },
        "cc.projects_members": [
            {
                "project_gid": "<project gid>",
                "user_gid": "b76f701d-3d34-4f39-8eeb-fafe294ab01e",
                "status": "invited",
                "roles": [
                    "member"
                ],
                "options": {
                    "language": "en",
                    "timezone": "Europe/Amsterdam"
                }
            },
            …
        ]
    }
}

result

user is the member's gid, if a single member was asked for.
users are the members gids, if multiple members were asked for.

data

cc.users is a dictionary with an entry for the user.
cc.projects_members is a list with metadata for the invited member.

Error responses

401 Unauthorized - missing or expired JWT
403 Forbidden - not the owner of this project
422 Unprocessable entity - invite failed