GET /api/v2/fact-find-employments/{factFindSession_uuid}
Personal access token & O auth2

Path parameters

  • factFindSession_uuid string Required

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[account_uuids] string

    Filter by a comma separated list of UUIDs.

  • filter[client_uuids] string

    Filter by a comma separated list of UUIDs.

  • filter[status] string

    Filter by a comma separated list of statuses.

  • filter[employer] string

    Filter by employer name.

  • filter[job_title] string

    Filter by job title.

  • filter[started_at] string

    Filter by start date. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.

  • filter[ended_at] string

    Filter by end date. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.

  • filter[email_address] string

    Filter by job title.

  • filter[phone_number] string

    Filter pby hone number - must have international code.

  • include string

    A comma separated list of items to include. Possible values are [address, income, email_address, phone_number, turnover_history].

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at]. 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
      • created_at string
      • updated_at string
      • status string
      • primary boolean
      • occupation string
      • occupation_code string
      • job_title string
      • employer string
      • started_at string
      • ended_at string
      • is_business_owner boolean
      • percentage_of_business_shared integer
      • address object
        Hide address attributes Show address attributes object
        • uuid string
        • created_at string
        • updated_at string
        • name string
        • address_1 string
        • address_2 string
        • address_3 string
        • address_4 string
        • town_city string
        • county string
        • postcode string
        • country string
        • move_in_date string
        • accounts string
      • phone_number object
        Hide phone_number attributes Show phone_number attributes object
        • uuid string
        • created_at string
        • updated_at string
        • type string
        • name string
        • value string
        • phone_number_meta object
          Hide phone_number_meta attributes Show phone_number_meta attributes object
          • country string
          • formatted string
        • accounts string
      • email_address object
        Hide email_address attributes Show email_address attributes object
        • uuid string
        • created_at string
        • updated_at string
        • type string
        • name string
        • value string
        • phone_number_meta object
          Hide phone_number_meta attributes Show phone_number_meta attributes object
          • country string
          • formatted string
        • accounts string
      • shared_owner_type string
      • shared_owner object
        Hide shared_owner attributes Show shared_owner attributes object
        • uuid string
        • created_at string
        • updated_at string
        • type string
        • role string
        • first_name string
        • last_name string
        • name string
        • email string
        • photo_url string
        • firm string
        • primary_phone_number string
        • primary_email string
        • current_time_entry string
        • assigned_adviser string
        • assigned_administrator string
        • assigned_paraplanner string
        • introduced_by string
        • groups string
        • tags string
        • owners string
        • first_contact_date string
        • next_review_date string
        • previous_review_date string
        • anniversary_review_date string
        • with_login boolean
        • has_joint_account boolean
        • can_be_deleted string
        • joint_account_circle string
        • circles string
        • ownership_percentage integer
        • inactive_at string
        • last_interaction_at string
        • referral_code string
        • permissions object
          Hide permissions attributes Show permissions attributes object
          • firm:read array[string]
          • network:read array[string]
        • custom_fields string
        • external_references string
      • last_salary_increase string
      • business_name string
      • business_year_end string
      • business_value object
        Hide business_value attributes Show business_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
      • directors string
      • shareholding_in_business object
        Hide shareholding_in_business attributes Show shareholding_in_business 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
      • profit object
        Hide profit attributes Show profit 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
      • accountant_company_name string
      • accountant_email string
      • accountant_telephone_number string
      • accountant_address string
      • turnover_history object
        Hide turnover_history attributes Show turnover_history attributes object
        • year integer
        • 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
      • income object
        Hide income attributes Show income attributes object
        • uuid string
        • created_at string
        • updated_at string
        • name string
        • type string
        • type_other string
        • amount object
          Hide amount attributes Show amount 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
        • amount_type string
        • start_date string
        • end_date string
        • frequency string
        • is_taxable boolean
        • shared_owner_type string
        • shared_owner string
        • employment string
        • account string
      • account object
        Hide account attributes Show account attributes object
        • uuid string
        • created_at string
        • updated_at string
        • type string
        • role string
        • first_name string
        • last_name string
        • name string
        • email string
        • photo_url string
        • external_references string
