> ## 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 Commands

> Get a list of custom commands valid for the specific document at this time.

This information should not be cached by clients, as it may change between documents and over time.
NsApiSlow threshold: 2000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-DocumentAgent.json post /api/v1/Agents/Document/GetDocumentCommands
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/GetDocumentCommands:
    post:
      tags:
        - Document_Agent
      summary: Get Document Commands
      description: "Get a list of custom commands valid for the specific document at this time.\n\nThis information should not be cached by clients, as it may change between documents and over time.\r\nNsApiSlow threshold: 2000 ms."
      operationId: v1DocumentAgent_GetDocumentCommands
      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.GetDocumentCommandsRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetDocumentCommandsRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetDocumentCommandsRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetDocumentCommandsRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetDocumentCommandsRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetDocumentCommandsRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetDocumentCommandsRequest
        description: DocumentId, AllowedReturnTypes
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Documents.CommandInfo'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Documents.CommandInfo'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Documents.CommandInfo'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Documents.CommandInfo'
            application/json-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Documents.CommandInfo'
            application/merge-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Documents.CommandInfo'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.DocumentCarriers.GetDocumentCommandsRequest:
      description: >-
        GetDocumentCommands: Get a list of custom commands valid for the
        specific document at this time. This information should not be cached by
        clients, as it may change between documents and over time.
      type: object
      properties:
        DocumentId:
          format: int32
          type: integer
        AllowedReturnTypes:
          type: array
          items:
            type: string
    SuperOffice.CRM.Documents.CommandInfo:
      type: object
      properties:
        Name:
          type: string
        DisplayName:
          type: string
        DisplayTooltip:
          type: string
        IconHint:
          type: string
        ReturnType:
          enum:
            - None
            - Message
            - SoProtocol
            - CustomGui
            - Other
            - URL
          type: string

````

## Related topics

- [Get Document Commands](/en/api/reference/restful/rest/document/get-document-commands.md)
- [Execute Document Command](/en/api/reference/restful/rest/document/execute-document-command.md)
- [SuperOffice.WebApi.Data.Document GetDocumentCommandsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Document_GetDocumentCommandsRequest.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)