Get consumer
Given an ID, this returns a Consumer. If the consumer is not found, a StatusResponse object is returned indicating the error.
If the consumer has a role of PowerUser or Viewer , they will have all their groups listed in viewableGroups . If their groupid is -1 and groupname All Users and Groups (current and future) it indicates that they have access to all current and future Users and Groups.
Lastly, if the consumer has a role of Admin and Configurator they will will have groupid -1 groupname All Users and Groups (current and future)
Header Parameters
x-api-keystring Required
Public API Key
Path Parameters
idinteger Required
The ID of an existing consumer whose information will be returned.
Minimum
1
Maximum
2147483647
Response
200
Object
The consumer's data object that matches the identifier.
Response Attributes
consumerobject
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
404
Object
Failed StatusResponse with an error message indicating that the consumer couldn't be found.
Response Attributes
messagesarray
Nullable:
True
Show child attributes
successboolean
Was this section helpful?
What made this section unhelpful for you?
Response
Was this section helpful?
What made this section unhelpful for you?