Developer Compliance Workspace1.0.0-beta.1

Read the Compliance workspace

Returns the 16 saved Compliance collections at one revision, including contacts and other private Space records. Attachments contain only their reusable metadata. For an oversized workspace, use the individually scoped collection operations.

GET/api/v1/compliance/workspace

Workspace automation for approved Dashio products. Each token is scoped to one Space and independently granted operations. Requests spend shared minute credits, and selected operation groups also share hourly quotas.

Required token scope is compliance:workspace:read. Scopes are independent.

This operation uses 12 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute. The compliance bulk group shares 15 requests per token and 40 per Space each UTC hour.

Run these examples on a trusted server with DASHIO_API_TOKEN configured. Use a private terminal when inspecting response data. Examples send one request with a bounded timeout and do not retry automatically.

Authentication

Dashio developer token (HTTP Bearer) API authentication guide

Download the complete schema as OpenAPI JSON or OpenAPI YAML.

Path parameters

None documented.

Query parameters

None documented.

Header parameters

None documented.

Request body

No content type declared

No request body schema is documented.

Request & response examples

Copy an example in your preferred language.

request.sh

: "${DASHIO_API_TOKEN:?Set DASHIO_API_TOKEN before running this example}"

curl --fail-with-body --include --silent --show-error --connect-timeout 10 --max-time 30 \
  --request GET 'https://app.dashio.net/api/v1/compliance/workspace' \
  --header "Authorization: Bearer $DASHIO_API_TOKEN"

Replace URL parameters, credentials, and schema placeholders before running. No request is sent by this page.

The saved v1 workspace and its current revision. No inline response example is available.

Run examples on a trusted server. Configure the environment variables and replace URL or schema placeholders. For a write, reuse its saved idempotency key only when retrying the identical request.

Responses

Headers on every response

X-Request-Idstring (uuid)Optional: Server-generated ID to include in a support request.

200

The saved v1 workspace and its current revision.

Response headers

RateLimit-LimitintegerOptional: Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.
RateLimit-RemainingintegerOptional: Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.
RateLimit-ResetintegerOptional: Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

application/json

schemaVersionintegerRequired: Required value: 1.
revisionintegerRequired: Optimistic revision used by workspace writes. Minimum: 0. Maximum: 9007199254740991.
collectionsobjectRequired: Workspace records keyed by stable collection IDs shared with schema v1 backups.

400

Unsupported query parameters.

application/json

statusCodeintegerRequired: Minimum: 400. Maximum: 599.
statusMessagestringOptional: A safe explanation suitable for display.
dataobjectRequired: No field description supplied.

401

A valid developer token is required.