Box Developer Documentation
Log in
Latest version

Get single shield list by shield list id

get
https://api.box.com/2.0
/shield_lists/:shield_list_id

Retrieves a single shield list by its ID.

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired

Version header.

Value is always 2025.0

Path Parameters

stringin pathrequired
90fb0e17-c332-40ed-b4f9-fa8908fbbb24

The unique identifier that represents a shield list. The ID for any Shield List can be determined by the response from the endpoint fetching all shield lists for the enterprise.

Response

application/jsonShield List

Returns the shield list object.

application/jsonClient error

The shield list was not found.

get
Get single shield list by shield list id
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.shieldLists.getShieldListByIdV2025R0(shieldListCountry.id);
Python Gen
client.shield_lists.get_shield_list_by_id_v2025_r0(shield_list_country.id)
.NET Gen
await client.ShieldLists.GetShieldListByIdV2025R0Async(shieldListId: shieldListCountry.Id);

Response Example

{
  "id": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24",
  "type": "shield_list",
  "content": {
    "type": "country",
    "country_codes": [
      "US",
      "PL"
    ]
  },
  "created_at": "2025-01-13T15:31:01.896Z",
  "description": "A list of things that are shielded",
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  },
  "name": "Shield List Name",
  "updated_at": "2025-01-13T15:31:01.896Z"
}