> ## Documentation Index
> Fetch the complete documentation index at: https://docs.base44.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List security findings
> This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.
Retrieves a list of security issues for the apps in a [workspace](/documentation/account-and-billing/about-workspaces). Issues come from the Base44 [security scan](/Setting-up-your-app/running-a-security-scan) and from connected 3rd-party scanners, such as Wiz.
Use this method to view, for each issue:
- What the scan found, and how severe it is.
- Where the issue is, such as an entity, a file, or a package.
- Whether it's open, resolved, or dismissed.
The list only includes issues from the latest successful scan for each app. It's not a history of previous scans.
The list doesn't capture issues from parts of a scan that failed or didn't run. Check the [security scan coverage](/developers/references/audit-logs-api/get-started/security-scan-findings#interpret-coverage) in the Audit Logs API before you report an app as clean.
To call this method, your API key must include the `compliance:inventory:read` and `compliance:findings:read` [scopes](/developers/references/compliance-api/get-started/authentication#scopes).
## OpenAPI
````yaml /developers/references/compliance-api/compliance-openapi.json get /{workspace_id}/security-findings
openapi: 3.1.0
info:
title: Base44 Compliance API
description: >
Read-only API for security partners to review the security configuration of
a Base44 workspace.
The API reports what exists in a workspace and how it's configured. It
doesn't report activity. To review activity, use the Audit Logs API.
The Compliance API is available for Enterprise workspaces only. To get
started, see the
[overview](/developers/references/compliance-api/get-started/overview).
version: 1.0.0
servers:
- url: https://app.base44.com/api/v1/compliance
description: Compliance API
security:
- ApiKeyAuth: []
PartnerTokenAuth: []
tags:
- name: compliance
description: Read workspace configuration, inventory, and security posture.
paths:
/{workspace_id}/security-findings:
get:
tags:
- compliance
summary: List security findings
description: >-
This API is in beta. Endpoints, fields, and behavior may still
change, so avoid depending on it in production.
Retrieves a list of security issues for the apps in a
[workspace](/documentation/account-and-billing/about-workspaces). Issues
come from the Base44 [security
scan](/Setting-up-your-app/running-a-security-scan) and from connected
3rd-party scanners, such as Wiz.
Use this method to view, for each issue:
- What the scan found, and how severe it is.
- Where the issue is, such as an entity, a file, or a package.
- Whether it's open, resolved, or dismissed.
The list only includes issues from the latest successful scan for each
app. It's not a history of previous scans.
The list doesn't capture issues from parts of a scan that failed
or didn't run. Check the [security scan
coverage](/developers/references/audit-logs-api/get-started/security-scan-findings#interpret-coverage)
in the Audit Logs API before you report an app as clean.
To call this method, your API key must include the
`compliance:inventory:read` and `compliance:findings:read`
[scopes](/developers/references/compliance-api/get-started/authentication#scopes).
operationId: list_security_findings__workspace_id__security_findings_get
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
description: >-
Workspace ID. Learn more about how to [retrieve your workspace
ID](/developers/references/compliance-api/get-started/authentication#workspace-id).
title: Workspace Id
description: >-
Workspace ID. Learn more about how to [retrieve your workspace
ID](/developers/references/compliance-api/get-started/authentication#workspace-id).
example: 67f2c8e01a3b5d004e92d7a1
- name: cursor
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: >-
Cursor for the next page. Pass the `next_cursor` value from the
previous response back unchanged. Don't send `limit` with it,
because the cursor already carries the limit. Cursors are valid
for 24 hours, and a cursor from a different workspace isn't valid.
Sending `limit` with a cursor, or an invalid cursor, returns a
`400` error.
title: Cursor
description: >-
Cursor for the next page. Pass the `next_cursor` value from the
previous response back unchanged. Don't send `limit` with it,
because the cursor already carries the limit. Cursors are valid for
24 hours, and a cursor from a different workspace isn't valid.
Sending `limit` with a cursor, or an invalid cursor, returns a `400`
error.
example: gAAAAABn7vJ...
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
maximum: 1000
minimum: 1
- type: 'null'
description: >-
Number of items per page. The maximum is 1000. Don't send it with
`cursor`, because the cursor already carries the limit.
Default: 100.
title: Limit
description: >-
Number of items per page. The maximum is 1000. Don't send it with
`cursor`, because the cursor already carries the limit.
Default: 100.
example: 100
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CompliancePage_ComplianceFinding_'
'400':
description: >-
The request is invalid, for example a parameter is malformed or the
`cursor` is invalid or expired. The error `type` is
`invalid_request_error`. See [error
codes](/developers/references/compliance-api/get-started/error-codes).
content:
application/json:
examples:
invalid_request_error:
summary: invalid_request_error
value:
error:
type: invalid_request_error
message: The request is invalid.
schema:
$ref: '#/components/schemas/ComplianceErrorResponse'
'401':
description: >-
A credential failed. The workspace API key is missing, unknown, or
disabled, or your signed token is missing or Base44 can't verify it
(`partner_key_required`). Check the `code` to see which credential
to fix. Don't ask the workspace admin to create a new key for
`partner_key_required`. The error `type` is `authentication_error`.
See [error
codes](/developers/references/compliance-api/get-started/error-codes).
content:
application/json:
examples:
authentication_error:
summary: authentication_error
value:
error:
type: authentication_error
message: Invalid workspace API key.
partner_key_required:
summary: partner_key_required
value:
error:
type: authentication_error
message: >-
Missing or invalid compliance partner assertion in the
Authorization header. The workspace API key is sent
separately and is not the credential at fault here.
code: partner_key_required
schema:
$ref: '#/components/schemas/ComplianceErrorResponse'
'402':
description: >-
The workspace's plan doesn't include the Compliance API, or its
subscription has lapsed (`plan_not_included`). The error `type` is
`permission_error`. See [error
codes](/developers/references/compliance-api/get-started/error-codes).
content:
application/json:
examples:
plan_not_included:
summary: plan_not_included
value:
error:
type: permission_error
message: This API key is not permitted to perform that request.
code: plan_not_included
schema:
$ref: '#/components/schemas/ComplianceErrorResponse'
'403':
description: >-
The key doesn't have the scope the method needs (`missing_scope`),
the key belongs to a different workspace (`workspace_mismatch`), the
Compliance API isn't enabled for the workspace
(`feature_not_enabled`), or Base44 suspended your partner
registration (`partner_not_approved`). The error `type` is
`permission_error`. See [error
codes](/developers/references/compliance-api/get-started/error-codes).
content:
application/json:
examples:
missing_scope:
summary: missing_scope
value:
error:
type: permission_error
message: >-
This API key is not permitted to perform that request.
Needed: [compliance:members:read]
code: missing_scope
required_scope: compliance:members:read
workspace_mismatch:
summary: workspace_mismatch
value:
error:
type: permission_error
message: API key does not belong to this workspace
code: workspace_mismatch
feature_not_enabled:
summary: feature_not_enabled
value:
error:
type: permission_error
message: The Compliance API is not enabled for this workspace.
code: feature_not_enabled
partner_not_approved:
summary: partner_not_approved
value:
error:
type: permission_error
message: >-
This compliance partner is not approved to call the
Compliance API. Contact Base44; the customer cannot
grant this.
code: partner_not_approved
schema:
$ref: '#/components/schemas/ComplianceErrorResponse'
'404':
description: >-
The workspace doesn't exist. The error `type` is `not_found_error`.
See [error
codes](/developers/references/compliance-api/get-started/error-codes).
content:
application/json:
examples:
not_found_error:
summary: not_found_error
value:
error:
type: not_found_error
message: Not found.
schema:
$ref: '#/components/schemas/ComplianceErrorResponse'
'429':
description: >-
The workspace sent too many requests. Wait the number of seconds in
the `retry-after` header, then retry with a newly signed
authentication token. The error `type` is `rate_limit_error`. See
[rate
limits](/developers/references/compliance-api/get-started/rate-limits).
content:
application/json:
examples:
rate_limit_error:
summary: rate_limit_error
value:
error:
type: rate_limit_error
message: >-
Rate limit exceeded. Retry after the interval in the
retry-after header.
schema:
$ref: '#/components/schemas/ComplianceErrorResponse'
'500':
description: >-
Something went wrong on Base44's side. Retry with exponential
backoff and a newly signed authentication token. If the code is
`inventory_too_large`, the workspace has more items than the API can
return, and retrying doesn't help. Ask your Base44 partner contact
for help. See [error
codes](/developers/references/compliance-api/get-started/error-codes).
content:
application/json:
examples:
api_error:
summary: api_error
value:
error:
type: api_error
message: >-
An internal error occurred. Retry with exponential
backoff.
inventory_too_large:
summary: inventory_too_large
value:
error:
type: api_error
message: >-
This workspace holds more rows than a single compliance
read supports (9999). Returning a partial inventory
would misreport it, so the request failed instead. Not
retryable without a change on our side.
code: inventory_too_large
schema:
$ref: '#/components/schemas/ComplianceErrorResponse'
components:
schemas:
CompliancePage_ComplianceFinding_:
properties:
data:
items:
$ref: '#/components/schemas/ComplianceFinding'
type: array
title: Data
description: Items on this page.
pagination:
$ref: '#/components/schemas/PublicPaginationInfo'
description: Pagination details for this page.
type: object
required:
- data
- pagination
title: CompliancePage[ComplianceFinding]
description: One page of results from a list endpoint.
ComplianceErrorResponse:
properties:
error:
$ref: '#/components/schemas/ComplianceErrorBody'
type: object
required:
- error
title: ComplianceErrorResponse
ComplianceFinding:
properties:
id:
type: string
title: Id
description: >-
Unique ID of the issue. Use it to match an issue across requests.
For `secrets`, `backend_functions`, and `code` issues, the ID
changes whenever the file changes. The ID of a `backend_functions`
issue also changes when the app changes its login requirements.
example: 68a1f3c2b7d9e4005c20e8f6:secrets:3f9a1c7e5b2d48a06e1f93c4a7b50d28
app_id:
type: string
title: App Id
description: Unique ID of the app the issue belongs to.
example: 68a1f3c2b7d9e4005c20e8f6
category:
type: string
title: Category
description: >-
Type of issue. Possible values are:
- `rls`: Row-level security is missing.
- `secrets`: A secret is hardcoded.
- `backend_functions`: A backend function has an authorization
issue.
- `dependencies`: A package has a known vulnerability.
- `code`: The code has an issue.
- `security_headers`: A [security
header](/Setting-up-your-app/running-a-security-scan#security-header-recommendations)
is recommended for the app. These depend on an app setting, so the
`location` fields are `null`.
- `third_party`: A connected third-party scanner reported the issue.
This category covers dependency vulnerabilities that Wiz finds. The
`dependencies` category covers only the Base44 scan.
example: rls
severity:
type: string
title: Severity
description: >-
How severe the issue is. Possible values are `"critical"`, `"high"`,
`"medium"`, and `"low"`. If the scanner doesn't rate an issue,
Base44 uses a default for the category: `critical` for `rls`,
`critical` for `secrets`, `high` for `backend_functions`, and
`medium` for the rest. On an app that doesn't require login, every
backend function can be called by anyone by design, so each is
listed once with severity `low`. Functions the scanner flags as
abusable keep severity `high`.
example: high
title:
type: string
title: Title
description: Short summary of the issue.
example: Row-level security recommended for Invoice
description:
type: string
title: Description
description: Explanation of the issue.
example: Anyone who can sign in can read every invoice.
location:
$ref: '#/components/schemas/ComplianceFindingLocation'
description: Where the issue is.
status:
type: string
enum:
- open
- resolved
- dismissed
title: Status
description: >-
Whether the issue needs attention. Possible values are `"open"`,
`"resolved"`, and `"dismissed"`. A value of `"open"` indicates the
issue isn't known to be resolved. A value of `"resolved"` indicates
Base44 recorded a fix. A value of `"dismissed"` indicates someone
dismissed it.
example: open
scanned_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Scanned At
description: >-
When the scan that reported the issue ran. Formatted as a UTC
timestamp in ISO 8601 format. Rows from one 3rd-party scan can
differ, because its code analysis step can lag. For
`security_headers` issues, it's when the app's header
recommendations last changed.
example: '2026-10-18T22:14:05Z'
source:
type: string
enum:
- base44_scanner
- wiz
title: Source
description: >-
Scanner that reported the issue. Possible values are
`"base44_scanner"` and `"wiz"`.
example: base44_scanner
type: object
required:
- id
- app_id
- category
- severity
- title
- description
- location
- status
- source
title: ComplianceFinding
PublicPaginationInfo:
properties:
total:
type: integer
title: Total
description: Total number of matching items.
example: 347
next_cursor:
anyOf:
- type: string
- type: 'null'
title: Next Cursor
description: >-
Cursor for fetching the next page. The value is `null` if there are
no more pages.
example: gAAAAABn7vJ...
has_more:
type: boolean
title: Has More
description: Whether there are more items to fetch.
example: true
type: object
required:
- total
- has_more
title: PublicPaginationInfo
description: Pagination metadata for a cursor-paginated page.
ComplianceErrorBody:
properties:
type:
type: string
title: Type
description: >-
Category of the error. See [error
types](/developers/references/compliance-api/get-started/error-codes#error-types).
example: permission_error
message:
type: string
title: Message
description: Explanation of the error for people to read.
example: >-
This API key is not permitted to perform that request. Needed:
[compliance:members:read]
code:
anyOf:
- type: string
- type: 'null'
title: Code
description: >-
Specific cause of the error, such as `missing_scope`,
`workspace_mismatch`, `plan_not_included`, `feature_not_enabled`,
`partner_key_required`, `partner_not_approved`, or
`inventory_too_large`. Omitted when `type` is enough. See
[Compliance API
codes](/developers/references/compliance-api/get-started/error-codes#compliance-api-codes).
example: missing_scope
required_scope:
anyOf:
- type: string
- type: 'null'
title: Required Scope
description: >-
Scope the method needs. Included only when `code` is
`missing_scope`.
example: compliance:members:read
type: object
required:
- type
- message
title: ComplianceErrorBody
ComplianceFindingLocation:
properties:
entity_name:
anyOf:
- type: string
- type: 'null'
title: Entity Name
description: Name of the entity. Set for `rls` issues.
example: Invoice
file_path:
anyOf:
- type: string
- type: 'null'
title: File Path
description: Path of the file.
example: functions/syncInvoices.js
line:
anyOf:
- type: integer
- type: 'null'
title: Line
description: Line number in the file.
example: 42
package_name:
anyOf:
- type: string
- type: 'null'
title: Package Name
description: >-
Name of the package. Set for `dependencies` issues and for
dependency issues from a 3rd-party scanner.
example: lodash
version:
anyOf:
- type: string
- type: 'null'
title: Version
description: Installed version of the package.
example: 4.17.15
type: object
title: ComplianceFindingLocation
description: >-
Where an issue is located, such as an entity, a file, or a package. Only
the fields that apply to the issue have values. The others are `null`.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: api_key
description: >-
Identifies the workspace you can read and limits your access to the
key's scopes. A workspace owner or admin creates the key and shares it
with you. See [Workspace API
key](/developers/references/compliance-api/get-started/authentication#workspace-api-key)
for more details.
PartnerTokenAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
The signed authentication token that identifies you as the security
partner. Sign a new token for each request with your signing key, using
`RS256` or `ES256`, and send it as a bearer token in the `Authorization`
header. See [Sign an authentication
token](/developers/references/compliance-api/get-started/authentication#sign-an-authentication-token)
for more details.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.