Skip to main content
GET
/
accounts
/
{account_id}
/
users
JavaScript
import Surge from '@surgeapi/node';

const client = new Surge({
  apiKey: process.env['SURGE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const user of client.users.list('acct_01j9a43avnfqzbjfch6pygv1td')) {
  console.log(user.id);
}
{
  "data": [
    {
      "first_name": "Brian",
      "id": "usr_01j9dwavghe1ttppewekjjkfrx",
      "last_name": "O'Conner",
      "metadata": {
        "email": "boconner@toretti.family",
        "user_id": "1234"
      },
      "photo_url": "https://toretti.family/people/brian.jpg"
    }
  ],
  "pagination": {
    "next_cursor": "g3QAAAABZAACaWRtAAAAGnBuXzAxamtzY2s5eDdkeW0wZnBxZjdjYmRyeQ==",
    "previous_cursor": null
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
account_id
string
required

The account ID to list users for.

Example:

"acct_01j9a43avnfqzbjfch6pygv1td"

Query Parameters

​
after
string

Cursor for forward pagination. Use the next_cursor from a previous response.

​
before
string

Cursor for backward pagination. Use the previous_cursor from a previous response.

Response

List of users

A paginated list of users

​
data
User · object[]
required

The list of users

​
pagination
Pagination · object
required

Cursor-based pagination information

Example:
{
  "next_cursor": "g3QAAAABZAACaWRtAAAAGnBuXzAxamtzY2s5eDdkeW0wZnBxZjdjYmRyeQ==",
  "previous_cursor": null
}