API Reference

Users

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve

users.retrieve() -> UserRetrieveResponse

GET/users/me

Get the current authenticated user.

ReturnsExpand Collapse

class UserRetrieveResponse: …

user: User

The current authenticated user.

id: str

The unique identifier of the user.

created_at: object

The time the user was created.

email: str

The email address of the user.

first_name: Optional[str]

The first name of the user.

has_completed_onboarding: bool

Whether the user has completed the onboarding tutorial.

last_name: Optional[str]

The last name of the user.

organization_id: str

The ID of the organization the user belongs to.

updated_at: object

The time the user was last updated.

organization_country: Optional[str]

ISO 3166-1 alpha-2 country code of the organization (e.g. FR). Used as the default region when normalizing national-format phone numbers.

Retrieve

Python

HTTP

TypeScript

Python

Ruby

import os
from revox import Revox

client = Revox(
    api_key=os.environ.get("REVOX_API_KEY"),  # This is the default and can be omitted
)
user = client.users.retrieve()
print(user.user)

200 example

{
  "user": {
    "id": "id",
    "created_at": {},
    "email": "email",
    "first_name": "first_name",
    "has_completed_onboarding": true,
    "last_name": "last_name",
    "organization_id": "organization_id",
    "updated_at": {},
    "organization_country": "organization_country"
  }
}

Returns Examples

200 example

{
  "user": {
    "id": "id",
    "created_at": {},
    "email": "email",
    "first_name": "first_name",
    "has_completed_onboarding": true,
    "last_name": "last_name",
    "organization_id": "organization_id",
    "updated_at": {},
    "organization_country": "organization_country"
  }
}