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

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

const response = await client.organizations.users.getGroupsReport();

console.log(response.data);
{
  "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",
      "groups": [
        {
          "id": "7b09cdc3-8948-47f0-aa62-74ac943d6c59",
          "name": "Engineering"
        },
        {
          "id": "8c09cdc3-8948-47f0-aa62-74ac943d6c60",
          "name": "Sales"
        }
      ]
    },
    {
      "id": "9d09cdc3-8948-47f0-aa62-74ac943d6c61",
      "record_type": "organization_owner",
      "email": "owner@example.com",
      "user_status": "enabled",
      "organization_user_bypasses_sso": false,
      "created_at": "2018-01-01T00:00:00.000Z",
      "last_sign_in_at": "2018-02-02T22:25:27.521Z",
      "groups": []
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Headers

​
Accept
enum<string>
default:application/json

Specify the response format. Use 'application/json' for JSON format or 'text/csv' for CSV format.

Available options:
application/json,
text/csv

Response

Successful response with a list of organization users and their group memberships.

​
data
OrganizationUserWithGroups · object[]