rpaix helprpaix help

AIX.API

home/Documentation/AIX.API
Expand All Collapse All
  • Getting Started
  • Usage
  • Users
    • get-user
    • get-user-by
    • get-user-extra
    • get-user-language
    • get-users
  • Webhooks
    • message-sent
    • email-sent
    • sms-sent
    • new-messages-received
    • bot-message

get-user

14 views 0 August 23, 2023 Updated on October 16, 2023 rpaix-chat-team

Returns the user details of a user.

token

Your admin secret token.
function

Enter
get-user.
user_id

The ID of the user.
extra
Set it to
true to get the additional user details. Default:
false.

Response



{
    "success": true,
    "response": {
        "id": "123456",
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "profile_image": "https://aix.rpaix.com/user.svg",
        "user_type": "visitor",
        "creation_time": "2023-05-12 14:28:57",
        "last_activity": "2023-05-12 14:28:57",
        "department": null,
        "token": "a521773c5a566a661c3fb00e93162b20ff955b12",
        "password": "",
        "details": [
            {
                "slug": "location",
                "name": "Location",
                "value": "Los Angeles, United States"
            },
            {
                "slug": "country_code",
                "name": "Country code",
                "value": "America/New_York"
            }
            ...
        ]
    }
}

Returns {"success":true, "response":false} if the user is not found.

Was this helpful?

Yes  No
Related Articles
  • bot-message
  • new-messages-received
  • sms-sent
  • email-sent
  • message-sent
  • Webhooks

Didn't find your answer? Contact Us

Previously
Users
Up Next
get-user-by
© 2023 rpaix.com. All Rights Reserved.