find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/telnyx:telnyx-organization-users-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Telnyx Organization Users API
  version: 2.0.0
  contact:
    email: support@telnyx.com
  x-endpoint-cost: light
  x-refined-note:
  - x-latency-category differs across the merged source definitions and was not carried
  description: 'Operations tagged Organization Users across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
  description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Organization Users
  description: Operations related to users in your organization
paths:
  /organizations/users:
    get:
      description: Returns a list of the users in your organization.
      summary: List organization users
      operationId: ListOrganizationUsers
      tags:
      - Organization Users
      x-group-parameters: 'true'
      x-endpoint-cost: medium
      parameters:
      - $ref: '#/components/parameters/users_PageNumber'
      - $ref: '#/components/parameters/users_PageSize'
      - $ref: '#/components/parameters/FilterOrganizationUserStatus'
      - $ref: '#/components/parameters/FilterOrganizationUserEmail'
      - $ref: '#/components/parameters/IncludeGroups'
      responses:
        '200':
          description: Successful response with a list of organization users.
          content:
            application/json:
              schema:
                type: object
                title: List Organization Users Response
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OrganizationUser'
                  meta:
                    $ref: '#/components/schemas/users_PaginationMeta'
        '400':
          $ref: '#/components/responses/users_BadRequestResponse'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/users_UnauthorizedResponse'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /organizations/users/users_groups_report:
    get:
      description: Returns a report of all users in your organization with their group memberships. This endpoint returns all users without pagination and always includes group information. The report can be retrieved in JSON or CSV format by sending specific content-type headers.
      summary: Get organization users groups report
      operationId: GetOrganizationUsersGroupsReport
      tags:
      - Organization Users
      x-group-parameters: 'true'
      x-endpoint-cost: medium
      parameters:
      - name: Accept
        in: header
        description: Specify the response format. Use 'application/json' for JSON format or 'text/csv' for CSV format.
        required: false
        schema:
          type: string
          enum:
          - application/json
          - text/csv
          default: application/json
      responses:
        '200':
          description: Successful response with a list of organization users and their group memberships.
          content:
            application/json:
              schema:
                type: object
                title: Users Groups Report Response
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OrganizationUserWithGroups'
              example:
                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: []
            text/csv:
              schema:
                type: string
                description: 'CSV formatted report of users and their groups. Columns: id, email, user_status, created_at, last_sign_in_at, groups (comma-separated list of group names).'
              example: 'id,email,user_status,created_at,last_sign_in_at,groups

                6a09cdc3-8948-47f0-aa62-74ac943d6c58,user@example.com,enabled,2018-02-02T22:25:27.521Z,2018-02-02T22:25:27.521Z,"Engineering, Sales"'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/users_UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/users_NotFoundResponse'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /organizations/users/{id}:
    get:
      description: Returns the details of a user in your organization, optionally including the groups the user belongs to.
      summary: Get organization user
      operationId: GetOrganizationUser
      tags:
      - Organization Users
      parameters:
      - name: id
        in: path
        description: Organization User ID
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/IncludeGroups'
      x-group-parameters: 'true'
      x-endpoint-cost: medium
      responses:
        '200':
          description: Successful response with details about an Organization User.
          content:
            application/json:
              schema:
                type: object
                title: Organization User Response
                properties:
                  data:
                    $ref: '#/components/schemas/OrganizationUser'
        '400':
          $ref: '#/components/responses/users_BadRequestResponse'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/users_UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/users_NotFoundResponse'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /organizations/users/{id}/actions/remove:
    post:
      description: Removes the specified user from your organization and returns the result of the removal.
      summary: Delete organization user
      operationId: DeleteOrganizationUser
      tags:
      - Organization Users
      parameters:
      - name: id
        in: path
        description: Organization User ID
        required: true
        schema:
          type: string
      x-group-parameters: 'true'
      x-endpoint-cost: medium
      responses:
        '200':
          description: Successful response with details about an Organization User.
          content:
            application/json:
              schema:
                type: object
                title: Organization User Response
                properties:
                  data:
                    $ref: '#/components/schemas/OrganizationUser'
        '400':
          $ref: '#/components/responses/users_BadRequestResponse'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/users_UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/users_NotFoundResponse'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
