Box Platform API — Collaborations (List)

naftiko: 1.0.0-alpha2
info:
  label: Box Platform API — Collaborations (List)
  description: 'Box Platform API — Collaborations (List). 4 operations. Lead operation: Box List pending collaborations. Self-contained
    Naftiko capability covering one Box business surface.'
  tags:
  - Box
  - Collaborations (List)
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BOX_API_KEY: BOX_API_KEY
capability:
  consumes:
  - type: http
    namespace: box-collaborations-list
    baseUri: https://api.box.com/2.0
    description: Box Platform API — Collaborations (List) business capability. Self-contained, no shared references.
    resources:
    - name: collaborations
      path: /collaborations
      operations:
      - name: getcollaborations
        method: GET
        description: Box List pending collaborations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: The status of the collaborations to retrieve
          required: true
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - 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: files-file_id-collaborations
      path: /files/{file_id}/collaborations
      operations:
      - name: getfilesidcollaborations
        method: GET
        description: Box List file collaborations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: file_id
          in: path
          type: string
          description: The unique identifier that represents a file.
          required: true
        - 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: marker
          in: query
          type: string
          description: Defines the position marker at which to begin returning results. This is
    - 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: groups-group_id-collaborations
      path: /groups/{group_id}/collaborations
      operations:
      - name: getgroupsidcollaborations
        method: GET
        description: Box List group collaborations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The ID of the group.
          required: true
        - 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.
    authentication:
      type: bearer
      token: '{{env.BOX_API_KEY}}'
  exposes:
  - type: rest
    namespace: box-collaborations-list-rest
    port: 8080
    description: REST adapter for Box Platform API — Collaborations (List). One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/collaborations
      name: collaborations
      description: REST surface for collaborations.
      operations:
      - method: GET
        name: getcollaborations
        description: Box List pending collaborations
        call: box-collaborations-list.getcollaborations
        with:
          status: rest.status
          fields: rest.fields
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/files/{file-id}/collaborations
      name: files-file-id-collaborations
      description: REST surface for files-file_id-collaborations.
      operations:
      - method: GET
        name: getfilesidcollaborations
        description: Box List file collaborations
        call: box-collaborations-list.getfilesidcollaborations
        with:
          file_id: rest.file_id
          fields: rest.fields
          limit: rest.limit
          marker: rest.marker
        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: box-collaborations-list.getfoldersidcollaborations
        with:
          folder_id: rest.folder_id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{group-id}/collaborations
      name: groups-group-id-collaborations
      description: REST surface for groups-group_id-collaborations.
      operations:
      - method: GET
        name: getgroupsidcollaborations
        description: Box List group collaborations
        call: box-collaborations-list.getgroupsidcollaborations
        with:
          group_id: rest.group_id
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: box-collaborations-list-mcp
    port: 9090
    transport: http
    description: MCP adapter for Box Platform API — Collaborations (List). One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: box-list-pending-collaborations
      description: Box List pending collaborations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: box-collaborations-list.getcollaborations
      with:
        status: tools.status
        fields: tools.fields
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: box-list-file-collaborations
      description: Box List file collaborations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: box-collaborations-list.getfilesidcollaborations
      with:
        file_id: tools.file_id
        fields: tools.fields
        limit: tools.limit
        marker: tools.marker
      outputParameters:
      - type: object
        mapping: $.
    - name: box-list-folder-collaborations
      description: Box List folder collaborations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: box-collaborations-list.getfoldersidcollaborations
      with:
        folder_id: tools.folder_id
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: box-list-group-collaborations
      description: Box List group collaborations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: box-collaborations-list.getgroupsidcollaborations
      with:
        group_id: tools.group_id
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.