Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Latest version

Get shield information barrier with specified ID

get
https://api.box.com/2.0
/shield_information_barriers/:shield_information_barrier_id

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Get shield information barrier based on provided ID.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
1910967

The ID of the shield information barrier.

Response

application/jsonShield information barrier

Returns the shield information barrier object.

application/jsonClient error

Returns a not_found error if the shield information barrier was not found.

application/jsonClient error

An unexpected client error.

get
Get shield information barrier with specified ID
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


Node/TypeScript v10
await client.shieldInformationBarriers.getShieldInformationBarrierById(
  barrierId,
);
Python v10
client.shield_information_barriers.get_shield_information_barrier_by_id(barrier_id)
.NET v10
await client.ShieldInformationBarriers.GetShieldInformationBarrierByIdAsync(shieldInformationBarrierId: barrierId);
Swift v10
try await client.shieldInformationBarriers.getShieldInformationBarrierById(shieldInformationBarrierId: barrierId)
Java v10
client.getShieldInformationBarriers().getShieldInformationBarrierById(barrierId)
Node v4
const barrier = await client.shieldInformationBarriers.getById({
    shield_information_barrier_id: 12345,
});
console.log(
    `Shield information barrier id ${barrier.id}`
);

Response Example

{
  "id": "11446498",
  "type": "shield_information_barrier",
  "created_at": "2020-06-26T18:44:45.869Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "enabled_at": "2020-07-26T18:44:45.869Z",
  "enabled_by": {
    "id": "11446498",
    "type": "user"
  },
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  },
  "status": "draft",
  "updated_at": "2020-07-26T18:44:45.869Z",
  "updated_by": {
    "id": "11446498",
    "type": "user"
  }
}