Skip to content

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
TypeHTTP (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.

Typeboolean
defaultfalse
limit

Number of results to return.

Typeinteger
default10
maximum100
minimum1
vendored

If true, return vendored campaigns created by the system.

Typeboolean
defaultfalse
configAt

Get the config at a given point in time.

Responses

Successful Response
application/json
JSON
{
"campaigns": [
{
"attacks": [
{
"converters": [
[
"base64",
"leetspeak",
"unicode_confusable",
"caesar",
"repeat_token",
"single_character"
]
],
"pack": "string",
"severity": 1,
"technique": "static_content",
"vector": "string"
}
],
"description": "string",
"id": "string",
"name": "string",
"orgId": "string",
"vendored": false
}
],
"next": "string",
"prev": "string"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Updated at: