Skip to main content
Comp AI - Documentation home page
Search...
⌘K
Ask AI
Support
Get started
Get started
Search...
Navigation
Frameworks
Get a single framework instance with full detail
Guides
Cloud Tests
Integrations
API
Join us on Discord
Auth
GET
Get current user info, organizations, and pending invitations
GET
List pending invitations for the organization
DEL
Revoke a pending invitation
Organization
GET
Get organization information
DEL
Delete organization
PATCH
Update organization
GET
Get v1organizationonboarding
POST
Transfer organization ownership
GET
Get role notification settings
PUT
Update role notification settings
GET
List active API keys
POST
Create a new API key
GET
Get available API key scopes
GET
Get organization primary color
POST
Upload organization logo
DEL
Remove organization logo
POST
Revoke an API key
People
GET
Get all people
POST
Create a new member
GET
Get all employee devices with fleet compliance data
GET
Get integration test statistics grouped by assignee
POST
Add multiple members to organization
GET
Get members who can read a specific resource type
GET
Get person by ID
DEL
Delete member
PATCH
Update member
GET
Get training video completions for a member
GET
Get fleet/device compliance for a member
DEL
Remove host (device) from Fleet
PATCH
Unlink device from member
GET
Get current user email notification preferences
PUT
Update current user email notification preferences
Risks
GET
Get all risks
POST
Create a new risk
GET
Get risk statistics grouped by assignee
GET
Get risk counts grouped by department
GET
Get risk by ID
DEL
Delete risk
PATCH
Update risk
Vendors
GET
Search global vendors database
GET
Get all vendors
POST
Create a new vendor
GET
Get vendor by ID
DEL
Delete vendor
PATCH
Update vendor
POST
Trigger vendor risk assessment
Internal - Vendors
POST
Trigger vendor risk assessment tasks for a batch of vendors (internal)
POST
Trigger vendor risk assessment for a single vendor and return run info (internal)
Context
GET
Get all context entries
POST
Create a new context entry
GET
Get context entry by ID
DEL
Delete context entry
PATCH
Update context entry
Devices
GET
Get all devices
GET
Get devices by member ID
Policies
GET
Get all policies
POST
Create a new policy
POST
Publish all draft policies
GET
Download all published policies as a single PDF
GET
Get mapped and all controls for a policy
POST
Map controls to a policy
POST
Regenerate policy content using AI
GET
Get a signed URL for the policy PDF
POST
Upload a PDF to a policy or version
DEL
Delete a policy PDF
GET
Get signed URL for policy PDF (alternate path)
DEL
Remove a control mapping from a policy
GET
Get policy by ID
DEL
Delete policy
PATCH
Update policy
GET
Get policy versions
POST
Create policy version
GET
Get policy version by ID
DEL
Delete policy version
PATCH
Update version content
POST
Publish new policy version
POST
Set active policy version
POST
Submit version for approval
POST
Accept pending policy changes and publish the version
POST
Deny pending policy changes
POST
Chat with AI about a policy
Attachments
GET
Get attachment download URL
Device Agent
GET
Download macOS Device Agent
GET
Download Windows Device Agent ZIP
Tasks
GET
Get all tasks
POST
Create a task
DEL
Delete multiple tasks
PATCH
Update status for multiple tasks
PATCH
Update assignee for multiple tasks
PATCH
Reorder tasks
POST
Bulk submit tasks for review
GET
Get page options for tasks overview
GET
Get task by ID
DEL
Delete a task
PATCH
Update a task
GET
Get task activity
POST
Regenerate task from template
POST
Submit task for review
POST
Approve a task
POST
Reject a task review
GET
Get task attachments
POST
Upload attachment to task
GET
Get attachment download URL
DEL
Delete task attachment
Task Automations
GET
Get all automations for a task
POST
Create a new evidence automation
GET
Get automation details
DEL
Delete an automation
PATCH
Update an existing automation
GET
Get all runs for a specific automation
GET
Get all versions for an automation
POST
Create a published version record for an automation
GET
Get all automation runs for a task
Evidence Export
GET
Get task evidence summary
GET
Export automation evidence as PDF
GET
Export task evidence as ZIP
Evidence Export (Auditor)
GET
Export all organization evidence as ZIP (Auditor only)
Comments
GET
Get comments for an entity
POST
Create a new comment
PUT
Update a comment
DEL
Delete a comment
Health
GET
Health check
Trust Portal
GET
Get complete trust portal settings for admin page
POST
Upload a favicon for the trust portal
DEL
Remove the trust portal favicon
GET
Get domain verification status
POST
Upload or replace a compliance certificate (PDF only)
POST
Generate a temporary signed URL for a compliance certificate
POST
List uploaded compliance certificates for the organization
POST
Upload an additional trust portal document
POST
List additional trust portal documents for the organization
POST
Generate a temporary signed URL for a trust portal document
POST
Delete (deactivate) a trust portal document
PUT
Enable or disable the trust portal
POST
Add or update a custom domain for the trust portal
POST
Check DNS records for a custom domain
PUT
Update trust portal FAQs
PUT
Update allowed domains for the trust portal
PUT
Update trust portal framework settings
GET
Get trust portal overview
POST
Update trust portal overview section
GET
List custom links for trust portal
POST
Create a custom link for trust portal
POST
Update a custom link
POST
Delete a custom link
POST
Reorder custom links
POST
Update vendor trust portal settings
GET
List vendors configured for trust portal
Trust Access
POST
Submit data access request
GET
List access requests
GET
Get access request details
POST
Approve access request
POST
Deny access request
GET
List access grants
POST
Revoke access grant
POST
Resend access granted email
GET
Get NDA details by token
POST
Preview NDA by token
POST
Sign NDA
POST
Resend NDA email
POST
Preview NDA PDF
POST
Reclaim access
GET
Get grant data by access token
GET
List policies by access token
GET
Download all policies as watermarked PDF
GET
Download all policies as ZIP with individual PDFs
GET
List compliance resources by access token
GET
List additional documents by access token
GET
Download all additional documents as a ZIP by access token
GET
Download additional document by access token
GET
Download compliance resource by access token
GET
Get FAQs for a trust portal
GET
Get overview section for a trust portal
GET
Get custom links for a trust portal
GET
Get favicon URL for a trust portal
GET
Get vendors/subprocessors for a trust portal
Framework Editor Task Templates
GET
Get all framework editor task templates
GET
Get framework editor task template by ID
DEL
Delete framework editor task template
PATCH
Update framework editor task template
Finding Templates
GET
Get all finding templates
POST
Create a finding template
GET
Get finding template by ID
DEL
Delete a finding template
PATCH
Update a finding template
Findings
GET
Get findings for a task
POST
Create a finding
GET
Get all findings for organization
GET
Get finding by ID
DEL
Delete a finding
PATCH
Update a finding
GET
Get finding history
Questionnaire
GET
Get v1questionnaire
GET
Get v1questionnaire 1
DEL
Delete v1questionnaire
POST
Post v1questionnaireparse
POST
Post v1questionnaireanswer single
POST
Post v1questionnairesave answer
POST
Post v1questionnairedelete answer
POST
Post v1questionnaireexport
POST
Post v1questionnaireupload and parse
POST
Post v1questionnaireupload and parseupload
POST
Post v1questionnaireparseupload
POST
Post v1questionnaireparseuploadtoken
POST
Post v1questionnaireanswersexport
POST
Post v1questionnaireanswersexportupload
POST
Post v1questionnaireauto answer
Knowledge Base
GET
List all knowledge base documents for an organization
GET
List all manual answers for an organization
POST
Save or update a manual answer
POST
Upload a knowledge base document
POST
Get a signed download URL for a document
POST
Get a signed view URL for a document
POST
Delete a knowledge base document
POST
Trigger processing of knowledge base documents
POST
Create a public access token for a run
POST
Delete a manual answer
POST
Delete all manual answers for an organization
SOA
POST
Save a SOA answer
POST
Auto-fill SOA document
POST
Create a new SOA document
POST
Ensure SOA configuration and document exist
POST
Approve a SOA document
POST
Decline a SOA document
POST
Submit SOA document for approval
Integrations
GET
Get v1integrationsoauthavailability
POST
Post v1integrationsoauthstart
GET
Get v1integrationsoauthcallback
GET
Get v1integrationsoauth apps
POST
Post v1integrationsoauth apps
GET
Get v1integrationsoauth appssetup
DEL
Delete v1integrationsoauth apps
GET
Get v1integrationsconnectionsproviders
GET
Get v1integrationsconnectionsproviders 1
GET
Get v1integrationsconnections
POST
Post v1integrationsconnections
GET
Get v1integrationsconnections 1
DEL
Delete v1integrationsconnections
PATCH
Patch v1integrationsconnections
POST
Post v1integrationsconnections test
POST
Post v1integrationsconnections pause
POST
Post v1integrationsconnections resume
POST
Post v1integrationsconnections disconnect
POST
Post v1integrationsconnections ensure valid credentials
PUT
Put v1integrationsconnections credentials
GET
Get v1integrationschecksproviders
GET
Get v1integrationschecksconnections
POST
Post v1integrationschecksconnections run
POST
Post v1integrationschecksconnections run 1
GET
Get v1integrationsvariablesproviders
GET
Get v1integrationsvariablesconnections
POST
Post v1integrationsvariablesconnections
GET
Get v1integrationsvariablesconnections options
GET
Get v1integrationstaskstemplate checks
GET
Get v1integrationstasks checks
POST
Post v1integrationstasks run check
GET
Get v1integrationstasks runs
POST
Post v1integrationssyncgoogle workspaceemployees
POST
Post v1integrationssyncgoogle workspacestatus
POST
Post v1integrationssyncripplingemployees
POST
Post v1integrationssyncripplingstatus
POST
Post v1integrationssyncrampemployees
POST
Post v1integrationssyncjumpcloudemployees
POST
Post v1integrationssyncjumpcloudstatus
POST
Post v1integrationssyncrampstatus
GET
Get v1integrationssyncemployee sync provider
POST
Post v1integrationssyncemployee sync provider
AdminIntegrations
GET
Get v1adminintegrations
GET
Get v1adminintegrations 1
POST
Post v1adminintegrationscredentials
DEL
Delete v1adminintegrationscredentials
Webhook
POST
Post v1integrationswebhooks
CloudSecurity
GET
Get v1cloud securityproviders
GET
Get v1cloud securityfindings
POST
Post v1cloud securityscan
POST
Post v1cloud securitytrigger
GET
Get v1cloud securityruns
Browserbase
GET
Get organization browser context status
POST
Get or create organization browser context
POST
Create a new browser session
POST
Close a browser session
POST
Navigate to a URL
POST
Check authentication status
POST
Create a browser automation
GET
Get all browser automations for a task
GET
Get a browser automation by ID
DEL
Delete a browser automation
PATCH
Update a browser automation
POST
Start automation with live view
POST
Execute automation on existing session
POST
Run a browser automation
GET
Get run history for an automation
GET
Get a specific run by ID
Task Management
GET
Get task items statistics for an entity
GET
Get task items for an entity
POST
Create a new task item
PUT
Update a task item
DEL
Delete a task item
POST
Upload attachment to task item
DEL
Delete attachment from task item
GET
Get task item activity log
Assistant Chat
POST
Stream AI chat completion
GET
Get assistant chat history
PUT
Save assistant chat history
DEL
Clear assistant chat history
Roles
GET
List all roles
POST
Create a custom role
GET
Resolve permissions for custom roles
GET
Get a role by ID
DEL
Delete a custom role
PATCH
Update a custom role
Training
POST
Send training completion email with certificate
POST
Generate training completion certificate PDF
Org Chart
GET
Get the organization chart
PUT
Create or update an interactive organization chart
DEL
Delete the organization chart
POST
Upload an image as the organization chart
Evidence Forms
GET
List evidence forms
GET
Get submission statuses for all forms
GET
Get current user submissions
GET
Get pending submission count for current user
GET
Get form definition and submissions
GET
Get a single submission
DEL
Delete a submission
POST
Submit evidence form entry
POST
Upload a file as an evidence submission
PATCH
Review a submission
POST
Upload evidence form file
GET
Export form submissions to CSV
Frameworks
GET
List framework instances for the organization
POST
Add frameworks to the organization
GET
List available frameworks (requires session, no active org needed — used during onboarding)
GET
Get overview compliance scores
GET
Get a single framework instance with full detail
DEL
Delete a framework instance
GET
Get a specific requirement with related controls
Audit Logs
GET
Get audit logs filtered by entity type and ID
Controls
GET
List controls with relations
POST
Create a new control
GET
Get dropdown options for creating controls
GET
Get control detail with progress
DEL
Delete a control
Secrets
GET
List all secrets (metadata only, no values)
POST
Create a new secret
GET
Get a secret with decrypted value
PUT
Update a secret
DEL
Delete a secret
Security Penetration Tests
GET
List penetration test runs
POST
Create penetration test
GET
List accessible GitHub repositories
GET
Get penetration test status
GET
Get penetration test progress
GET
Get penetration test output
GET
Get penetration test PDF
POST
Receive penetration test webhook events
Pentest Billing
GET
Get pentest subscription status
POST
Create a Stripe checkout session for pentest subscription
POST
Handle Stripe checkout success callback
POST
Create a Stripe billing portal session
POST
Check and charge overage for a pentest run
Get a single framework instance with full detail
cURL
Copy
Ask AI
curl
--request
GET
\
--url
http://localhost:3333/v1/frameworks/{id}
Frameworks
Get a single framework instance with full detail
GET
http://localhost:3333
https://api.trycomp.ai
/
v1
/
frameworks
/
{id}
Try it
Get a single framework instance with full detail
cURL
Copy
Ask AI
curl
--request
GET
\
--url
http://localhost:3333/v1/frameworks/{id}
Path Parameters
id
string
required
Response
200 - undefined
Was this page helpful?
Yes
No
Get overview compliance scores
Delete a framework instance
⌘I
Assistant
Responses are generated using AI and may contain mistakes.