Get organization user

Returns a user in your organization.

GET /organizations/users/{id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

const user = await client.organizations.users.retrieve('id');

console.log(user.data);

200

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "organization_sub_user",
    "email": "[e-mail]",
    "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"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Organization User ID

Query Parameters

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

200

application/json

Successful response with details about an Organization User.

data · OrganizationUser · object

Show child attributes

Example:

{
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "organization_sub_user",
  "email": "[e-mail]",
  "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"
}