Users
Retrieve a user
Client API
Interactions
Messages
Users
Retrieve a user
Retrieves the user with the given ID.
GET
/
users
/
{user_id}
import { ProficientClient } from "@proficient/client";
const proficient = new ProficientClient({
apiKey: process.env.PROFICIENT_AI_PUBLISHABLE_KEY,
userExternalId: "...", // The user's unique ID in your system
});
const userId = "u_1eRoyubdUqWifFiTREaLcvh6";
const user = await proficient.users.get(userId);
{
"id": "<string>",
"object": "user",
"created_at": 123,
"external_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"live_mode": true,
"updated_at": 123
}
import { ProficientClient } from "@proficient/client";
const proficient = new ProficientClient({
apiKey: process.env.PROFICIENT_AI_PUBLISHABLE_KEY,
userExternalId: "...", // The user's unique ID in your system
});
const userId = "u_1eRoyubdUqWifFiTREaLcvh6";
const user = await proficient.users.get(userId);
Path Parameters
The unique identifier of the user
Response
200
application/json
<p>Represents a user of your project.</p>
import { ProficientClient } from "@proficient/client";
const proficient = new ProficientClient({
apiKey: process.env.PROFICIENT_AI_PUBLISHABLE_KEY,
userExternalId: "...", // The user's unique ID in your system
});
const userId = "u_1eRoyubdUqWifFiTREaLcvh6";
const user = await proficient.users.get(userId);
{
"id": "<string>",
"object": "user",
"created_at": 123,
"external_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"live_mode": true,
"updated_at": 123
}