Skip to main content
GET
Endpoint for getting a report by report id

Path Parameters

report_id
string<uuid>
required

Query Parameters

with_files
boolean | null

If this is false, the related_files field will be empty.

Defaults to true.

Response

Report

id
string<uuid>
required
isPrivate
boolean
required
projectTitle
string
required
companyId
string<uuid>
required
companyHandle
string
required
clientName
string
required
engagementKind
enum<string>
required

Kind of [Engagement].

Available options:
spearbit_web3,
spearbit_web2,
spearbit_vciso,
cantina_managed,
cantina_guild,
cantina_solo,
public_competition,
private_competition,
public_bounty,
private_bounty
engagementStartDate
string<date-time>
required
engagementEndDate
string<date-time>
required
commitHashes
string[]
required
typeOfProject
string[]
required
teamMembers
object[]
required
findingStats
object[]
required
createdBy
string<uuid>
required
createdAt
string<date-time>
required
publishedAt
string<date-time>
required
seoTitle
string | null

Custom text for the TITLE tag when the report is viewed in a browser

seoDescription
string | null

Custom text for the META description tag when the report is viewed in a browser

description
string | null

Description of the report

clientWebsite
string | null
engagementId
string<uuid> | null
repositoryId
string<uuid> | null
guildId
string<uuid> | null
findings
object[]