Workspace Documents

Lists the workspace-level documents (company summary and market research) with their status and, for ready documents, a short-lived signed download URL. For campaign-level documents, see Campaign Documents.

Download URLs are short-lived. Each download_url is a signed link valid for ~5 minutes. Fetch the document promptly, or call the endpoint again to get a fresh link. URLs are generated server-side and scoped to your workspace.

List workspace documents

GET /api/v1/workspace/documents · scope workspace:read

Example request

curl -X GET "https://app.machfive.io/api/v1/workspace/documents" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response (200 OK)

{
  "workspace_id": "uuid",
  "documents": [
    {
      "type": "company_summary",
      "title": "Company Summary",
      "status": "ready",
      "download_url": "https://.../signed-url"
    },
    {
      "type": "market_research",
      "title": "Market Research",
      "status": "unavailable",
      "download_url": null
    }
  ]
}

Document type values: company_summary, market_research.

Document status

Error responses