> ## Documentation Index
> Fetch the complete documentation index at: https://rollout.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Smart List

> Requires `smartLists: true` in the credential's `entitiesToSync` selection and a connector that supports this operation. [Choose what data to sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout), or [fix an entity that is not configured to sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).



## OpenAPI

````yaml /openapi/crm.json get /smart-lists/{id}
openapi: 3.0.3
info:
  title: Universal CRM API Documentation
  description: Development documentation
  version: '1.0'
servers:
  - url: https://crm.universal.rollout.com/api
security: []
paths:
  /smart-lists/{id}:
    get:
      tags:
        - Smart Lists
      summary: Get Smart List
      description: >-
        Requires `smartLists: true` in the credential's `entitiesToSync`
        selection and a connector that supports this operation. [Choose what
        data to
        sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout),
        or [fix an entity that is not configured to
        sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).
      operationId: getSmart-listsById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: fields
          in: query
          required: false
          schema:
            type: string
            description: >-
              Comma-separated top-level fields to return; the parameter can also
              be repeated, once per field. `id` is always returned. Omit it, or
              pass `allFields`, to get every field, including `original`.
              Unknown names return 400.
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  description:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  isFub2:
                    description: Present unless the request's `fields` leaves it out.
                    type: boolean
                  shared:
                    description: Present unless the request's `fields` leaves it out.
                    type: boolean
                  userId:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: string
                  conditions:
                    description: Present unless the request's `fields` leaves it out.
                    type: array
                    items:
                      type: array
                      items:
                        type: object
                        properties:
                          fld:
                            type: string
                          opr:
                            type: string
                          num:
                            nullable: true
                            type: string
                          unit:
                            type: string
                          val:
                            type: array
                            items:
                              anyOf:
                                - type: string
                                - type: number
                        required:
                          - fld
                          - opr
                          - num
                          - unit
                          - val
                  sortBy:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  columns:
                    description: Present unless the request's `fields` leaves it out.
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        enabled:
                          type: boolean
                        width:
                          type: number
                      required:
                        - name
                        - enabled
                  sharedWith:
                    description: Present unless the request's `fields` leaves it out.
                    type: object
                    properties:
                      userIds:
                        type: array
                        items:
                          anyOf:
                            - type: string
                            - type: number
                      teamIds:
                        type: array
                        items:
                          anyOf:
                            - type: string
                            - type: number
                    required:
                      - userIds
                      - teamIds
                  created:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: string
                  updated:
                    description: Present unless the request's `fields` leaves it out.
                    nullable: true
                    type: string
                  rolloutUpdated:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  originalIds:
                    description: Present unless the request's `fields` leaves it out.
                    type: object
                    additionalProperties:
                      anyOf:
                        - type: number
                        - type: string
                  original:
                    description: Present unless the request's `fields` leaves it out.
                    type: object
                    additionalProperties:
                      type: object
                      additionalProperties: {}
                required:
                  - id
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                required:
                  - errorMessage
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                required:
                  - errorMessage
        '409':
          description: Response for status 409
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                    enum:
                      - >-
                        Data for this credential is not ready yet. Please try
                        again.
                required:
                  - errorMessage
      security:
        - jwt: []
          credential_id: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      description: Consumer JWT minted by the tenant's backend
    credential_id:
      type: apiKey
      in: header
      name: X-Rollout-Credential-Id
      description: The Rollout Credential ID to use for queries/mutations

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.