How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx UserAddresses API

Operations for working with UserAddress records. UserAddress records are stored addresses that users can use for non-emergency-calling purposes, such as for shipping addresses for orders of wireless SIMs (or other physical items). They cannot be used for emergency calling and are distinct from Address records, which are used on phone numbers.

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

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

This API exposes 3 operations across 2 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

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

3 operations 2 paths 17 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 UserAddresses 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 3

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

UserAddresses 3

Operations for working with UserAddress records. UserAddress records are stored addresses that users can use for non-emergency-calling purposes, such as for shipping addresses for…

GET
/user_addresses
List all user addresses
FindUserAddress 3 params → 200400401404
POST
/user_addresses
Creates a user address
CreateUserAddress body → 200422
GET
/user_addresses/{id}
Retrieve a user address
GetUserAddress 1 param → 200401404422

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are UserAddress (17 properties), UserAddressCreate (14 properties), PaginationMeta (4 properties). Each schema is shown below with its type and property counts.

user-addresses_postal_code
string
The postal code of the user address.
UserAddressCreate
object
14 properties 6 required
user-addresses_neighborhood
string
The neighborhood of the user address. This field is not used for addresses in the US but is used for some international addresses.
UserAddress
object
17 properties
user-addresses_phone_number
string
The phone number associated with the user address.
PaginationMeta
object
4 properties
user-addresses_street_address
string
The primary street address information about the user address.
skip_address_verification
boolean
An optional boolean value specifying if verification of the address should be skipped or not. UserAddresses are generally used for shipping addresses, and fail…
user-addresses_administrative_area
string
The locality of the user address. For US addresses, this corresponds to the state of the address.
customer_reference
string
A customer reference string for customer look ups.
user-addresses_first_name
string
The first name associated with the user address.
user-addresses_borough
string
The borough of the user address. This field is not used for addresses in the US but is used for some international addresses.
user-addresses_extended_address
string
Additional street address information about the user address such as, but not limited to, unit number or apartment number.
user-addresses_locality
string
The locality of the user address. For US addresses, this corresponds to the city of the address.
user-addresses_business_name
string
The business name associated with the user address.
user-addresses_country_code
string
The two-character (ISO 3166-1 alpha-2) country code of the user address.
user-addresses_last_name
string
The last name associated with the user address.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-useraddresses-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
Where this information came from

This is an independent, third-party profile of Telnyx UserAddresses API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.