List training campaigns

POST

/training/campaigns

Query and filter training campaigns.

Request

Authorization

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Successful operation

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location '/training/campaigns' \
--header 'Content-Type: application/json' \
--data '{
    "distinct_count": "string",
    "distinct_on": "host_name",
    "include_total_count": true,
    "limit": 10,
    "offset": 0,
    "query": "name='\''WINPC-4291'\'' AND status IN ('\''active'\'', '\''pending'\'')",
    "sort": "name desc, id"
}'

Response Example

{
    "distinct_values": [
        {
            "count": 0,
            "value": null
        }
    ],
    "pagination": {
        "count": 0,
        "total_count": 1000
    },
    "items": [
        {
            "configuration": {
                "notification": {
                    "delivery_methods": [
                        "slack"
                    ],
                    "message": "You've been assigned a training."
                },
                "target": {
                    "excluded_groups": [
                        "8CA67511-744C-4D74-B26E-7281CF88712F"
                    ],
                    "excluded_people": [
                        "joe.user@example.com"
                    ],
                    "included_groups": [
                        "8CA67511-744C-4D74-B26E-7281CF88712F"
                    ],
                    "included_people": [
                        "joe.user@example.com"
                    ]
                }
            },
            "end_date": "2021-01-01T00:00:00Z",
            "id": "8CA67511-744C-4D74-B26E-7281CF88712F",
            "name": "Campaign 1",
            "start_date": "2021-01-01T00:00:00Z"
        }
    ]
}

Modified at 2026-07-24 15:31:52

Get a Shadow AI instance by id

Create a training campaign