Developer Compliance1.0.0-beta.1

Read a supplier delivery plan and recent cases

Returns the saved schedule and the 50 most recent delivery cases. deliveryAvailable describes whether current paid email dispatch is configured. Recipients, respondent answers and delivery credentials are excluded.

GET/api/v1/compliance/suppliers/{supplierId}/delivery

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:supplier-delivery:read. Scopes are independent.

This operation uses 1 credit from a shared budget of 60 credits per token and 300 per Space each UTC minute.

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

Path parameters

supplierIdstringRequired: Stable supplier record ID in the token’s Space, up to 200 characters. Encode it as one path segment.
Example"supplier-001"

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/suppliers/{supplierId}/delivery' \
  --header "Authorization: Bearer $DASHIO_API_TOKEN"

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

Schema-generated example; not a captured response.

{
  "plan": {
    "id": "d40beec9-3477-45cb-92e4-152f5b9d0686",
    "sourceCaseId": "<sourceCaseId>",
    "state": "active",
    "mode": "Manual",
    "timeZone": "<timeZone>",
    "nextDate": "<nextDate>",
    "responseWindowDays": 1,
    "intervalMonths": 0,
    "reminderDays": [
      1
    ]
  },
  "cases": [
    {
      "id": "d40beec9-3477-45cb-92e4-152f5b9d0686",
      "status": "awaiting_response",
      "blockedReason": null,
      "scheduledDate": "<scheduledDate>",
      "dueDate": "<dueDate>",
      "version": 1,
      "acceptedEmails": 0,
      "failedEmails": 0,
      "pendingEmails": 0,
      "submissionCount": 0
    }
  ],
  "deliveryAvailable": false
}

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 current plan and recent case metadata.

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

planobject | nullRequired: No field description supplied.
casesarray of objectRequired: Maximum items: 50.
deliveryAvailablebooleanRequired: No field description supplied.

400

Invalid identifier, query, action or body.

application/json

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

401

Developer token is missing or invalid.