Query parameters
-
Filter by a comma separated list of UUIDs.
-
Filter by a comma separated list of UUIDs.
-
Filter by a comma separated list of UUIDs.
-
Filter by a comma separated list of statuses.
-
Filter by employer name.
-
Filter by job title.
-
Filter by start date. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.
-
Filter by end date. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.
-
Filter by job title.
-
Filter pby hone number - must have international code.
-
A comma separated list of items to include. Possible values are [address, income, email_address, phone_number, turnover_history].
-
Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC. Defaults to 'created_at'.
-
Number of results to return with pagination (Default 15. Max 500).
GET
/api/v2/employments
curl \
--request GET 'https://api.plannrcrm.com/api/v2/employments' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"uuid": "ce2261d8-f0fa-4687-82d5-0791ff80b353",
"income": {
"name": "My Salary",
"type": "salary",
"uuid": "27ffb556-ebfa-48b7-b88d-7332a1950cc5",
"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-08-07",
"frequency": "annually",
"created_at": "2025-08-07T13:41:47+01:00",
"employment": "App\\Http\\Resources\\EmploymentResource",
"is_taxable": true,
"start_date": "2024-08-07",
"type_other": "Other income type",
"updated_at": "2025-08-07T13:41:47+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": "bf1e376d-3998-4602-84e6-2b59f9621e14",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-08-07T13:41:47+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:47+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"address": {
"name": "Work Address",
"uuid": "bb4f4321-de45-4bf8-a371-da8764bb00c0",
"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-08-07T13:41:47+01:00",
"updated_at": "2025-08-07T13:41:47+01:00",
"move_in_date": "2024-08-07"
},
"primary": true,
"employer": "Plannr Technologies Ltd",
"ended_at": "2021-08-07T13:41:47+01:00",
"directors": "Susan F. Lancaster",
"job_title": "Senior financial adviser",
"created_at": "2025-08-07T13:41:47+01:00",
"occupation": "Financial Adviser",
"started_at": "2020-08-07T13:41:47+01:00",
"updated_at": "2025-08-07T13:41:47+01:00",
"phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "1d573519-04e6-4e0c-8128-ec32ca75f93c",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-08-07T13:41:47+01:00",
"updated_at": "2025-08-07T13:41:47+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": "caf3e030-4988-4c8f-9abf-0ff983c9780d",
"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": "2025-08-07T13:41:47+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:47+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"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-08-07T13:41:47+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-07T13:41:47+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-08-07T13:41:47+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-07T13:41:47+01:00"
},
"business_name": "My Business",
"email_address": {
"name": "Work number",
"type": "phone_number",
"uuid": "e3b8b0a1-11ab-4955-808c-de029df0343d",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-08-07T13:41:47+01:00",
"updated_at": "2025-08-07T13:41:47+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
}
]
}