Endpoint

/api/v1/get_user

Method

GET

Description

This endpoint retrieves detailed information about the authenticated user. It provides various details including the user's email, name, associated identities, metadata, and more.

Example Request

bashCode kopieren
GET /api/v1/get_user

Example Response

jsonCode kopieren
{
    "user": {
        "user_id": "google-oauth2|123456789012345678901",
        "email": "[email protected]",
        "given_name": "John",
        "email_verified": true,
        "updated_at": "2024-07-28T18:16:33.568Z",
        "identities": [
            {
                "access_token": "ya29.a0AXyoCgtJQY6FVBiPDTJqCi0fLLf1L28pSqmKxol4FGYxJxfav2njnzYWwFBwXtPX3hk2dCtjcRVMNqGvtMgwkV1fzzfvf0rR2Rvoh9cYOBYoYkpaJ7FQGa5x7EYr42Bg-jIYu4Sf-Lk-JA8i_jDxAk0WRvrF766-HkD2aCgYKARkSARESFQHGX2MiF6Hvujhte15p45fnUGg9OQ0171",
                "expires_in": 3599,
                "connection": "google-oauth2",
                "user_id": "123456789012345678901",
                "provider": "google-oauth2",
                "isSocial": true}
        ],
        "created_at": "2024-03-18T17:08:05.432Z",
        "user_metadata": {
            "message_me": false,
            "newsletter": false,
            "api_keys": [
                "bbot_abcdefghij1234567890",
                "bbot_klmnopqrst1234567890",
                "bbot_uvwxyz12345678901234"
            ],
            "updates": false,
            "features": true,
            "apps": {},
            "tokens": 500,
            "follows_me": true,
            "mentions_me": true},
        "name": "John Doe",
        "nickname": "john.doe",
        "picture": "<https://lh3.googleusercontent.com/a/ACg8ocL54DkmYmCmnGDiKfGJ2zv18r-NpU1XNQOJ2_5LY12BInK1IJQ=s96-c>",
        "family_name": "Doe",
        "last_login": "2024-07-28T18:16:16.163Z",
        "last_ip": "192.168.1.1",
        "logins_count": 125,
        "app_metadata": {}
    }
}

Response Attributes

• user: (object) The authenticated user's details.
  • user_id: (string) Unique identifier of the user.
  • email: (string) User's email address.
  • given_name: (string) User's given (first) name.
  • email_verified: (boolean) Whether the user's email is verified.
  • updated_at: (string) Timestamp when the user was last updated.
  • identities: (array) List of identity objects associated with the user.
    • access_token: (string) Access token for the identity.
    • expires_in: (integer) Expiration time of the access token in seconds.
    • connection: (string) Connection type (e.g., "google-oauth2").
    • user_id: (string) User ID within the connection.
    • provider: (string) Provider of the connection (e.g., "google-oauth2").
    • isSocial: (boolean) Whether the connection is social.
  • created_at: (string) Timestamp when the user was created.
  • user_metadata: (object) Custom metadata associated with the user.
    • message_me: (boolean) User preference for receiving messages.
    • newsletter: (boolean) User subscription status for newsletters.
    • api_keys: (array) List of API keys associated with the user.
    • updates: (boolean) User preference for receiving updates.
    • features: (boolean) User preference for receiving feature updates.
    • apps: (object) Custom app data associated with the user.
    • tokens: (integer) Number of tokens the user has.
    • follows_me: (boolean) Whether the user follows me.
    • mentions_me: (boolean) Whether the user mentions me.
  • name: (string) Full name of the user.
  • nickname: (string) User's nickname.
  • picture: (string) URL of the user's profile picture.
  • family_name: (string) User's family (last) name.
  • last_login: (string) Timestamp of the user's last login.
  • last_ip: (string) IP address used during the user's last login.
  • logins_count: (integer) Total number of logins by the user.
  • app_metadata: (object) Additional metadata associated with the user's apps.

Notes

• The response provides comprehensive information about the authenticated user.
• The timestamps are in ISO 8601 format.
• The identities array contains details about the user's authentication identities, including access tokens and their expiration.
• The user_metadata and app_metadata objects can include various custom data associated with the user.