Box

Box Shield Information Barriers API

Shield information barrier in Box defines an ethical wall. An ethical wall is a mechanism that prevents exchanges or communication that could lead to conflicts of interest and therefore result in business activities ethically or legally questionable.

Documentation GitHub OpenAPI

Operations 4

GET /shield_information_barriers/{shield_information_barrier_id} Box Get shield information barrier with specified ID #

POST /shield_information_barriers/change_status Box Add changed status of shield information barrier with specified ID #

GET /shield_information_barriers Box List shield information barriers #

POST /shield_information_barriers Box Create shield information barrier #

Documentation

https://developer.box.com/reference/get-authorize

https://developer.box.com/reference/post-oauth2-token

https://developer.box.com/reference/post-files-id-copy

https://developer.box.com/reference/post-file-requests-id-copy

https://developer.box.com/reference/post-folders-id-copy

https://developer.box.com/reference/post-folder-locks

https://developer.box.com/reference/post-metadata-templates-schema

https://developer.box.com/reference/post-metadata-cascade-policies

https://developer.box.com/reference/post-metadata-queries-execute-read

https://developer.box.com/reference/post-comments

https://developer.box.com/reference/post-collaborations

https://developer.box.com/reference/post-tasks

https://developer.box.com/reference/post-task-assignments

https://developer.box.com/reference/put-files-id--add-shared-link

https://developer.box.com/reference/put-folders-id--add-shared-link

https://developer.box.com/reference/post-web-links

https://developer.box.com/reference/put-web-links-id--add-shared-link

https://developer.box.com/reference/post-users

https://developer.box.com/reference/post-invites

https://developer.box.com/reference/post-groups

https://developer.box.com/reference/post-group-memberships

https://developer.box.com/reference/post-webhooks

https://developer.box.com/reference/post-files-id-metadata-global-boxSkillsCards

https://developer.box.com/reference/options-events

https://developer.box.com/reference/get-collections-id

https://developer.box.com/reference/get-recent-items

https://developer.box.com/reference/post-retention-policies

https://developer.box.com/reference/post-retention-policy-assignments

https://developer.box.com/reference/post-legal-hold-policies

https://developer.box.com/reference/post-legal-hold-policy-assignments

https://developer.box.com/reference/get-file-version-retentions-id

https://developer.box.com/reference/get-file-version-legal-holds-id

https://developer.box.com/reference/post-shield-information-barriers-change-status

https://developer.box.com/reference/post-shield-information-barrier-reports

https://developer.box.com/reference/post-shield-information-barrier-segments

https://developer.box.com/reference/post-shield-information-barrier-segment-members

https://developer.box.com/reference/post-shield-information-barrier-segment-restrictions

https://developer.box.com/reference/get-device-pinners-id

https://developer.box.com/reference/post-terms-of-services

https://developer.box.com/reference/post-terms-of-service-user-statuses

https://developer.box.com/reference/post-collaboration-whitelist-entries

https://developer.box.com/

Specifications

https://raw.githubusercontent.com/api-evangelist/box/refs/heads/main/openapi/box-shield-information-barriers-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/box-shield-information-barriers-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Box Platform Shield Information Barriers API
  description: Box Platform provides functionality to provide access to content stored within Box. It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.
  termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
  contact:
    name: Box, Inc
    url: https://box.dev
    email: devrel@box.com
  license:
    name: Apache-2.0
    url: http://www.apache.org/licenses/LICENSE-2.0
  version: 2.0.0
  x-box-commit-hash: '5819125043'
servers:
- url: https://api.box.com/2.0
  description: Box Platform API server
security:
- OAuth2Security: []
tags:
- name: Shield Information Barriers
  description: 'Shield information barrier in Box defines an ethical wall.

    An ethical wall is a mechanism that prevents exchanges or communication that

    could lead to conflicts of interest and therefore result in

    business activities ethically or legally questionable.'
  x-box-tag: shield_information_barriers
