> ## 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 domains
> This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.
Retrieves a list of [custom domains](/Setting-up-your-app/Setting-up-your-custom-domain) in a [workspace](/documentation/account-and-billing/about-workspaces).
Use this method to view, for each domain:
- Whether it's a [serving domain](/Setting-up-your-app/Setting-up-your-custom-domain) or an [email domain](/Setting-up-your-app/Sending-emails-from-a-custom-domain).
- Which app it's connected to.
- Whether it's verified and enabled.
- For email domains, whether sending is suspended.
To call this method, your API key must include the `compliance:inventory:read` [scope](/developers/references/compliance-api/get-started/authentication#scopes).
## OpenAPI
````yaml /developers/references/compliance-api/compliance-openapi.json get /{workspace_id}/domains
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}/domains:
get:
tags:
- compliance
summary: List domains
description: >-
This API is in beta. Endpoints, fields, and behavior may still
change, so avoid depending on it in production.
Retrieves a list of [custom
domains](/Setting-up-your-app/Setting-up-your-custom-domain) in a
[workspace](/documentation/account-and-billing/about-workspaces).
Use this method to view, for each domain:
- Whether it's a [serving
domain](/Setting-up-your-app/Setting-up-your-custom-domain) or an [email
domain](/Setting-up-your-app/Sending-emails-from-a-custom-domain).
- Which app it's connected to.
- Whether it's verified and enabled.
- For email domains, whether sending is suspended.
To call this method, your API key must include the
`compliance:inventory:read`
[scope](/developers/references/compliance-api/get-started/authentication#scopes).
operationId: list_domains__workspace_id__domains_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_Annotated_Union_ComplianceServingDomain__ComplianceEmailDomain___FieldInfo_annotation_NoneType__required_True__discriminator__kind____
'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_Annotated_Union_ComplianceServingDomain__ComplianceEmailDomain___FieldInfo_annotation_NoneType__required_True__discriminator__kind____:
properties:
data:
items:
oneOf:
- $ref: '#/components/schemas/ComplianceServingDomain'
- $ref: '#/components/schemas/ComplianceEmailDomain'
discriminator:
propertyName: kind
mapping:
email: '#/components/schemas/ComplianceEmailDomain'
serving: '#/components/schemas/ComplianceServingDomain'
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[Annotated[Union[ComplianceServingDomain,
ComplianceEmailDomain], FieldInfo(annotation=NoneType, required=True,
discriminator='kind')]]
description: One page of results from a list endpoint.
ComplianceErrorResponse:
properties:
error:
$ref: '#/components/schemas/ComplianceErrorBody'
type: object
required:
- error
title: ComplianceErrorResponse
ComplianceServingDomain:
properties:
kind:
type: string
const: serving
title: Kind
description: Type of domain. Always `"serving"` for this item.
default: serving
example: serving
id:
type: string
title: Id
description: Unique ID of the domain, in the format `{kind}:{app_id}:{domain}`.
example: serving:68a1f3c2b7d9e4005c20e8f6:invoices.acme.com
domain:
type: string
title: Domain
description: Domain name.
example: invoices.acme.com
app_id:
type: string
title: App Id
description: Unique ID of the app the domain is connected to.
example: 68a1f3c2b7d9e4005c20e8f6
created_date:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created Date
description: >-
When the domain was connected to the app. Formatted as a UTC
timestamp in ISO 8601 format. A `null` value indicates no time is
recorded.
example: '2026-02-12T09:30:00Z'
verified:
type: boolean
title: Verified
description: >-
Whether the domain passed its last verification check with the
domain provider.
example: true
last_checked_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Checked At
description: >-
When the domain was last checked with the provider. Formatted as a
UTC timestamp in ISO 8601 format. A `null` value indicates it hasn't
been checked.
example: '2026-10-20T06:00:00Z'
enabled:
type: boolean
title: Enabled
description: Whether the domain is enabled.
example: true
disabled_by:
anyOf:
- type: string
- type: 'null'
title: Disabled By
description: >-
Who disabled the domain. Possible values are `"admin"` and
`"subscription"`. A `null` value indicates the domain isn't
disabled.
example: admin
is_external:
type: boolean
title: Is External
description: >-
Whether the domain was bought outside Base44. This is `false` for
[domains purchased through
Base44](/Setting-up-your-app/Buying-a-domain-from-Base44).
example: false
type: object
required:
- id
- domain
- app_id
- verified
- enabled
- is_external
title: ComplianceServingDomain
ComplianceEmailDomain:
properties:
kind:
type: string
const: email
title: Kind
description: Type of domain. Always `"email"` for this item.
default: email
example: email
id:
type: string
title: Id
description: Unique ID of the domain, in the format `{kind}:{app_id}:{domain}`.
example: email:68a1f3c2b7d9e4005c20e8f6:mail.acme.com
domain:
type: string
title: Domain
description: Domain name.
example: mail.acme.com
app_id:
type: string
title: App Id
description: Unique ID of the app the domain is connected to.
example: 68a1f3c2b7d9e4005c20e8f6
created_date:
type: 'null'
title: Created Date
description: >-
Always `null`. Base44 doesn't record a creation time for email
domains.
configuration_status:
type: string
title: Configuration Status
description: >-
Status of the domain's email setup. Possible values are
`"not_configured"`, `"pending_dns_configuration"`,
`"pending_user_dns_configuration"`, `"pending_domain_verification"`,
`"active"`, `"failed_provider_creation"`,
`"failed_dns_configuration"`, and `"failed_verification"`. A value
of `"active"` indicates the domain is verified and can send email.
example: active
verified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Verified At
description: >-
When the domain was verified. Formatted as a UTC timestamp in ISO
8601 format. A `null` value indicates it isn't verified.
example: '2026-02-13T11:00:00Z'
disabled:
type: boolean
title: Disabled
description: Whether sending email from the domain is disabled.
example: false
suspended:
$ref: '#/components/schemas/ComplianceSuspension'
description: Whether sending email from the domain is suspended, and why.
external:
type: boolean
title: External
description: Whether the domain was purchased outside Base44.
example: true
type: object
required:
- id
- domain
- app_id
- configuration_status
- disabled
- suspended
- external
title: ComplianceEmailDomain
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
ComplianceSuspension:
properties:
flag:
type: boolean
title: Flag
description: Whether sending email from the domain is suspended.
example: false
reason:
anyOf:
- type: string
- type: 'null'
title: Reason
description: >-
The reason why sending is suspended. A `null` value indicates no
reason is recorded.
example: Complaint rate too high
type: object
required:
- flag
title: ComplianceSuspension
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.