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

# Get a credit summary

> Returns the latest stored credit and underwriting summary without raw report data.



## OpenAPI

````yaml /api-reference/openapi.json get /contacts/{contactId}/credit-summary
openapi: 3.1.0
info:
  title: Funding Machine Public API
  version: 1.0.0
  description: >-
    Read-only access to stored Funding Machine and CRM data. Version 1 never
    creates, changes, bills, pulls, or underwrites data.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://marketplace-app.myfundingmachine.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Locations
    description: Discover locations accessible to the credential.
  - name: Contacts
    description: Find CRM contacts.
  - name: Credit
    description: Read stored, tenant-scoped credit and underwriting data.
  - name: Funding
    description: Read funding plans and applicant next steps.
  - name: Pipeline
    description: Read CRM deal and Funding Machine pipeline state.
  - name: Dashboard
    description: Read bounded aggregate statistics.
paths:
  /contacts/{contactId}/credit-summary:
    get:
      tags:
        - Credit
      summary: Get a credit summary
      description: >-
        Returns the latest stored credit and underwriting summary without raw
        report data.
      operationId: getCreditSummary
      parameters:
        - $ref: '#/components/parameters/ContactId'
        - $ref: '#/components/parameters/LocationId'
      responses:
        '200':
          $ref: '#/components/responses/Success'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    ContactId:
      name: contactId
      in: path
      required: true
      description: CRM contact ID.
      schema:
        type: string
        minLength: 1
        maxLength: 128
    LocationId:
      name: locationId
      in: query
      description: >-
        Required for agency keys. Ignored for a location key, which stays pinned
        to its own CRM location. A foreign or transferred-out location is
        refused; the read does not run against that location.
      schema:
        type: string
        minLength: 1
        maxLength: 64
  responses:
    Success:
      description: Successful read
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SuccessEnvelope'
    InvalidRequest:
      description: Invalid path or query parameter
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing, malformed, unknown, expired, or revoked bearer credential
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: The credential lacks read access or cannot access the requested location
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: Per-credential rate limit exceeded
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          description: Seconds until retry.
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          description: Requests allowed per window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests remaining in this window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix timestamp in seconds for reset.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: Unexpected server error
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  headers:
    RequestId:
      description: Stable identifier for this request.
      schema:
        type: string
        pattern: ^req_
  schemas:
    SuccessEnvelope:
      type: object
      required:
        - data
        - requestId
      properties:
        data: {}
        requestId:
          type: string
          pattern: ^req_
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - requestId
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - forbidden
                - not_found
                - rate_limited
                - internal_error
            message:
              type: string
            requestId:
              type: string
              pattern: ^req_
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Use an existing fmk_ API key from Settings → Integrations or an fmo_
        OAuth access token.

````

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