List
List information about all users available to either the current authenticated user or the team, if the user belongs to a team. The list method takes an optional first argument to limit the returned user objects.
Examples
HTTP
Node.js
1
# HTTP request:
2
https://api.paperspace.io
3
GET /users/getUsers
4
x-api-key: 1ba4f98e7c0...
5
# Returns 200 on success
Copied!
1
paperspace.users.list(function(err, res) {
2
// handle error or result
3
});
Copied!
Parameters
Name
Type
Attributes
Description
id
string
<optional>
Optional user id to match on
email
string
<optional>
Optional email to match on
firstname
string
<optional>
Optional firstname to match on
lastname
string
<optional>
Optional lastname to match on
dtCreated
string
<optional>
Optional datetime created value to match on
teamId
string
<optional>
Optional teamId to match on
Returns
[ user, ... ] - JSON array of user objects
Type array
1
//Example return value:
2
[
3
{
4
"id": "u123abc",
5
"email": "[email protected]",
6
"firstname": "Jon",
7
"lastname": "Snow",
8
"dtCreated": "2017-04-15T16:20:59.609Z",
9
"teamId": "te456def"
10
},
11
{
12
"id": "u789ghi",
13
"email": "[email protected]",
14
"firstname": "Jeff",
15
"lastname": "Green",
16
"dtCreated": "2016-12-07T15:59:09.769Z",
17
"teamId": "te456def"
18
}
19
]
Copied!
Last modified 9mo ago
Copy link