Fetch a single end-user record.

GEThttps://staging.softsolz.uk/api/v1/services/customer-auth/users/{id}

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Response

Response Body

idstringEnd-user id.

emailstringEnd-user email.

namestring | nullDisplay name.

profile_picture_urlstring | nullAvatar URL.

statusstringAccount status.

email_verified_atstring | nullWhen the email was verified.

mfa_enabledbooleanWhether TOTP MFA is enabled.

mfa_enabled_atstring | nullWhen TOTP MFA was enabled.

last_login_atstring | nullLast successful login.

created_atstringCreation timestamp.

updated_atstringLast update timestamp.

metadataobjectTenant-defined metadata bag.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.customerAuth.getUser('<id>');
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "id": "string",
    "email": "string",
    "name": "string",
    "profile_picture_url": "string",
    "status": "string",
    "email_verified_at": "string",
    "mfa_enabled": true,
    "mfa_enabled_at": "string",
    "last_login_at": "string",
    "created_at": "string",
    "updated_at": "string",
    "metadata": {}
  }
}