---
updatedAt: 2026-09-01T11:27:16.000Z
agentTools:
  projectIndex: https://documentation.nedap-harmony.com/llms.txt
---

# GetDocument

<p><b>Required scopes:</b> read:documents</p>

# OpenAPI definition

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "Harmony API - Public",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://nedap-harmony.com"
    }
  ],
  "paths": {
    "/api/{workspaceId}/documents/v1/{documentId}": {
      "get": {
        "tags": [
          "Document"
        ],
        "summary": "GetDocument",
        "description": "<p><b>Required scopes:</b> read:documents</p>",
        "operationId": "GetDocument",
        "parameters": [
          {
            "name": "documentId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspaceId",
            "in": "path",
            "description": "WorkspaceId of the workspace the API call is for.",
            "required": true,
            "schema": {
              "type": "string",
              "description": "WorkspaceId of the workspace the API call is for.",
              "format": "uuid"
            }
          },
          {
            "name": "test",
            "in": "query",
            "description": "Whether this is a request for 'Test' or 'Live' environment. True refers to the 'Test' environment, no value or False refers to the 'Live' environment.",
            "schema": {
              "type": "boolean",
              "description": "Whether this is a request for 'Test' or 'Live' environment. True refers to the 'Test' environment, no value or False refers to the 'Live' environment."
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Document"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests"
          }
        },
        "security": [
          {
            "apiToken": [
              "read:documents"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Document": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": true,
            "readOnly": true
          },
          "contents": {
            "type": "object",
            "nullable": true
          },
          "origin": {
            "$ref": "#/components/schemas/Origin"
          },
          "expiration": {
            "type": "string",
            "format": "date-time"
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "reference": {
            "type": "string",
            "nullable": true
          },
          "test": {
            "type": "boolean",
            "nullable": true,
            "readOnly": true
          },
          "lastModification": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "readOnly": true
          }
        },
        "additionalProperties": false
      },
      "Origin": {
        "type": "object",
        "properties": {
          "originType": {
            "$ref": "#/components/schemas/OriginType"
          },
          "readPointId": {
            "type": "string",
            "nullable": true
          },
          "hookId": {
            "type": "string",
            "nullable": true
          },
          "hookJobStatusId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OriginType": {
        "enum": [
          "ReadPoint",
          "Hook",
          "Api"
        ],
        "type": "string"
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        }
      }
    },
    "securitySchemes": {
      "apiToken": {
        "type": "http",
        "description": "Enter the obtained API Token.",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "security": [
    {
      "apiToken": []
    }
  ],
  "x-samples-languages": [
    "curl",
    "javascript",
    "csharp",
    "java",
    "python"
  ]
}
```