Skip to main content
POST
/
api
/
user
/
list
List users in organization and team (filtered)
curl --request POST \
  --url https://your-instance.example.com/api/user/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organizationId": "64ee9a8b1e7f2a0011223344",
  "departmentId": "64eea1110000000000000020"
}
'
[
  {
    "_id": "5f7b1c2e8a1d4e0012c3b4a6",
    "fullName": "Sam Patel",
    "email": "sam.patel@acme.example",
    "accessRole": "AGENT",
    "organizationId": "64a1b2c3d4e5f60012345678"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
organizationId
string

Restrict results to this organization; non-superadmins are silently scoped to their own org regardless of value.

​
departmentId
string

Restrict results to users in this department; omitted/empty falls back to the caller department (for DEPARTMENT_HEAD/SALES_REP).

Response

Users list returned (bare array of user summaries — no envelope)

​
_id
string
required
​
email
string<email>
required
​
accessRole
string
required
​
organizationId
string
required
​
fullName
string
​
phoneNumber
string
​
designation
string
​
sinchPhoneNumber
string
​
departmentId
string
​
loginDisabled
boolean
Example:
[
  {
    "_id": "5f7b1c2e8a1d4e0012c3b4a6",
    "fullName": "Sam Patel",
    "email": "sam.patel@acme.example",
    "accessRole": "AGENT",
    "organizationId": "64a1b2c3d4e5f60012345678"
  }
]