Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[size]
integer
default:20

Number of avatars to return per page.

Required range: 1 <= x <= 100
page[number]
integer
default:1

Page number to retrieve, starting at 1.

Required range: x >= 1
filter[name]
string

Return avatars whose names contain this value, using case-insensitive matching.

Required string length: 1 - 255
filter[id]

Return the avatar with this exact ID. Stable identifier of a Telnyx stock avatar or an organization-owned custom avatar. Custom avatar IDs are returned by the Avatars API and use the avatar_ prefix.

Available options:
elena,
ben,
jordan,
lin,
avery,
raphael
Example:

"avatar_0123456789abcdef0123456789abcdef"

filter[avatar_type]
enum<string>

Return only stock or custom avatars. Whether the avatar is provided by Telnyx or was uploaded by the authenticated organization.

Available options:
stock,
custom

Response

A page of available avatars.

data
object[]
required
meta
object
required