GET /api/v2/fact-find-employments/{factFindSession_uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/fact-find-employments/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "uuid": "8f3ebbb0-9a6e-4da8-a811-f81fed17e031",
      "income": {
        "name": "My Salary",
        "type": "salary",
        "uuid": "ff50b28a-2d94-40d1-8700-9a1b641e1c38",
        "amount": {
          "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"
          }
        },
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "end_date": "2026-03-30",
        "frequency": "annually",
        "created_at": "2026-03-30T13:19:41+01:00",
        "employment": "App\\Http\\Resources\\EmploymentResource",
        "is_taxable": true,
        "start_date": "2025-03-30",
        "type_other": "Other income type",
        "updated_at": "2026-03-30T13:19:41+01:00",
        "amount_type": "net",
        "shared_owner": "App\\Http\\Resources\\AccountResource",
        "shared_owner_type": "individual"
      },
      "profit": {
        "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": "employed",
      "account": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "6f76f303-744d-48a7-9270-6fee79e73e7c",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2026-03-30T13:19:41+01:00",
        "first_name": "Gareth",
        "updated_at": "2026-03-30T13:19:41+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "address": {
        "name": "Work Address",
        "uuid": "7b969ae6-ee8d-4381-bab9-04cc21a72ac2",
        "county": "Hampshire",
        "country": "United Kingdom",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "postcode": "PO7 7YH",
        "address_1": "Suite E, 5 The Briars",
        "address_2": "Waterberry Drive",
        "address_3": "The Innovative Centre",
        "address_4": "Waterlooville",
        "town_city": "Waterlooville",
        "created_at": "2026-03-30T13:19:41+01:00",
        "updated_at": "2026-03-30T13:19:41+01:00",
        "move_in_date": "2025-03-30"
      },
      "primary": true,
      "employer": "Plannr Technologies Ltd",
      "ended_at": "2022-03-30T13:19:41+01:00",
      "directors": "Susan F. Lancaster",
      "job_title": "Senior financial adviser",
      "created_at": "2026-03-30T13:19:41+01:00",
      "occupation": "Financial Adviser",
      "started_at": "2021-03-30T13:19:41+01:00",
      "updated_at": "2026-03-30T13:19:41+01:00",
      "phone_number": {
        "name": "Work number",
        "type": "phone_number",
        "uuid": "70a5bea4-c11e-49b2-afb7-2dd9dd38b53e",
        "value": "+443330903630",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "created_at": "2026-03-30T13:19:41+01:00",
        "updated_at": "2026-03-30T13:19:41+01:00",
        "phone_number_meta": {
          "country": "GB",
          "formatted": "0333 090 3630"
        }
      },
      "shared_owner": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "7037945e-9bb7-4269-a029-7520ac546f9b",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "circles": "App\\Http\\Resources\\CircleResource",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
        "created_at": "2026-03-30T13:19:41+01:00",
        "first_name": "Gareth",
        "updated_at": "2026-03-30T13:19:41+01:00",
        "with_login": true,
        "inactive_at": "2026-03-30",
        "permissions": {
          "firm:read": [
            "firm"
          ],
          "network:read": [
            "network:uuid"
          ]
        },
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "referral_code": "ABC12345",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2026-03-30T13:19:41+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2026-03-30T13:19:41+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "last_interaction_at": "2026-03-30 13:19:41",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "previous_review_date": "2026-03-30T13:19:41+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2026-03-30T13:19:41+01:00"
      },
      "business_name": "My Business",
      "email_address": {
        "name": "Work number",
        "type": "phone_number",
        "uuid": "9db6d994-deb7-4986-a5c4-cd06d0289c07",
        "value": "+443330903630",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "created_at": "2026-03-30T13:19:41+01:00",
        "updated_at": "2026-03-30T13:19:41+01:00",
        "phone_number_meta": {
          "country": "GB",
          "formatted": "0333 090 3630"
        }
      },
      "business_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"
        }
      },
      "occupation_code": "FAC02774",
      "accountant_email": "accountant@email.com",
      "turnover_history": {
        "year": 2020,
        "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"
          }
        }
      },
      "business_year_end": "2020-12-31",
      "is_business_owner": true,
      "shared_owner_type": "individual",
      "accountant_address": "23 Chollerton, Hexham, Northumberland, NE46 4TF",
      "last_salary_increase": "2019-01-01",
      "accountant_company_name": "My Accountant",
      "shareholding_in_business": {
        "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"
        }
      },
      "accountant_telephone_number": "+441234567890",
      "percentage_of_business_shared": 50
    }
  ]
}