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

# List lists

> Every list the key's creator can read, with its counts. **Requires scope:** `records:read`.



## OpenAPI

````yaml /openapi-v1.json get /v1/lists
openapi: 3.1.0
info:
  title: Custral API
  version: v1
  description: >-
    The curated, versioned, API-key-authenticated public REST surface (`/v1`).
    Every endpoint here is what the official SDKs (`@custral/sdk`) and the MCP
    server are built on. Authenticate with a secret API key (`sk_…`) created in
    **Settings → Developers → Applications**.


    Every `/v1` response is sent with **HTTP 200**, success and failure alike. A
    success carries `data`; a failure carries `error` with a machine-readable
    `code` (see the `Error` schema), so branch on `error`, never on the status.
    `POST /v1/mcp` is the one exception: it answers auth failures with real 401
    / 403 / 429 statuses, as MCP clients expect.
  contact:
    name: Custral Support
    email: hello@custral.com
    url: https://custral.com
  license:
    name: Proprietary
    url: https://custral.com
servers:
  - url: https://api.custral.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Identity
    description: Introspect the calling API key.
  - name: Records
    description: Create, list, retrieve, and update records on any object.
  - name: Objects
    description: Read the object (table) schema of your workspace.
  - name: Conversations
    description: View, manage, and ingest conversations and their messages.
  - name: MCP
    description: Custral's MCP server, and the tool surface a key sees on it.
  - name: Documents
    description: Read record notes / page documents as markdown.
  - name: Connectors
    description: The MCP servers Stella can use tools from.
  - name: Property agents
    description: AI auto-fill agents on properties.
  - name: Usage modules
    description: Metered-product setups, their usage events, and per-record usage.
  - name: Applications & keys
    description: Developer applications and the API keys they hold.
  - name: Widget identity
    description: Vouch for who a chat widget visitor is.
  - name: Embeds & real-time
    description: Read the rows behind your own embed block, with an embed token.
  - name: Lists
    description: Read lists and change who is on them.
  - name: Customer journeys
    description: The workspace's customer journey, and where each customer is in it.
  - name: Quotes
    description: Quotes, contracts and contract templates.
  - name: Billing
    description: >-
      Customer billing, invoices, subscriptions, revenue metrics, the billing
      page, Stripe customer links, billing setup, products and plans.
paths:
  /v1/lists:
    get:
      tags:
        - Lists
      summary: List lists
      description: >-
        Every list the key's creator can read, with its counts. **Requires
        scope:** `records:read`.
      operationId: listLists
      parameters:
        - name: object
          in: query
          required: false
          description: 'Only this object''s lists: its id, key or name.'
          schema:
            type: string
          example: Companies
      responses:
        '200':
          description: The lists.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/List'
                  reqId:
                    $ref: '#/components/schemas/RequestId'
components:
  schemas:
    List:
      type: object
      properties:
        id:
          type: string
          example: comp_3Ab9xK2mQ7
        name:
          type: string
          example: Live customers
        kind:
          type: string
          enum:
            - static
            - smart
            - cohort
          description: >-
            `static` is hand-picked, `smart` follows a filter, `cohort` is a
            recurring call list.
        objectId:
          type: string
        objectName:
          type:
            - string
            - 'null'
          example: Companies
        recordCount:
          type: integer
          description: Members now.
        doneCount:
          type: integer
          description: Members marked done.
        targetSize:
          type:
            - integer
            - 'null'
          description: A cohort's size per period, when it has one.
        filterCount:
          type: integer
          description: How many filters a smart list or cohort selects by.
      required:
        - id
        - name
        - kind
        - objectId
    RequestId:
      type: string
      description: >-
        A per-request id (`req_…`). Quote it to support when reporting a
        problem.
      example: req_2a1f9c8e7b6d5
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: sk_...
      description: >-
        A Custral API key, created in Settings → Developers → Applications, sent
        as `Authorization: Bearer sk_…`. The `X-Api-Key` header is also accepted
        and takes precedence. Use a **secret** key (`sk_…`) from your server; a
        publishable key (`pk_…`) may hold only `objects:read` and `usage:write`.
        Never expose a secret key in a browser.

````

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