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

# List Model

> A flexible search tool for your platform's records.

Choose what kind of records you want to look through by setting it in
the web address (``model_key`` — for example ``users``, ``wallets``, or
``payment_intents``). Then send your filters, sorting, and page settings
in the request body. The results only ever include your own platform's
records — you can never see another platform's data.



## OpenAPI

````yaml POST /v1/platform/listings/{model_key}
openapi: 3.1.0
info:
  title: Finogate Platform API v1
  version: 0.1.0
servers:
  - url: https://api-sandbox.finogates.com
    description: Sandbox
  - url: https://api.finogates.com
    description: Production
security: []
tags:
  - name: auth
  - name: users
  - name: payees
  - name: verification
  - name: bank accounts
  - name: card processing
  - name: digital-assets
  - name: international
  - name: onboarding
  - name: pending-applications
  - name: wallets
  - name: payments
  - name: catalog
  - name: webhooks
  - name: phone-numbers
  - name: sms
  - name: calls
  - name: listings
  - name: embed-tokens
paths:
  /v1/platform/listings/{model_key}:
    post:
      tags:
        - listings
      summary: Search Your Records
      description: |-
        A flexible search tool for your platform's records.

        Choose what kind of records you want to look through by setting it in
        the web address (``model_key`` — for example ``users``, ``wallets``, or
        ``payment_intents``). Then send your filters, sorting, and page settings
        in the request body. The results only ever include your own platform's
        records — you can never see another platform's data.
      operationId: list_model_v1_platform_listings__model_key__post
      parameters:
        - name: model_key
          in: path
          required: true
          schema:
            type: string
            title: Model Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListingRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - _AuthenticatedBearer: []
components:
  schemas:
    ListingRequest:
      properties:
        filters:
          items:
            $ref: '#/components/schemas/ListingFilter'
          type: array
          title: Filters
        sort:
          items:
            $ref: '#/components/schemas/ListingSort'
          type: array
          title: Sort
        include:
          items:
            type: string
          type: array
          title: Include
          description: Relationship paths to include.
        search:
          anyOf:
            - type: string
            - type: 'null'
          title: Search
        cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Cursor
        include_deleted:
          type: boolean
          title: Include Deleted
          default: false
        limit:
          type: integer
          maximum: 200
          minimum: 1
          title: Limit
          default: 50
      type: object
      title: ListingRequest
      description: >-
        Listing request supporting filters, sort, includes, search, and cursor
        pagination.
    ListResponse:
      properties:
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code for the response.
        data:
          title: Data
          description: Payload or error details.
        query_generated_time:
          type: integer
          title: Query Generated Time
          description: >-
            UTC timestamp (milliseconds since epoch) when response was
            generated.
        row_count:
          type: integer
          minimum: 0
          title: Row Count
          description: Total rows matching the request filters (not just this page).
        limit:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Limit
          description: >-
            Page size used for this response. Null for cursor-paginated
            endpoints.
        current_page:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Current Page
          description: >-
            1-indexed page number for this response. Null for cursor-paginated
            endpoints.
        total_page_number:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Total Page Number
          description: >-
            Total number of pages given the current limit. Null for
            cursor-paginated endpoints.
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: Cursor for the next page, if available.
      type: object
      required:
        - status_code
        - data
        - query_generated_time
        - row_count
      title: ListResponse
      description: |-
        Standard response wrapper for list responses.

        Declare ``ListResponse[list[SomeModel]]`` to render the real ``data``
        array schema in OpenAPI/Swagger; a bare ``ListResponse`` leaves ``data``
        untyped.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ListingFilter:
      properties:
        field:
          type: string
          maxLength: 128
          minLength: 1
          title: Field
        op:
          $ref: '#/components/schemas/FilterOp'
          default: eq
        value:
          anyOf:
            - {}
            - type: 'null'
          title: Value
      type: object
      required:
        - field
      title: ListingFilter
      description: Single filter clause.
    ListingSort:
      properties:
        field:
          type: string
          maxLength: 128
          minLength: 1
          title: Field
        dir:
          $ref: '#/components/schemas/SortDir'
          default: desc
      type: object
      required:
        - field
      title: ListingSort
      description: Sorting clause.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    FilterOp:
      type: string
      enum:
        - eq
        - neq
        - gt
        - gte
        - lt
        - lte
        - in
        - not_in
        - contains
        - like
        - ilike
        - is_null
        - not_null
      title: FilterOp
    SortDir:
      type: string
      enum:
        - asc
        - desc
      title: SortDir
  securitySchemes:
    _AuthenticatedBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/platform/auth/token

````