Get a user by ID

client.users.retrieve(, ?): User { id, created_at, email, 3 more }

GET/users/{id}

Retrieve detailed information about a specific user

ParametersExpand Collapse

id: string

ReturnsExpand Collapse

User { id, created_at, email, 3 more }

id: string

Unique identifier with user_ prefix

created_at: string

Timestamp when the user was created

formatdate-time

email: string

Email address of the user

formatemail

first_name: string

First name of the user

last_name: string

Last name of the user

updated_at: string

Timestamp when the user was last updated

formatdate-time

Get a user by ID

import Luminary from 'withluminary';

const client = new Luminary();

const user = await client.users.retrieve('id');

console.log(user.id);

{
  "id": "user_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "created_at": "2024-01-15T09:30:00Z",
  "email": "jane.doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "updated_at": "2024-01-20T14:45:00Z"
}

Returns Examples

{
  "id": "user_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "created_at": "2024-01-15T09:30:00Z",
  "email": "jane.doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "updated_at": "2024-01-20T14:45:00Z"
}