Docupilot

Docupilot permissions API

The permissions API from Docupilot — 4 operation(s) for permissions.

GitHub OpenAPI

Documentation

📖
Documentation
https://help.docupilot.app/developers/api-overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/openapi/docupilot-permissions-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/json-schema/

Other Resources

🔗
SwaggerUI
https://{subdomain}.docupilot.app/~/dashboard/api-docs/swagger-ui/
🔗
Webhooks
https://help.docupilot.app/create-document/api-and-webhook-integration
🔗
JSONExamples
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/examples/
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/vocabulary/docupilot-vocabulary.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/docupilot/refs/heads/main/json-ld/docupilot.jsonld

OpenAPI Specification

docupilot-permissions-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Docupilot accounts APIs ai permissions API
  version: '1.0'
  description: Docupilot accounts APIs
  termsOfService: https://docupilot.app/terms-and-conditions/
  contact:
    name: Team Docupilot
    email: support@docupilot.app
tags:
- name: permissions
paths:
  /dashboard/api/v2/permissions/content_block/:
    get:
      operationId: get_content_block_permissions
      description: Returns content_block permissions
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: query
        name: ids
        schema:
          type: string
      tags:
      - permissions
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
                    enum:
                    - read
                    - write
                    - manage
                example:
                  '199':
                  - read
                  - write
                  '1201':
                  - read
                  '90':
                  - write
              examples:
                ResponseExample:
                  value:
                    '199':
                    - manage
                    - read
                    - write
                    '1201':
                    - read
                    '90':
                    - write
                    - read
                  summary: Response Example
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/api/v2/permissions/folder/:
    get:
      operationId: get_folder_permissions
      description: Returns folder permissions
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: query
        name: ids
        schema:
          type: string
      tags:
      - permissions
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
                    enum:
                    - read
                    - write
                    - manage
                example:
                  '199':
                  - read
                  - write
                  '1201':
                  - read
                  '90':
                  - write
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/api/v2/permissions/global/:
    get:
      operationId: get_global_permissions
      description: Returns permission for each role
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      tags:
      - permissions
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalPermission'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/api/v2/permissions/template/:
    get:
      operationId: get_template_permissions
      description: Returns template permissions
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: query
        name: ids
        schema:
          type: string
      tags:
      - permissions
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
                    enum:
                    - read
                    - write
                    - manage
                example:
                  '199':
                  - read
                  - write
                  '1201':
                  - read
                  '90':
                  - write
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
components:
  schemas:
    GlobalPermission:
      type: object
      properties:
        templates:
          type: boolean
        folders:
          type: boolean
        workspace:
          type: boolean
        workspace:update:
          type: boolean
        workspace:delete:
          type: boolean
        billing:
          type: boolean
        team:manage:
          type: boolean
        integrations:
          type: boolean
        reports:
          type: boolean
        api_settings:
          type: boolean
        eSignatures:
          type: boolean
        extensions:
          type: boolean
        delivery:create:
          type: boolean
        settings:esign:general:
          type: boolean
        settings:esign:webhook:
          type: boolean
      required:
      - api_settings
      - billing
      - delivery:create
      - eSignatures
      - extensions
      - folders
      - integrations
      - reports
      - settings:esign:general
      - settings:esign:webhook
      - team:manage
      - templates
      - workspace
      - workspace:delete
      - workspace:update
      description: ''
    ForbiddenError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      description: ''
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      description: ''
  securitySchemes:
    OAuthAuthentication:
      type: http
      scheme: bearer
      description: OAuth2 Bearer Token Authentication
    SessionAuthentication:
      type: apiKey
      in: cookie
      name: sessionid
      description: browser based login takes care of this
externalDocs:
  description: Help docs on how to use API
  url: https://help.docupilot.app/developers/api-overview