> ## 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 Published Project Documents

> Get published appointment documents by project id.

NsApiSlow threshold: 2000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-DocumentAgent.json post /api/v1/Agents/Document/GetPublishedProjectDocuments
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - DocumentAgent
  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/Agents/Document/GetPublishedProjectDocuments:
    post:
      tags:
        - Document_Agent
      summary: Get Published Project Documents
      description: |-
        Get published appointment documents by project id.

        NsApiSlow threshold: 2000 ms.
      operationId: v1DocumentAgent_GetPublishedProjectDocuments
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - 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
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetPublishedProjectDocumentsRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetPublishedProjectDocumentsRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetPublishedProjectDocumentsRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetPublishedProjectDocumentsRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetPublishedProjectDocumentsRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetPublishedProjectDocumentsRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetPublishedProjectDocumentsRequest
        description: ProjectId
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Document'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Document'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Document'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Document'
            application/json-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Document'
            application/merge-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Document'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetPublishedProjectDocumentsRequest:
      description: >-
        GetPublishedProjectDocuments: Get published appointment documents by
        project id.
      type: object
      properties:
        ProjectId:
          format: int32
          type: integer
    SuperOffice.CRM.Services.Document:
      description: "Carrier object for Document.\r\nServices for the Document Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IDocumentAgent\">Document Agent</see>."
      type: object
      properties:
        DocumentId:
          format: int32
          description: Primary key
          type: integer
        Attention:
          description: Attention/salutation
          type: string
        Header:
          description: Visible document name
          type: string
        Name:
          description: File name
          type: string
        OurRef:
          description: Our reference, searchable field from freetext search
          type: string
        YourRef:
          description: Your reference
          type: string
        Description:
          description: >-
            The actual text, max 2047 significant characters even though it is
            stored as a larger data type on some databases
          type: string
        DocumentTemplate:
          description: ''
          type: string
        IsPublished:
          description: True if document have an entry in published table
          type: boolean
        PersonId:
          format: int32
          description: Person ID of person the appointment is with, may be 0
          type: integer
        PersonFullName:
          description: The full name of the person this document belongs to.
          type: string
        AssociateFullName:
          description: >-
            The associate's culture formatted fullname (firstname, middleName
            and lastname)
          type: string
        ContactId:
          format: int32
          description: Contact ID of owning contact, may be 0
          type: integer
        ContactName:
          description: Contact name
          type: string
        ProjectId:
          format: int32
          description: ID of project referred to, may be 0
          type: integer
        ProjectName:
          description: Project name
          type: string
        AssociateId:
          format: int32
          description: ID of associate whose diary the appointment is in, REQUIRED
          type: integer
        Snum:
          format: int32
          description: >-
            The sequence number allocated from refcount on used template when
            creating the document
          type: integer
        SaleId:
          format: int32
          description: Owning sale, if any (may be 0)
          type: integer
        SaleName:
          description: Heading of Owning sale, if any. (may be blank)
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [SuperOffice.WebApi.Data.Document GetPublishedProjectDocumentsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Document_GetPublishedProjectDocumentsRequest.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)
- [Get Published Document](/en/api/reference/restful/agent/document_agent/get-published-document.md)
- [Get Published Documents](/en/api/reference/restful/agent/document_agent/get-published-documents.md)
