Connections, auth and API

How do I get app roles and their users through the API?

Call the user API, whose output includes the user's app roles, or fetch user data with the Kissflow User details connector in an integration.

How-to

Short answer: Use the user API to fetch a user's details, including their app roles. Inside Kissflow, you can get user data with the User details connector instead.

Why it happens

  • App roles belong to each user's details, so you read them through the user endpoints.
  • The API reference's sample response for Retrieve a user lists account-level fields such as UserType and Groups, not app roles, so check what your own response returns.

How to fix it

With the REST API:

  1. Create an access key. See API authentication.
  2. Call Retrieve a user (GET /user/2/{account_id}/{user_id}) and look for the user's app roles in the response. See API and SDK documentation.
  3. Repeat for each user you need. Get user IDs from List all users (GET /user/2/{account_id}/).

In an integration:

  1. Add the User details action Get user data.
  2. Map the user IDs from a previous step, or enter them.
  3. Select the user fields you need and test the action.

To list members of a group, use the Retrieve user group details action in the same connector.

Related answers