Get personal addresses
GET {{baseUrl}}/api/subscriptions/recipients/personalAddresses?deliveryType=EMAIL
Get a list of personal addresses for a specific delivery type. Currently we only support EMAIL, FILE, FTP and PRINTER delivery types. This endpoint returns the address name, address ID, physical address and other information of the current user's personal addresses. You obtain the authorization token needed to execute the request using POST /auth/login. You pass the authorization token in the request header. You retrieve the personal addresses by specifying delivery type in the path of the request.
Body
PARAM
| Key | Datatype | Required | Description |
deliveryType
|
string | (Required) Delivery Type, supported delivery types are: EMAIL, FILE, FTP, PRINTER | |
fields
|
null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token |
RESPONSES
status OK
| {
"personalAddresses": [
{
"id": "F2D90E56444C4DCCA113FF9B4BCDC14B",
"name": "Gmail",
"address": "xduatwork@gmail.com",
"deliveryMode": "EMAIL",
"deviceId": "1D2E6D168A7711D4BE8100B0D04B6F0B",
"isDefault": true
}
]
} |
ENDPOINTS