Skip to content

API endpoints

This is a reference for the Pullminder REST API. The base URL is https://api.pullminder.com. All organization-scoped routes use the path prefix /api/orgs/{orgId}.

MethodPathDescription
GET/auth/githubInitiate GitHub OAuth login flow
GET/auth/github/callbackHandle GitHub OAuth callback
POST/auth/logoutEnd the current session
GET/auth/meGet the authenticated user profile
MethodPathDescription
GET/api/orgsList organizations the user belongs to
GET/api/orgs/{orgId}/Get organization details
PATCH/api/orgs/{orgId}/onboardingUpdate onboarding state
DELETE/api/orgs/{orgId}/Delete the organization
MethodPathDescription
GET/api/orgs/{orgId}/reposList repositories in the organization
PATCH/api/orgs/{orgId}/repos/{repoId}Update repository settings (e.g., toggle active)
POST/api/orgs/{orgId}/repos/syncSync repository list from GitHub
POST/api/orgs/{orgId}/repos/bulk-activateActivate multiple repositories at once
GET/api/orgs/{orgId}/repos/{repoId}/badgeGet the badge configuration for a repository
POST/api/orgs/{orgId}/repos/{repoId}/badgeCreate a badge for a repository
DELETE/api/orgs/{orgId}/repos/{repoId}/badgeDelete a repository badge
GET/api/orgs/{orgId}/repos/{repoId}/detected-frameworksList detected frameworks for a repository
POST/api/orgs/{orgId}/repos/{repoId}/rule-packs/{packId}/enableEnable an auto-detected rule pack
DELETE/api/orgs/{orgId}/repos/{repoId}/rule-packs/{packId}/enableDisable an auto-detected rule pack
MethodPathDescription
GET/api/orgs/{orgId}/prsList analyzed pull requests (supports filters)
GET/api/orgs/{orgId}/prs/{prId}Get pull request detail and risk breakdown
GET/api/orgs/{orgId}/prs/{prId}/reviewsGet review analysis for a pull request
GET/api/orgs/{orgId}/prs/{prId}/coverageGet coverage data for a pull request
GET/api/orgs/{orgId}/prs/{prId}/reviewer-promptGet the AI reviewer brief for a pull request
MethodPathDescription
GET/api/orgs/{orgId}/rulesList installed rule packs
POST/api/orgs/{orgId}/rules/{slug}/installInstall a rule pack from the registry
DELETE/api/orgs/{orgId}/rules/{slug}Uninstall a rule pack
PATCH/api/orgs/{orgId}/rules/{slug}Update rule pack settings (action, enabled state)
POST/api/orgs/{orgId}/rules/{slug}/upgradeUpgrade a rule pack to the latest version
GET/api/orgs/{orgId}/rules/{slug}/detailGet full detail for an installed rule pack
GET/api/orgs/{orgId}/rules/{slug}/overridesList per-repository overrides for a rule pack
PUT/api/orgs/{orgId}/rules/{slug}/overrides/{repoId}Set a per-repository override for a rule pack
MethodPathDescription
GET/api/orgs/{orgId}/policiesList policies
POST/api/orgs/{orgId}/policiesCreate a policy
PATCH/api/orgs/{orgId}/policies/{policyId}Update a policy
DELETE/api/orgs/{orgId}/policies/{policyId}Delete a policy
MethodPathDescription
GET/api/orgs/{orgId}/analytics/summaryAggregated analytics summary
GET/api/orgs/{orgId}/analytics/risk-trendRisk score trend over time
GET/api/orgs/{orgId}/analytics/top-categoriesMost common finding categories
GET/api/orgs/{orgId}/analytics/repo-breakdown/searchPer-repository risk and finding breakdown
GET/api/orgs/{orgId}/analytics/review-timeReview duration statistics
GET/api/orgs/{orgId}/analytics/patternsRecurring finding patterns
GET/api/orgs/{orgId}/analytics/reviewer-activityPer-reviewer activity and response times
GET/api/orgs/{orgId}/analytics/coverage-trendCode coverage trend over time
MethodPathDescription
GET/api/orgs/{orgId}/reports/baselineGet baseline analysis report
GET/api/orgs/{orgId}/reports/baseline/reposGet per-repository baseline data
MethodPathDescription
POST/api/orgs/{orgId}/baseline/scanTrigger a historical baseline scan
GET/api/orgs/{orgId}/baseline/statusCheck baseline scan progress
GET/api/orgs/{orgId}/baseline/summaryGet baseline scan summary
MethodPathDescription
GET/api/orgs/{orgId}/alertsList alerts (high-risk, policy blocks)
POST/api/orgs/{orgId}/alerts/readMark alerts as read
MethodPathDescription
GET/api/orgs/{orgId}/auditList audit log entries for the organization
MethodPathDescription
PATCH/api/orgs/{orgId}/settingsUpdate organization settings
POST/api/orgs/{orgId}/settings/test-webhookSend a test Slack webhook message
PUT/api/orgs/{orgId}/settings/registryConfigure a custom rule registry
DELETE/api/orgs/{orgId}/settings/registryRemove the custom rule registry
POST/api/orgs/{orgId}/settings/registry/syncSync rule packs from the custom registry
MethodPathDescription
GET/api/orgs/{orgId}/retentionGet data retention policies
PATCH/api/orgs/{orgId}/retentionUpdate retention policy for a resource type
MethodPathDescription
POST/api/orgs/{orgId}/checkoutCreate a checkout session
GET/api/orgs/{orgId}/subscriptionGet current subscription details
POST/api/orgs/{orgId}/subscription/cancelCancel the subscription
GET/api/orgs/{orgId}/billing/historyList payment history
POST/api/orgs/{orgId}/subscription/upgradeUpgrade to a higher plan
POST/api/orgs/{orgId}/subscription/downgradeDowngrade to a lower plan
POST/api/orgs/{orgId}/subscription/upgrade/previewPreview prorated cost of an upgrade
MethodPathDescription
GET/api/me/data-exportExport all personal data
DELETE/api/me/accountDelete the user account
MethodPathDescription
GET/api/orgs/{orgId}/usageGet usage statistics
GET/api/orgs/{orgId}/statsGet organization stats (stat cards)
GET/api/orgs/{orgId}/searchSearch across PRs, repos, and findings
GET/api/orgs/{orgId}/category-metaGet metadata for finding categories
MethodPathDescription
GET/api/v1/registry/rulesList all available rule packs in the registry

These endpoints do not require authentication:

MethodPathDescription
GET/healthHealth check
GET/badge/{token}Render a risk score badge image
POST/webhooks/githubReceive GitHub webhook events
GET/api/checkout/confirmBilling checkout confirmation callback
GET/api/checkout/failureBilling checkout failure callback
POST/api/leadsSubmit a lead (rate limited)
GET/badges/scoreScore badge image
GET/badges/findingsFindings badge image
GET/badges/policiesPolicies badge image
GET/badges/coverageCoverage badge image

These endpoints use GITHUB_TOKEN authentication instead of session cookies.

MethodPathDescription
GET/api/v1/cli/scoreGet risk score for a PR
GET/api/v1/cli/briefGet reviewer brief for a PR
GET/api/v1/cli/configGet CLI configuration
GET/api/v1/cli/config/orgGet organization-level CLI configuration