Users

Retrieve a user

Get detailed information about a specific user by their ID.

The Retrieve a User endpoint lets you fetch details about a specific user. This is useful for displaying account details, verifying ownership, or managing users in your application.

Endpoint

GET /v1/users/{user_id}

Path Parameters

Parameter	Type	Required	Description
user_id	string	Yes	The unique identifier of the user to retrieve.

Headers

Key	Value	Required
Authorization	Bearer <access_token>	Yes

Response

Successful Response (200 OK)

{
  "id": "user_123",
  "email": "user@example.com",
  "name": "Jane Doe",
  "status": "active",
  "created_at": "2024-09-18T10:15:00Z",
  "updated_at": "2025-01-10T14:22:00Z"
}

ield	Type	Description
id	string	Unique identifier for the user.
email	string	The user’s email address.
name	string	Full name of the user.
status	string	Current account status (active, suspended, pending).
created_at	string	ISO 8601 timestamp when the user was created.
updated_at	string	ISO 8601 timestamp when the user was last updated.

Error Response (404 / 401)

{
  "error": "not_found",
  "message": "User not found."
}

Error Code	Meaning
not_found	No user exists with the given ID.
unauthorized	Missing or invalid access token.

Example Usage

cURL

curl -X GET "https://api.example.com/v1/users/user_123" \
  -H "Authorization: Bearer your_access_token"

JavaScript (Fetch)

const response = await fetch("https://api.example.com/v1/users/user_123", {
  method: "GET",
  headers: {
    "Authorization": "Bearer your_access_token"
  }
});

const data = await response.json();
console.log(data.email);

You can only retrieve users your access token is authorized to view. Admin tokens may have wider access than standard user tokens.

Authenticate user

Create a new user

Need help? Contact Support

Join our Discord Community

Questions? Contact Sales

On this page

Title