Clarify API
Users

Get the current user

Returns the user the request authenticates as, in the same JSON:API shape as getting a user by ID. A workspace API key that is not bound to a person has no current user.

GET
/workspaces/{workspace}/users/me

Authorization

Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

Response Body

application/json

curl -X GET "https://example.com/workspaces/string/users/me"
{  "data": {    "type": "user",    "id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",    "attributes": {      "_id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",      "name": {        "first_name": "Alex",        "last_name": "Rivera"      },      "roles": {        "items": [          "member"        ]      },      "email": "alex@acme.com",      "profile_picture": "https://storage.clarify.ai/avatars/acme/alex-rivera.png",      "last_active_at": "2026-02-01T17:45:00.000Z",      "_created_at": "2026-01-15T09:30:00.000Z",      "_updated_at": "2026-02-01T17:45:00.000Z"    }  }}

Set object field visibility

Shows or hides an object type’s fields on the record detail view. The `hiddenInDetails` map keys each field name to a boolean, where `true` hides the field. The change is applied asynchronously and the response body is empty.

Get a user

Returns a single workspace user as a JSON:API resource, including their roles and the time they were last active.