Skip to main content
GET
/
v2
/
tasks
Search for missions.
curl --request GET \
  --url https://client.synack.com/api/tasks/v2/tasks \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "description": "<string>",
    "taskTemplateUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "taskTemplateCredits": 123,
    "campaignUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "campaignName": "<string>",
    "listingUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "listingCodename": "<string>",
    "organizationUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationCodename": "<string>",
    "status": "APPROVED",
    "attachments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "description": "<string>",
        "originalFilename": "<string>",
        "data": "<string>",
        "thumbnailData": "<string>",
        "sizeInBytes": 123,
        "groupId": "<string>",
        "position": 123,
        "createdOn": "2023-12-25",
        "createdBy": "<string>",
        "modifiedOn": "2023-12-25",
        "modifiedBy": "<string>",
        "deletedOn": "2023-12-25",
        "version": 123,
        "mimeType": "<string>"
      }
    ],
    "hasBeenViewed": true,
    "payout": "<unknown>",
    "credits": 123,
    "assetTypes": [
      "<string>"
    ],
    "attackTypes": [
      "<string>"
    ],
    "sv": [
      "<string>"
    ],
    "cwe": [
      "<string>"
    ],
    "categories": [
      "<string>"
    ],
    "taskType": "<string>",
    "attempts": 123,
    "batchId": "<string>",
    "controlFamily": "<string>",
    "definitionId": "<string>",
    "definitionName": "<string>",
    "fismaLow": "<string>",
    "fismaModerate": "<string>",
    "fismaHigh": "<string>",
    "taskGroup": "<string>",
    "response": "<string>",
    "structuredResponse": "<string>",
    "position": 123,
    "createdOn": "2023-12-25",
    "modifiedOn": "2023-12-25",
    "maxCompletionTimeInSecs": 123,
    "pausedDurationInSecs": 123,
    "version": 123,
    "validResponses": [
      {
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "publishedOn": "2023-12-25",
    "claimedOn": "2023-12-25",
    "completedOn": "2023-12-25",
    "validatedOn": "2023-12-25",
    "reviewedOn": "2023-12-25",
    "pausedOn": "2023-12-25",
    "deactivatedOn": "2023-12-25",
    "invalidatedOn": "2023-12-25",
    "returnedForEditOn": "2023-12-25",
    "canEditResponse": true,
    "isAssigneeCurrentUser": true,
    "assignedBySynackUser": true
  }
]

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.

Available options:
PUBLISHED,
TITLE,
STATUS,
CAMPAIGNTITLE,
AMOUNT,
SUBMITTED,
RESULT,
ASSET,
CLAIMED,
SYN_CATEGORIES,
CATEGORIES
​
sortDir
enum<string>[]

Sort direction.

Available options:
asc,
desc
​
approvedStartDate
string<date>

Filter by approved date (this value can be sent alone to the query). If both approved start and end date are provided, it is required for startDate < endDate.

​
approvedEndDate
string<date>

Filter by approved date (this value can be sent alone to the query). If both approved start and end date are provided, it is required for startDate < endDate.

​
assetTypes
string[]

Filter by asset types.

​
attackTypes
string[]

Filter by attack types.

​
categories
string[]

Filter by categories.

​
cwe
string[]

Filter by CWEs.

​
Uids
string[]

Filter by tasks UIDs.

​
orgUids
string<uuid>[]

Filter by organization UIDs.

​
listingUids
string<uuid>[]

Filter by listing UIDs.

​
status
enum<string>[]

Filter by task status.

Task status enum.

Available options:
APPROVED,
CLAIMED,
CREATED,
COMPLETED,
FOR_REVIEW,
PUBLISHED
​
sv
string

Filter by tasks SV.

​
assignee
string

Filter by user assignee to the tasks.

​
campaignUid
string

Filter by campaign UID.

​
deactivated
boolean

Filter by activated/deactivated tasks and campaigns.

​
deactivatedTasks
boolean

Filter by activated/deactivated tasks only - no impact from campaigns.

​
attachments
boolean

Include attachments for the tasks in the response. By default is false.

​
viewed
boolean

Include the viewed field in the response. By default is false.

​
q
string

Query used to perform a full text search on task's title, description or scope.

​
taskTemplateUid
string

Filter by task template UID.

​
definitionId
string

Filter by definition ID.

​
batchId
string

Filter by batch ID.

​
taskGroup
string

Filter by task group.

​
structuredResponse
string

Filter by task structured response.

​
taskTypes
string[]

Filter task types, case insensitively. Currently accepted values are: "MISSION", "SV2M" and "TAAS".

​
includeAssignedBySynackUser
boolean

Return whether the task was assigned to the researcher by a boss user.

​
includeTaskTemplateCredits
boolean

Return the task template credits for the task.

Response

Successful operation.

​
id
string<uuid>
​
title
string
​
description
string
​
taskTemplateUid
string<uuid>
​
taskTemplateCredits
integer
​
campaignUid
string<uuid>
​
campaignName
string
​
listingUid
string<uuid>
​
listingCodename
string
​
organizationUid
string<uuid>
​
organizationCodename
string
​
status
enum<string>

Task status enum.

Available options:
APPROVED,
CLAIMED,
CREATED,
COMPLETED,
FOR_REVIEW,
PUBLISHED
​
attachments
object[]
​
hasBeenViewed
boolean
​
payout
any
​
credits
integer
​
assetTypes
string[]
​
attackTypes
string[]
​
sv
string[]
​
cwe
string[]
​
categories
string[]
​
taskType
string
​
attempts
integer
​
batchId
string
​
controlFamily
string
​
definitionId
string
​
definitionName
string
​
fismaLow
string
​
fismaModerate
string
​
fismaHigh
string
​
taskGroup
string
​
response
string

It will only be seen by:

  • Users with Client role (only if the task is in APPROVED status).
​
structuredResponse
string

It will only be seen by:

  • Users with Client role (only if the task is in APPROVED status).
​
position
integer
​
createdOn
string<date>
​
modifiedOn
string<date>
​
maxCompletionTimeInSecs
integer
​
pausedDurationInSecs
integer
​
version
integer
​
validResponses
object[]
​
publishedOn
string<date>
​
claimedOn
string<date>
​
completedOn
string<date>
​
validatedOn
string<date>
​
reviewedOn
string<date>
​
pausedOn
string<date>
​
deactivatedOn
string<date>
​
invalidatedOn
string<date>
​
returnedForEditOn
string<date>
​
canEditResponse
boolean
​
isAssigneeCurrentUser
boolean
​
assignedBySynackUser
boolean

Whether this task was assigned to a researcher by a boss user or not. Only available to researcher users when specifying 'includeAssignedBySynackUser=true' in the query string.