List shield information barrier segments


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



Query Parameters

integer / int64in queryoptional

The maximum number of items to return per page.

stringin queryoptional

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

The ID of the shield information barrier.


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.

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

Request Example

const result = await client.shieldInformationBarrierSegments.getAll({
	shield_information_barrier_id: '123'
console.log(`There are ${result.entries.length} shield information barrier segments`);
TypeScript (Beta)
await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegments(
    shieldInformationBarrierId: barrierId,
  } satisfies GetShieldInformationBarrierSegmentsQueryParamsArg

Response Example

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