Unicat API Reference

Up - API Reference - Home


/api/users/get

Requires JWT.

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

Request

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

{
    "user": "<user gid>"
}

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "user": "<user gid>",
    },
    "data": {
        "cc.users": {
            "<user gid>": {
                "gid": "<user 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"
                }
            }
        },
    }
}

result

user is the user 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.

Error response

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