- Authentication
- Access Token (Oauth - Username/Password)
- API Key (Machine 2 Machine)
- JWT (JSON Web Token)
- Create JWT token From User/Pass
- Create JWT token from Refresh JWT
- Create JWT token after MFA request
- Create JWT token For Delegated Access
- Revoke JWT(s) by UID (user@domain)
- Revoke JWT by JTI (JWT ID)
- Revoke current JWT
- Read Current JWT
- Generate Short-Lived Application JWT
- Create JWT token from Refresh JWT
- Create JWT token after MFA request
- NetsapiensJs Auth
- Masquerade
- Phone Numbers
- destination-application mappings and parameter parsing
- Use Cases
- Count Phone Numbers for DomainGET
- Get All Phone Numbers for System or ResellerGET
- Count All Phone Numbers for System or ResellerGET
- Get All Phone Numbers for DomainGET
- Add Phone Number in DomainPOST
- Remove Phone Number from DomainDELETE
- Update Phone Number in DomainPUT
- Get Specific Phone Number in DomainGET
- Phones/Macs
- Supported Models and Servers
- Phone Configurations
- Read Mac Addresses
- Count Mac Addresses
- Read Mac Addresses in Domain
- Read Specific Mac Address
- Read Specific Mac Addresses in Domain
- Add MAC address
- Add MAC address for Domain
- Update MAC address
- Update MAC address in Domain
- Remove MAC address
- Remove MAC address in Domain
- SnapBuilder
- Phone Templates
- Read Device Profiles
- Count Device Profiles
- Get specific Device Profile for Model of Phone
- Count Phone Configurations in a Domain
- Get Phone Configuration for specific Mac
- Create Phone Configuration for Specific Mac Address
- Update Phone Configuration for Specific Mac Address
- Delete Phone Configuration for Specific Mac Address
- Version
- Event Subscriptions
- Resellers
- Domains
- Users
- Devices
- Get Devices for User
- Count Devices for Domain
- Count Devices for Reseller
- Count Devices for User
- Count Devices by Device
- Create Device for User
- Update Device for User
- Delete Device for User
- Get Specifc Device
- Get Devices in Domain
- Get Devices for Reseller or System Wide
- Get device profile image
- Read a single device
- List devices for a reseller
- Sites
- Call Center
- Callqueues
- Agents
- Agent Actions
- QueuedCalls
- Statistics
- Get Callqueue Statistics for a Specific Queue
- Get Callqueue Statistics for all Queues Aggregated
- Get Callqueue Statistics for all Queues by Queue
- Get Agent Statistics for all Queues by Agent
- Get Agent Statistics for Single Queues by Agent
- Get Agent Statistics for Single Agent
- Get DNIS Statistics for all Queues
- Get DNIS Statistics for Single Queue
- Get Agent Log
- Send Call Center Email Report
- Get Abandoned Calls for all Queues
- Get Abandoned Calls for a Specific Queue
- Call Dispositions
- Answer Rules
- Call Blocking
- Auto Attendant
- Media
- Voicemail
- Greetings
- Read Greetings for User
- Count Greetings for User
- Read Specific Greeting for User
- Delete Specific Greeting for User
- Create a new Greeting from TTS
- Update Greeting with TTS script
- Create a new Greeting from Upload (JSON + Base64 File)
- Update Greeting from Upload (JSON + Base64 File)
- Create a new Greeting from Upload (Multipart/Mixed Post)
- Update Greeting from Upload (Multipart/Mixed Post)
- Create a new Greeting from Upload (JSON + Base64 File)
- Update Greeting from Upload (JSON + Base64 File)
- Create a new Greeting from Upload (Multipart/Mixed Post)
- Update Greeting from Upload (Multipart/Mixed Post)
- Music on Hold
- Domain
- Read MOH for Domain
- Count MOH for Domain
- Create a new MOH for Domain from TTS
- Update MOH for Domain from TTS
- Create a new MOH for Domain from Upload (JSON + Base64 File)
- Update MOH for Domain from Upload (JSON + Base64 File)
- Create a new MOH for Domain from Upload (Multipart/Mixed Post)
- Update MOH for Domain from Upload (Multipart/Mixed Post)
- Reorder MOH for Domain
- Delete MOH for Domain
- Create a new MOH for Domain from Upload (JSON + Base64 File)
- Update MOH for Domain from Upload (JSON + Base64 File)
- Create a new MOH for Domain from Upload (Multipart/Mixed Post)
- Update MOH for Domain from Upload (Multipart/Mixed Post)
- User
- Read MOH for User
- Count MOH for User
- Create a new MOH for Domain from TTS
- Create a new MOH for User from Upload (JSON + Base64 File)
- Update MOH for User from Upload (JSON + Base64 File)
- Update MOH for Domain from TTS
- Create a new MOH for User from Upload (Multipart/Mixed Post)
- Update a MOH for User from Upload (Multipart/Mixed Post)
- Reorder MOH for User
- Delete MOH for User
- Create a new MOH for User from Upload (JSON + Base64 File)
- Update MOH for User from Upload (JSON + Base64 File)
- Create a new MOH for User from Upload (Multipart/Mixed Post)
- Update a MOH for User from Upload (Multipart/Mixed Post)
- Domain
- Hold Messages
- Text to Speech
- CDR (Call History)
- CDR (Call History)
- Read CDRs
- Read CDRs for Domain
- Read CDRs for Specific User
- Count CDRs and SUM minutes
- Count CDRs and SUM minutes for Domain
- Count CDRs and SUM minutes for Specifc User
- Read a single CDR by call ID
- Update a CDR record
- Read a domain-scoped CDR by call ID
- Update a domain-scoped CDR
- Read a user-scoped CDR by call ID
- Search CDRs for Domain
- Update a user-scoped CDR
- Read CDRs for Site in Domain
- CDR call/minute time-series for a domain
- CDR call/minute time-series (reseller / system-wide)
- Top domains / resellers by call volume
- CDR Schedule
- Count CDR Schedules for Domain
- List CDR Schedules for Domain
- Create CDR Schedule
- Update CDR Schedule
- Delete CDR Schedule
- Read CDR Schedule
- Count CDR Schedules for Reseller
- Count CDR Schedules by Name
- List All CDR Schedules (Super User)
- Create CDR Schedule (System-wide)
- Read CDR Schedule (System-wide)
- Update CDR Schedule (System-wide)
- Delete CDR Schedule (System-wide)
- Read CDR Schedule by Reseller
- Update CDR Schedule by Reseller
- Delete CDR Schedule by Reseller
- List CDR Schedules for Reseller
- Create CDR Schedule for Reseller
- Call Traces & Cradle to Grave
- Transcriptions & Sentiment
- Calls (live/active calls)
- Read Active Calls In Domain
- Read Specific Active Call In Domain
- Count Active Calls In Domain
- Read Active Calls for User
- Read Specific Active Call
- Make a new Call
- Make a new Call to Record File
- Disconnect Call
- Transfer Peer Call
- Transfer Call
- Answer Call
- Hold Active Call
- Un-Hold Active Call
- Reject Call
- Report Active Calls
- Active call time-series for a domain
- Active call time-series (reseller / system-wide)
- Contacts
- Addresses
- Get Addresses for Domain
- Create Address for Domain
- Validate Address
- Update Address for Domain
- Delete Address For Domain
- Update Address for User
- Get Address Using Address ID
- Update Address Endpoint
- Delete Address Endpoint
- Create Address for User
- Get Addresses for User
- Delete Address For User
- Create Address Endpoint
- Get Address Endpoints for a Domain
- Get Addresses Count for Domain
- Voicemail Reminders
- Dialrule
- Read Dialrules in a Dialplan
- Count Dialrules in a Dialplan
- Read Specific Dialrule in a Dialplan
- Add a new dial rule into a dial plan
- Update a dial rule by ID in a dial plan
- Delete a dial rule by ID in a dial plan
- Read Dialplans
- Create Dialplan Global
- Create Dialplan for Domain
- Update Dialplan for Domain
- Delete Dialplan for Domain
- Count Dialplans
- Dial Permisions
- Read Policies
- Count Policies
- Read Specific Policy
- Read Policies in Domain
- Read Specific Policy in Domain
- Read Permissions in a DialPolicy
- Read Permissions in a DialPolicy in Domain
- Read Specific Permission in a Dialpolicy
- Read Specific Permission in a Dialpolicy in Domain
- Create Dialpolicy Table
- Update Dialpolicy
- Update Dialpolicy in Domain
- Add a new permission to a dialpolicy table
- Add a new permission to a dialpolicy table in Domain
- Update a permission in a dialpolicy table
- Update a permission in a dialpolicy table in Domain
- Delete a permission by ID in a dialpolicy
- Delete a permission by ID in a dialpolicy in Domain
- Delete Dialpolicy
- Delete Dialpolicy in Domain
- Messages
- SMS Block
- Get Messagesessions for Domain
- Start a new Message Session
- Get Messagesessions for User
- Get Messages for Messagesession
- Send a message (Chat)
- Send a message (Group Chat)
- Send a message (Media Chat)
- Send a message (SMS)
- Send a message (Group SMS)
- Send a message (MMS)
- Update Messagesession (Participants)
- Update Messagesession (Session Name)
- Update Messagesession (Leave)
- Delete Messagesession
- Add Participant to Messagesession
- Remove Participant from Messagesession
- Create a message session
- Send a message (Group Chat)
- Send a message (Media Chat)
- Send a message (SMS)
- Send a message (Group SMS)
- Send a message (MMS)
- Update Messagesession (Session Name)
- SMS Numbers
- Recordings
- Email
- Connections
- Get a specific Domain Connection
- Get All Connections for a Domain
- Delete a Domain Connection
- Update a Domain Connection
- Create a Domain Connection
- Create a Connection (not domain-scoped)
- Read All Connections (not domain-scoped)
- Get a Specific Connection (not domain-scoped)
- Update a Specific Connection (not domain-scoped)
- Delete a Specific Connection (not domain-scoped)
- Count All Conections
- List route connections
- Routes
- Route Profiles
- Meetings
- Event Logs
- Iotum
- Read Iotum Video Domain Resellers
- Read Iotum Video Host
- Read All Iotum Video Hosts in a Domain
- Read Iotum Video Host Conferences
- Read Iotum Video Host Contacts
- Read Iotum Video Company
- Read Iotum Video Company Products
- Read Iotum Video Available Products
- Create a Host
- Create Host Contacts
- Create Iotum Video Subscription
- Update Domain's Iotum Company
- Update Domain's Iotum Subscriptions
- Update User's Iotum Host
- Delete Iotum Video Subscription
- Delete a Host
- Create Iotum Video Company
- Create a Ad-hoc Conference
- Delete a Video Company
- Create a Meeting with Id
- Read Meeting
- Create a Meeting
- Read Meetings for User
- Count Domains Meetings
- Count Meeting
- Register Meeting
- Update a Meeting
- Delete a Meeting
- Request a Meeting ID
- Backup & Restore
- Configs
- Images
- Read Image
- Create Image from Upload (JSON + Base64 File)
- Delete an Image
- Update Image from Upload (Multipart/Mixed Post)
- Create Image from Upload (Multipart/Mixed Post)
- Update Image from Upload (JSON + Base64 File)
- Create Image from Upload (Multipart/Mixed Post)
- Update Image from Upload (JSON + Base64 File)
- Templates
- Timeframes
- Domain (Shared)
- Always
- Specific Dates
- Create Specific Dates Timeframe
- Create Additional Date Ranges within Specific Dates Timeframe
- Convert Timeframe to Another Type
- Update Date Ranges within Specific Dates Timeframe
- Delete Specific Timeframe for Domain (Shared)
- Create Specific Dates Timeframe
- Replace All Date Ranges in Specific Dates Timeframe
- Delete Date Range within Specific Dates Timeframe
- Update Date Ranges within Specific Dates Timeframe
- Days of Week
- Holiday
- Create Holidays Timeframe
- Create Additional Holidays within Holiday Timeframe
- Replace All Holidays in Holiday Timeframe
- Update Holidays within Holiday Timeframe
- Delete Holiday within Holiday Timeframe
- Create Additional Holidays within Holiday Timeframe
- Delete Holiday within Holiday Timeframe
- Create Holidays Timeframe
- Replace All Holidays in Holiday Timeframe
- Update Holidays within Holiday Timeframe
- Custom
- Create Custom Timeframe
- Create Additional Entries within Custom Timeframe
- Replace All Entries in Custom Timeframe
- Update Entries within Custom Timeframe
- Delete Entry within Custom Timeframe
- Create Additional Entries within Custom Timeframe
- Delete Entry within Custom Timeframe
- Create Custom Timeframe
- Replace All Entries in Custom Timeframe
- Update Entries within Custom Timeframe
- Count Timeframes for Domain (all users)
- Read All Timeframes for Domain (Shared)
- Read Specific Timeframe for Domain (Shared)
- Delete Specific Timeframe for Domain (Shared)
- Convert Timeframe to Another Type
- User
- Always
- Specific Dates
- Create Specific Dates Timeframe
- Create Additional Date Ranges within Specific Dates Timeframe
- Convert Timeframe to Another Type
- Update Date Ranges within Specific Dates Timeframe
- Delete Specific Timeframe for User
- Create Specific Dates Timeframe
- Replace All Date Ranges in Specific Dates Timeframe
- Delete Date Range within Specific Dates Timeframe
- Update Date Ranges within Specific Dates Timeframe
- Days of Week
- Holiday
- Create Additional Holidays within Holiday Timeframe
- Delete Holiday within Holiday Timeframe
- Create Holidays Timeframe
- Update Holidays within Holiday Timeframe
- Replace All Holidays in Holiday Timeframe
- Create Additional Holidays within Holiday Timeframe
- Delete Holiday within Holiday Timeframe
- Create Holidays Timeframe
- Update Holidays within Holiday Timeframe
- Replace All Holidays in Holiday Timeframe
- Custom
- Create Additional Entries within Custom Timeframe
- Delete Entry within Custom Timeframe
- Create Custom Timeframe
- Update Entries within Custom Timeframe
- Replace All Entries in Custom Timeframe
- Create Additional Entries within Custom Timeframe
- Delete Entry within Custom Timeframe
- Create Custom Timeframe
- Update Entries within Custom Timeframe
- Replace All Entries in Custom Timeframe
- Read All Timeframes for User
- Read Specific Timeframe for User
- Delete Specific Timeframe for User
- Convert Timeframe to Another Type
- Holiday Information
- Domain (Shared)
- Firebase
- SSL Certificates
- Manage Code
- View Servers Available to manage code on
- Read all code packages for all servers in cluster
- Read all package details for a specific server
- Update/Refresh repository info on Server
- View current repos info on Server
- Add repository version to Server
- Remove repository version from Server
- Install/Update a netsapiens package or packages on a specific server
- Prefrom a dist-upgrade on a server updating all existing packages (netsapiens and not) to latest version available
- Cleanup unused packages on a specific server
- iNSight
- Conference
- Charts
- Dashboards
- Quotas
- Departments
- Presence
- Audit Log
- Access Log
- Avatars
- Generic
- Add/Update Avatar for UserPUT
- Read Avatar Metadata by FilenameGET
- Delete Avatar for User by FilenameDELETE
- Read Avatar Metadata for UserGET
- Count Avatars for UserGET
- Add/Update Avatar for User's ContactPUT
- Add/Update Avatar for Domains's Shared ContactPUT
- Add Avatar for UserPOST
- Add Avatar for User's ContactPOST
- Add Avatar for Domain's Shared ContactPOST
- Delete Avatar for UserDELETE
- Read Avatar Metadata for User's ContactGET
- Delete Avatar for User's ContactDELETE
- Read Avatar Metadata for Domain's Shared ContactGET
- Delete Avatar for Domain's Shared ContactDELETE
- Translations
- License
- Reject Log
- Push Notifications
- App Info
- Brands
- Global
- Reseller
- List brands for a reseller (minimal fields)
- Get all brands for a reseller (full data)
- List brands for reseller + hostname (minimal fields)
- Get all brands for reseller + hostname (full data)
- Get active brand for hostname (resolved)
- Get a specific brand (full data)
- Create a new brand
- Update a brand
- Delete a brand
- Copy a brand
- Domain
- List brands for a domain (minimal fields)
- Get all brands for a domain (full data)
- Create a new brand (domain-scoped)
- List brands for domain + hostname (minimal fields)
- Get all brands for domain + hostname (full data)
- Get active brand for domain + hostname (resolved)
- Get a specific brand (domain-scoped)
- Update a brand (domain-scoped)
- Delete a brand (domain-scoped)
- Copy a brand (domain-scoped)
- Brand Assets
- vCon
- Phones
- Horizon SDK
- Inboxes
- Defaults
- Speech Words
- List system speech words
- Read a system speech word
- Update a system speech word
- Download a system speech word audio file
- Re-record a system speech word via TTS
- Replace a system speech word audio file
- List a domain's speech words
- Read a domain's resolved speech word
- Create or update a domain override
- Delete a domain override
- Download a domain's speech word audio file
- Re-record a domain's speech word via TTS
- Replace a domain's speech word audio file
- Stream a system speech word via a timed-auth link
- Bulk re-record system speech words via TTS
- Stream a domain's speech word via a timed-auth link
- Bulk re-record a domain's speech words via TTS
- User Settings
- Network Tests
- List network test reports
- Create a network test report
- Get a single network test report
- Delete a network test report
- List a user's network test reports
- Create a network test report for a user
- Get a single network test report under a user
- Delete a network test report under a user
- List network test reports system-wide
- Get a single network test report (system-wide)
- Delete a network test report (system-wide)
- SMS Carriers
- ipaware
- Service Codes
- Read a Service Code
- Update a Service Code
- Delete a Service Code
- Read a Service Code for a Domain
- Update a Service Code for a Domain
- Delete a Service Code for a Domain
- List Service Codes
- Create a Service Code
- Count Service Codes
- List Service Codes for a Domain
- Create a Service Code for a Domain
- Count Service Codes for a Domain
- Schemas
- Schemas
- Enums
- securitySchemes
- Default Folder
- Inbox
- InboxMember
- AuthenticationRequired
- BadRequest
- RecordNotFound
- RouteProfile
- Vcon
- MfaDeleteRequest
- MfaEnrollWithTokenRequest
- MfaEnrollRequest
- MfaVerifyResponse
- MfaVerifyRequest
- GenAuthenticatorRequest
- BrandAsset
- Brand
- InsightAlertResponse
- ApplicationTokenResponse
- ApplicationTokenRequest
- AppinfoR
- PushR
- RejectlogR
- LicenseR
- BulkTranslationResponse
- Error
- TranslationRawRecord
- HealthResponse
- TranslationCreateResponse
- TranslationNamespacesResponse
- TranslationLocalesResponse
- CdrUpdatable
- MasqueradePopNoTargetResponse
- MasqueradeV2EndResponse
- MasqueradeV2Response
- RefreshCookieResponse
- MeResponse
- NetsapiensJsResponse
- RepoDetails
- RepoRequest
- CodeApplicationServerDetails
- CodeApplicationServer
- CodeApplication
- AuthenticationRequired1
- BadRequest1
- RecordNotFound1
- EmailTestResponse
- EmailValidate
- Avatar
- OIDCProvider
- SmsBlock
- SSOEnroll
- AbandondedCallStat
- Phoneconfiguration
- PhoneConfigBtn
- QueueStat
- Auditlog
- InsightValue
- Holiday
- DeviceModelButtonType
- DeviceModel
- DeviceImage
- DeviceProfile
- DeviceProfileButton
- Dialpolicy
- Permission
- DispositionReason
- PublicUserInfo
- RouteConnection
- Route
- Presence
- Dashboard
- Chart
- AnswerruleFeatureSimRing
- ConferenceCDR
- Conference
- ConferenceParticipant
- Dialplan
- NumberEnabledMap
- Certficate
- Start
- Limit
- Transcription
- CallBlocking
- AnswerruleFeatureWithRemove
- IotumContact
- IotumHost
- RecurringTimeframeHolidayObservance
- RecurringTimeframeType
- TimeframeDOW
- TimeframeHoliday
- TimeframeSpecificDate
- RecurringTimeframe
- RecordingOld
- DatetimeEnd
- DatetimeStart
- StringInteger
- ConfigDefinition
- AuthRequestMFA
- StringDefaultStar
- MimeTypes
- MessageType
- RecordingConfiguration
- MeetingStatus
- Template
- Image
- JwtRequestSuccess
- OneZeroDefaultZero
- OneZeroDefaultOne
- OneZeroBoolean
- JwtResponse
- DeletegateRequest
- Connection
- ConnectionExtra
- DeleteType
- Timestamp
- Configuration
- Meeting
- SmsNumber
- AddressCreateReturn
- BackupResponse
- Restore
- MessageSend
- AddressEndpoint
- AddressValidate
- AutoAttendantFailOptions
- AutoAttendantTierOption
- AutoAttendantTier
- AutoAttendant
- Timerange
- TtsVoice
- AgentPath
- CallqueuePath
- CallActions
- DialruleApplication
- UserNamePath
- DeviceLegacy
- Agentlog
- EmailCreate
- YesNoStringNoDefault
- YesNoStringYesDefault
- UserName
- DomainNamePath
- Synchronous
- Recording
- ApiKeyAuth
- SubscriptionModel
- Subscription
- DomainName
- Scopes
- TimeZone
- YesNoString
- DomainBilling
- User
- Domain
- Message
- Vmailnag
- Messagesession
- NdpServer
- NdpModel
- NdpPhone
- CdrR
- CdrU
- CdrD
- MediaRequest
- Audiofile
- ApiKey
- Reseller
- Address
- AccessToken
- Timeframe
- AnswerruleFeature
- Answerrule
- Contact
- Phonenumber
- DialRule
- Count
- CallRequest
- AuthRequest
- Site
- AnswerruleLegacy
- Agent
- CallQueue
- Device
- UserLegacy
- DomainLegacy
- Address
- Authentication
- ActiveCall
- ErrorResponse
- DefaultR
- SpeechWordR
- UsersettingValue
- NetworktestR
- IpawareError
- SmscarrierFields
- ServiceCode
- DefaultC
- SpeechWordU
- UsersettingR
- NetworktestReport
- CdrSchedule
- IpawareValidationError
- SmscarrierR
- ServiceCodeCreate
- HorizonExtension
- DefaultU
- SpeechWordRender
- UsersettingC
- CdrScheduleInput
- IpawareAllowedIpAdd
- SmscarrierC
- ServiceCodeKeyedUpdate
- SuccessResponse
- SpeechWordUpload
- UsersettingU
- SpeechWordBulkRender
- IpawareAllowedIpRemove
- SmscarrierPortalR
- ServiceCodeKeyedDelete
- SpeechWordBulkResult
- IpawareAllowedIpMutationResult
- SmscarrierBuiltinU
- DomainServiceCodeCreate
- IpawareAllowEntry
- SmscarrierCustomU
- DomainServiceCodeKeyedUpdate
- IpawareAllowedIpsList
- IpawarePendingChange
- IpawareConfigState
- IpawareConfigKeyState
- IpawareConfigUpdateResult
- IpawareStatusZ
- IpawareBlockEntry
- IpawareFirewallState
- IpawareFirewallBlockRequest
- IpawareFirewallUnblockRequest
- IpawareFirewallOpResult
- RecordNotFound
- BadRequest
- AuthenticationRequired
Read Avatar Metadata by Filename
GET
/domains/{domain}/users/{user}/avatar/{filename}
Last modified:2026-07-28 22:44:33
OperationId:ReadUserAvatarFile
user and domain. Returns 404 when the filename does not belong to this user.Request
Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************or
Path Params
Responses
🟢200Success
application/json
Bodyapplication/json
🟠404Record not found
🟠400Bad Request
🟠401Authentication Required
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/technext/users/1001/avatar/5beca5a04b039508c4df4306c10040e2.webp' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Example 1
{
"filename": "string",
"filetype": "string",
"filesize-large-bytes": 0,
"filesize-small-bytes": 0,
"path": "string",
"path-small": "string",
"path-large": "string",
"created-datetime": "string",
"user": "1000",
"domain": "example.com"
}Modified at 2026-07-28 22:44:33