Get a mortgage search Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
"PlannrCRM MCP server": {
  "url": "https://apidocs.plannrcrm.com/mcp"
}
Close
GET /api/v2/mortgage-searches/{uuid}
Personal access token & O auth2

This endpoint will return a single mortgage search with its relationships.

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • uuid string Required

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • name string

      The name of the mortgage search

    • status string

      The status of the mortgage search

    • provider string

      The provider that the mortgage search is for

    • provider_reference string

      The provider reference of the mortgage search

    • provider_data array

      Any provider data related to the mortgage search

    • applicants array[object]

      The applicants of the mortgage search

      Hide applicants attributes Show applicants attributes object
      • uuid string
      • created_at string
      • updated_at string
      • account string
    • cases array[object]

      The cases that are related to the mortgage search

      Hide cases attributes Show cases attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • status string
      • type string
      • review_at string
      • assigned_to_uuids array[string]
      • group_uuids array[string]
      • completed_at string
      • value object
        Hide value attributes Show value attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • status_position integer
      • participants_count integer
      • participants string
      • task_board_uuid string
      • plans string
      • custom_fields string
    • products array[object]

      The products that are related to the mortgage search

      Hide products attributes Show products attributes object
      • uuid string
      • created_at string
      • updated_at string
      • provider_reference string
      • provider_scenario_name string
      • provider_scenario_data array
      • lender_name string
      • product_title string
      • files string
    • files array[object]

      The files that are related to the mortgage search

      Hide files attributes Show files attributes object
      • uuid string
      • created_at string
      • original_created_at string
      • updated_at string
      • uploaded_at string
      • status string
      • filename string
      • name string
      • extension string
      • type string
      • size string
      • path string
      • last_modified string
      • progress string
      • download_url string
      • folder_name string
      • folder string
      • documentable_type string
      • documentable string
      • navigator object
        Hide navigator attributes Show navigator attributes object
        • model_type string
        • model_uuid string
      • firm string
      • account string
      • tags string
GET /api/v2/mortgage-searches/{uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/mortgage-searches/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "uuid": "f33dc73c-10ca-4590-a600-b145711ca333",
  "created_at": "2026-06-09T14:10:15+01:00",
  "updated_at": "2026-06-09T14:10:15+01:00",
  "name": "My Mortgage Search",
  "status": "pending",
  "provider": "Mortgage Brain",
  "provider_reference": "123456789",
  "provider_data": [],
  "applicants": [
    {
      "uuid": "4c3ae304-8ca6-4895-970d-83288e9ded43",
      "created_at": "2026-06-09T14:10:15+01:00",
      "updated_at": "2026-06-09T14:10:15+01:00",
      "account": "App\\Http\\Resources\\MinimalAccountResource"
    }
  ],
  "cases": [
    {
      "uuid": "34c3730d-4301-4744-ac5b-ac28bc31cd8a",
      "created_at": "2026-06-09T14:10:15+01:00",
      "updated_at": "2026-06-09T14:10:15+01:00",
      "name": "finance",
      "slug": "finance",
      "status": "App\\Http\\Resources\\CasesStatusResource",
      "type": "App\\Http\\Resources\\CasesTypeResource",
      "review_at": "2026-06-09T14:10:15+01:00",
      "assigned_to_uuids": [
        "0090d62e-56b2-4e19-942b-5cb233863165"
      ],
      "group_uuids": [
        "115a0259-1468-4116-87c9-709e9c6768e1"
      ],
      "completed_at": "2026-06-09T14:10:15+01:00",
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        }
      },
      "status_position": 4,
      "participants_count": 4,
      "participants": "App\\Http\\Resources\\AccountResource",
      "task_board_uuid": "def5a5df-7f94-403c-813a-a5afb87caa37",
      "plans": "App\\Http\\Resources\\Plans\\PlanResource",
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource"
    }
  ],
  "products": [
    {
      "uuid": "99de8c08-24a0-4564-8cda-918cbc280b7f",
      "created_at": "2026-06-09T14:10:15+01:00",
      "updated_at": "2026-06-09T14:10:15+01:00",
      "provider_reference": "example-reference",
      "provider_scenario_name": "Single Applicant, Small Deposit",
      "provider_scenario_data": [],
      "lender_name": "HSBC",
      "product_title": "5% Fixed Rate - 5 year",
      "files": "App\\Http\\Resources\\FileResource"
    }
  ],
  "files": [
    {
      "uuid": "624bbdad-8c53-4761-8a2c-ce8557095752",
      "created_at": "2026-06-09T14:10:15+01:00",
      "original_created_at": "2026-06-09T14:10:15+01:00",
      "updated_at": "2026-06-09T14:10:15+01:00",
      "uploaded_at": "2026-06-09T14:10:15+01:00",
      "status": "uploaded",
      "filename": "Welcome to Plannr.pdf",
      "name": "Welcome to Plannr",
      "extension": "pdf",
      "type": "type",
      "size": "21691783",
      "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
      "last_modified": "2026-06-09T14:10:15+01:00",
      "progress": "100",
      "download_url": "https://api.plannrcrm.com/file/4101b774-8f3c-4340-8803-aed0922713c9/download",
      "folder_name": "folder 2",
      "folder": "App\\Http\\Resources\\FolderResource",
      "documentable_type": "account",
      "documentable": "Object",
      "navigator": {
        "model_type": "account",
        "model_uuid": "c8cd1635-8004-4919-8300-37efd8ae588d"
      },
      "firm": "App\\Http\\Resources\\FirmResource",
      "account": "App\\Http\\Resources\\MinimalAccountResource",
      "tags": "App\\Http\\Resources\\TagResource"
    }
  ]
}