Get Users by Roles

1 min

POST

https://api.upstartcommerce.com/v1/users/list-by-roles

This endpoint returns all users having the specified role. The filter works as "any" -- a user will be returned if they have at least one role from the request.

acceptstringGenerated from available response content types

bodyarrayA list of role ids.

200A list of users.

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

403<p>An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.</p>

404The requested resource was not found in the NoChannel system.

409The request conflicts with the current state of the resource.

500Internal server error. The server encountered an unexpected condition that prevented it from fulfilling the request.

curl --request POST \
     --url https://api.upstartcommerce.com/v1/users/list-by-roles \
     --header 'accept: application/json'