Skip to main content
GET
Get security awareness summary

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

companyId
string<uuid>
required

Company whose posture to fetch

provider
enum<string>
default:all
Available options:
all,
phin,
bsn,
huntress,
cyberhoot,
phished
maxUsers
integer
default:25

Most high-risk or incomplete users to return

Required range: 1 <= x <= 100

Response

Security awareness summary

data
object
required

Metrics a provider does not supply are null, never zero.