Get all employments

GET /api/v1/client/{client_uuid}/employment
Personal access token & O auth2

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [shared_owner, address, email_address, phone_number, income].

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, employer]. 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
GET /api/v1/client/{client_uuid}/employment 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/client/client_uuid/employment' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "uuid": "488a675a-0c67-42ea-97f5-a81a61cf08d3",
      "income": {
        "name": "My Salary",
        "type": "salary",
        "uuid": "0eab50fd-f2e5-4f33-82ce-369b91f81bb2",
        "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": "2025-04-22",
        "frequency": "annually",
        "created_at": "2025-04-22T13:44:17+01:00",
        "employment": "App\\Http\\Resources\\EmploymentResource",
        "is_taxable": true,
        "start_date": "2024-04-22",
        "updated_at": "2025-04-22T13:44:17+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",
      "address": {
        "name": "Work Address",
        "uuid": "7133a977-8f0d-4c51-a115-5ff545472968",
        "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": "2025-04-22T13:44:17+01:00",
        "updated_at": "2025-04-22T13:44:17+01:00",
        "move_in_date": "2024-04-22"
      },
      "primary": true,
      "employer": "Plannr Technologies Ltd",
      "ended_at": "2021-04-22T13:44:17+01:00",
      "directors": "Susan F. Lancaster",
      "job_title": "Senior financial adviser",
      "created_at": "2025-04-22T13:44:17+01:00",
      "occupation": "Financial Adviser",
      "started_at": "2020-04-22T13:44:17+01:00",
      "updated_at": "2025-04-22T13:44:17+01:00",
      "phone_number": {
        "name": "Work number",
        "type": "phone_number",
        "uuid": "1984ed01-ca96-4d26-94de-dbc59f7c81ea",
        "value": "+443330903630",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "created_at": "2025-04-22T13:44:17+01:00",
        "updated_at": "2025-04-22T13:44:17+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": "1de3df99-2bf9-482f-a788-30da4c890e49",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-04-22T13:44:17+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-04-22T13:44:17+01:00",
        "with_login": true,
        "inactive_at": "2025-04-22",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2025-04-22T13:44:17+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-04-22T13:44:17+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "previous_review_date": "2025-04-22T13:44:17+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-04-22T13:44:17+01:00"
      },
      "business_name": "My Business",
      "email_address": {
        "name": "Work number",
        "type": "phone_number",
        "uuid": "544dfd50-5a3a-44cf-9270-2390111c6853",
        "value": "+443330903630",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "created_at": "2025-04-22T13:44:17+01:00",
        "updated_at": "2025-04-22T13:44:17+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": {
        "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_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
    }
  ]
}