Skip to main content
GET
/
v1
/
assessment-groups
/
{assessmentGroupId}
/
members
List members of an Assessment Group
curl --request GET \
  --url https://client.synack.com/api/assessment/v1/assessment-groups/{assessmentGroupId}/members \
  --header 'Authorization: Bearer <token>'
{
  "members": [
    {
      "userUid": "<string>",
      "id": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "userEmail": "jsmith@example.com",
      "userName": "<string>"
    }
  ],
  "metadata": {
    "pagination": {
      "total": 1,
      "page": 2,
      "perPage": 2,
      "totalPages": 1,
      "self": "<string>",
      "prev": "<string>",
      "next": "<string>",
      "first": "<string>",
      "last": "<string>"
    },
    "actions": [
      {}
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
assessmentGroupId
integer
required

Numeric identifier of the Assessment Group.

Required range: x >= 1

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
perPage
integer
default:50
Required range: 1 <= x <= 200
​
sort
enum<string>
default:createdAt

Field to sort by.

Available options:
createdAt,
role,
userUid
​
sortDir
enum<string>
default:asc
Available options:
asc,
desc
​
role
enum<string>

Filter members by role. Strongbolt role granted to (or held by) an Assessment Group member. Mirrors CLIENT_VISIBLE_ROLES_ASSIGNABLE_TO_ORG_LISTING_GROUP in synack_synack's strongbolt initializer.

Available options:
rbac_group_admin,
assessment_member,
assessment_creator,
assessment_read_only,
assessment_operator,
infra_admin

Response

Member collection (may be empty).

​
members
object[]
required
​
metadata
object
required