List all users - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service returns the list of users.

Method Endpoint
GET 
/api/users

Response body

The following lines show an example of a JSON response body:

[
    {
        "id": "eca7c247-dd7e-4318-a7ba-6f67a3f0a4b3",
        "displayName": "First User",
        "emailAddress": "user1@mail.com"
    },
    {
        "id": "e128b37d-2b92-4276-8810-a624d16fbbda",
        "displayName": "Second User",
        "emailAddress": "user2@mail.com"
    }
]
Field Type Description
id String The user's identifier.
displayName String The user's name as it appears in the portal.
emailAddress String The user's email address.
Return code Description
200 OK The request is valid and data is returned.
401 UNAUTHORIZED The authorization header was not provided or is invalid.
403 FORBIDDEN The user or API key does not have the ADMIN or USERS_ADMIN role.

For a comprehensive list of all possible return codes, see Return codes.