Box Folders API — Folders

naftiko: 1.0.0-alpha2
info:
  label: Box Folders API — Folders
  description: 'Box Folders API — Folders. 27 operations. Lead operation: Box Create folder. Self-contained Naftiko capability
    covering one Box business surface.'
  tags:
  - Box
  - Folders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BOX_API_KEY: BOX_API_KEY
capability:
  consumes:
  - type: http
    namespace: folders-folders
    baseUri: ''
    description: Box Folders API — Folders business capability. Self-contained, no shared references.
    resources:
    - name: folders
      path: /folders
      operations:
      - name: postfolders
        method: POST
        description: Box Create folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: folders-trash-items
      path: /folders/trash/items
      operations:
      - name: getfolderstrashitems
        method: GET
        description: Box List trashed items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: limit
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: offset
          in: query
          type: integer
          description: The offset of the item at which to begin the response.
        - name: usemarker
          in: query
          type: boolean
          description: Specifies whether to use marker-based pagination instead of
        - name: marker
          in: query
          type: string
          description: Defines the position marker at which to begin returning results. This is
        - name: direction
          in: query
          type: string
          description: The direction to sort results in. This can be either in alphabetical ascending
        - name: sort
          in: query
          type: string
          description: Defines the **second** attribute by which items
    - name: folders-folder_id
      path: /folders/{folder_id}
      operations:
      - name: getfoldersid
        method: GET
        description: Box Get folder information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: if-none-match
          in: header
          type: string
          description: Ensures an item is only returned if it has changed.
        - name: boxapi
          in: header
          type: string
          description: The URL, and optional password, for the shared link of this item.
        - name: sort
          in: query
          type: string
          description: Defines the **second** attribute by which items
        - name: direction
          in: query
          type: string
          description: The direction to sort results in. This can be either in alphabetical ascending
        - name: offset
          in: query
          type: integer
          description: The offset of the item at which to begin the response.
        - name: limit
          in: query
          type: integer
          description: The maximum number of items to return per page.
      - name: postfoldersid
        method: POST
        description: Box Restore folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: putfoldersid
        method: PUT
        description: Box Update folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: if-match
          in: header
          type: string
          description: Ensures this item hasn't recently changed before
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletefoldersid
        method: DELETE
        description: Box Delete folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: if-match
          in: header
          type: string
          description: Ensures this item hasn't recently changed before
        - name: recursive
          in: query
          type: boolean
          description: Delete a folder that is not empty by recursively deleting the
    - name: folders-folder_id}#add_shared_link
      path: /folders/{folder_id}#add_shared_link
      operations:
      - name: putfoldersidaddsharedlink
        method: PUT
        description: Box Add shared link to folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: fields
          in: query
          type: string
          description: Explicitly request the `shared_link` fields
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: folders-folder_id}#get_shared_link
      path: /folders/{folder_id}#get_shared_link
      operations:
      - name: getfoldersidgetsharedlink
        method: GET
        description: Box Get shared link for folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: fields
          in: query
          type: string
          description: Explicitly request the `shared_link` fields
          required: true
    - name: folders-folder_id}#remove_shared_link
      path: /folders/{folder_id}#remove_shared_link
      operations:
      - name: putfoldersidremovesharedlink
        method: PUT
        description: Box Remove shared link from folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: fields
          in: query
          type: string
          description: Explicitly request the `shared_link` fields
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: folders-folder_id}#update_shared_link
      path: /folders/{folder_id}#update_shared_link
      operations:
      - name: putfoldersidupdatesharedlink
        method: PUT
        description: Box Update shared link on folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: fields
          in: query
          type: string
          description: Explicitly request the `shared_link` fields
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: folders-folder_id-collaborations
      path: /folders/{folder_id}/collaborations
      operations:
      - name: getfoldersidcollaborations
        method: GET
        description: Box List folder collaborations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
    - name: folders-folder_id-copy
      path: /folders/{folder_id}/copy
      operations:
      - name: postfoldersidcopy
        method: POST
        description: Box Copy folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier of the folder to copy.
          required: true
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: folders-folder_id-items
      path: /folders/{folder_id}/items
      operations:
      - name: getfoldersiditems
        method: GET
        description: Box List items in folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: usemarker
          in: query
          type: boolean
          description: Specifies whether to use marker-based pagination instead of
        - name: marker
          in: query
          type: string
          description: Defines the position marker at which to begin returning results. This is
        - name: offset
          in: query
          type: integer
          description: The offset of the item at which to begin the response.
        - name: limit
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: boxapi
          in: header
          type: string
          description: The URL, and optional password, for the shared link of this item.
        - name: sort
          in: query
          type: string
          description: Defines the **second** attribute by which items
        - name: direction
          in: query
          type: string
          description: The direction to sort results in. This can be either in alphabetical ascending
    - name: folders-folder_id-metadata
      path: /folders/{folder_id}/metadata
      operations:
      - name: getfoldersidmetadata
        method: GET
        description: Box List metadata instances on folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
    - name: folders-folder_id-metadata-enterprise-securityClassification-6VMVochwUWo
      path: /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo
      operations:
      - name: getfoldersidmetadataenterprisesecurityclassification6vmvochwuwo
        method: GET
        description: Box Get classification on folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
      - name: postfoldersidmetadataenterprisesecurityclassification6vmvochwuwo
        method: POST
        description: Box Add classification to folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: putfoldersidmetadataenterprisesecurityclassification6vmvochwuwo
        method: PUT
        description: Box Update classification on folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletefoldersidmetadataenterprisesecurityclassification6vmvochwuwo
        method: DELETE
        description: Box Remove classification from folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
    - name: folders-folder_id-metadata-scope-template_key
      path: /folders/{folder_id}/metadata/{scope}/{template_key}
      operations:
      - name: getfoldersidmetadataidid
        method: GET
        description: Box Get metadata instance on folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: scope
          in: path
          type: string
          description: The scope of the metadata template
          required: true
        - name: template_key
          in: path
          type: string
          description: The name of the metadata template
          required: true
      - name: postfoldersidmetadataidid
        method: POST
        description: Box Create metadata instance on folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: scope
          in: path
          type: string
          description: The scope of the metadata template
          required: true
        - name: template_key
          in: path
          type: string
          description: The name of the metadata template
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: putfoldersidmetadataidid
        method: PUT
        description: Box Update metadata instance on folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: scope
          in: path
          type: string
          description: The scope of the metadata template
          required: true
        - name: template_key
          in: path
          type: string
          description: The name of the metadata template
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletefoldersidmetadataidid
        method: DELETE
        description: Box Remove metadata instance from folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: scope
          in: path
          type: string
          description: The scope of the metadata template
          required: true
        - name: template_key
          in: path
          type: string
          description: The name of the metadata template
          required: true
    - name: folders-folder_id-trash
      path: /folders/{folder_id}/trash
      operations:
      - name: getfoldersidtrash
        method: GET
        description: Box Get trashed folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
      - name: deletefoldersidtrash
        method: DELETE
        description: Box Permanently remove folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
    - name: folders-folder_id-watermark
      path: /folders/{folder_id}/watermark
      operations:
      - name: getfoldersidwatermark
        method: GET
        description: Box Get watermark for folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
      - name: putfoldersidwatermark
        method: PUT
        description: Box Apply watermark to folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletefoldersidwatermark
        method: DELETE
        description: Box Remove watermark from folder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: path
          type: string
          description: The unique identifier that represent a folder.
          required: true
  exposes:
  - type: rest
    namespace: folders-folders-rest
    port: 8080
    description: REST adapter for Box Folders API — Folders. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/folders
      name: folders
      description: REST surface for folders.
      operations:
      - method: POST
        name: postfolders
        description: Box Create folder
        call: folders-folders.postfolders
        with:
          fields: rest.fields
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/trash/items
      name: folders-trash-items
      description: REST surface for folders-trash-items.
      operations:
      - method: GET
        name: getfolderstrashitems
        description: Box List trashed items
        call: folders-folders.getfolderstrashitems
        with:
          fields: rest.fields
          limit: rest.limit
          offset: rest.offset
          usemarker: rest.usemarker
          marker: rest.marker
          direction: rest.direction
          sort: rest.sort
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/{folder-id}
      name: folders-folder-id
      description: REST surface for folders-folder_id.
      operations:
      - method: GET
        name: getfoldersid
        description: Box Get folder information
        call: folders-folders.getfoldersid
        with:
          folder_id: rest.folder_id
          fields: rest.fields
          if-none-match: rest.if-none-match
          boxapi: rest.boxapi
          sort: rest.sort
          direction: rest.direction
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postfoldersid
        description: Box Restore folder
        call: folders-folders.postfoldersid
        with:
          folder_id: rest.folder_id
          fields: rest.fields
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putfoldersid
        description: Box Update folder
        call: folders-folders.putfoldersid
        with:
          folder_id: rest.folder_id
          fields: rest.fields
          if-match: rest.if-match
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletefoldersid
        description: Box Delete folder
        call: folders-folders.deletefoldersid
        with:
          folder_id: rest.folder_id
          if-match: rest.if-match
          recursive: rest.recursive
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/folder-id-add-shared-link
      name: folders-folder-id-add-shared-link
      description: REST surface for folders-folder_id}#add_shared_link.
      operations:
      - method: PUT
        name: putfoldersidaddsharedlink
        description: Box Add shared link to folder
        call: folders-folders.putfoldersidaddsharedlink
        with:
          folder_id: rest.folder_id
          fields: rest.fields
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/folder-id-get-shared-link
      name: folders-folder-id-get-shared-link
      description: REST surface for folders-folder_id}#get_shared_link.
      operations:
      - method: GET
        name: getfoldersidgetsharedlink
        description: Box Get shared link for folder
        call: folders-folders.getfoldersidgetsharedlink
        with:
          folder_id: rest.folder_id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/folder-id-remove-shared-link
      name: folders-folder-id-remove-shared-link
      description: REST surface for folders-folder_id}#remove_shared_link.
      operations:
      - method: PUT
        name: putfoldersidremovesharedlink
        description: Box Remove shared link from folder
        call: folders-folders.putfoldersidremovesharedlink
        with:
          folder_id: rest.folder_id
          fields: rest.fields
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/folder-id-update-shared-link
      name: folders-folder-id-update-shared-link
      description: REST surface for folders-folder_id}#update_shared_link.
      operations:
      - method: PUT
        name: putfoldersidupdatesharedlink
        description: Box Update shared link on folder
        call: folders-folders.putfoldersidupdatesharedlink
        with:
          folder_id: rest.folder_id
          fields: rest.fields
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/{folder-id}/collaborations
      name: folders-folder-id-collaborations
      description: REST surface for folders-folder_id-collaborations.
      operations:
      - method: GET
        name: getfoldersidcollaborations
        description: Box List folder collaborations
        call: folders-folders.getfoldersidcollaborations
        with:
          folder_id: rest.folder_id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/{folder-id}/copy
      name: folders-folder-id-copy
      description: REST surface for folders-folder_id-copy.
      operations:
      - method: POST
        name: postfoldersidcopy
        description: Box Copy folder
        call: folders-folders.postfoldersidcopy
        with:
          folder_id: rest.folder_id
          fields: rest.fields
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/{folder-id}/items
      name: folders-folder-id-items
      description: REST surface for folders-folder_id-items.
      operations:
      - method: GET
        name: getfoldersiditems
        description: Box List items in folder
        call: folders-folders.getfoldersiditems
        with:
          folder_id: rest.folder_id
          fields: rest.fields
          usemarker: rest.usemarker
          marker: rest.marker
          offset: rest.offset
          limit: rest.limit
          boxapi: rest.boxapi
          sort: rest.sort
          direction: rest.direction
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/{folder-id}/metadata
      name: folders-folder-id-metadata
      description: REST surface for folders-folder_id-metadata.
      operations:
      - method: GET
        name: getfoldersidmetadata
        description: Box List metadata instances on folder
        call: folders-folders.getfoldersidmetadata
        with:
          folder_id: rest.folder_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/{folder-id}/metadata/enterprise/securityclassification-6vmvochwuwo
      name: folders-folder-id-metadata-enterprise-securityclassification-6vmvochwuwo
      description: REST surface for folders-folder_id-metadata-enterprise-securityClassification-6VMVochwUWo.
      operations:
      - method: GET
        name: getfoldersidmetadataenterprisesecurityclassification6vmvochwuwo
        description: Box Get classification on folder
        call: folders-folders.getfoldersidmetadataenterprisesecurityclassification6vmvochwuwo
        with:
          folder_id: rest.folder_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postfoldersidmetadataenterprisesecurityclassification6vmvochwuwo
        description: Box Add classification to folder
        call: folders-folders.postfoldersidmetadataenterprisesecurityclassification6vmvochwuwo
        with:
          folder_id: rest.folder_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putfoldersidmetadataenterprisesecurityclassification6vmvochwuwo
        description: Box Update classification on folder
        call: folders-folders.putfoldersidmetadataenterprisesecurityclassification6vmvochwuwo
        with:
          folder_id: rest.folder_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletefoldersidmetadataenterprisesecurityclassification6vmvochwuwo
        description: Box Remove classification from folder
        call: folders-folders.deletefoldersidmetadataenterprisesecurityclassification6vmvochwuwo
        with:
          folder_id: rest.folder_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/{folder-id}/metadata/{scope}/{template-key}
      name: folders-folder-id-metadata-scope-template-key
      description: REST surface for folders-folder_id-metadata-scope-template_key.
      operations:
      - method: GET
        name: getfoldersidmetadataidid
        description: Box Get metadata instance on folder
        call: folders-folders.getfoldersidmetadataidid
        with:
          folder_id: rest.folder_id
          scope: rest.scope
          template_key: rest.template_key
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postfoldersidmetadataidid
        description: Box Create metadata instance on folder
        call: folders-folders.postfoldersidmetadataidid
        with:
          folder_id: rest.folder_id
          scope: rest.scope
          template_key: rest.template_key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putfoldersidmetadataidid
        description: Box Update metadata instance on folder
        call: folders-folders.putfoldersidmetadataidid
        with:
          folder_id: rest.folder_id
          scope: rest.scope
          template_key: rest.template_key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletefoldersidmetadataidid
        description: Box Remove metadata instance from folder
        call: folders-folders.deletefoldersidmetadataidid
        with:
          folder_id: rest.folder_id
          scope: rest.scope
          template_key: rest.template_key
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/{folder-id}/trash
      name: folders-folder-id-trash
      description: REST surface for folders-folder_id-trash.
      operations:
      - method: GET
        name: getfoldersidtrash
        description: Box Get trashed folder
        call: folders-folders.getfoldersidtrash
        with:
          folder_id: rest.folder_id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletefoldersidtrash
        description: Box Permanently remove folder
        call: folders-folders.deletefoldersidtrash
        with:
          folder_id: rest.folder_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/folders/{folder-id}/watermark
      name: folders-folder-id-watermark
      description: R

# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/box/refs/heads/main/capabilities/folders-folders.yaml