Pocketm8
  1. Users
Pocketm8
  • Auth
    • User
      • Sign In
      • Reset Password
      • Send SMS Code
      • Verify Code
      • Verify Token
      • Verify Challenge
  • Profile
    • Get Profile
      GET
    • Update Profile
      PATCH
    • Update Email
      PUT
    • Update Phone
      PUT
    • Resend Code
      POST
    • Update Avatar
      POST
    • Verify Code
      POST
  • Users
    • Get Users
      GET
  • Contacts
    • Get Contact
      GET
    • Get Contacts
      GET
  • Tasks
    • Create Task
      POST
    • Delete Task
      DELETE
    • Update Task
      PUT
    • Update Task Status
      POST
    • Get Task
      GET
    • Get Tasks
      GET
  • Relations
    • Task Edit
      GET
    • File Edit
      GET
  • Files
    • Get File
      GET
    • Get Files
      GET
    • Upload File
      POST
    • Delete File
      DELETE
    • Update File
      PATCH
  • Avatars
    • Upload Avatar file
  • Integrations
    • Matrix
      • Files
        • Link File
        • Unlink File
  1. Users

Get Users

Developing
GET
/users
Returns a list of users. The response is filtered based on the authenticated user’s role — some users may be hidden or restricted depending on access permissions.

Request

Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://admin.letschat.ch/api/users?page=1&perPage=10&order=asc&orderBy=lastName&role=client&search=Kahn'

Responses

🟢200Success
application/json
Body

Example
{
    "data": [
        {
            "id": "01JP1ZQWBJ35DXWD7RWQCB95PQ",
            "firstName": "asd",
            "lastName": "ads",
            "birthdate": null,
            "chatUsername": "67cfde3100209cb866f7",
            "unread": null,
            "locationId": 3,
            "roleId": "client",
            "locationName": "Aaretal",
            "completedTasks": 0,
            "overdueTasks": 0
        },
        {
            "id": "01JP1ZM7DT3SQMY8661CXWQW85",
            "firstName": "asd",
            "lastName": "ads",
            "birthdate": null,
            "chatUsername": "67cfddb90031104b9927",
            "unread": null,
            "locationId": 3,
            "roleId": "client",
            "locationName": "Aaretal",
            "completedTasks": 0,
            "overdueTasks": 0
        },
        {
            "id": "01JP1ZMBEQKYD98YAQREZ40Q3H",
            "firstName": "asd",
            "lastName": "ads",
            "birthdate": null,
            "chatUsername": "67cfddbd0038e093a906",
            "unread": null,
            "locationId": 3,
            "roleId": "client",
            "locationName": "Aaretal",
            "completedTasks": 0,
            "overdueTasks": 0
        },
        {
            "id": "01JP1ZN82ANX434P7M8J79GFNQ",
            "firstName": "asd",
            "lastName": "ads",
            "birthdate": null,
            "chatUsername": "67cfdddb000d1af39aa9",
            "unread": null,
            "locationId": 3,
            "roleId": "client",
            "locationName": "Aaretal",
            "completedTasks": 0,
            "overdueTasks": 0
        },
        {
            "id": "01JP1ZTB1F8392NKT5D65KHKXD",
            "firstName": "asdas",
            "lastName": "adsasd",
            "birthdate": "2025-03-03T23:00:00.000Z",
            "chatUsername": "67cfde820005dae04d0a",
            "unread": null,
            "locationId": 3,
            "roleId": "client",
            "locationName": "Aaretal",
            "completedTasks": 0,
            "overdueTasks": 0
        }
    ],
    "meta": {
        "total": 18,
        "lastPageNumber": 4,
        "currentPageNumber": 1,
        "isNextPage": true,
        "isPreviousPage": false
    }
}
Modified at 2025-04-17 08:32:54
Previous
Verify Code
Next
Get Contact
Built with