List Users

GET/management/v1/projects/{projectId}/users

Use it in a workflow

Add a step and choose the Voucherify connector.
Pick the List Users action (under Management).
Fill in the fields below, then reference the result from later steps as {{listUsers.response.data}}.

Request

Path parameters

projectIdstringrequired

Provide the unique identifier of the project.

Response

Returns 200 with an object. Read it in later steps with {{listUsers.response.data.<field>}}.

objectstring

The type of the object represented by JSON. This object stores information about the users in a dictionary.

One oflistDefault "list"

data_refstring

Identifies the name of the attribute that contains the array of user objects.

One ofdataDefault "data"

dataarray<object>

Array of user objects.

idstring

The unique identifier of the user who has been assigned to the project.

loginstring

The login data of the user who has been assigned to the project.

emailstring

The email address of the user who has been assigned to the project.

first_namestring

The first name of the user who has been assigned to the project.

last_namestring

The last name of the user who has been assigned to the project.

projectsobject

Lists key-value pairs, where the key is the project to which the user is assigned. The value is the role assigned in a given project. The predefined Voucherify roles are: `ADMIN`, `USER`, `VIEWER`, `MERCHANT`, `USER_RESTRICTED` (for the Areas and Stores, an Enterprise feature).

is_ownerboolean

Determines if the user is the owner for the organization in Voucherify.

totalinteger

The total number of users.

json

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "string",
      "login": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "projects": {},
      "is_owner": false
    }
  ],
  "total": 0
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.

Was this page helpful?