Get campaigns.

GET

/backend/v1/campaigns

Retrieves a list of campaigns that match the given criteria,
with the option to adjust the limit for more results.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Query Parameters

cursor

Selects page for paginated results. Pass in the next or prev attribute in the response

ascending

Whether results should be sorted in ascending order.

Type

boolean

Default

false

limit

Number of results to return.

Type

integer

Default

10

Maximum

100

Minimum

1

vendored

If true, return vendored campaigns created by the system.

Type

boolean

Default

false

attackTechnique

Filter by campaigns that include an attack of these types

before

Only return campaigns created before this timestamp.

after

Only return campaigns created after this timestamp.

lastRunBefore

Only return campaigns that last ran before this timestamp.

lastRunAfter

Only return campaigns that last ran after this timestamp.

sortBy

Sort results by the given parameter.

Default

"created_at"

includeUsers

Include users

Type

boolean

Default

false

Responses

Successful Response

Content-Type

application/json

"string"

GET

/backend/v1/campaigns

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

cursor

ascending

limit

vendored

attackTechnique

before

after

lastRunBefore

lastRunAfter

sortBy

includeUsers

Samples

Powered by VitePress OpenAPI