> ## Documentation Index > Fetch the complete documentation index at: https://docs.watchdog.no/llms.txt > Use this file to discover all available pages before exploring further. # Get an agreement document relationship > Returns the link between this agreement and a document, with document details. Read its text with GET /v1/documents/{id}/text, or get the file with GET /v1/documents/{id}/download. This read does not start text extraction. ## OpenAPI ````yaml /openapi.json get /v1/agreements/{id}/documents/{document_id} openapi: 3.1.0 info: title: Watchdog API version: 1.0.0 description: >- The Watchdog API is served from https://api.watchdog.no. Request bodies are limited to 2 MiB unless an endpoint says otherwise. Files are uploaded directly to storage, not through the API. servers: - url: https://api.watchdog.no description: Watchdog API security: [] paths: /v1/agreements/{id}/documents/{document_id}: get: tags: - Agreement documents - Agreements - Documents summary: Get an agreement document relationship description: >- Returns the link between this agreement and a document, with document details. Read its text with GET /v1/documents/{id}/text, or get the file with GET /v1/documents/{id}/download. This read does not start text extraction. operationId: getAgreementDocument parameters: - name: X-Organization-Id in: header required: false schema: type: string description: >- The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations. - name: fields in: query required: false schema: type: string description: >- Return only these fields, comma-separated; use dots for nested fields, such as document.id. Fields: agreement_id, ingestion_status, document, role, price_imported, active_price_import, imported_price_count, has_historical_price_import, position, suggestion, preparation, created_at, updated_at. - schema: type: string format: uuid required: true name: id in: path - schema: type: string format: uuid required: true name: document_id in: path responses: '200': description: The resource. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. ETag: schema: type: string required: true description: >- Version of the resource. Send it as If-Match to change it only if it has not changed since. content: application/json: schema: $ref: '#/components/schemas/AgreementDocument' '400': description: >- The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: '#/components/schemas/Error_validation_error' example: error: code: validation_error message: >- The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB. request_id: req_example '401': description: The bearer token is missing or invalid. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. WWW-Authenticate: schema: type: string required: false description: Bearer authentication challenge, when supplied. content: application/json: schema: $ref: '#/components/schemas/Error_invalid_token' example: error: code: invalid_token message: The bearer token is missing or invalid. request_id: req_example '403': description: >- Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: >- #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required example: error: code: forbidden message: >- Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required. request_id: req_example '404': description: The resource does not exist in the current organization. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: '#/components/schemas/Error_not_found' example: error: code: not_found message: The resource does not exist in the current organization. request_id: req_example '409': description: >- Agreement work is in progress, an active agreement is missing a required field, the source document is unavailable, or the Idempotency-Key was reused with a different request. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: '#/components/schemas/Error_conflict_source_unavailable' example: error: code: conflict message: >- Agreement work is in progress, an active agreement is missing a required field, the source document is unavailable, or the Idempotency-Key was reused with a different request. request_id: req_example '429': description: Too many requests. Wait for the Retry-After delay before retrying. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. Retry-After: schema: type: string example: '60' required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/Error_rate_limit_exceeded' example: error: code: rate_limit_exceeded message: >- Too many requests. Wait for the Retry-After delay before retrying. request_id: req_example '500': description: >- Unexpected server failure. Include the request ID when contacting support. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: '#/components/schemas/Error_internal_error' example: error: code: internal_error message: >- Unexpected server failure. Include the request ID when contacting support. request_id: req_example '503': description: >- Temporarily unavailable. Retry after the Retry-After delay, when provided. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. Retry-After: schema: type: string example: '60' required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/Error_service_unavailable' example: error: code: service_unavailable message: >- Temporarily unavailable. Retry after the Retry-After delay, when provided. request_id: req_example security: - ApiKeyBearer: [] components: schemas: AgreementDocument: type: object properties: agreement_id: type: string format: uuid ingestion_status: type: string enum: - pending - accepted - rejected - cancelled - failed document: $ref: '#/components/schemas/Document' role: type: string enum: - terms - price_list - uncategorized - excluded price_imported: type: boolean description: True when prices have been imported from this document. active_price_import: type: - object - 'null' properties: id: type: string format: uuid status: type: string enum: - queued - running workflow_run_id: type: string format: uuid workflow_run_item_id: type: string format: uuid required: - id - status - workflow_run_id - workflow_run_item_id additionalProperties: false description: >- The price import from this document that is in progress, if any. Cancel it through its workflow run. imported_price_count: type: integer description: Prices on this agreement imported from this document. has_historical_price_import: type: boolean description: >- True when some prices from this document are not tracked per import: they are not counted in imported_price_count or deleted with delete_imported_prices. position: type: - integer - 'null' suggestion: type: - object - 'null' properties: role: type: - string - 'null' enum: - terms - price_list - uncategorized - excluded - null reason: type: - string - 'null' import_context: type: - string - 'null' required: - role - reason - import_context additionalProperties: false preparation: type: object properties: status: type: string enum: - not_required - not_started - queued - running - ready - failed - needs_role workflow_run_id: type: - string - 'null' format: uuid workflow_run_item_id: type: - string - 'null' format: uuid description: >- Cancel this workflow run item to stop preparing only this document. extraction_id: type: - string - 'null' format: uuid document_index_id: type: - string - 'null' format: uuid failure: type: - object - 'null' properties: code: type: string enum: - password_protected - unreadable_document - source_unavailable - unsupported_media_type - content_not_ready - classification_failed - dispatch_failed - admission_expired - cancelled - preparation_failed message: type: string required: - code - message additionalProperties: false required: - status - workflow_run_id - workflow_run_item_id - extraction_id - document_index_id - failure additionalProperties: false created_at: type: string format: date-time updated_at: type: string format: date-time required: - agreement_id - ingestion_status - document - role - price_imported - active_price_import - imported_price_count - has_historical_price_import - position - suggestion - preparation - created_at - updated_at Error_validation_error: type: object properties: error: type: object properties: code: type: string enum: - validation_error message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_invalid_token: type: object properties: error: type: object properties: code: type: string enum: - invalid_token message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required: type: object properties: error: type: object properties: code: type: string enum: - forbidden - token_disabled - organization_required - insufficient_role - mfa_required message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_not_found: type: object properties: error: type: object properties: code: type: string enum: - not_found message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_conflict_source_unavailable: type: object properties: error: type: object properties: code: type: string enum: - conflict - source_unavailable message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_rate_limit_exceeded: type: object properties: error: type: object properties: code: type: string enum: - rate_limit_exceeded message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_internal_error: type: object properties: error: type: object properties: code: type: string enum: - internal_error message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_service_unavailable: type: object properties: error: type: object properties: code: type: string enum: - service_unavailable message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Document: type: object properties: id: type: string format: uuid file_name: type: string mime_type: type: - string - 'null' file_size: type: - integer - 'null' page_count: type: - integer - 'null' md5_checksum: type: - string - 'null' description: Base64 MD5 of the file. Null until the upload has been verified. properties: oneOf: - type: object properties: kind: type: string enum: - workbook sheets: type: array items: type: object properties: name: type: string hidden: type: boolean row_count: type: integer minimum: 0 required: - name - hidden - row_count required: - kind - sheets - type: 'null' description: >- What the file contains, keyed by `kind`. For `workbook` (XLSX): each worksheet in order, with its `name`, whether it is `hidden`, and `row_count` (rows with at least one non-empty cell). Null when not available for this file. created_at: type: string format: date-time updated_at: type: - string - 'null' format: date-time version: type: - integer - 'null' previous_version_id: type: - string - 'null' format: uuid required: - id - file_name - mime_type - file_size - page_count - md5_checksum - properties - created_at - updated_at - version - previous_version_id securitySchemes: ApiKeyBearer: type: http scheme: bearer description: >- Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.