List shield information barrier segments

get

https://api.box.com/2.0

/shield_information_barrier_segments

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

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Query Parameters

limit integer / int64in queryoptional

example1000max1000

The maximum number of items to return per page.

marker stringin queryoptional

example"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.

shield_information_barrier_id stringin queryrequired

example"1910967"

The ID of the shield information barrier.

Response

200application/json

Returns a paginated list of shield information barrier segment objects.

404application/jsonClient error

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

defaultapplication/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.

Request Example

Node

const result = await client.shieldInformationBarrierSegments.getAll({
	shield_information_barrier_id: '123'
});
console.log(`There are ${result.entries.length} shield information barrier segments`);