Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/telnyx:telnyx-short-codes-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Telnyx Short Codes 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 Short Codes 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: Short Codes
description: Short codes
paths:
/short_codes:
get:
summary: List short codes
operationId: ListShortCodes
tags:
- Short Codes
x-group-parameters: 'true'
parameters:
- name: filter
in: query
style: deepObject
explode: true
description: 'Consolidated filter parameter (deepObject style). Originally: filter[messaging_profile_id]'
schema:
type: object
properties:
messaging_profile_id:
type: string
description: Filter by Messaging Profile ID. Use the string `null` for phone numbers without assigned profiles. A synonym for the `/messaging_profiles/{id}/short_codes` endpoint when querying about an extant profile.
- $ref: '#/components/parameters/PageConsolidated'
responses:
'200':
description: Successful response with a list of short codes.
content:
application/json:
schema:
type: object
title: List Short Codes Response
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShortCode'
meta:
$ref: '#/components/schemas/messaging_PaginationMeta_0b38e7044b'
4XX:
$ref: '#/components/responses/messaging_GenericErrorResponse_0b38e7044b'
description: Returns short codes owned by the authenticated account. Apply the documented filters and pagination parameters to narrow the result set.
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/short_codes/{id}:
get:
summary: Retrieve a short code
operationId: RetrieveShortCode
tags:
- Short Codes
parameters:
- $ref: '#/components/parameters/ShortCodeId'
responses:
'200':
description: Successful response with details about a short code.
content:
application/json:
schema:
type: object
title: Short Code Response
properties:
data:
$ref: '#/components/schemas/ShortCode'
4XX:
$ref: '#/components/responses/messaging_GenericErrorResponse_0b38e7044b'
description: Returns the messaging configuration and assignment details for the specified short code.
patch:
summary: Update short code
operationId: UpdateShortCode
description: 'Update the settings for a specific short code. To unbind a short code from a profile, set the `messaging_profile_id` to `null` or an empty string.
To add or update tags, include the tags field as an array of strings.'
tags:
- Short Codes
parameters:
- $ref: '#/components/parameters/ShortCodeId'
requestBody:
description: Short code update
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateShortCodeRequest'
responses:
'200':
description: Successful response with details about a short code.
content:
application/json:
schema:
type: object
title: Short Code Response
properties:
data:
$ref: '#/components/schemas/ShortCode'
4XX:
$ref: '#/components/responses/messaging_GenericErrorResponse_0b38e7044b'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
responses:
messaging_GenericErrorResponse_0b38e7044b:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/messaging_Errors_0b38e7044b'
example:
errors:
- code: string
title: string
detail: string
source:
pointer: /data/attributes/phone_number
parameter: string
ShortCodeResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/ShortCode_2'
title: Short Code Response
type: object
description: Successful response with details about a short code.
ListShortCodesResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/ShortCode_2'
type: array
meta:
$ref: '#/components/schemas/messaging_PaginationMeta'
title: List Short Codes Response
type: object
description: Successful response with a list of short codes.
messaging_GenericErrorResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/messaging_Errors'
description: Unexpected error
schemas:
messaging_Errors_0b38e7044b:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/messaging_Error_0b38e7044b'
messaging_Error_0b38e7044b:
required:
- code
- title
properties:
code:
type: string
x-format: integer
title:
type: string
detail:
type: string
source:
type: object
properties:
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
format: json-pointer
parameter:
description: Indicates which query parameter caused the error.
type: string
meta:
type: object
messaging_PaginationMeta_0b38e7044b:
type: object
required:
- total_pages
- total_results
- page_size
- page_number
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
ShortCode:
type: object
required:
- messaging_profile_id
example:
record_type: short_code
id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
short_code: '12345'
country_code: US
messaging_profile_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
tags:
- test_customer
created_at: '2019-01-23T18:10:02.574Z'
updated_at: '2019-01-23T18:10:02.574Z'
properties:
record_type:
type: string
example: short_code
enum:
- short_code
description: Identifies the type of the resource.
readOnly: true
id:
type: string
format: uuid
description: Identifies the type of resource.
readOnly: true
short_code:
type: string
description: Short digit sequence used to address messages.
readOnly: true
country_code:
type: string
description: ISO 3166-1 alpha-2 country code.
pattern: ^[A-Z]{2}$
example: US
readOnly: true
messaging_profile_id:
type:
- string
- 'null'
description: Unique identifier for a messaging profile.
tags:
type:
- array
description: Tags associated with the resource.
items:
type: string
created_at:
type: string
format: date-time
description: ISO 8601 formatted date indicating when the resource was created.
readOnly: true
updated_at:
type: string
format: date-time
description: ISO 8601 formatted date indicating when the resource was updated.
readOnly: true
UpdateShortCodeRequest:
type: object
required:
- messaging_profile_id
properties:
messaging_profile_id:
type: string
description: Unique identifier for a messaging profile.
tags:
type:
- array
description: Tags associated with the resource.
items:
type: string
example:
messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600000000
tags:
- test_customer
messaging_Errors:
properties:
errors:
items:
$ref: '#/components/schemas/messaging_Error'
type: array
messaging_PaginationMeta:
properties:
page_number:
example: 2
type: integer
page_size:
example: 25
type: integer
total_pages:
example: 3
type: integer
total_results:
example: 55
type: integer
required:
- total_pages
- total_results
- page_size
- page_number
type: object
messaging_Error:
properties:
code:
type: string
x-format: integer
detail:
type: string
meta:
type: object
source:
properties:
parameter:
description: Indicates which query parameter caused the error.
type: string
pointer:
description: JSON pointer (RFC6901) to the offending entity.
format: json-pointer
type: string
type: object
title:
type: string
required:
- code
- title
ShortCode_2:
example:
country_code: US
created_at: '2019-01-23T18:10:02.574Z'
id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
messaging_profile_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
record_type: short_code
short_code: '12345'
tags:
- test_customer
updated_at: '2019-01-23T18:10:02.574Z'
properties:
country_code:
description: ISO 3166-1 alpha-2 country code.
example: US
pattern: ^[A-Z]{2}$
readOnly: true
type: string
created_at:
description: ISO 8601 formatted date indicating when the resource was created.
format: date-time
readOnly: true
type: string
id:
description: Identifies the type of resource.
format: uuid
readOnly: true
type: string
messaging_profile_id:
description: Unique identifier for a messaging profile.
type:
- string
- 'null'
record_type:
description: Identifies the type of the resource.
enum:
- short_code
example: short_code
readOnly: true
type: string
short_code:
description: Short digit sequence used to address messages.
readOnly: true
type: string
tags:
items:
type: string
type:
- array
updated_at:
description: ISO 8601 formatted date indicating when the resource was updated.
format: date-time
readOnly: true
type: string
required:
- messaging_profile_id
type: object
UpdateShortCodeRequest_2:
example:
messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600000000
tags:
- test_customer
properties:
messaging_profile_id:
description: Unique identifier for a messaging profile.
type: string
tags:
items:
type: string
type:
- array
required:
- messaging_profile_id
type: object
parameters:
ShortCodeId:
name: id
in: path
description: The id of the short code
required: true
schema:
type: string
format: uuid
PageConsolidated:
name: page
in: query
style: deepObject
explode: true
description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]'
schema:
type: object
properties:
number:
type: integer
minimum: 1
default: 1
description: The page number to load
size:
type: integer
minimum: 1
maximum: 250
default: 20
description: The size of the page
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