Logo
MicroStrategy REST API API Documentation

List Transmitters

GET {{baseUrl}}/api/transmitters

Get a list of all transmitters that the authenticated user has access to. This endpoint returns the name, ID, and other information about transmitters. You obtain the authorization token needed to execute the request using POST /auth/login. You pass the authorization token in the request header.

 

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

{ "transmitters": [ { "name": "Email", "id": "C35E4F47777A11D4BE6C00B0D04B6F0B", "description": "Transmits email messages via SMTP", "deliveryType": "email", "emailTransmitterProperties": { "senderDisplayName": "MicroStrategy Distribution Services", "senderEmailAddress": "DistributionServices@MicroStrategy.com", "replyToDisplayName": "MicroStrategy Distribution Services", "replyToEmailAddress": "DistributionServices@MicroStrategy.com", "recipientFieldType": "to", "saveMessageToFile": true, "sendMessageViaSmtp": false, "saveFilePath": "", "notifyOnSuccess": false, "notifyOnFailure": false, "notificationEmailAddress": "" } }, { "name": "File", "id": "892AF97969B94385AC476763F32140BF", "description": "Transmits files to networked computers and servers", "deliveryType": "file" } ] }



Curl
curl -X GET 'baseUrl/api/transmitters?fields=' -H 'X-MSTR-AuthToken: authToken'

ENDPOINTS