List events
GET {{baseUrl}}/api/events
Get a list of all events that the authenticated user has access to. This endpoint returns the name, ID, and other information about events. 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
{
"events": [
{
"name": "Books Closed",
"id": "46DD16B543213B52372B5FB732FB611A",
"description": "",
"acg": 255
},
{
"name": "Database Load",
"id": "66E860724E8E124E07E658A36ACAEC9B",
"description": "",
"acg": 255
}
]
} |
ENDPOINTS