Skip to content
Arsen API Documentation

List all campaigns

GET
/v1/campaigns

Returns a list of campaigns previously created. The campaigns are returned in sorted order, with the most recent appearing first.

Parameters

Query Parameters

select
string format: select=field,field
default: All fields
Allowed values: name status score scenarios targetCount createdAt scheduledAt completedAt abortedAt 
select=name,status

Comma-separated list of fields to include in the response. Field ID is always selected

filter

Fields to filter results, separated by & and operator separated by :. Fields can be repeated to filter by multiple values

object
field
string
Allowed values: status score targetCount createdAt scheduledAt completedAt abortedAt
operator
string
Allowed values: $eq $ne $gt $lt $gte $lte
value
string
filter[score]=$gt:60&filter[status]=$eq:completed
sort
string format: sort[field]=direction
Allowed values: name status score targetCount createdAt scheduledAt completedAt abortedAt 
sort[name]=desc

Fields to sort result, separated by &. Direction can be asc or desc

page
number
default: 1 
page=2

Page number to retrieve

limit
number
default: 100 
limit=10

Number of item per page

Responses

200

object
status
required
string
Allowed values: success
pagination
required
object
data
required
object
campaigns
required
Array<object>
object
id
required
string
name
string
status

The campaign is first scheduled. The campaign is running when the phishing simulation starts. When the simulation is completed, the campaign is completed.

string
Allowed values: scheduled completed aborted
targetCount
number
scenarios
Array<object>
object
id
string
name
string
score

The computed score of all targets in the campaign. Null if the campaign is not completed.

number
nullable <= 100
createdAt
string format: date-time
scheduledAt

The date and time the campaign is scheduled to start.

string format: date-time
completedAt

The date and time the campaign is completed. Null if the campaign is not completed.

string format: date-time
nullable
abortedAt

The date and time the campaign is aborted. Null if the campaign is not aborted.

string format: date-time
nullable

400

Bad request

object
error
string
statusCode
required
number

401

Unauthorized

object
message
required
string
statusCode
required
number

408

Request timeout

object
message
required
string
statusCode
required
number

429

Too many requests

object
message
required
string
statusCode
required
number

500

Internal server error

object
message
required
string
statusCode
required
number