components:
  responses:
    UnauthenticatedResponse:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/call-scripting_ErrorResponse'
          examples:
            Authentication Failed:
              value:
                errors:
                - code: '10009'
                  title: Authentication failed
                  detail: Could not understand the provided credentials.
                  meta:
                    url: https://developers.telnyx.com/docs/overview/errors/10009
    users_UnauthorizedResponse:
      description: The user doesn't have the required permissions to perform the requested action.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/users_ErrorResponse'
          examples:
            notAuthorized:
              value:
                errors:
                - code: '10010'
                  title: Not authorized
                  detail: You are not authorized to access the requested resource.
                  meta:
                    url: https://developers.telnyx.com/docs/overview/errors/10010
                  source:
                    pointer: /
    users_BadRequestResponse:
      description: Bad request, the request was unacceptable, often due to missing a required parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/users_ErrorResponse'
          examples:
            missingParameter:
              value:
                errors:
                - code: '10015'
                  title: Bad Request
                  detail: The request failed because it was not well-formed.
                  source:
                    pointer: /
                  meta:
                    url: https://developers.telnyx.com/docs/overview/errors/10015
    users_NotFoundResponse:
      description: The requested resource doesn't exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/users_ErrorResponse'
          examples:
            notFound:
              value:
                errors:
                - code: '10005'
                  title: Resource not found
                  detail: The requested resource or URL could not be found.
                  meta:
                    url: https://developers.telnyx.com/docs/overview/errors/10005
                  source:
                    pointer: /
    UnauthenticatedResponse_2:
      content:
        application/json:
          examples:
            Authentication Failed:
              value:
                errors:
                - code: '10009'
                  detail: Could not understand the provided credentials.
                  meta:
                    url: https://developers.telnyx.com/docs/overview/errors/10009
                  title: Authentication failed
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Unauthorized
    users_UnauthorizedResponse_2:
      content:
        application/json:
          examples:
            notAuthorized:
              value:
                errors:
                - code: '10010'
                  detail: You are not authorized to access the requested resource.
                  meta:
                    url: https://developers.telnyx.com/docs/overview/errors/10010
                  source:
                    pointer: /
                  title: Not authorized
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: The user doesn't have the required permissions to perform the requested action.
    ListOrganizationUsersResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: '#/components/schemas/OrganizationUser'
                type: array
              meta:
                $ref: '#/components/schemas/users_PaginationMeta'
            title: List Organization Users Response
            type: object
      description: Successful response with a list of organization users.
    users_BadRequestResponse_2:
      content:
        application/json:
          examples:
            missingParameter:
              value:
                errors:
                - code: '10015'
                  detail: The request failed because it was not well-formed.
                  meta:
                    url: https://developers.telnyx.com/docs/overview/errors/10015
                  source:
                    pointer: /
                  title: Bad Request
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Bad request, the request was unacceptable, often due to missing a required parameter.
    UsersGroupsReportResponse:
      content:
        application/json:
          example:
            data:
            - created_at: '2018-02-02T22:25:27.521Z'
              email: user@example.com
              groups:
              - id: 7b09cdc3-8948-47f0-aa62-74ac943d6c59
                name: Engineering
              - id: 8c09cdc3-8948-47f0-aa62-74ac943d6c60
                name: Sales
              id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
              last_sign_in_at: '2018-02-02T22:25:27.521Z'
              organization_user_bypasses_sso: false
              record_type: organization_sub_user
              user_status: enabled
            - created_at: '2018-01-01T00:00:00.000Z'
              email: owner@example.com
              groups: []
              id: 9d09cdc3-8948-47f0-aa62-74ac943d6c61
              last_sign_in_at: '2018-02-02T22:25:27.521Z'
              organization_user_bypasses_sso: false
              record_type: organization_owner
              user_status: enabled
          schema:
            properties:
              data:
                items:
                  $ref: '#/components/schemas/OrganizationUserWithGroups'
                type: array
            title: Users Groups Report Response
            type: object
        text/csv:
          example: 'id,email,user_status,created_at,last_sign_in_at,groups

            6a09cdc3-8948-47f0-aa62-74ac943d6c58,user@example.com,enabled,2018-02-02T22:25:27.521Z,2018-02-02T22:25:27.521Z,"Engineering, Sales"'
          schema:
            description: 'CSV formatted report of users and their groups. Columns: id, email, user_status, created_at, last_sign_in_at, groups (comma-separated list of group names).'
            type: string
      description: Successful response with a list of organization users and their group memberships.
    users_NotFoundResponse_2:
      content:
        application/json:
          examples:
            notFound:
              value:
                errors:
                - code: '10005'
                  detail: The requested resource or URL could not be found.
                  meta:
                    url: https://developers.telnyx.com/docs/overview/errors/10005
                  source:
                    pointer: /
                  title: Resource not found
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: The requested resource doesn't exist.
    OrganizationUserResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/OrganizationUser'
            title: Organization User Response
            type: object
      description: Successful response with details about an Organization User.
  schemas:
    OrganizationUserWithGroups:
      type: object
      title: OrganizationUserWithGroups
      description: An organization user with their group memberships always included.
      properties:
        id:
          type: string
          description: Identifies the specific resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        record_type:
          type: string
          description: Identifies the type of the resource. Can be 'organization_owner' or 'organization_sub_user'.
          example: organization_sub_user
        email:
          type: string
          format: email
          description: The email address of the user.
          example: user@example.com
        user_status:
          description: The status of the account.
          type: string
          enum:
          - enabled
          - disabled
          - blocked
          default: enabled
          example: enabled
        organization_user_bypasses_sso:
          type: boolean
          description: Indicates whether this user is allowed to bypass SSO and use password authentication.
          example: false
        created_at:
          type: string
          description: ISO 8601 formatted date indicating when the resource was created.
          example: '2018-02-02T22:25:27.521Z'
        last_sign_in_at:
          type:
          - string
          - 'null'
          description: ISO 8601 formatted date indicating when the resource last signed into the portal. Null if the user has never signed in.
          example: '2018-02-02T22:25:27.521Z'
        groups:
          type: array
          description: The groups the user belongs to.
          items:
            $ref: '#/components/schemas/UserGroupReference'
      required:
      - id
      - record_type
      - email
      - user_status
      - created_at
      - groups
      example:
        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
    users_PaginationMeta:
      title: Pagination Meta
      type: object
      properties:
        total_pages:
          type: integer
          example: 3
        total_results:
          type: integer
          example: 55
        page_number:
          type: integer
          example: 2
        page_size:
          type: integer
          example: 25
    UserGroupReference:
      type: object
      title: UserGroupReference
      description: A reference to a group that a user belongs to.
      properties:
        id:
          type: string
          description: The unique identifier of the group.
          example: 7b09cdc3-8948-47f0-aa62-74ac943d6c59
        name:
          type: string
          description: The name of the group.
          example: Engineering
      required:
      - id
      - name
      example:
        id: 7b09cdc3-8948-47f0-aa62-74ac943d6c59
        name: Engineering
    OrganizationUser:
      type: object
      title: OrganizationUser
      properties:
        id:
          type: string
          description: Identifies the specific resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        record_type:
          type: string
          description: Identifies the type of the resource. Can be 'organization_owner' or 'organization_sub_user'.
          example: organization_sub_user
        email:
          type: string
          format: email
          description: The email address of the user.
          example: user@example.com
        user_status:
          description: The status of the account.
          type: string
          enum:
          - enabled
          - disabled
          - blocked
          default: enabled
          example: enabled
        organization_user_bypasses_sso:
          type: boolean
          description: Indicates whether this user is allowed to bypass SSO and use password authentication.
          example: false
        created_at:
          type: string
          description: ISO 8601 formatted date indicating when the resource was created.
          example: '2018-02-02T22:25:27.521Z'
        last_sign_in_at:
          type:
          - string
          - 'null'
          description: ISO 8601 formatted date indicating when the resource last signed into the portal. Null if the user has never signed in.
          example: '2018-02-02T22:25:27.521Z'
        groups:
          type: array
          description: The groups the user belongs to. Only included when include_groups parameter is true.
          items:
            $ref: '#/components/schemas/UserGroupReference'
      example:
        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'
    users_ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              detail:
                type: string
              meta:
                type: object
                properties:
                  url:
                    type: string
                    format: uri
              title:
                type: string
              source:
                type: object
                properties:
                  pointer:
                    type: string
    call-scripting_ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              detail:
                type: string
              meta:
                type: object
                properties:
                  url:
                    type: string
                    format: uri
              title:
                type: string
              source:
                type: object
                properties:
                  pointer:
                    type: string
    ErrorResponse:
      properties:
        errors:
          items:
            properties:
              code:
                type: string
              detail:
                type: string
              meta:
                properties:
                  url:
                    format: uri
                    type: string
                type: object
              source:
                properties:
                  pointer:
                    type: string
                type: object
              title:
                type: string
            type: object
          type: array
      type: object
  parameters:
    users_PageSize:
      name: page[size]
      in: query
      description: The size of the page
      schema:
        type: integer
        minimum: 1
        maximum: 250
        default: 250
    IncludeGroups:
      name: include_groups
      in: query
      description: 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.
      schema:
        type: boolean
        default: false
    FilterOrganizationUserEmail:
      name: filter[email]
      in: query
      description: Filter by email address (partial match)
      schema:
        type: string
    FilterOrganizationUserStatus:
      name: filter[user_status]
      in: query
      description: Filter by user status
      schema:
        type: string
        enum:
        - enabled
        - disabled
        - blocked
    users_PageNumber:
      name: page[number]
      in: query
      description: The page number to load
      schema:
        type: integer
        minimum: 1
        default: 1
    PageNumber:
      description: The page number to load
      in: query
      name: page[number]
      schema:
        default: 1
        minimum: 1
        type: integer
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
    Payment:
      type: apiKey
      in: header
      name: Authorization
      description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
    agent-memory_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    bearerAuth:
      type: http
      scheme: bearer
    branded-calling_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    collections_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
    number-reputation_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    oauthClientAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
    outbound-voice-profiles_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    pronunciation-dicts_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
    rcs-registration_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
    stored-payment-transactions_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    transcriptions-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
    web-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    pay-connectors_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key, not the processor bearer token.
    telnyxApiKey:
      type: http
      scheme: bearer
      description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
  categories:
  - communication
  - developer-tools
  docs:
    apiReference: https://developers.telnyx.com
    homepage: https://telnyx.com
    llms: https://telnyx.com/llms.txt