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

# Retrieve List

> Retrieves a list by ID



## OpenAPI

````yaml GET /lists/{id}
openapi: 3.0.1
info:
  title: OpenAPI Letterby
  description: API for Letterby
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://letterby.com/api/v4
security:
  - apiKeyAuth: []
paths:
  /lists/{id}:
    get:
      description: Retrieves a list by ID
      parameters:
        - name: id
          in: path
          required: true
          description: ID of the list to retrieve
          schema:
            type: string
      responses:
        '200':
          description: List retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        $ref: '#/components/schemas/List'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    List:
      type: object
      properties:
        id:
          type: string
          description: List ID
        url:
          type: string
          description: List handle
        branding:
          type: boolean
          description: Indicates whether the list has branding enabled.
        startFrom:
          type: integer
          nullable: true
        mode:
          type: string
          nullable: true
          description: List mode, default by 'referrals'
        name:
          type: string
          description: List name
        referrals:
          type: boolean
          description: Indicates whether the list allows referrals.
        color:
          type: string
          description: The color code associated with the list (e.g., hex color).
        title:
          type: string
          nullable: true
          description: The title of the list, typically shown to the user.
        desc:
          type: string
          nullable: true
          description: A description of the list, typically displayed to users.
        socialDescription:
          type: string
          nullable: true
          description: The description shown when sharing the list on social media.
        senderName:
          type: string
          description: >-
            The name that appears as the sender when messages or emails are
            sent.
        replyTo:
          type: string
          description: The email address to reply to when messages are sent from the list.
        sender:
          type: string
          description: The sender identifier for email or message communication.
        legal:
          type: string
          description: Legal name associated with the list (for compliance purposes).
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the list was created.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp when the list was last updated.
        userId:
          type: string
          description: The unique identifier of the user who created or owns the list.
        domainId:
          type: string
          nullable: true
          description: >-
            The unique identifier of the domain associated with the list, if
            applicable.
        defaultPageId:
          type: string
          nullable: true
          description: The unique identifier of the default page associated with the list.
        referralPageId:
          type: string
          nullable: true
          description: The unique identifier of the referral page associated with the list.
        successPageId:
          type: string
          nullable: true
          description: The unique identifier of the success page associated with the list.
        icon:
          type: string
          nullable: true
          description: The icon image for the list.
        favicon:
          type: string
          nullable: true
          description: The favicon associated with the list.
        ogImage:
          type: string
          nullable: true
          description: The Open Graph image used for social media previews.
        listSettingsId:
          type: string
          description: The unique identifier of the list settings.
        whitelistEmailId:
          type: string
          nullable: true
          description: The unique identifier for the whitelisted email, if any.
        templateId:
          type: string
          nullable: true
          description: The unique identifier of the template used for the list.
        themeId:
          type: string
          nullable: true
          description: The unique identifier of the theme associated with the list.
        columns:
          type: array
          items:
            type: string
          description: An array of column names for the list.
        customHeadCode:
          type: string
          nullable: true
          description: Custom HTML code to be added to the head section of the list pages.
        customBodyCode:
          type: string
          nullable: true
          description: Custom HTML code to be added to the body section of the list pages.
        googleAnalytics:
          type: string
          nullable: true
          description: Google Analytics tracking ID for the list.
        plausibleAnalytics:
          type: string
          nullable: true
          description: Plausible Analytics tracking ID for the list.
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
  responses:
    Unauthorized:
      description: Unauthorized - Invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: apiKey
      description: API key to authorize requests

````