paths:
  /shield_information_barriers/{shield_information_barrier_id}:
    get:
      operationId: get_shield_information_barriers_id
      summary: Box Get shield information barrier with specified ID
      tags:
      - Shield Information Barriers
      x-box-tag: shield_information_barriers
      description: Get shield information barrier based on provided ID.
      parameters:
      - name: shield_information_barrier_id
        description: The ID of the shield information barrier.
        example: '1910967'
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the shield information barrier object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrier'
        '404':
          description: 'Returns a `not_found` error if

            the shield information barrier was not found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
  /shield_information_barriers/change_status:
    post:
      operationId: post_shield_information_barriers_change_status
      summary: Box Add changed status of shield information barrier with specified ID
      tags:
      - Shield Information Barriers
      x-box-tag: shield_information_barriers
      description: Change status of shield information barrier with the specified ID.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              - status
              properties:
                id:
                  type: string
                  example: '1910967'
                  description: The ID of the shield information barrier.
                status:
                  type: string
                  enum:
                  - pending
                  - disabled
                  example: pending
                  description: The desired status for the shield information barrier.
      responses:
        '200':
          description: Returns the updated shield information barrier object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrier'
        '404':
          description: 'Returns a `not_found` error if the

            shield information barrier was not found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '409':
          description: 'Returns an error if there exists Conflicts

            with existing information barriers.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
  /shield_information_barriers:
    get:
      operationId: get_shield_information_barriers
      summary: Box List shield information barriers
      tags:
      - Shield Information Barriers
      x-box-tag: shield_information_barriers
      description: 'Retrieves a list of shield information barrier objects

        for the enterprise of JWT.'
      parameters:
      - name: marker
        description: 'Defines the position marker at which to begin returning results. This is

          used when paginating using marker-based pagination.'
        in: query
        required: false
        example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
        schema:
          type: string
      - name: limit
        description: The maximum number of items to return per page.
        in: query
        required: false
        example: 1000
        schema:
          type: integer
          format: int64
          maximum: 1000
      responses:
        '200':
          description: 'Returns a paginated list of

            shield information barrier objects,

            empty list if currently no barrier.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarriers'
        '404':
          description: Returns a `not_found` error if could not find an enterprise using JWT.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
    post:
      operationId: post_shield_information_barriers
      summary: Box Create shield information barrier
      tags:
      - Shield Information Barriers
      x-box-tag: shield_information_barriers
      description: 'Creates a shield information barrier to

        separate individuals/groups within the same

        firm and prevents confidential information passing between them.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enterprise:
                  allOf:
                  - $ref: '#/components/schemas/Enterprise--Base'
                  description: The `type` and `id` of enterprise this barrier is under.
              required:
              - enterprise
      responses:
        '201':
          description: Returns a new shield information barrier object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrier'
        '404':
          description: Returns an error if the enterprise was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
