API Guide

Get Alias(es)

This API call provides a broad overview of alias(es) tied to an account. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: GET

Endpoint URL:


Sample Output:

        "alias_id": 1,
        "firstname": "First",
        "lastname": "User",
        "email": "firstuser@domain.com",
        "forcepasswordreset": 0
        "alias_id": 2,
        "firstname": "Second",
        "lastname": "User",
        "email": "seconduser@domain.com",
        "forcepasswordreset": 1


Parameter Description Acceptable Values Required
alias_id The unique identifier of the alias. Integer N

Error Responses

Description Code Cause
NULL 401 Your API key does not have sufficient permission to access this endpoint.