API Reference

List users

get
https://user-api.omni.chat/v1/users

Retrieves a paginated list of users filtered by the provided query parameters. Results are sorted by createdAt in descending order. The response format defaults to JSON, but CSV can be requested via the Content-Type header.

Query Params
string

Filter by user name (full-text search).

role
array of strings

Filter by one or more roles.

role
boolean

Filter by disabled status.

boolean

Filter users who cannot start conversations.

boolean

Filter users who cannot send stickers.

integer

Maximum number of users to return per page.

string

Pagination token returned from the previous request to retrieve the next page.

string
enum

Sort order. Use name for ascending or -name for descending.

Allowed:
Headers
string

Set to text/csv to receive the response as a CSV file instead of JSON.

Responses

Updated 13 days ago

Language
Credentials
Header
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 13 days ago