API Reference

Users

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve

users.retrieve() -> UserRetrieveResponse { user }

GET/users/me

Get the current authenticated user.

ReturnsExpand Collapse

class UserRetrieveResponse { user }

user: { id, created_at, email, 6 more}

The current authenticated user.

id: String

The unique identifier of the user.

created_at: untyped

The time the user was created.

email: String

The email address of the user.

first_name: String

The first name of the user.

has_completed_onboarding: bool

Whether the user has completed the onboarding tutorial.

last_name: String

The last name of the user.

organization_id: String

The ID of the organization the user belongs to.

updated_at: untyped

The time the user was last updated.

organization_country: String

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

Ruby

HTTP

TypeScript

Python

Ruby

require "revox"

revox = Revox::Client.new(api_key: "My API Key")

user = revox.users.retrieve

puts(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"
  }
}