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-users

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

Returns the user details of all the users.

token

Your admin secret token.
function

Enter
get-users.
sorting
Set the order of the returned values. Enter ["column", "order"] and replace
column with one of the following values:
first_name, last_name, email, profile_image, user_type, creation_time, last_activity, department. Replace order with ASC or DESC.
user_types
Array in JSON format of user types to include in the return value. Array syntax:
["", "", "", ...]. Accepted values: visitor, lead, user, agent, admin. Default: all.
search
The string to search.
pagination
Integer from 1 to N to limit the results number. Enter 1 to get the first 100 results, 2 for the results from 101 to 200, etc.
extra
Set it to true to include all users extra details as well. Set it as an array of user extra detail slugs to include only a subset of extra details. Default: false.
user_ids
Array of IDs. If set, returns only the users with ID included in the given array of IDs. Array syntax:
["", "", "", ...]. Default: false.

Arguments



{
    "success": true,
    "response": [
        {
            "id": "880",
            "first_name": "User",
            "last_name": "#28838",
            "email": null,
            "profile_image": "https://aix.rpaix.com/user.svg",
            "user_type": "visitor",
            "creation_time": "2023-05-13 08:58:18",
            "last_activity": "2023-05-13 09:07:39",
            "department": null,
            "token": "6d969f64f598ju73714b9b39f3d3700b66f16820"
        },
        {
            "id": "879",
            "first_name": "User",
            "last_name": "#86883",
            "email": null,
            "profile_image": "https://aix.rpaix.com/user.svg",
            "user_type": "visitor",
            "creation_time": "2020-05-13 08:38:41",
            "last_activity": "2020-05-13 08:58:12",
            "department": null,
            "token": "2e506467070b6ty6661d04353f4a462ec927f19a"
        }
        ...
    ]
}

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
get-user-language
Up Next
Webhooks
© 2023 rpaix.com. All Rights Reserved.