MicroStrategy REST API API Documentation
Get contact by ID
GET {{baseUrl}}/api/contacts/:id
Get information of a specific contact by its ID.This endpoint returns the name, ID, linked user, contact addresses and other information about the given contact.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 contact ID using GET /contacts.You pass the contact 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
| {
"name": "New contact",
"id": "6544F8020A8E4F5982D656373130CF3C",
"description": "contact description",
"enabled": true,
"linkedUser": {
"name": "San Francisco Manager",
"id": "B6CC2CA24D83B68D80BFB4A86832FC0D"
},
"contactAddresses": [
{
"name": "Music Manager (San Francisco)",
"id": "E20BE97B874D389A4B7D7BA0F3F36348",
"physicalAddress": "sfo_music@yourorganization.com",
"deliveryType": "email",
"deviceId": "1D2E6D168A7711D4BE8100B0D04B6F0B",
"deviceName": "Generic email",
"isDefault": true
}
],
"memberships": []
} |
Curl
curl -X GET 'baseUrl/api/contacts/:id?fields=' -H 'X-MSTR-AuthToken: authToken'
ENDPOINTS