List users by name

POSThttp://localhost:4000/api/users/getUsersDisplayListByNames

Returns your users by name, optionally only the active ones or those in one brand.

Your API key needs the marketingCampaigns.MANAGE permission.

Body Params

activeOnlyboolean

Only return active users.

brandIdinteger

Only return users of this brand.

Responses

200Successful response.

400The request is not valid.

401The API key is missing, invalid, expired or disabled.

403The API key does not have the permission this endpoint needs.

Language

Credentials

Bearer

Kept in this browser tab and sent only to the Estactics API. Requests act on your real data.

cURL Request

curl --request POST \
  --url http://localhost:4000/api/users/getUsersDisplayListByNames \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"activeOnly":true}'

Response

Click Try It! to send a request and see the response here, or choose an example: