menu
close

#Users

The users section of our public API allows you to retrieve information about all the users that have been identified by Poool.
It is necessary to recover the user ID on the front side to be able to use this part of the API:

#get user's informations

  • Route: /identity/:id
  • Method: GET
Provides various information about a user identified by Poool.
Parameters
id
Type: String
Required
User ID

#Get a user serveys answers

  • Route: /identity/:id/answers
  • Method: GET
Allows you to get all the answers to surveys answered by a Poool user.
Parameters
id
Type: String
Required
User ID
from
Type: Date
Default: startOfWeek(new Date())
Starting date of search
to
Type: Date
Default: endOfWeek(new Date())
Ending date of search
page
Type: Number
Default: 1
Current page
size
Type: Number
Default: 10
Results per page

#Change user's segment

  • Route: /identity/:id/segment
  • Method: POST
Allows manual modification of a user's segment.
Parameters
id
Type: String
Required
User ID
segment
Type: String
Required
Group filter
arrow_forward
NextSurveys