GET /api/v1/resources/{resource_id}

Read a resource and the caller's resolved access to it.

Endpoint

Method: GET
Path: /api/v1/resources/{resource_id}
Required scope: resource:read
Base URL: https://dokki.one

Parameters

resource_id — required path UUID for a resource the API key can access.

Request example

curl "https://dokki.one/api/v1/resources/$RESOURCE_ID" \
  -H "Authorization: Bearer $DOKKI_API_KEY"

Response

A successful response contains resource and access. The resource includes its identity, type, name, icon, metadata, workspace, hierarchy, timestamps, archive and private state, and public-access setting. metadata is an application-defined JSON object; preserve unknown keys when you later update it.

{
  "resource": {
    "id": "8f3d...",
    "type": "document",
    "name": "Project brief",
    "icon": "lucide:file-text",
    "metadata": { "owner": "product" },
    "is_private": true,
    "public_access": null
  },
  "access": {
    "permission": "write",
    "resource_role": "editor",
    "workspace_role": "editor",
    "org_role": null
  }
}

Errors

401 — missing or invalid API key.
403 — API key lacks resource:read or current resource access.
404 — resource is unavailable to the caller.

Get {resource_id}