Box Developer Documentation
Log in
Latest version

List shield information barrier segments

get
https://api.box.com/2.0
/shield_information_barrier_segments

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

Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID.

Request

bearer [ACCESS_TOKEN]
application/json

Query Parameters

integer (int64)in queryoptional
1000
1000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

stringin queryrequired
1910967

The ID of the shield information barrier.

Response

application/jsonList of Shield Information Barrier Segments

Returns a paginated list of shield information barrier segment objects.

application/jsonClient error

Returns a not_found error if the shield information Barrier of given ID was not found.

application/jsonClient error

An unexpected client error.

get
List shield information barrier segments
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegments(
  {
    shieldInformationBarrierId: barrierId,
  } satisfies GetShieldInformationBarrierSegmentsQueryParams,
);
Python Gen
client.shield_information_barrier_segments.get_shield_information_barrier_segments(
    barrier_id
)
.NET Gen
await client.ShieldInformationBarrierSegments.GetShieldInformationBarrierSegmentsAsync(queryParams: new GetShieldInformationBarrierSegmentsQueryParams(shieldInformationBarrierId: barrierId));
Swift Gen (Beta)
try await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegments(queryParams: GetShieldInformationBarrierSegmentsQueryParams(shieldInformationBarrierId: barrierId))
Node
const result = await client.shieldInformationBarrierSegments.getAll({
	shield_information_barrier_id: '123'
});
console.log(`There are ${result.entries.length} shield information barrier segments`);

Response Example

{
  "entries": [
    {
      "created_at": "2020-06-26T18:44:45.869Z",
      "created_by": {
        "id": "11446498",
        "type": "user"
      },
      "description": "'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'",
      "id": "11446498",
      "name": "Investment Banking",
      "shield_information_barrier": {
        "id": "11446498",
        "type": "shield_information_barrier"
      },
      "type": "shield_information_barrier_segment",
      "updated_at": "2020-07-26T18:44:45.869Z",
      "updated_by": {
        "id": "11446498",
        "type": "user"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}