GET /api/v2/mortgage-searches
Personal access token & O auth2

This endpoint will return all mortgage searches in the firm.

Headers

  • X-PLANNR-ACCOUNT-UUID string

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[account_uuids] string

    Filter by a comma separated list of account UUIDs (through applicants).

  • filter[case_uuids] string

    Filter by a comma separated list of case UUIDs.

  • filter[status] string

    Filter by status.

  • filter[provider] string

    Filter by provider.

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [applicants, cases].

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, status, provider]. Negative sign to denote DESC. Defaults to '-created_at'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data 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.

      • 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
GET /api/v2/mortgage-searches 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/mortgage-searches' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "uuid": "da908778-c446-4164-b331-d55f79acf2ee",
      "cases": [
        {
          "name": "finance",
          "slug": "finance",
          "type": "App\\Http\\Resources\\CasesTypeResource",
          "uuid": "c6695af2-5f2c-4488-abf9-ea122bb40993",
          "plans": "App\\Http\\Resources\\Plans\\PlanResource",
          "value": {
            "amount": {
              "example": "4000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£40.00",
              "description": "Money amount formatted with currency"
            }
          },
          "status": "App\\Http\\Resources\\CasesStatusResource",
          "review_at": "2026-01-19T20:52:27+00:00",
          "created_at": "2026-01-19T20:52:27+00:00",
          "updated_at": "2026-01-19T20:52:27+00:00",
          "group_uuids": [
            "db3898c2-633b-4df9-ba5b-2e103dde7c56"
          ],
          "completed_at": "2026-01-19T20:52:27+00:00",
          "participants": "App\\Http\\Resources\\AccountResource",
          "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
          "status_position": 4,
          "task_board_uuid": "a9997bef-d40e-4832-9e47-1096067ad7b7",
          "assigned_to_uuids": [
            "32202154-cbd5-4812-93ae-bdf04afc13eb"
          ],
          "participants_count": 4
        }
      ],
      "status": "pending",
      "provider": "Mortgage Brain",
      "applicants": [
        {
          "uuid": "c5652c2c-f92e-4573-bc55-47769b808cad",
          "account": "App\\Http\\Resources\\MinimalAccountResource",
          "created_at": "2026-01-19T20:52:27+00:00",
          "updated_at": "2026-01-19T20:52:27+00:00"
        }
      ],
      "created_at": "2026-01-19T20:52:27+00:00",
      "updated_at": "2026-01-19T20:52:27+00:00",
      "provider_data": [],
      "provider_reference": "123456789"
    }
  ]
}