ITiterable
lists

Preview users in a list

Get a random sample of up to 5000 users within a list. <b>Rate limit</b>: 5 requests/minute, per project.

get/api/lists/previewUsers

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Query parameters

listIdinteger required

list id

preferUserIdboolean

If true, will return the userId instead of email if both exists in a user profile for a hybrid project.

sizeinteger

Number of users the response will return, up to 5000. Defaults to 1000.

Response

successful operation

Changes

No recorded changes to this operation across all 4 revisions of this API.