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

# List lists

> List lists, optionally filtered by object or name.



## OpenAPI

````yaml GET /data/v1/lists
openapi: 3.1.0
info:
  title: Unify Data API
  summary: Interact with objects, attributes, and records within the Unify platform.
  version: '1'
  termsOfService: https://www.unifygtm.com/legal/terms-and-conditions
  contact:
    name: Unify Support
    url: https://www.unifygtm.com/support
    email: support@unifygtm.com
servers:
  - url: https://api.unifygtm.com
    variables: {}
security:
  - ApiKeyAuth: []
tags:
  - name: Data
  - name: Object Record Query Jobs
  - name: Event Query Jobs
  - name: Lists
  - name: List Entries
  - name: Objects
  - name: Object Attributes
  - name: Object Attribute Options
  - name: Object Records
paths:
  /data/v1/lists:
    get:
      tags:
        - Data
        - Lists
      description: List the lists the caller can see.
      operationId: list_lists
      parameters:
        - name: cursor
          in: query
          required: false
          description: >-
            Opaque cursor returned by the previous page. Pass it unchanged with
            the

            same filters.
          schema:
            $ref: '#/components/schemas/UValues.UUuid'
          explode: false
        - name: limit
          in: query
          required: false
          description: Maximum number of lists to return. Defaults to 100.
          schema:
            type: integer
            minimum: 1
            maximum: 100
          explode: false
        - name: object
          in: query
          required: false
          description: Filter lists by object API name.
          schema:
            $ref: '#/components/schemas/UObjects.UObjectName'
          explode: false
        - name: name
          in: query
          required: false
          description: Filter lists by exact name.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: Response for a successful paginated list of lists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListListsResponse'
        '400':
          description: Response for any operation that results in a bad request error.
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                properties:
                  status:
                    type: string
                    enum:
                      - bad_request
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/UResponses.BadRequestError'
                  message:
                    type: string
                description: >-
                  Response for any operation that results in a bad request
                  error.
        '401':
          description: Response for any operation that results in an unauthorized error.
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - message
                properties:
                  status:
                    type: string
                    enum:
                      - unauthorized
                  message:
                    type: string
                description: >-
                  Response for any operation that results in an unauthorized
                  error.
        '403':
          description: Response for any operation that results in a forbidden error.
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - message
                properties:
                  status:
                    type: string
                    enum:
                      - forbidden
                  message:
                    type: string
                description: Response for any operation that results in a forbidden error.
        '429':
          description: Response for any operation that exceeds a rate limit.
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - message
                properties:
                  status:
                    type: string
                    enum:
                      - rate_limited
                  message:
                    type: string
                description: Response for any operation that exceeds a rate limit.
        '500':
          description: Response for any operation that results in an internal server error.
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - message
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                description: >-
                  Response for any operation that results in an internal server
                  error.
components:
  schemas:
    UValues.UUuid:
      type: string
      description: String UUIDv4 value.
      title: UUuid
    UObjects.UObjectName:
      type: string
      description: |-
        The API name of an object, e.g. `company`, `person`, `opportunity`, or a
        custom object's API name.
    ListListsResponse:
      type: object
      required:
        - status
        - data
        - next_cursor
      properties:
        status:
          type: string
          enum:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/UList'
          description: Lists ordered by creation time, newest first.
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Opaque cursor for the next page, or `null` when there are no more
            lists.
      description: Response for a successful paginated list of lists.
    UResponses.BadRequestError:
      type: object
      required:
        - code
      properties:
        code:
          type: string
        path:
          type: array
          items:
            anyOf:
              - type: string
              - type: integer
        object_api_name:
          type: string
        attribute_api_name:
          type: string
      allOf:
        - type: object
          unevaluatedProperties: {}
      description: Validation error detail returned for bad request responses.
    UList:
      type: object
      required:
        - id
        - created_at
        - updated_at
        - name
        - object
        - owner_id
        - share_status
      properties:
        id:
          $ref: '#/components/schemas/UValues.UUuid'
          description: Unique identifier for the list.
        created_at:
          type: string
          format: date-time
          description: Date and time the list was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time the list was last updated.
        name:
          type: string
          description: Name of the list. Unique within the workspace.
        object:
          $ref: '#/components/schemas/UObjects.UObjectName'
          description: >-
            API name of the object whose records the list holds. Cannot be
            changed

            after creation.
        owner_id:
          $ref: '#/components/schemas/UValues.UUuid'
          description: ID of the user who owns the list.
        share_status:
          $ref: '#/components/schemas/UListShareStatus'
          description: Who can see and change the list.
      description: A named collection of records of one object.
    UListShareStatus:
      type: string
      enum:
        - ONLY_ME
        - ALL_OTHERS_CAN_VIEW
        - ALL_OTHERS_CAN_EDIT
      description: >-
        Who can see and change a list beyond its owner.


        - `ONLY_ME`: Access is limited to the owner and users explicitly granted

        access.

        - `ALL_OTHERS_CAN_VIEW`: Everyone in the workspace can view the list.
        Only

        the owner and users with manage access can change it.

        - `ALL_OTHERS_CAN_EDIT`: Everyone in the workspace can view and change
        the

        list.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

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