Headers
-
Content-Type
string -
Accept
string -
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 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).
GET
/api/v2/employments
curl \
--request GET 'https://api.plannrcrm.com/api/v2/employments' \
--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": "dc841d15-1713-440b-87c7-ca75c8e7e2e4",
"income": {
"name": "My Salary",
"type": "salary",
"uuid": "6eb645e8-98b3-4f1c-a074-a3aebc885298",
"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-02",
"frequency": "annually",
"created_at": "2025-04-02T13:27:59+01:00",
"employment": "App\\Http\\Resources\\EmploymentResource",
"is_taxable": true,
"start_date": "2024-04-02",
"updated_at": "2025-04-02T13:27:59+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": "abe446b2-2b2f-4b65-9da8-a03c8366f1ee",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-02T13:27:59+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-02T13:27:59+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"address": {
"name": "Work Address",
"uuid": "6e647dc8-ab14-4f87-93fa-5253871a055c",
"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-02T13:27:59+01:00",
"updated_at": "2025-04-02T13:27:59+01:00",
"move_in_date": "2024-04-02"
},
"primary": true,
"employer": "Plannr Technologies Ltd",
"ended_at": "2021-04-02T13:27:59+01:00",
"directors": "Susan F. Lancaster",
"job_title": "Senior financial adviser",
"created_at": "2025-04-02T13:27:59+01:00",
"occupation": "Financial Adviser",
"started_at": "2020-04-02T13:27:59+01:00",
"updated_at": "2025-04-02T13:27:59+01:00",
"phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "9ca78b20-ad30-4150-a6bc-0cb9316066a6",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-04-02T13:27:59+01:00",
"updated_at": "2025-04-02T13:27:59+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": "9b7b279d-db47-464b-b65d-6b7e0b894d36",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-02T13:27:59+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-02T13:27:59+01:00",
"with_login": true,
"inactive_at": "2025-04-02",
"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-02T13:27:59+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-02T13:27:59+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-02T13:27:59+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-02T13:27:59+01:00"
},
"business_name": "My Business",
"email_address": {
"name": "Work number",
"type": "phone_number",
"uuid": "19828856-acbc-485a-a5ff-8390185db616",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-04-02T13:27:59+01:00",
"updated_at": "2025-04-02T13:27:59+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
}
]
}