Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Organization Users API

Operations related to users in your organization

Telnyx Organization Users API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organization Users. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

4 operations 4 paths 5 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Organization Users API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Organization Users 4

Operations related to users in your organization

GET
/organizations/users
List organization users
ListOrganizationUsers 5 params → 200400401403
GET
/organizations/users/users_groups_report
Get organization users groups report
GetOrganizationUsersGroupsReport 1 param → 200401403404
GET
/organizations/users/{id}
Get organization user
GetOrganizationUser 2 params → 200400401403404
POST
/organizations/users/{id}/actions/remove
Delete organization user
DeleteOrganizationUser 1 param → 200400401403404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are OrganizationUserWithGroups (8 properties), OrganizationUser (8 properties), users_PaginationMeta (4 properties), UserGroupReference (2 properties). Each schema is shown below with its type and property counts.

users_PaginationMeta
object
4 properties
OrganizationUser
object
8 properties
ErrorResponse
object
1 property
OrganizationUserWithGroups
object
An organization user with their group memberships always included.
8 properties 6 required
UserGroupReference
object
A reference to a group that a user belongs to.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-organization-users-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API