Skip to main content
GET
/
organizations
/
users
JavaScript
import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const organizationUser of client.organizations.users.list()) {
  console.log(organizationUser.id);
}
{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "organization_sub_user",
      "email": "user@example.com",
      "user_status": "enabled",
      "organization_user_bypasses_sso": false,
      "created_at": "2018-02-02T22:25:27.521Z",
      "last_sign_in_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page[number]
integer
default:1

The page number to load

Required range: x >= 1
page[size]
integer
default:250

The size of the page

Required range: 1 <= x <= 250
filter[user_status]
enum<string>

Filter by user status

Available options:
enabled,
disabled,
blocked
filter[email]
string

Filter by email address (partial match)

include_groups
boolean
default:false

When set to true, includes the groups array for each user in the response. The groups array contains objects with id and name for each group the user belongs to.

Response

Successful response with a list of organization users.

data
OrganizationUser · object[]
meta
Pagination Meta · object