Docupilot

Docupilot workspaces API

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

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-workspaces-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-workspaces-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Docupilot accounts APIs ai workspaces 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: workspaces
paths:
  /dashboard/accounts/v2/workspaces/:
    get:
      operationId: list_workspaces
      summary: Get list of Workspaces
      parameters:
      - in: query
        name: active
        schema:
          type: boolean
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - workspaces
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Workspace'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
    post:
      operationId: create_workspace
      summary: Create Workspace
      tags:
      - workspaces
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Workspace'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Workspace'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Workspace'
        required: true
      security:
      - SessionAuthentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/accounts/v2/workspaces/current/:
    get:
      operationId: get_current_workspace
      summary: get current workspace details
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      tags:
      - workspaces
      security:
      - OAuthAuthentication: []
      - SessionAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
    patch:
      operationId: update_current_workspace
      summary: update current workspace details
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      tags:
      - workspaces
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedWorkspace'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedWorkspace'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedWorkspace'
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchedWorkspace'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/accounts/v2/workspaces/current/delete/:
    post:
      operationId: delete_current_workspace
      summary: Delete a workspace and other related data permanently
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      tags:
      - workspaces
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteCurrentWorkspace'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeleteCurrentWorkspace'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DeleteCurrentWorkspace'
        required: true
      security:
      - SessionAuthentication: []
      responses:
        '200':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/accounts/v2/workspaces/retention_preference/:
    get:
      operationId: get_workspace_data_retention_preference
      summary: get workspace data retention preference
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      tags:
      - workspaces
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetentionPreference'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
    put:
      operationId: update_workspace_data_retention_preference
      summary: update workspace data retention preference
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      tags:
      - workspaces
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetentionPreference'
            examples:
              Example1:
                value:
                  merge_data: P1D
                  generated_document: P1D
                summary: Retention Example 1 Day
              Example2:
                value:
                  merge_data: P1M0DT0H
                  generated_document: P1M0DT0H
                summary: Retention Example 1 Month
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RetentionPreference'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RetentionPreference'
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetentionPreference'
              examples:
                Example1:
                  value:
                    merge_data: P1D
                    generated_document: P1D
                  summary: Retention Example 1 Day
                Example2:
                  value:
                    merge_data: P1M0DT0H
                    generated_document: P1M0DT0H
                  summary: Retention Example 1 Month
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
components:
  schemas:
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      description: ''
    ValidationError:
      type: object
      properties:
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        non_field_errors:
          type: array
          items:
            type: string
      required:
      - errors
      - non_field_errors
      description: ''
    ForbiddenError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      description: ''
    RetentionPreference:
      type: object
      properties:
        merge_data:
          type: string
        generated_document:
          type: string
      description: ''
    PatchedWorkspace:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        org_name:
          type: string
          maxLength: 60
        unique_key:
          type: string
          readOnly: true
        role:
          type: string
          readOnly: true
        timezone:
          enum:
          - Pacific/Midway
          - America/Adak
          - Pacific/Honolulu
          - Pacific/Marquesas
          - America/Anchorage
          - America/Tijuana
          - America/Los_Angeles
          - America/Phoenix
          - America/Chihuahua
          - America/Denver
          - America/Belize
          - America/Chicago
          - Pacific/Easter
          - America/Mexico_City
          - America/Regina
          - America/Bogota
          - America/Cancun
          - America/New_York
          - America/Port-au-Prince
          - America/Havana
          - America/Indiana/Indianapolis
          - America/Asuncion
          - America/Halifax
          - America/Caracas
          - America/Cuiaba
          - America/Manaus
          - America/Santiago
          - America/Grand_Turk
          - America/St_Johns
          - America/Fortaleza
          - America/Sao_Paulo
          - America/Cayenne
          - America/Buenos_Aires
          - America/Godthab
          - America/Montevideo
          - America/Miquelon
          - America/Bahia
          - America/Noronha
          - Atlantic/Azores
          - Atlantic/Cape_Verde
          - UTC
          - Africa/Casablanca
          - Europe/London
          - Africa/Monrovia
          - Europe/Amsterdam
          - Europe/Belgrade
          - Europe/Brussels
          - Europe/Warsaw
          - Africa/Algiers
          - Africa/Windhoek
          - Asia/Amman
          - Europe/Athens
          - Asia/Beirut
          - Africa/Cairo
          - Asia/Damascus
          - Asia/Gaza
          - Africa/Harare
          - Europe/Helsinki
          - Asia/Jerusalem
          - Europe/Kaliningrad
          - Africa/Tripoli
          - Asia/Baghdad
          - Asia/Istanbul
          - Asia/Kuwait
          - Europe/Minsk
          - Europe/Moscow
          - Africa/Nairobi
          - Asia/Tehran
          - Asia/Muscat
          - Europe/Astrakhan
          - Asia/Baku
          - Europe/Samara
          - Indian/Mauritius
          - Asia/Tbilisi
          - Asia/Yerevan
          - Asia/Kabul
          - Asia/Tashkent
          - Asia/Yekaterinburg
          - Asia/Karachi
          - Asia/Kolkata
          - Asia/Colombo
          - Asia/Katmandu
          - Asia/Almaty
          - Asia/Dhaka
          - Asia/Rangoon
          - Asia/Novosibirsk
          - Asia/Bangkok
          - Asia/Barnaul
          - Asia/Hovd
          - Asia/Krasnoyarsk
          - Asia/Tomsk
          - Asia/Chongqing
          - Asia/Irkutsk
          - Asia/Kuala_Lumpur
          - Australia/Perth
          - Asia/Taipei
          - Asia/Ulaanbaatar
          - Asia/Pyongyang
          - Australia/Eucla
          - Asia/Chita
          - Asia/Tokyo
          - Asia/Seoul
          - Asia/Yakutsk
          - Australia/Adelaide
          - Australia/Darwin
          - Australia/Brisbane
          - Australia/Canberra
          - Pacific/Guam
          - Australia/Hobart
          - Asia/Vladivostok
          - Australia/Lord_Howe
          - Pacific/Bougainville
          - Asia/Srednekolymsk
          - Asia/Magadan
          - Pacific/Norfolk
          - Asia/Sakhalin
          - Pacific/Guadalcanal
          - Asia/Anadyr
          - Pacific/Auckland
          - Pacific/Fiji
          - Pacific/Chatham
          - Pacific/Tongatapu
          - Pacific/Apia
          - Pacific/Kiritimati
          type: string
          readOnly: true
        plan_id:
          type: string
          nullable: true
          readOnly: true
        plan_status:
          type: string
          readOnly: true
        active:
          type: boolean
          readOnly: true
        mfa_enforced:
          type: boolean
          readOnly: true
        created_time:
          type: string
          format: date-time
          readOnly: true
      description: ''
    Workspace:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        org_name:
          type: string
          maxLength: 60
        unique_key:
          type: string
          readOnly: true
        role:
          type: string
          readOnly: true
        timezone:
          enum:
          - Pacific/Midway
          - America/Adak
          - Pacific/Honolulu
          - Pacific/Marquesas
          - America/Anchorage
          - America/Tijuana
          - America/Los_Angeles
          - America/Phoenix
          - America/Chihuahua
          - America/Denver
          - America/Belize
          - America/Chicago
          - Pacific/Easter
          - America/Mexico_City
          - America/Regina
          - America/Bogota
          - America/Cancun
          - America/New_York
          - America/Port-au-Prince
          - America/Havana
          - America/Indiana/Indianapolis
          - America/Asuncion
          - America/Halifax
          - America/Caracas
          - America/Cuiaba
          - America/Manaus
          - America/Santiago
          - America/Grand_Turk
          - America/St_Johns
          - America/Fortaleza
          - America/Sao_Paulo
          - America/Cayenne
          - America/Buenos_Aires
          - America/Godthab
          - America/Montevideo
          - America/Miquelon
          - America/Bahia
          - America/Noronha
          - Atlantic/Azores
          - Atlantic/Cape_Verde
          - UTC
          - Africa/Casablanca
          - Europe/London
          - Africa/Monrovia
          - Europe/Amsterdam
          - Europe/Belgrade
          - Europe/Brussels
          - Europe/Warsaw
          - Africa/Algiers
          - Africa/Windhoek
          - Asia/Amman
          - Europe/Athens
          - Asia/Beirut
          - Africa/Cairo
          - Asia/Damascus
          - Asia/Gaza
          - Africa/Harare
          - Europe/Helsinki
          - Asia/Jerusalem
          - Europe/Kaliningrad
          - Africa/Tripoli
          - Asia/Baghdad
          - Asia/Istanbul
          - Asia/Kuwait
          - Europe/Minsk
          - Europe/Moscow
          - Africa/Nairobi
          - Asia/Tehran
          - Asia/Muscat
          - Europe/Astrakhan
          - Asia/Baku
          - Europe/Samara
          - Indian/Mauritius
          - Asia/Tbilisi
          - Asia/Yerevan
          - Asia/Kabul
          - Asia/Tashkent
          - Asia/Yekaterinburg
          - Asia/Karachi
          - Asia/Kolkata
          - Asia/Colombo
          - Asia/Katmandu
          - Asia/Almaty
          - Asia/Dhaka
          - Asia/Rangoon
          - Asia/Novosibirsk
          - Asia/Bangkok
          - Asia/Barnaul
          - Asia/Hovd
          - Asia/Krasnoyarsk
          - Asia/Tomsk
          - Asia/Chongqing
          - Asia/Irkutsk
          - Asia/Kuala_Lumpur
          - Australia/Perth
          - Asia/Taipei
          - Asia/Ulaanbaatar
          - Asia/Pyongyang
          - Australia/Eucla
          - Asia/Chita
          - Asia/Tokyo
          - Asia/Seoul
          - Asia/Yakutsk
          - Australia/Adelaide
          - Australia/Darwin
          - Australia/Brisbane
          - Australia/Canberra
          - Pacific/Guam
          - Australia/Hobart
          - Asia/Vladivostok
          - Australia/Lord_Howe
          - Pacific/Bougainville
          - Asia/Srednekolymsk
          - Asia/Magadan
          - Pacific/Norfolk
          - Asia/Sakhalin
          - Pacific/Guadalcanal
          - Asia/Anadyr
          - Pacific/Auckland
          - Pacific/Fiji
          - Pacific/Chatham
          - Pacific/Tongatapu
          - Pacific/Apia
          - Pacific/Kiritimati
          type: string
          readOnly: true
        plan_id:
          type: string
          nullable: true
          readOnly: true
        plan_status:
          type: string
          readOnly: true
        active:
          type: boolean
          readOnly: true
        mfa_enforced:
          type: boolean
          readOnly: true
        created_time:
          type: string
          format: date-time
          readOnly: true
      required:
      - active
      - created_time
      - id
      - mfa_enforced
      - org_name
      - plan_id
      - plan_status
      - role
      - timezone
      - unique_key
      description: ''
    DeleteCurrentWorkspace:
      type: object
      properties:
        otp:
          type: string
          writeOnly: true
      required:
      - otp
      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