Unicat API Reference

/api/members/get

Requires JWT.

Get info about a membership. It must be you, or a member of one of the projects you own or are a member of.

Request

POST /api/members/get
Authorization: Bearer <JWT>

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

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "user": "<user gid>",
    },
    "data": {
        "cc.users": {
            "<member gid>": {
                "gid": "<member gid>",
                "username": "user-name",
                "email": "<user email>",
                "name": "User Name",
                "avatar": "1ad71cbd-9b97-4ea7-94ef-bcdd86c6467c.jpg",
                "status": "active",
                "options": {
                    "language": "en",
                    "timezone": "Europe/Amsterdam"
                }
            }
        },
        "cc.projects_members": [
            {
                "project_gid": "<project gid>",
                "user_gid": "<member gid>",
                "status": "active",
                "roles": [
                    "owner"
                ],
            },
            …
        ],
    }
}

result

user is the member gid you provided.

data

cc.users is a dictionary with one entry for the user. If this is you, you get complete data, otherwise, you get the short user data.
cc.projects_members is a list with one entry for the membership. If this is you, you get complete data, otherwise, you get the short membership data.

Error response

400 Bad request - missing argument
401 Unauthorized - missing or expired JWT
422 Unprocessable Entity - no info for this user