Skip to content

List the advisory contacts

View .md
GET
/projects/{projectId}/advisory-contacts
curl --request GET \
--url 'https://zkao.io/api/v1/projects/example/advisory-contacts?page=1&limit=50&tier=EMBARGO&status=ACTIVE' \
--header 'Authorization: Bearer <token>'

Requires scope: contacts:read. The programme’s contact list, oldest first, which is the order to read it in when reconciling against a record kept elsewhere.

Its own scope, not read: this list is other people’s work addresses and the record of who learns about a vulnerability before the public does, so a routine pipeline token does not reach it.

software on each row is what notices are matched on. A project with no security programme reads as an empty list.

projectId
required
string
page
integer
default: 1 >= 1
limit
integer
default: 50 >= 1 <= 100
tier
string
Allowed values: EMBARGO DOWNSTREAM ANNOUNCE
status
string
Allowed values: ACTIVE PENDING_VERIFICATION BOUNCED UNSUBSCRIBED

OK

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
email
required
string
organization
required
string
tier
required
string
status
required

PENDING_VERIFICATION until the contact confirms the address. An unconfirmed address receives nothing embargoed.

string
software
required

The software this contact runs, which notices are matched on.

Array<object>
object
owner
required
string
name
required
string
createdAt
required
string format: date-time
page
required
integer
limit
required
integer
total
required
integer
Examplegenerated
{
"items": [
{
"id": "example",
"email": "example",
"organization": "example",
"tier": "example",
"status": "example",
"software": [
{
"owner": "example",
"name": "example"
}
],
"createdAt": "2026-04-15T12:00:00Z"
}
],
"page": 1,
"limit": 1,
"total": 1
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

integer
Example
{
"error": {
"code": "unauthorized"
}
}

Missing, malformed, expired, or revoked token

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

integer
Example
{
"error": {
"code": "unauthorized"
}
}

The token lacks the required scope

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

integer
Example
{
"error": {
"code": "unauthorized"
}
}