Endpoints

Profile

In Vrite, your profile data (email, username, bio, etc.) is shared across all workspaces you’re a member of. You can change it in the profile settings (including sensitive information like your email or password).

You can only retrieve the profile details of the user who created (or last regenerated) the token with proper permissions.

Retrieve Profile

Retrieves profile information and statuses of ongoing verifications of the user associated with the token.

GET

/profile

Response object

idstring

ID of the user

avatarstring

URL of the user's profile image

usernamestring

Short username

biostring

User's bio

fullNamestring

User's full name

emailstring

Email address

newEmailChangeInVerificationboolean

Whether a new email is in verification after a change

oldEmailChangeInVerificationboolean

Whether an old email is in verification after a change

passwordChangeInVerificationboolean

Whether a password change is in verification

emailInVerificationboolean

Whether the email is in verification after a sign up

Request

curl --request GET \
--url "https://api.vrite.io/profile" \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Accept: application/json'

const client = createClient({
  token: "<API_TOKEN>"
});
const result = await client.profile.get();

Response

{
  "id": "af549178ac762ac86132359c",
  "avatar": "string",
  "username": "string",
  "bio": "string",
  "fullName": "string",
  "email": "[email protected]",
  "newEmailChangeInVerification": true,
  "oldEmailChangeInVerification": true,
  "passwordChangeInVerification": true,
  "emailInVerification": true
}