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

# List / filter leads

> Requires the `leads:read` scope. Rate tier: `read`.



## OpenAPI

````yaml /openapi.json get /api/v1/leads
openapi: 3.1.0
info:
  title: Grand Charter Public API
  version: 1.0.0
  description: >-
    Org-scoped integration API for the Grand Charter legal platform.


    Authenticate every request with an integration API key in the `x-api-key`
    header. Keys are created in the attorney portal under **Settings →
    Integrations → API Credentials** (or by platform admins) and carry an
    explicit list of scopes; each operation below names its required scope
    (`x-required-scope`).


    Conventions: JSON bodies/responses in camelCase; money in integer cents;
    ISO-8601 UTC timestamps; keyset cursor pagination (`after`, `limit` →
    `nextCursor`); errors use `{ success: false, error, code }`.


    Idempotency: most mutations require an `X-Idempotency-Key` header — each
    operation description below says so explicitly. Exceptions that do NOT
    consume the header (retrying them can create duplicates): `POST /leads`,
    `PATCH /leads/{leadId}`, and `PATCH /cases/{caseId}`.
servers:
  - url: https://www.presolve.com
    description: Production
security:
  - integrationApiKey: []
tags:
  - name: Platform
  - name: Org & Team
  - name: Cases
  - name: Leads
  - name: Clients
  - name: Contacts
  - name: Documents
  - name: Notes
  - name: Tasks
  - name: Calendar
  - name: Deadlines
  - name: Intake
  - name: E-Sign
  - name: Billing
  - name: Settlement Funds
  - name: Referrals
  - name: Communications
  - name: Medical
  - name: Reports & Exports
  - name: Events & Webhooks
paths:
  /api/v1/leads:
    get:
      tags:
        - Leads
      summary: List / filter leads
      description: 'Requires the `leads:read` scope. Rate tier: `read`.'
      operationId: get_leads
      parameters:
        - in: query
          name: after
          schema:
            type: string
            minLength: 1
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
        - in: query
          name: includeDeleted
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
            default: 'false'
        - in: query
          name: leadStatus
          schema:
            type: string
            enum:
              - new_lead
              - screened_needs_match
              - matched_to_firm_marketplace
              - matched_to_firm_match_direct
              - pending_turndown
              - screened_turned_down
              - no_contact_turned_down
              - PromotedToCase
              - hidden
              - ContactInProgress
              - under_review_with_firm
              - PendingLead
              - ContactAttemptsMaxed
              - DuplicateLead
              - financing_lead
              - defendant
              - test_lead
              - pending_promotion
              - converted
              - matched_to_firm_signed_retainers
              - waiting_for_retainer
        - in: query
          name: leadType
          schema:
            type: string
            enum:
              - inbound_call
              - inbound_message
              - online_submission
              - financing_intake
              - online_contact_promoted
              - admin_upload
              - insta_lead_form
              - hubspot_lead
              - admin_financing_upload
        - in: query
          name: source
          schema:
            type: string
            minLength: 1
            maxLength: 200
        - in: query
          name: createdAfter
          schema:
            type: string
        - in: query
          name: createdBefore
          schema:
            type: string
        - in: query
          name: q
          schema:
            type: string
            minLength: 2
            maxLength: 200
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeadsListResponse'
        '400':
          description: Validation failed (VALIDATION_FAILED).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, or expired API key (UNAUTHORIZED).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: API key lacks the required scope (FORBIDDEN).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found in the caller’s organization (NOT_FOUND).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded (RATE_LIMITED). Honor Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - integrationApiKey: []
components:
  schemas:
    LeadsListResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        leads:
          type: array
          items:
            $ref: '#/components/schemas/Lead'
        nextCursor:
          type:
            - string
            - 'null'
      required:
        - success
        - leads
        - nextCursor
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: >-
            Human-readable error message. 5xx responses are always scrubbed to
            "Internal server error".
        code:
          type: string
          description: >-
            Stable machine-readable error code (ErrorCode), e.g. UNAUTHORIZED,
            FORBIDDEN, VALIDATION_FAILED, NOT_FOUND, INVALID_STATE_TRANSITION,
            DUPLICATE_ENTRY, STALE_REVISION, IDEMPOTENCY_IN_PROGRESS,
            IDEMPOTENCY_CONFLICT, RATE_LIMITED, INTERNAL_ERROR.
      required:
        - success
        - error
        - code
    Lead:
      type: object
      properties:
        id:
          type: string
        caseId:
          type:
            - string
            - 'null'
        firstName:
          type:
            - string
            - 'null'
        lastName:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
        zipCode:
          type:
            - string
            - 'null'
        city:
          type:
            - string
            - 'null'
        state:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        caseType:
          type:
            - string
            - 'null'
        subCaseType:
          type:
            - string
            - 'null'
        leadType:
          type:
            - string
            - 'null'
        leadStatus:
          type: string
        caseMatchStatus:
          type:
            - string
            - 'null'
        turnDownReason:
          type:
            - string
            - 'null'
        turnDownNotes:
          type:
            - string
            - 'null'
        pendingTurndownAt:
          type:
            - string
            - 'null'
          description: ISO-8601 UTC timestamp
        highValue:
          type: boolean
        injuryDescription:
          type:
            - string
            - 'null'
        utmSource:
          type:
            - string
            - 'null'
        utmMedium:
          type:
            - string
            - 'null'
        utmCampaign:
          type:
            - string
            - 'null'
        utmCampaignId:
          type:
            - string
            - 'null'
        utmAdgroupId:
          type:
            - string
            - 'null'
        utmTerm:
          type:
            - string
            - 'null'
        utmContent:
          type:
            - string
            - 'null'
        gclid:
          type:
            - string
            - 'null'
        gbraid:
          type:
            - string
            - 'null'
        gadSource:
          type:
            - string
            - 'null'
        trustedFormCertUrl:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          description: ISO-8601 UTC timestamp
        updatedAt:
          type: string
          description: ISO-8601 UTC timestamp
        deletedAt:
          type:
            - string
            - 'null'
          description: ISO-8601 UTC timestamp
      required:
        - id
        - caseId
        - firstName
        - lastName
        - email
        - phone
        - zipCode
        - city
        - state
        - description
        - caseType
        - subCaseType
        - leadType
        - leadStatus
        - caseMatchStatus
        - turnDownReason
        - turnDownNotes
        - pendingTurndownAt
        - highValue
        - injuryDescription
        - utmSource
        - utmMedium
        - utmCampaign
        - utmCampaignId
        - utmAdgroupId
        - utmTerm
        - utmContent
        - gclid
        - gbraid
        - gadSource
        - trustedFormCertUrl
        - createdAt
        - updatedAt
        - deletedAt
  securitySchemes:
    integrationApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Org-issued integration API key (service account credential). The
        plaintext secret is shown once at creation.

````