---
title: "Get List Details"
method: GET
path: "/gw/api/v1/restrictions/list"
tags: ["preTradeComplianceRestrictions"]
---

# Get List Details

`GET /gw/api/v1/restrictions/list`

Returns list metadata and instrument entries. The list must be owned by the caller. Returns 403 for both unauthorized and non-existent lists to prevent ID enumeration.<br><br>**Scope**: `restrictions.read`<br>**Security Policy**: `HTTPS`

## Query parameters

- `masterUserName` string, required
- `listId` integer, required
- `isEmpTrack` string

## Headers

- `Authorization` string, required

## Response `200`

List metadata and entries.

- ListDetailsResponse — Response body for GET /external/listdetails.
  - `status` string, required — Always `ok` on success.
  - `listId` integer, required — Range 1–2147483647.
  - `type` string — Example values: SYMBOL, CONID, EXCHANGE, SECTOR, ISSUERORCONID.
  - `name` string — List name.
  - `description` string, nullable — List description.
  - `entries` ListEntry[], required — Instrument entries. Empty array when none.
    - `id` integer — Entry ID.
    - `type` string — Example values: ISSUER, CONID, SYMBOL, INDUSTRY.
    - `createdAt` integer — Creation timestamp in epoch milliseconds.
    - `params` ListEntryParams — Instrument identifier parameters. Keys depend on entry type: ISSUER/CONID entries use `symbol`, `symboldesc`, `val`; INDUSTRY entries use `indgroup`; other types may use different keys.
      - `symbol` string — Instrument identifier. Format depends on entry type.
      - `symboldesc` string — Human-readable instrument description.
      - `val` string — Internal entity identifier.

## Other responses

- `400` — Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.
- `401` — Missing, invalid, or unparseable Authorization token.
- `403` — Resource does not belong to the caller, does not exist, or an unsupported HTTP method was used. All cases return an identical body to prevent ID enumeration.
- `500` — Internal server error.

---

[API](https://skmtc.net/interactivebrokers/apis/api-reference.md) · [All operations](https://skmtc.net/interactivebrokers/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/interactivebrokers/api-reference/revisions/67f9f562c2c6/schema)