Get List

Route

/v2/lists/{list_id}

Description

Retrieve detailed information about a specific policy configuration list, including all values and metadata.

Method

GET

Inputs

Parameter	Type	Required	Description
list_id	string	Yes	Unique identifier of the list to retrieve

Path Parameters

• list_id: The unique identifier of the list (provided in the URL path)

Request Example

GET /v2/lists/list-123

Output

Field	Type	Description
id	string	Unique list identifier
name	string	List name
description	string	List description
type	string	List type (file_extension, domain, keyword, etc.)
values	array[string]	Complete list of all values
value_count	integer	Total number of values in list
usage	object	Usage information showing where list is referenced
created_at	string	Creation timestamp (ISO 8601)
updated_at	string	Last update timestamp (ISO 8601)

Usage Object

Field	Type	Description
policy_count	integer	Number of policies using this list
policies	array[string]	Names of policies referencing this list

Rate Limit

• 60 requests per minute per API key
• 5 concurrent requests per endpoint

Example Response

{
  "id": "list-123",
  "name": "Office File Extensions",
  "description": "Common Microsoft Office file extensions",
  "type": "file_extension",
  "values": [
    ".docx", ".xlsx", ".pptx", ".doc", ".xls", ".ppt",
    ".docm", ".xlsm", ".pptm", ".dotx", ".xltx", ".potx",
    ".dotm", ".xltm", ".potm", ".odt", ".ods", ".odp"
  ],
  "value_count": 18,
  "usage": {
    "policy_count": 3,
    "policies": [
      "Document Protection Policy",
      "Email Attachment Policy", 
      "Cloud Upload Restriction"
    ]
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:45:00Z"
}

Usage Notes

• Returns complete list of all values (no pagination)
• Usage information helps understand policy dependencies
• Large lists (>1000 values) may have slower response times