MicroStrategy REST API API Documentation
Get Dynamic Recipient List by ID
GET {{baseUrl}}/api/dynamicRecipientLists/:id
Get information of a specific dynamic recipient list by its ID. This endpoint returns the name, ID, linked user, source report ID, project ID and other information about the given dynamic recipient list. 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 dynamic recipient list ID using GET /dynamicRecipientLists. You pass the dynamic recipient list 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 | |
X-MSTR-ProjectID
|
string | (Required) Project ID |
RESPONSES
status OK
| {
"name": "New dynamic address list",
"id": "4AEEA24C6E4089931F9C7DB574998705",
"description": "",
"sourceReportId": "993FBBBD5D401DEB7A7389B162B6618F",
"physicalAddress": {
"attributeId": "27614DEAFF40BECC2C60FAAFCE393AF5",
"attributeFormId": "45C11FA478E745FEA08D781CEA190FE5"
},
"linkedUser": {
"attributeId": "4FF474CD21491328DF59EC97F5DB61CA",
"attributeFormId": "45C11FA478E745FEA08D781CEA190FE5"
},
"device": {
"attributeId": "5ECA1D4EB446E268D00AD687785396DB",
"attributeFormId": "45C11FA478E745FEA08D781CEA190FE5"
},
"recipientName": {
"attributeId": "3A775CF38F4E6FD5904C5A8231D591FB",
"attributeFormId": "45C11FA478E745FEA08D781CEA190FE5"
},
"notificationAddress": {
"attributeId": "27614DEAFF40BECC2C60FAAFCE393AF5",
"attributeFormId": "45C11FA478E745FEA08D781CEA190FE5"
},
"notificationDevice": {
"attributeId": "5ECA1D4EB446E268D00AD687785396DB",
"attributeFormId": "45C11FA478E745FEA08D781CEA190FE5"
},
"personalization": {
"attributeId": "8C8EE328FB48E6811DD78BA38F8E8F42",
"attributeFormId": "45C1 Curl curl -X GET 'baseUrl/api/dynamicRecipientLists/:id?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' ENDPOINTS |