Skip to content
MuninX MuninX Docs

List users

GET
/users
 
curl --request GET \
  --url 'https://api.muninx.com/users?type=admin%2Cagent&status=active%2Csuspended&agent-type=human%2Cai-assisted&auto-assign-tickets=true' \
  --header 'Authorization: Bearer <token>'

Returns users visible to the caller based on their role. Supports optional comma-separated filters.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
type
string

Filter by user types. Accepted values are admin, agent, and customer.

Example 
admin,agent
status
string

Filter by status. Accepted values are active and suspended.

Example 
active,suspended
agent-type
string

Filter by agent type. Accepted values are human, ai-assisted, and ai-autonomous.

Example 
human,ai-assisted
organization
string

Filter by organization ID.

auto-assign-tickets
string
Allowed values: true false

Filter by auto-assign-tickets flag.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
users
Array<object>
object
name
string
last-name
string
email
string format: email
created-at
string format: date-time
password

Omitted from normal API responses.

string
type
string
Allowed values: admin agent customer
organization
string
status
string
Allowed values: pending active suspended
auto-assign-tickets
boolean
agent-type
string
Allowed values: human ai-assisted ai-autonomous
Example 
{
  "users": [
    {
      "email": "[email protected]",
      "name": "Alice",
      "last-name": "Doe",
      "organization": "acme",
      "type": "admin",
      "agent-type": "human",
      "status": "active",
      "auto-assign-tickets": true
    },
    {
      "email": "[email protected]",
      "name": "Bob",
      "last-name": "Smith",
      "organization": "acme",
      "type": "agent",
      "agent-type": "ai-assisted",
      "status": "pending",
      "auto-assign-tickets": false
    }
  ]
}

400

Section titled “400 ”

RFC 9457 problem details

Media type application/problem+json

RFC 9457 problem details.

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
key
additional properties
any
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

401

Section titled “401 ”

RFC 9457 problem details

Media type application/problem+json

RFC 9457 problem details.

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
key
additional properties
any
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

403

Section titled “403 ”

RFC 9457 problem details

Media type application/problem+json

RFC 9457 problem details.

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
key
additional properties
any
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

500

Section titled “500 ”

RFC 9457 problem details

Media type application/problem+json

RFC 9457 problem details.

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
key
additional properties
any
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}