> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Document Url

> Get a URL referring to the given document content.

<para/>This URL may be passed to the ultimate client (text editor of some kind?), which is then responsible for all further operations.<para/>The returned string is a fully qualified URL.<para/>Not all documents and document plugins support this feature.



## OpenAPI

````yaml /openapi/rest/openapi-v3-Document.json get /api/v1/Document/{documentId}/Url
openapi: 3.0.0
info:
  version: v1-REST
  title: SuperOffice REST API v1
  description: SuperOffice REST API - Document
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Document/{documentId}/Url:
    get:
      tags:
        - Document
      summary: Get Document Url
      description: >-
        Get a URL referring to the given document content.


        <para/>This URL may be passed to the ultimate client (text editor of
        some kind?), which is then responsible for all further
        operations.<para/>The returned string is a fully qualified
        URL.<para/>Not all documents and document plugins support this feature.
      operationId: v1DocumentEntity_GetDocumentUrl
      parameters:
        - name: documentId
          in: path
          description: SuperOffice document primary key
          required: true
          schema:
            format: int32
            type: integer
        - name: versionId
          in: query
          description: >-
            Version ID if applicable/desired; a blank value implies "latest"
            version and is always acceptable.
          required: false
          schema:
            type: string
        - name: writeableUrl
          in: query
          description: >-
            If true, then a URL that supports saving is requested. Som edocument
            plugins may not support read-only URLs, so there is no guarantee
            that a False value will actually yield a read-only URL, and vice
            versa.
          required: false
          schema:
            type: boolean
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
            text/xml:
              schema:
                type: string
            application/json-patch+json:
              schema:
                type: string
            application/merge-patch+json:
              schema:
                type: string
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components: {}

````

## Related topics

- [Get Document Url](/en/api/reference/restful/agent/document_agent/get-document-url.md)
- [SuperOffice.WebApi.Data.Document GetDocumentUrlRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Document_GetDocumentUrlRequest.md)
- [NSDocumentAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSDocumentAgent.md)
- [SuperOffice.WebApi.Agents.DocumentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DocumentAgent.md)
- [SuperOffice.WebApi.Agents.IDocumentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IDocumentAgent.md)
- [Troubleshooting](/integrations/sharepoint-documents/troubleshooting.md)