List users API

This API returns the list of all users in a project.

  • Replace PROJECT_ID with your project ID (see Integration settings / API)

Request Headers:

Authorization: Bearer API_KEY
  • Replace the API_KEY above with your real API key (see Integration Settings / API)

Example response:

  "users": [
      "project": "5808e7031a943c7e564cdb16",
      "userId": "007",
      "lastSeen": "2016-12-01T00:00:00.000Z",
      "traits": {
        "email": "",
        "name": "John Doe",
        "createdAt": "2016-01-01T00:00:00.000Z"
      "email": "",
      "name": "John Doe",
      "unsubscribed": false,
      "created": "2016-01-01T00:00:00.000Z",
      "id": "5808e7031a943c7e564cdb17"

Filtering results by userId

If you need to find a result by userId ( the id passed on the widget ), you can do that by adding the userId query param in the URL.


This will return an array only with the user that matches the userId.

Was this article helpful?
6 out of 7 found this helpful

Articles in this section

Our Support hours:
Monday to Friday from 9:00 am - 2:00 am CET. Monday to Friday from 0:00 am - 5:00 pm PST.