Telnyx OAuth Grants API
The OAuth Grants API from Telnyx — 2 operation(s) for oauth grants.
The OAuth Grants API from Telnyx — 2 operation(s) for oauth grants.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/telnyx:telnyx-oauth-grants-api"
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.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Telnyx OAuth Grants 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 OAuth Grants 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: OAuth Grants
paths:
/oauth/grants:
get:
operationId: ListOAuthGrants
tags:
- OAuth Grants
summary: List OAuth grants
description: Retrieve a paginated list of OAuth grants for the authenticated user
parameters:
- name: page[size]
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 20
description: Number of results per page
- name: page[number]
in: query
schema:
type: integer
minimum: 1
default: 1
description: Page number
responses:
'200':
description: List of OAuth grants
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/OAuthGrant'
meta:
$ref: '#/components/schemas/oauth_PaginationMeta'
example:
data:
- id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
record_type: oauth_grant
client_id: string
scopes:
- string
created_at: '2024-01-23T18:10:02.574Z'
meta:
page_number: 0
page_size: 0
total_results: 0
total_pages: 0
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/oauth_Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/oauth_Error'
x-latency-category: responsive
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/oauth/grants/{id}:
delete:
operationId: RevokeOAuthGrant
tags:
- OAuth Grants
summary: Revoke OAuth grant
description: Revokes the specified OAuth grant, withdrawing the access previously granted to the client.
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: OAuth grant ID
responses:
'200':
description: OAuth grant revoked successfully
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/OAuthGrant'
example:
data:
id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
record_type: oauth_grant
client_id: string
scopes:
- string
created_at: '2024-01-23T18:10:02.574Z'
'404':
description: OAuth grant not found
content:
application/json:
schema:
$ref: '#/components/schemas/oauth_Error'
x-latency-category: responsive
get:
operationId: GetOAuthGrant
tags:
- OAuth Grants
summary: Get OAuth grant
description: Returns the details of a single OAuth grant on your account by its ID.
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: OAuth grant ID
responses:
'200':
description: OAuth grant details
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/OAuthGrant'
example:
data:
id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
record_type: oauth_grant
client_id: string
scopes:
- string
created_at: '2024-01-23T18:10:02.574Z'
'404':
description: OAuth grant not found
content:
application/json:
schema:
$ref: '#/components/schemas/oauth_Error'
x-latency-category: responsive
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/oauth_grants:
get:
operationId: ListOAuthGrants_2
tags:
- OAuth Grants
summary: List OAuth grants
description: Retrieve a paginated list of OAuth grants for the authenticated user
parameters:
- name: page[size]
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 20
description: Number of results per page
- name: page[number]
in: query
schema:
type: integer
minimum: 1
default: 1
description: Page number
responses:
'200':
description: List of OAuth grants
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/OAuthGrant'
meta:
$ref: '#/components/schemas/oauth_oauth_PaginationMeta'
example:
data:
- id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
record_type: oauth_grant
client_id: string
scopes:
- string
created_at: '2024-01-23T18:10:02.574Z'
meta:
page_number: 0
page_size: 0
total_results: 0
total_pages: 0
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/oauth_oauth_Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/oauth_oauth_Error'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/oauth_grants/{id}:
delete:
operationId: RevokeOAuthGrant_2
tags:
- OAuth Grants
summary: Revoke OAuth grant
description: Revokes the specified OAuth grant, withdrawing the access previously granted to the client.
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: OAuth grant ID
responses:
'200':
description: OAuth grant revoked successfully
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/OAuthGrant'
example:
data:
id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
record_type: oauth_grant
client_id: string
scopes:
- string
created_at: '2024-01-23T18:10:02.574Z'
'404':
description: OAuth grant not found
content:
application/json:
schema:
$ref: '#/components/schemas/oauth_oauth_Error'
get:
operationId: GetOAuthGrant_2
tags:
- OAuth Grants
summary: Get OAuth grant
description: Returns the details of a single OAuth grant on your account by its ID.
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: OAuth grant ID
responses:
'200':
description: OAuth grant details
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/OAuthGrant'
example:
data:
id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
record_type: oauth_grant
client_id: string
scopes:
- string
created_at: '2024-01-23T18:10:02.574Z'
'404':
description: OAuth grant not found
content:
application/json:
schema:
$ref: '#/components/schemas/oauth_oauth_Error'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
schemas:
OAuthGrant:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier for the OAuth grant
record_type:
type: string
enum:
- oauth_grant
description: Record type identifier
client_id:
type: string
description: OAuth client identifier
scopes:
type: array
items:
type: string
description: List of granted OAuth scopes
last_used_at:
type:
- string
- 'null'
format: date-time
description: Timestamp when the grant was last used
created_at:
type: string
format: date-time
description: Timestamp when the grant was created
required:
- id
- record_type
- client_id
- scopes
- created_at
oauth_oauth_Error:
type: object
properties:
error:
type: string
description: Error code
error_description:
type: string
description: Human-readable error description
required:
- error
oauth_Error:
type: object
properties:
error:
type: string
description: Error code
error_description:
type: string
description: Human-readable error description
required:
- error
oauth_oauth_PaginationMeta:
type: object
properties:
page_number:
type: integer
description: Current page number
page_size:
type: integer
description: Number of items per page
total_results:
type: integer
description: Total number of results
total_pages:
type: integer
description: Total number of pages
oauth_PaginationMeta:
type: object
properties:
page_number:
type: integer
description: Current page number
page_size:
type: integer
description: Number of items per page
total_results:
type: integer
description: Total number of results
total_pages:
type: integer
description: Total number of pages
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