Skip to main content
GET
/
v1
/
assessments
Get assessments (V1)
curl --request GET \
  --url https://api.synack.com/v1/assessments \
  --header 'Authorization: Bearer <token>'
[
  {
    "uid": "assessmentuid921",
    "name": "My Security Assessment",
    "createdAt": "2023-11-07T05:31:56Z",
    "type": "Web",
    "testCounts": {
      "pending": 1,
      "scheduled": 1,
      "active": 1,
      "paused": 1,
      "completed": 1
    },
    "vulnerabilityCount": 13,
    "description": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "tags": [
      {
        "id": 123,
        "name": "<string>",
        "editable": true,
        "organization_profile_id": 123
      }
    ],
    "ownerContacts": [
      {
        "id": 123,
        "name": "<string>",
        "email": "<string>"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
assessment_group_id
integer

Filter by assessment group ID

Response

Assessments retrieved successfully

​
uid
string
required
Example:

"assessmentuid921"

​
name
string
required
Example:

"My Security Assessment"

​
createdAt
string<date-time>
required
​
type
enum<string>
required
Available options:
web,
host,
api,
mobile
Example:

"Web"

​
testCounts
object
required
​
vulnerabilityCount
integer
required
Required range: x >= 0
Example:

13

​
description
string
​
updatedAt
string<date-time>
​
tags
object[]
​
ownerContacts
object[]