All categoriesAPIUsers API endpoint

Users API endpoint

This endpoint is designed to get a list of users registered on your feedback portal.

/api/v1/users/

Only the GET method for retrieving users is supported at the moment.

GET

You need to provide Authorization header with Bearer token:

curl -H 'Accept: application/json'\
-H "Authorization: Bearer <API_TOKEN>"\
https://productroad.com/api/v1/users/

In the response you will get a list consisting of records about the user in the following format:

[
{
"id": "<COMPANY USER ID>",
"email": "<COMPANY USER EMAIL>",
"name": "<COMPANY USER NAME>",
"alias": "<COMPANY USER ALIAS>",
"registered": "<CREATOR REGISTRATION DATETIME ISO FORMATTED>",
"is_admin": <IS COMPANY ADMIN BOOL>,
"is_team": <IS COMPANY TEAM BOOL>
},
...
]

On this list:

id: unique constant user id

email: user's email

name: full name of user

alias: a short name of user

registered: registration date and time in ISO format

is_admin: whether the user is the administrator of your feedback portal

is_team: whether the user is the member of your feedback portal's team