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

# List persons

> Paginated list of persons (borrowers) visible to the calling API key, scoped to the key's organization allowlist.



## OpenAPI

````yaml /api-reference/external_api.openapi.json get /persons
openapi: 3.1.0
info:
  title: Monterey External Reporting API
  description: >-
    Org-scoped, API-key-authenticated reporting endpoints for Monterey Financial
    clients.
  version: 0.1.0
servers:
  - url: https://api.montereyfinancial.app
    description: Production
security:
  - BearerApiKey: []
paths:
  /persons:
    get:
      tags:
        - Persons
      summary: List persons
      description: >-
        Paginated list of persons (borrowers) visible to the calling API key,
        scoped to the key's organization allowlist.
      operationId: list_persons_persons_get
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Opaque pagination cursor from a previous response's
              `page.next_cursor`. Omit on the first page.
            title: Cursor
          description: >-
            Opaque pagination cursor from a previous response's
            `page.next_cursor`. Omit on the first page.
        - name: limit
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 1000
                minimum: 1
              - type: 'null'
            description: >-
              Page size for cursor pagination. Default 100, minimum 1, maximum
              1000. Requests above the maximum return 422 — narrow your page
              size and use the returned `next_cursor` to walk additional pages.
            title: Limit
          description: >-
            Page size for cursor pagination. Default 100, minimum 1, maximum
            1000. Requests above the maximum return 422 — narrow your page size
            and use the returned `next_cursor` to walk additional pages.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_PersonRow_'
        '401':
          description: Missing or invalid API key.
        '403':
          description: organization_id outside the key's allowlist.
        '404':
          description: Resource not in scope or does not exist.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerApiKey: []
components:
  schemas:
    Page_PersonRow_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PersonRow'
          type: array
          title: Items
        page:
          $ref: '#/components/schemas/PageMeta'
      type: object
      required:
        - items
        - page
      title: Page[PersonRow]
      description: 'A page of results: `items` plus a `page` pagination envelope.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
      description: >-
        Parameter-validation error (HTTP 422). `detail` lists each violated
        constraint with its location, message, and type.
    PersonRow:
      properties:
        id:
          type: string
          title: Id
          description: The person's unique ID.
        display_name:
          type: string
          title: Display Name
        is_active:
          type: boolean
          title: Is Active
      type: object
      required:
        - id
        - display_name
        - is_active
      title: PersonRow
      description: An individual party — typically a borrower on one or more accounts.
      examples:
        - display_name: Jane Smith
          id: 01J6WV0U1T2S3R4Q5P6N7M8L9K
          is_active: true
    PageMeta:
      properties:
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: Opaque token to pass as ?cursor= to fetch the next page.
        has_more:
          type: boolean
          title: Has More
          description: True if more rows exist past this page.
        limit:
          type: integer
          title: Limit
          description: Echo of the resolved page size.
      type: object
      required:
        - has_more
        - limit
      title: PageMeta
      description: >-
        Pagination envelope on list responses. `next_cursor` is non-null when
        more rows exist — pass it back as `cursor` to continue.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
      description: >-
        A single parameter-validation failure: `loc` is the path to the
        offending input, `msg` is human-readable, and `type` is the rule that
        failed.
  securitySchemes:
    BearerApiKey:
      type: http
      description: Static API key issued via the client portal. Treat it like a password.
      scheme: bearer
      bearerFormat: ApiKey

````