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

# List static and dynamic lists

> Both kinds behind one endpoint: static rows first, then dynamic, each
stamped with `type`. The row shape differs by kind. Discriminate on
`type`. Here `type` is **single-valued** rather than repeatable; omit it
to get both. `pagination.totalElements` is the sum of the two sources'
own counts. This endpoint takes no `folderId`.




## OpenAPI

````yaml /api-reference/openapi.yaml get /v2/lists
openapi: 3.1.0
info:
  title: Inflection Developer API
  version: 1.0.0
  description: >
    The Inflection Developer API (`/v2`). Authenticate with a Personal Access

    Token (`Authorization: Bearer inf_pat_...`).


    **`/v2` is `/v1` plus more.** Every `/v1` endpoint is served here unchanged,

    so a client can pin to one version and reach the whole API. On top of those

    sit reads `/v1` never had: journeys, journey and email stats with a journey

    rollup, and the email and list collections. `/v1` remains published.


    **Response envelope.** Every response is wrapped:

    `{ "data": …, "pagination": …, "errors": [...], "meta": { "status":
    "SUCCESS|FAILURE", "timestamp": "…" } }`.

    `data` carries the payload, `pagination` appears only on paged lists, and on

    failures `errors` is populated with `meta.status: "FAILURE"`.


    **Query parameters are camelCase**: `pageNumber`, `pageSize`, `startTime`,

    `folderId`. The journeys, emails, lists and stats reads additionally accept

    the snake_case spelling of every scalar parameter (`page_number`,

    `folder_id`, …); the contact, activity and list-member endpoints do not.

    Repeatable parameters also accept a `[]` suffix (`status[]`, `tag[]`).


    **Asynchronous contact writes.** `POST/PATCH /v2/contacts*` are processed

    asynchronously: they return **200** with a `PENDING` transaction

    acknowledgement (not the created/updated contact). Poll

    `GET /v2/contacts/transactions/{transactionId}` for the per-contact result.


    **Status-code quirks** (documented per-operation): a missing **contact** is

    reported as **400** (not 404), whereas a missing **list**, **email** or

    **journey** is **404**. For journeys and emails that also covers a

    soft-deleted record and a malformed id. Nothing returns 201 or 204.


    **Empty results are not errors.** On the paged reads, a `tag`, `folderId` or

    `search` that matches nothing returns an empty page, not a 404.


    **Errors.** Failures use the envelope above

    (`errors[].{errorCode,message,detail}`). Authentication and authorization

    failures (401/403) are returned with an empty body. The journey stats rollup

    adds `RESULT_SET_TOO_LARGE` (a **400**) when a filter matches more journeys

    than one request may cover; narrow it rather than paging further.


    **Rate limiting.** Requests are metered per tenant. Exceeding the budget

    yields **429** (empty body) on any endpoint; the `Retry-After` header gives

    the seconds to wait and `X-RateLimit-Limit` the sustained per-second budget.
servers:
  - url: https://api.inflection.io
    description: Production
security:
  - PatAuth: []
tags:
  - name: Contacts
    description: Create, read, and update contacts. Writes are asynchronous.
  - name: Contact Activity
    description: >-
      Product, marketing, and combined activity for a contact, plus Salesforce
      data.
  - name: Journeys
    description: Read journeys (campaigns), their schedule and their derived status.
  - name: Stats
    description: >-
      Send and engagement metrics for journeys and emails, with a journey
      rollup.
  - name: Lists
    description: Static and dynamic lists, and static-list members.
  - name: Emails
    description: Email listing and creation.
  - name: Product Users
    description: |
      Read product users -- the logins underneath a contact -- by id or email,
      and list them for a contact or an organization.
  - name: Organizations
    description: Read organizations (company accounts) and a contact's memberships.
  - name: Email Versions
    description: Per-contact versions of a Personalized Email Asset, served under `/v1`.
