MicroStrategy REST API API Documentation
Get addresses for a specific user
GET {{baseUrl}}/api/v2/users/:userId/addresses
Get all of the addresses for a specific user. This endpoint returns the name, ID, and other information about user 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 obtain the user ID using GET /users. You pass the user ID in the path of the request.
Body
PARAM
| Key | Datatype | Required | Description |
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
| {
"addresses": [
{
"id": "5D6CB3D0364CB1A9F6229BBDA56924D2",
"name": "Test Address",
"physicalAddress": "test3@example.com",
"deliveryType": "email",
"deviceId": "1D2E6D168A7711D4BE8100B0D04B6F0B",
"deviceName": "Generic email",
"isDefault": false
},
{
"id": "89ECAC003543CA0BE81E2B83DFB78A09",
"name": "Test Address",
"physicalAddress": "test1@example.com",
"deliveryType": "email",
"deviceId": "1D2E6D168A7711D4BE8100B0D04B6F0B",
"deviceName": "Generic email",
"isDefault": false
},
{
"id": "3ABD0B5A614B5FB32743C299D0DD65AD",
"name": "Test Address",
"physicalAddress": "test2@example.com",
"deliveryType": "email",
"deviceId": "1D2E6D168A7711D4BE8100B0D04B6F0B",
"deviceName": "Generic email",
"isDefault": false
},
{
"id": "E617028C5B4541EE713CC9B7179EE2A0",
"name": "Test Address",
"physicalAddress": "test@example.com",
"deliveryType": "email",
"deviceId": "1D2E6D168A7711D4BE8100B0D04B6F0B",
"deviceName": "Generic email",
"isDefault": true
}
]
} |
Curl
curl -X GET 'baseUrl/api/v2/users/:userId/addresses?fields=' -H 'X-MSTR-AuthToken: authToken'
ENDPOINTS