MicroStrategy REST API API Documentation
List all contact groups
GET {{baseUrl}}/api/contactGroups
Get a list of all contact groups that the authenticated user has access to.This endpoint returns the name, ID, linked user, contact members and other information about contact groups.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 |
offset
|
number | Starting point within the collection of returned results. Used to control paging behavior. | |
limit
|
number | Maximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit. | |
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
| {
"contactGroups": [
{
"name": "San Francisco - Category Managers",
"id": "D0153F224A740B2CB716CF9AF1FF7B00",
"description": "This contact group includes all Category Managers for San Francisco.",
"enabled": true,
"linkedUser": {
"name": "San Francisco Manager",
"id": "B6CC2CA24D83B68D80BFB4A86832FC0D"
},
"members": [
{
"name": "San Francisco Music Manager",
&quo Curl curl -X GET 'baseUrl/api/contactGroups?offset=0&limit=-1&fields=' -H 'X-MSTR-AuthToken: authToken' ENDPOINTS |