Theme switcher

Get all consumers

This returns a list of all Consumers. The optional paramater includeViewableGroups will return the list of Groups that the corresponding consumer has access to. If includeViewableGroups is not included in the URL query parameters, the default value will be false.

When includeViewableGroups is set to true, consumers with the roles of PowerUser and Viewer will have all their groups listed in viewableGroups . Consumers with groupid -1 groupname All Users and Groups (current and future) indicates that they have access to all current and future Users and Groups.

Lastly, consumers with the roles of Admin and Configurator will have groupid -1 groupname All Users and Groups (current and future)

Header Parameters

x-api-keystring Required

Public API Key

Query Parameters

includeViewableGroupsboolean

Set to true to display Viewable Groups in the Response

Response

200
Object
A list of all consumers

Response Attributes

consumersarray

Show child attributes

400
Object
Bad Request. Failed StatusResponse with an error message indicating the reason of the failure, and success equal to false.

Response Attributes

messagesarray
Nullable:
True

Show child attributes

successboolean
401
Object
Unauthorized

Response Attributes

messagesarray
Nullable:
True

Show child attributes

successboolean
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?