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

Alianza End User API

The End User API from Alianza — 12 operation(s) for end user.

Alianza End User API is one of 60 APIs that Alianza publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include End User. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 16 operations across 12 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 2.

Requests are made against 4 base URLs: https://api.d2.alianza.com, https://api.q2.alianza.com, https://api.b2.alianza.com, https://api.alianza.com.

16 operations 12 paths 34 schemas 2 DELETE4 GET1 PATCH4 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2
Base URL
https://api.alianza.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Alianza End User API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-TOKEN (X-Auth-Token).

Paths & Operations 16

Across 12 paths, the API surfaces 16 operations — 2 DELETE, 4 GET, 1 PATCH, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

End User 16
GET
/v2/partition/{partitionId}/account/{accountId}/user
Get end user list
retrieveEndUserList 4 params → 200400404
POST
/v2/partition/{partitionId}/account/{accountId}/user
Create end user
createEndUser 3 params body → 200400404
GET
/v2/partition/{partitionId}/account/{accountId}/user/prevalidate/email/{email}
Prevalidate the end user's email address before saving the end user
prevalidateEmailAddress 5 params → 200400404
POST
/v2/partition/{partitionId}/account/{accountId}/user/activationdeprecated
End User activation
activation_1 3 params body → 200400404
GET
/v2/partition/{partitionId}/account/{accountId}/user/{userId}
Retrieve end user
retrieveEndUser 5 params → 200400404
PUT
/v2/partition/{partitionId}/account/{accountId}/user/{userId}
Update end user
updateEndUser 4 params body → 200400404
DELETE
/v2/partition/{partitionId}/account/{accountId}/user/{userId}
Delete end user
deleteEndUser 4 params → 400404
PATCH
/v2/partition/{partitionId}/account/{accountId}/user/{userId}
Update end user
patch_4 4 params body → 200400404
POST
/v2/partition/{partitionId}/account/{accountId}/user/{userId}/send-welcome-email
Send welcome email to user
sendWelcomeEmail 4 params → 404
PUT
/v2/partition/{partitionId}/account/{accountId}/user/{userId}/callingplanproduct/{callingPlanProductId}deprecated
Change Calling Plan
changeCallingPlan_1 5 params → 200
POST
/v2/partition/{partitionId}/account/{accountId}/user/{userId}/callingplanswapdeprecated
Change Calling Plan Immediately
swapCallingPlan_1 4 params body → 200
DELETE
/v2/partition/{partitionId}/account/{accountId}/user/{userId}/cancelpendingcallingplandeprecated
Cancel Pending Callingplan
cancelPendingCallingPlan_1 4 params → 200
GET
/v2/partition/{partitionId}/account/{accountId}/user/{userId}/voicemail
Retrieve end user voicemail
getVoicemailData 4 params → 200400404
PUT
/v2/partition/{partitionId}/account/{accountId}/user/{userId}/unlockvm
Unlock end user voicemail
unlockVm 5 params → 200400404
PUT
/v2/partition/{partitionId}/account/{accountId}/user/{userId}/resetpassword
Reset end user password
resetPassword_2 4 params → 200400404
PUT
/v2/partition/{partitionId}/account/{accountId}/user/{userId}/repurpose
Repurpose an existing user to be a different user (end user swap)
repurposeEndUser 4 params body → 200400404

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are EndUserV2X (30 properties), PortX (26 properties), LatLongCustomerServiceRecordX (23 properties), TelephoneNumberAccountV2X (22 properties). Each schema is shown below with its type and property counts.

ScheduleX
object
4 properties
E911AddressX
object
21 properties
MediaFriendsX
object
3 properties
RingPhoneCallHandlingX
object
3 properties
DeviceX
object
17 properties 7 required
SimultaneousRingCallHandlingX
object
2 properties
CallHandlingWithTimeoutX
object
4 properties
ReassignEndUserX
object
5 properties
LatLongCustomerServiceRecordX
object
23 properties
CustomerServiceRecordX
object
21 properties
WeeklyScheduleX
object
2 properties
VoicemailMessageX
object
18 properties
CallScreeningSettingsX
object
8 properties
UserGroupX
object
3 properties
TnData
object
3 properties
CallerIdConfigX
object
4 properties 3 required
EndUserActivationV2X
object
6 properties
FindMeEndpointX
object
4 properties
CallHandlingSettingsX
object
8 properties
DynamicTelephoneNumberActivationX
object
15 properties
AddressX
object
17 properties
CallHandlingScheduleX
object
2 properties
CallingPlanX
object
8 properties
TelecomSettingsX
object
8 properties
TelephoneNumberAccountV2X
object
22 properties
CustomCallScreenX
object
3 properties
CallHandlingX
object
3 properties
DirectoryListingX
object
3 properties
PortX
object
26 properties
EndUserV2X
object
30 properties 1 required
TelephoneNumberAccountBareX
object
10 properties
CustomScheduleX
object
3 properties
CallingPlanSwapX
object
2 properties
FindMeFollowMeCallHandlingX
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alianza-end-user-api-openapi.yml Raw ↑

Other APIs Alianza publishes across the network.

Alianza Account API
Alianza Account Device API
Alianza Account Device Line API
Alianza Account Prevalidate API
Alianza Account User API
Alianza Address API
Alianza Asynchronous JOB Tracker API
Alianza Authorize API
Alianza Brand Settings API
Alianza Bulk Operation Collection API
Alianza Bulk Operation Job API
Alianza Business Line API
Where this information came from

This is an independent, third-party profile of Alianza End User 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.