Skip to main content
GET
/
v2
/
campaigns
Search for Group of Missions.
curl --request GET \
  --url https://client.synack.com/api/tasks/v2/campaigns/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "listingUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "listingCodename": "<string>",
    "listingName": "<string>",
    "organizationUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationName": "<string>",
    "organizationCodename": "<string>",
    "status": "CREATED",
    "published": "2023-12-25",
    "completed": "2023-12-25",
    "tasksCompleted": 123,
    "tasksTotal": 123,
    "tasksPassed": 123,
    "tasksFailed": 123,
    "tasksPublishedWaiting": 123,
    "isRetestable": true,
    "parentUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deactivated": "2023-12-25",
    "createdOn": "2023-12-25",
    "createdByRole": "<string>",
    "creditsDeducted": 123,
    "catalogCategory": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:1

Page to start showing results from.

Required range: x >= 1
​
perPage
integer
default:1

Number of items to show per page.

Required range: x >= 1
​
sort
enum<string>[]

Sorts by field names. If sorting is done on "TASKSFAILED" then it will set includeTaskStats to true.

Available options:
PUBLISHED,
TASKSFAILED,
CREATED,
STATUSCREATED,
COMPLETED
​
sortDir
enum<string>[]

Sort direction.

Available options:
asc,
desc
​
q
string

Search by campaign's title, description or scope

​
createdByRole
string

Filter campaigns by created_role

​
orgUids
string<uuid>[]

Filter by organization UIDs.

​
listingUids
string<uuid>[]

Filter by listing UIDs.

​
status
enum<string>[]

Filter by Campaign Status.

Campaign status enum.

Available options:
CREATED,
COMPLETED,
PUBLISHED
​
listingType
string[]

Filter by listing types. Search is performed on the campaign's tags.

​
includeTaskStats
boolean
default:false

If this set to true, then additional tasks stats fields will be set for each campaign in the response which include:

  • tasksTotal
  • tasksCompleted
  • tasksPassed
  • tasksFailed
​
includeCatalogCategory
boolean
default:false

If set to true, then the CampaignCatalog that each Campaign belongs to will be included in the response.

​
includePublishedWaiting
boolean
default:false

If this is set to true, then additional tasksPublishedWaiting field will be set for each campaign in the response, which contains the count of missions that have been in PUBLISHED state for more than 30 minutes.

​
publishedStartDate
string<date>

It is possible this value alone to the query. If both published start and end date are provided, it is required for startDate < endDate.

​
publishedEndDate
string<date>

It is possible this value alone to the query. If both published start and end date are provided, it is required for startDate < endDate.

​
deactivated
boolean

Filter by activated/deactivated campaigns.

​
creditsDeducted
boolean
default:false

Whether to return deducted credits.

Response

Successful operation.

​
id
string<uuid>
​
title
string
​
listingUid
string<uuid>
​
listingCodename
string
​
listingName
string
​
organizationUid
string<uuid>
​
organizationName
string
​
organizationCodename
string
​
status
enum<string>

Campaign status enum.

Available options:
CREATED,
COMPLETED,
PUBLISHED
​
published
string<date> | null
​
completed
string<date> | null
​
tasksCompleted
integer
​
tasksTotal
integer
​
tasksPassed
integer
​
tasksFailed
integer
​
tasksPublishedWaiting
integer

Count of missions that have been in PUBLISHED state for more than 30 minutes.

​
isRetestable
boolean

This flag will be set to true if these conditions are met:

  • The campaign is completed.
  • The campaign is not a retest (parentUid is NULL).
  • The campaign's listing has the boss active flag set to true.
  • The campaign's listing has active tests.
  • The campaign's listing is not paused by the client.
​
parentUid
string<uuid> | null
​
deactivated
string<date> | null
​
createdOn
string<date> | null
​
createdByRole
string | null
​
creditsDeducted
integer | null
​
catalogCategory
object

The CatalogCategory which this Campaign belongs to (via CampaignTemplate).