List campaigns

Lists the campaigns for a workspace with its cycles, sorted by their creation date in descending order (most recent entries first). A campaign cycle forms a group of attacks sent at a period of time. Periods of two cycles can't overlap. Recurring campaigns usually have multiple cycles, whereas one-off campaigns usually have only one.

Scopes required:

simulation:read

get/v1/campaigns

Request

Base URL: https://public-api.tryriot.com
URL: https://public-api.tryriot.com/v1/campaigns
Auth: API key in header x-api-key

Query parameters

cursorstring

Pagination cursor for retrieving the next page of results. This value is obtained from the 'x-next-cursor' response header of a previous API call. The cursor should be passed unchanged to fetch next pages. See https://docs.tryriot.com/api-reference/introduction#pagination for examples.

limitinteger

Maximum number of items to return. Maximum value is 100.

workspace_idstring uuid required

ID of the workspace for which to retrieve campaigns

statusCampaignStatusSchema[]

Filters campaigns based on their status. Accepts a comma-separated string of status values. Only campaigns matching the specified statuses will be included in the response.

created_afterstring date-time

Filters campaigns based on their creation date. Only campaigns created after specified date (UTC) will be included in the response.

created_beforestring date-time

Filters campaigns based on their creation date. Only campaigns created before specified date (UTC) will be included in the response.

Headers

x-item-limitinteger

Maximum number of items to return. Maximum value is 100.

x-next-cursorstring

Response

Campaigns list

Example response

{
  "data": [
    {
      "cycles": [
        {
          "name": "Batch 1"
        }
      ],
      "name": "One-off campaign on 5 employees"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.