Get employments for a session | PlannrCRM API documentation

Get employments for a session 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

{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

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
  
  business_unit string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  terms_of_business_at string
  
  client_agreement_at 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": "96582f76-1d7c-4578-ad51-2fc9194f9108",
        "created_at": "2026-07-08T12:45:06+01:00",
        "updated_at": "2026-07-08T12:45:06+01:00",
        "status": "employed",
        "primary": true,
        "occupation": "Financial Adviser",
        "occupation_code": "FAC02774",
        "job_title": "Senior financial adviser",
        "employer": "Plannr Technologies Ltd",
        "started_at": "2021-07-08T12:45:06+01:00",
        "ended_at": "2022-07-08T12:45:06+01:00",
        "is_business_owner": true,
        "percentage_of_business_shared": 50,
        "address": {
          "uuid": "812b0042-4f46-4bdc-927a-f2fbb30f1dae",
          "created_at": "2026-07-08T12:45:06+01:00",
          "updated_at": "2026-07-08T12:45:06+01:00",
          "name": "Work Address",
          "address_1": "Suite E, 5 The Briars",
          "address_2": "Waterberry Drive",
          "address_3": "The Innovative Centre",
          "address_4": "Waterlooville",
          "town_city": "Waterlooville",
          "county": "Hampshire",
          "postcode": "PO7 7YH",
          "country": "United Kingdom",
          "move_in_date": "2025-07-08",
          "accounts": "App\\Http\\Resources\\AccountResource"
        },
        "phone_number": {
          "uuid": "b979eb72-5e55-4ab1-a960-1057f19bdd41",
          "created_at": "2026-07-08T12:45:06+01:00",
          "updated_at": "2026-07-08T12:45:06+01:00",
          "type": "phone_number",
          "name": "Work number",
          "value": "+443330903630",
          "phone_number_meta": {
            "country": "GB",
            "formatted": "0333 090 3630"
          },
          "accounts": "App\\Http\\Resources\\AccountResource"
        },
        "email_address": {
          "uuid": "11ac2000-270a-4c9b-b646-aa3d23c93ed0",
          "created_at": "2026-07-08T12:45:06+01:00",
          "updated_at": "2026-07-08T12:45:06+01:00",
          "type": "phone_number",
          "name": "Work number",
          "value": "+443330903630",
          "phone_number_meta": {
            "country": "GB",
            "formatted": "0333 090 3630"
          },
          "accounts": "App\\Http\\Resources\\AccountResource"
        },
        "shared_owner_type": "individual",
        "shared_owner": {
          "uuid": "9e1a65a8-b6fe-437e-9d74-cc1f78523bfd",
          "created_at": "2026-07-08T12:45:06+01:00",
          "updated_at": "2026-07-08T12:45:06+01:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "firm": "App\\Http\\Resources\\FirmResource",
          "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
          "primary_email": "App\\Http\\Resources\\ContactDetailResource",
          "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
          "assigned_adviser": "App\\Http\\Resources\\AccountResource",
          "assigned_administrator": "App\\Http\\Resources\\AccountResource",
          "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
          "introduced_by": "App\\Http\\Resources\\AccountResource",
          "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
          "groups": "App\\Http\\Resources\\GroupResource",
          "tags": "App\\Http\\Resources\\TagResource",
          "owners": "App\\Http\\Resources\\AccountResource",
          "first_contact_date": "2026-07-08T12:45:06+01:00",
          "next_review_date": "2026-07-08T12:45:06+01:00",
          "previous_review_date": "2026-07-08T12:45:06+01:00",
          "anniversary_review_date": "2026-07-08T12:45:06+01:00",
          "terms_of_business_at": "2026-07-08T12:45:06+01:00",
          "client_agreement_at": "2026-07-08T12:45:06+01:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "joint_account_circle": "App\\Http\\Resources\\CircleResource",
          "circles": "App\\Http\\Resources\\CircleResource",
          "ownership_percentage": 100,
          "inactive_at": "2026-07-08",
          "last_interaction_at": "2026-07-08 12:45:06",
          "referral_code": "ABC12345",
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
          "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
        },
        "last_salary_increase": "2019-01-01",
        "business_name": "My Business",
        "business_year_end": "2020-12-31",
        "business_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"
          }
        },
        "directors": "Susan F. Lancaster",
        "shareholding_in_business": {
          "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"
          }
        },
        "profit": {
          "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"
          }
        },
        "accountant_company_name": "My Accountant",
        "accountant_email": "accountant@email.com",
        "accountant_telephone_number": "+441234567890",
        "accountant_address": "23 Chollerton, Hexham, Northumberland, NE46 4TF",
        "turnover_history": {
          "year": 2020,
          "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"
            }
          }
        },
        "income": {
          "uuid": "20df7843-9a5f-407a-b350-f21747826a0c",
          "created_at": "2026-07-08T12:45:06+01:00",
          "updated_at": "2026-07-08T12:45:06+01:00",
          "name": "My Salary",
          "type": "salary",
          "type_other": "Other income type",
          "amount": {
            "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"
            }
          },
          "amount_type": "net",
          "start_date": "2025-07-08",
          "end_date": "2026-07-08",
          "frequency": "annually",
          "is_taxable": true,
          "shared_owner_type": "individual",
          "shared_owner": "App\\Http\\Resources\\AccountResource",
          "employment": "App\\Http\\Resources\\EmploymentResource",
          "account": "App\\Http\\Resources\\MinimalAccountResource"
        },
        "account": {
          "uuid": "9f60256e-fe96-4cb5-bc49-58fd1396d449",
          "created_at": "2026-07-08T12:45:06+01:00",
          "updated_at": "2026-07-08T12:45:06+01:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
          "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
        }
      }
    ]
  ]
}