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

# Get CRM List



## OpenAPI

````yaml GET /api/v2/crm/lists/{list_id}
openapi: 3.1.0
info:
  title: CRM API
  description: >-
    Create CRM lists, add creators, check creator membership, and update CRM
    contacts. CRM API calls are free but require an active TopYappers
    subscription.
  version: 2.0.0
servers:
  - url: https://api.topyappers.com
security:
  - apiKeyAuth: []
paths:
  /api/v2/crm/lists/{list_id}:
    get:
      tags:
        - CRM Lists
      summary: Get CRM list
      parameters:
        - $ref: '#/components/parameters/ListId'
      responses:
        '200':
          description: CRM list returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmListResponse'
        '403':
          $ref: '#/components/responses/AuthError'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimitError'
components:
  parameters:
    ListId:
      name: list_id
      in: path
      required: true
      description: CRM list ID.
      schema:
        type: string
  schemas:
    CrmListResponse:
      type: object
      properties:
        message:
          type: string
          example: OK
        response:
          $ref: '#/components/schemas/CrmList'
    CrmList:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        website_id:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        budget:
          type: number
          nullable: true
        start_date:
          type: string
          nullable: true
        end_date:
          type: string
          nullable: true
        team_id:
          type: string
        active:
          type: boolean
        contact_count:
          type: integer
          nullable: true
        to_outreach_count:
          type: integer
          nullable: true
        date_created:
          type: string
          nullable: true
        date_updated:
          type: string
          nullable: true
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
  responses:
    AuthError:
      description: >-
        Missing or invalid API key, inactive subscription, or inaccessible team
        scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: CRM list or contact not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimitError:
      description: Too many requests. The response includes a `Retry-After` header.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-ty-api-key

````