---
title: "Get list"
method: GET
path: "/crm/lists/{id}"
tags: ["Lists"]
---

# Get list

`GET /crm/lists/{id}`

Get list

## Path parameters

- `id` string, required

## Query parameters

- `raw` boolean
- `fields` string, nullable

## Headers

- `x-apideck-consumer-id` string, required
- `x-apideck-app-id` string, required
- `x-apideck-service-id` string

## Response `200`

List

- GetListResponse
  - `status_code` integer, required — HTTP Response Status Code
  - `status` string, required — HTTP Response Status
  - `service` string, required — Apideck ID of service provider
  - `resource` string, required — Unified API resource name
  - `operation` string, required — Operation performed
  - `data` List, required
    - `id` string, required — The unique identifier of the List.
    - `name` string, required — The name of the List.
    - `description` string, nullable — The description of the List.
    - `type` 'static' | 'dynamic', nullable — Whether the List is static (a fixed set of records) or dynamic (a saved segment that is automatically kept up to date based on filter criteria).
    - `visibility` 'private' | 'shared' | 'public', nullable — The visibility of the List. Which of these values a given connector can return depends on its native sharing model — see the connector-specific gotchas below for details.
    - `owner_id` string, nullable — The unique identifier of the user who owns the List.
    - `filter_criteria` object, nullable — The filter criteria used to determine which records belong to a dynamic List. Shape is connector-native and passed through largely as-is (e.g. Close returns its own nested query-tree structure) rather than normalized to a common format.
    - `record_count` integer, nullable — The number of records currently in the List.
    - `folder_id` string, nullable — The unique identifier of the folder the List is organized under.
    - `object_type` string, nullable — The type of CRM records the List contains. Normalized to a lowercase plural noun for the vendor's standard object types (e.g. contacts, companies, opportunities, leads, tickets, campaigns, tasks, events); for vendor-specific or custom object types the raw downstream identifier is passed through unchanged, following the connector's native casing (e.g. a HubSpot custom objectTypeId like 2-12345 or a Salesforce custom object API name), so a raw value may not always be distinguishable from a normalized one. This field is intentionally open-ended — no closed enum is enforced.
    - `is_dynamic` boolean, nullable — Whether the List is dynamic, meaning its records are automatically kept up to date based on filter criteria. This is a boolean mirror of `type` (`true` when `type` is `dynamic`, `false` when `static`), provided for callers that prefer a boolean check over a string comparison.
    - `is_favorite` boolean, nullable — Whether the List has been marked as a favorite.
    - `is_default` boolean, nullable — Whether the List is a default List.
    - `is_system` boolean, nullable — Whether the List is a system-generated List.
    - `custom_fields` CustomField[]
      - union
        - object
          - `id` string, nullable, required — Unique identifier for the custom field.
          - `name` string, nullable — Name of the custom field.
          - `description` string, nullable — More information about the custom field
          - `value` union
            - string, nullable
            - number, nullable
            - boolean, nullable
            - object, nullable
            - union[]
              - …
        - object
          - `id` string, nullable — Unique identifier for the custom field.
          - `name` string, nullable, required — Name of the custom field.
          - `description` string, nullable — More information about the custom field
          - `value` union
            - string, nullable
            - number, nullable
            - boolean, nullable
            - object, nullable
            - union[]
              - …
    - `tags` string[], nullable
    - `updated_by` string, nullable — The unique identifier of the user who last updated the List.
    - `created_by` string, nullable — The unique identifier of the user who created the List.
    - `updated_at` string, date-time, nullable — The date and time when the List was last updated.
    - `created_at` string, date-time, nullable — The date and time when the List was created.
  - `meta` Meta — Response metadata
    - `items_on_page` integer — Number of items returned in the data property of the response
    - `cursors` object — Cursors to navigate to previous or next pages through the API
      - `previous` string, nullable — Cursor to navigate to the previous page of results through the API
      - `current` string, nullable — Cursor to navigate to the current page of results through the API
      - `next` string, nullable — Cursor to navigate to the next page of results through the API
    - `total_count` integer — Number of records available in total for this resource
    - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200.
      - `type` string — Discriminator for the warning kind.
      - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available.
      - `error` string, nullable — Short error description from the downstream provider, when available.
      - `operation` string, nullable — Identifier of the workflow step that failed.
      - `message` string, nullable — Detailed message from the downstream provider, when available.
  - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `404` — The specified resource was not found
- `422` — Unprocessable
- `default` — Unexpected error

---

[API](https://skmtc.net/apideck-libraries/apis/crm-api.md) · [All operations](https://skmtc.net/apideck-libraries/apis/crm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apideck-libraries/crm-api/revisions/2bceab9768fd/schema)