components:
  schemas:
    ClientError:
      title: Client error
      type: object
      x-box-resource-id: client_error
      description: A generic error
      properties:
        type:
          description: error
          example: error
          type: string
          enum:
          - error
        status:
          description: The HTTP status of the response.
          example: 400
          type: integer
          format: int32
        code:
          description: A Box-specific error code
          example: item_name_invalid
          type: string
          enum:
          - created
          - accepted
          - no_content
          - redirect
          - not_modified
          - bad_request
          - unauthorized
          - forbidden
          - not_found
          - method_not_allowed
          - conflict
          - precondition_failed
          - too_many_requests
          - internal_server_error
          - unavailable
          - item_name_invalid
          - insufficient_scope
        message:
          description: A short message describing the error.
          example: Method Not Allowed
          type: string
        context_info:
          description: 'A free-form object that contains additional context

            about the error. The possible fields are defined on

            a per-endpoint basis. `message` is only one example.'
          type:
          - object
          - 'null'
          properties:
            message:
              type: string
              description: More details on the error.
              example: Something went wrong.
        help_url:
          description: A URL that links to more information about why this error occurred.
          example: https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
          type: string
        request_id:
          description: 'A unique identifier for this response, which can be used

            when contacting Box support.'
          type: string
          example: abcdef123456
    ShieldInformationBarrier:
      title: Shield information barrier
      type: object
      x-box-resource-id: shield_information_barrier
      x-box-tag: shield_information_barriers
      x-box-variants:
      - base
      - standard
      x-box-variant: standard
      description: 'A standard representation of a

        shield information barrier object'
      properties:
        id:
          type: string
          example: '11446498'
          description: The unique identifier for the shield information barrier
        type:
          type: string
          description: The type of the shield information barrier
          example: shield_information_barrier
          enum:
          - shield_information_barrier
        enterprise:
          allOf:
          - $ref: '#/components/schemas/Enterprise--Base'
          description: The `type` and `id` of enterprise this barrier is under.
        status:
          type: string
          enum:
          - draft
          - pending
          - disabled
          - enabled
          - invalid
          description: Status of the shield information barrier
          example: draft
        created_at:
          type: string
          format: date-time
          example: '2020-06-26T18:44:45.869Z'
          description: 'ISO date time string when this

            shield information barrier object was created.'
        created_by:
          allOf:
          - $ref: '#/components/schemas/User--Base'
          description: The user who created this shield information barrier.
        updated_at:
          type: string
          format: date-time
          example: '2020-07-26T18:44:45.869Z'
          description: ISO date time string when this shield information barrier was updated.
        updated_by:
          allOf:
          - $ref: '#/components/schemas/User--Base'
          description: The user that updated this shield information barrier.
        enabled_at:
          type: string
          format: date-time
          example: '2020-07-26T18:44:45.869Z'
          description: ISO date time string when this shield information barrier was enabled.
        enabled_by:
          allOf:
          - $ref: '#/components/schemas/User--Base'
          - description: The user that enabled this shield information barrier.
    Enterprise--Base:
      title: Enterprise (Base)
      type: object
      x-box-resource-id: enterprise--base
      x-box-variants:
      - base
      - mini
      - standard
      - full
      x-box-variant: base
      description: 'A mini representation of a enterprise, used when

        nested within another resource.'
      properties:
        id:
          type: string
          description: The unique identifier for this enterprise
          example: '1910967'
        type:
          type: string
          description: '`enterprise`'
          example: enterprise
          enum:
          - enterprise
    User--Base:
      title: User (Base)
      type: object
      x-box-resource-id: user--base
      x-box-tag: users
      x-box-variants:
      - base
      - mini
      - standard
      - full
      x-box-variant: base
      description: 'A mini representation of a user, used when

        nested within another resource.'
      required:
      - type
      - id
      properties:
        id:
          type: string
          description: The unique identifier for this user
          example: '11446498'
        type:
          type: string
          description: '`user`'
          example: user
          enum:
          - user
    ShieldInformationBarriers:
      title: List of Shield Information Barriers
      type: object
      x-box-resource-id: shield_information_barriers
      x-box-tag: shield_information_barriers
      description: List of Shield Information Barrier objects
      allOf:
      - type: object
        description: 'The part of an API response that describes marker

          based pagination'
        properties:
          limit:
            description: 'The limit that was used for these entries. This will be the same as the

              `limit` query parameter unless that value exceeded the maximum value

              allowed. The maximum value varies by API.'
            example: 1000
            type: integer
            format: int64
          next_marker:
            description: The marker for the start of the next page of results.
            example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
            type:
            - string
            - 'null'
      - properties:
          entries:
            type: array
            description: A list of shield information barrier objects
            items:
              $ref: '#/components/schemas/ShieldInformationBarrier'
  securitySchemes:
    OAuth2Security:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://account.box.com/api/oauth2/authorize
          tokenUrl: https://api.box.com/oauth2/token
          scopes:
            root_readonly: Read all files and folders stored in Box
            root_readwrite: Read and write all files and folders stored in Box
            manage_app_users: Provision and manage app users
            manage_managed_users: Provision and manage managed users
            manage_groups: Manage an enterprise's groups
            manage_webhook: Create webhooks programmatically through the API
            manage_enterprise_properties: Manage enterprise properties
            manage_data_retention: Manage data retention polices
            manage_legal_hold: Manage Legal Holds
externalDocs:
  description: Box Developer Documentation
  url: https://developer.box.com