List Users

In this code snippet you learn how to get a list Users associated with an Application.

Prerequisites

You will need to use an existing Application containing at least one User in order to see a list of a Users. See the Create Conversation code snippet for information on how to create an Application. See also the Create User code snippet on how to create a User.

Write the code

Add the following to list-users.sh:

curl "https://api.nexmo.com/v1/users" \
     -H 'Authorization: Bearer '$JWT\
     -H 'Content-Type: application/json'

View full source

Run your code

Save this file to your machine and run it:

bash list-users.sh

Prerequisites

npm install @vonage/server-sdk

Create a file named list-users.js and add the following code:

const { Vonage } = require('@vonage/server-sdk');

const vonage = new Vonage({
  applicationId: VONAGE_APPLICATION_ID,
  privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH,
});

View full source

Write the code

Add the following to list-users.js:

const run = async () => {
  try{
    for await (const user of vonage.users.listAllUsers()) {
      console.log(user);
    }
  } catch (error) {
    console.error(error);
  }
};

run();

View full source

Run your code

Save this file to your machine and run it:

node list-users.js

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk-kotlin:1.1.2'

Create a file named ListUsers and add the following code to the main method:

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_APPLICATION_PRIVATE_KEY_PATH)
}

View full source

Write the code

Add the following to the main method of the ListUsers file:

val users = client.users.list()

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.users with the package containing ListUsers:

gradle run -Pmain=com.vonage.quickstart.kt.users.ListUsers

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk:8.15.1'

Create a file named ListUsers and add the following code to the main method:

VonageClient client = VonageClient.builder()
        .apiKey(VONAGE_API_KEY)
        .apiSecret(VONAGE_API_SECRET)
        .build();

View full source

Write the code

Add the following to the main method of the ListUsers file:

List<BaseUser> users = client.getUsersClient().listUsers();

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.users with the package containing ListUsers:

gradle run -Pmain=com.vonage.quickstart.users.ListUsers

Prerequisites

pip install vonage

Write the code

Add the following to list-users.py:

from vonage import Auth, Vonage

client = Vonage(
    Auth(
        application_id=VONAGE_APPLICATION_ID,
        private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
    )
)

users_list, next_page_cursor = client.users.list_users()

print(users_list)

View full source

Run your code

Save this file to your machine and run it:

python list-users.py

Try it out

When you run the code you will get a list of Users associated with an Application.