Skip to content

Query Users

Request

Returns a list of users in the connected workspace or tenant. Used to discover whose conversations can be queried.

Operation ID: chat_query_users

Security
BearerAuth
Query
metaArray of strings

Add metadata to the response by invoking meta functions. Documentation for meta functions is available. Not all meta functions are available at every endpoint.

limitinteger or null

Number of users to return. Defaults to 100 with a maximum of 1000. If a provider has a maximum limit lower than 1000, the provider's maximum limit will be used instead. A page may hold fewer results than limit, or none, even when more remain; keep paging until the returned cursor is empty.

filterArray of strings

Filter results by this query. For more information on filtering, refer to our Filtering Guide. Defaults to no filter. If used more than once, the queries are ANDed together.

cursorstring or null

Start search from cursor position.

include_raw_databoolean or null

Include the raw data from the chat provider in the response. Defaults to false.

curl
curl -i -X GET \
  https://api.synqly.com/v1/chat/users \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
cursorstringrequired

Cursor to use to retrieve the next page of results

resultArray of objects(ocsfv1.3.0entitymanagementEntityManagement)required

List of users, each wrapped in an OCSF Entity Management event of type Read.

messagesobject or null(MessagesResponse)

Additional messages from the service response that may be helpful to the client.

metaobject or null(MetaResponse)

Various metadata about the results organized by group, then type, then field.

Response
{ "result": [ { … } ], "cursor": "string", "messages": { "problems": [ … ] }, "meta": { "stats": { … }, "api": { … }, "mapping": { … } } }