This API returns the list of all users in a project.
GET https://app.satismeter.com/api/users?project=PROJECT_ID
-
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": "john@doe.com",
"name": "John Doe",
"createdAt": "2016-01-01T00:00:00.000Z"
},
"email": "john@doe.com",
"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.
GET https://app.satismeter.com/api/users?project=PROJECT_ID&userId=USER_ID
This will return an array only with the user that matches the userId.