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

# Get one list's metadata

> One list's metadata: name, kind (`entityType`), `completionStatus` (`processing` while an import, copy, save-to-list or enrichment is still populating it, `complete` otherwise — poll this after any 202 that targets the list), the row count, and the enrichment `metrics` (rows enriched and rows carrying a LinkedIn URL, professional email, personal email or valid phone). `metrics` is null for a company list, where those counters do not apply. `?include=columns` adds the custom and smart column definitions.

Errors:
- `404` `LIST_NOT_FOUND` — No list with that id is visible to the token owner.
- `422` `VALIDATION_FAILED` — listId is not a 24-hex id, or include is not "columns".
- `429` `RATE_LIMITED` — The lists rate bucket is exhausted.

Requires one of the following token scopes: lists.



## OpenAPI

````yaml /openapi.json get /business/lists/{listId}
openapi: 3.1.0
info:
  title: Fuse Business API
  version: 1.0.0
  description: >-
    External API for lists, campaigns, prospect search and contacts.
    Authenticate with your API token as HTTP Basic. All paths are under /api/v1.
servers:
  - url: https://api.tryfuse.ai/api/v1
    description: Production
security:
  - basicAuth: []
tags:
  - name: Lists
  - name: Custom columns
  - name: Smart columns
  - name: Exports
  - name: Campaigns
  - name: Knowledge hubs
  - name: Analytics
  - name: Website intent
  - name: Account
  - name: Prospect search
  - name: Campaign steps
  - name: Scheduled sends
  - name: Campaign templates
  - name: Agents
  - name: Research
  - name: Company search
  - name: Saved searches
  - name: Folders
  - name: Contacts
paths:
  /business/lists/{listId}:
    get:
      tags:
        - Lists
      summary: Get one list's metadata
      description: >-
        One list's metadata: name, kind (`entityType`), `completionStatus`
        (`processing` while an import, copy, save-to-list or enrichment is still
        populating it, `complete` otherwise — poll this after any 202 that
        targets the list), the row count, and the enrichment `metrics` (rows
        enriched and rows carrying a LinkedIn URL, professional email, personal
        email or valid phone). `metrics` is null for a company list, where those
        counters do not apply. `?include=columns` adds the custom and smart
        column definitions.


        Errors:

        - `404` `LIST_NOT_FOUND` — No list with that id is visible to the token
        owner.

        - `422` `VALIDATION_FAILED` — listId is not a 24-hex id, or include is
        not "columns".

        - `429` `RATE_LIMITED` — The lists rate bucket is exhausted.


        Requires one of the following token scopes: lists.
      operationId: getList
      parameters:
        - name: listId
          in: path
          required: true
          description: 24-character hex id of the list (from GET /business/lists).
          schema:
            type: string
            description: 24-character hex id of the list (from GET /business/lists).
        - name: include
          in: query
          required: false
          description: >-
            Set to columns to add the list's custom column definitions (id,
            name, type) to the response.
          schema:
            type: string
            enum:
              - columns
            description: >-
              Set to columns to add the list's custom column definitions (id,
              name, type) to the response.
      responses:
        '200':
          description: Success
          headers:
            RateLimit-Limit:
              schema:
                type: integer
              description: Requests permitted in the current window.
            RateLimit-Remaining:
              schema:
                type: integer
              description: Requests remaining in the current window.
            RateLimit-Reset:
              schema:
                type: integer
              description: Seconds until the current window resets.
          content:
            application/json:
              schema:
                type: object
                required:
                  - list
                properties:
                  list:
                    type: object
                    required:
                      - id
                      - name
                      - entityType
                      - completionStatus
                      - totalRecords
                      - metrics
                    properties:
                      id:
                        type: string
                      name:
                        type:
                          - string
                          - 'null'
                      entityType:
                        type: string
                        enum:
                          - contactList
                          - companyList
                      completionStatus:
                        type:
                          - string
                          - 'null'
                      totalRecords:
                        type: integer
                      metrics:
                        type:
                          - object
                          - 'null'
                        required:
                          - totalEnriched
                          - totalWithLinkedin
                          - totalWithProfessionalEmail
                          - totalWithPersonalEmail
                          - totalWithValidPhone
                        properties:
                          totalEnriched:
                            type: integer
                          totalWithLinkedin:
                            type: integer
                          totalWithProfessionalEmail:
                            type: integer
                          totalWithPersonalEmail:
                            type: integer
                          totalWithValidPhone:
                            type: integer
                      columns:
                        type: array
                        items:
                          type: object
                          required:
                            - id
                            - name
                            - type
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            type:
                              type: string
              example:
                list:
                  id: 68a1f20b9c41d20014b3e901
                  name: Q3 Fintech CFOs
                  entityType: contactList
                  completionStatus: complete
                  totalRecords: 412
                  metrics:
                    totalEnriched: 400
                    totalWithLinkedin: 412
                    totalWithProfessionalEmail: 350
                    totalWithPersonalEmail: 40
                    totalWithValidPhone: 120
                  columns:
                    - id: 68a1f3009c41d20014b3e9a1
                      name: Lead Score
                      type: string
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - basicAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            param:
              type:
                - string
                - 'null'
            doc_url:
              type:
                - string
                - 'null'
            request_id:
              type:
                - string
                - 'null'
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Your API token (`af_…`) as the Basic-auth username, with an empty
        password.

````