paths:
  /v2/lists:
    get:
      tags:
        - Lists
      summary: List static and dynamic lists
      description: |
        Both kinds behind one endpoint: static rows first, then dynamic, each
        stamped with `type`. The row shape differs by kind. Discriminate on
        `type`. Here `type` is **single-valued** rather than repeatable; omit it
        to get both. `pagination.totalElements` is the sum of the two sources'
        own counts. This endpoint takes no `folderId`.
      operationId: listLists
      parameters:
        - $ref: '#/components/parameters/ListKind'
        - $ref: '#/components/parameters/Search'
        - $ref: '#/components/parameters/PageNumber'
        - $ref: '#/components/parameters/PageSize'
      responses:
        '200':
          description: Paged lists, static first.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPageResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    ListKind:
      name: type
      in: query
      required: false
      description: |
        Which kind of list to return. **Single-valued**, unlike the other `type`
        filters; omit it to return both kinds. Unrelated to the `listType` field
        on a dynamic-list row, which is an internal classification.
      schema:
        type: string
        enum:
          - static
          - dynamic
    Search:
      name: search
      in: query
      required: false
      description: |
        Case-insensitive substring match on the asset's name. Regex
        metacharacters are escaped, not interpreted.
      schema:
        type: string
    PageNumber:
      name: pageNumber
      in: query
      required: false
      description: 1-based page number.
      schema:
        type: integer
        minimum: 1
        maximum: 2147483647
        default: 1
    PageSize:
      name: pageSize
      in: query
      required: false
      description: Items per page.
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 20
  schemas:
    ListPageResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ListItem'
        pagination:
          $ref: '#/components/schemas/Pagination'
        meta:
          $ref: '#/components/schemas/Meta'
    ListItem:
      description: |
        A static or dynamic list. The two shapes differ; discriminate on `type`.
      oneOf:
        - $ref: '#/components/schemas/StaticListSummary'
        - $ref: '#/components/schemas/DynamicListSummary'
    Pagination:
      type: object
      description: Present only on paged list responses.
      properties:
        pageNumber:
          type: integer
        pageSize:
          type: integer
        totalElements:
          type: integer
        totalPages:
          type: integer
    Meta:
      type: object
      description: Envelope metadata present on every response.
      properties:
        status:
          type: string
          enum:
            - SUCCESS
            - FAILURE
        timestamp:
          type: string
          format: date-time
      required:
        - status
    ErrorEnvelope:
      type: object
      description: Standard failure envelope.
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorItem'
        meta:
          $ref: '#/components/schemas/Meta'
    StaticListSummary:
      description: A static list as it appears in the combined list collection.
      allOf:
        - $ref: '#/components/schemas/StaticList'
        - type: object
          properties:
            type:
              type: string
              enum:
                - static
            flow:
              type: object
              additionalProperties: true
    DynamicListSummary:
      type: object
      description: |
        A dynamic list as it appears in the combined list collection. Every key
        is always present; unset ones are null.
      properties:
        dynamicListId:
          type: string
        name:
          type: string
        description:
          type: string
        listType:
          type: string
          enum:
            - dynamic_list_asset
            - campaign_audience
          description: Internal classification. Unrelated to the `type` filter.
        generatedQueryContext:
          type: string
          enum:
            - person
            - person_org
        isValidQuery:
          type: boolean
          description: True once a query has been compiled for this list.
        directoryId:
          type: string
        directoryName:
          type: string
        createdAt:
          type: string
        createdBy:
          type: integer
        updatedAt:
          type: string
        updatedBy:
          type: integer
        type:
          type: string
          enum:
            - dynamic
    ErrorItem:
      type: object
      properties:
        errorCode:
          type: string
          examples:
            - NOT_FOUND
        message:
          type: string
        detail:
          type: string
      required:
        - errorCode
        - message
    StaticList:
      type: object
      properties:
        staticListId:
          type: string
        name:
          type: string
        createdBy:
          type: integer
          description: Account id.
        updatedBy:
          type: integer
        createdAt:
          type: string
        updatedAt:
          type: string
        numRecords:
          type: integer
          description: Current member count.
        directoryId:
          type: string
          description: Present when the list is in a folder.
        isDeleted:
          type: boolean
  responses:
    BadRequest:
      description: Malformed request or validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing or invalid Personal Access Token. Empty body.
    Forbidden:
      description: >-
        The PAT lacks the required scope (READ for reads, WRITE for writes).
        Empty body.
    TooManyRequests:
      description: |
        Per-tenant rate limit exceeded. Empty body. Retry after the number of
        seconds given in the `Retry-After` header.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Sustained request budget, in requests per second, per tenant.
          schema:
            type: integer
  securitySchemes:
    PatAuth:
      type: http
      scheme: bearer
      bearerFormat: inf_pat
      description: |
        Personal Access Token or OAuth 2.1 access token, sent as a bearer
        credential (`Authorization: Bearer inf_pat_...`). Read operations
        require a token with the `READ` scope; write operations
        (POST/PATCH/DELETE) require `WRITE`.

````