Get an employee [DEPRECATED: Use get an account route]
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
GET /api/v1/employee/{uuid}
curl \
-X GET https://api.plannrcrm.com/api/v1/employee/uuid \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "b9cd4aae-f579-421f-bb0e-67509b8ff12c",
"county": "Hampshire",
"billing": {
"invoice_email": "gareth@codepotato.co.uk",
"invoice_county": "Hampshire",
"invoice_country": "United Kingdom",
"invoice_postcode": "PO7 7YH",
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville"
},
"country": "United Kingdom",
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"month_end": 25,
"town_city": "Waterlooville",
"created_at": "2024-11-20T13:24:00+00:00",
"updated_at": "2024-11-20T13:24:00+00:00",
"ip_whitelist": [
"192.168.0.1",
"127.0.0.1"
],
"brand_colours": {
"sidebar_text": "#ffffff",
"sidebar_hover": "#0A0A42",
"email_sub_text": "#ffffff",
"sidebar_accent": "#36367E",
"sidebar_active": "#53DBB8",
"email_background": "#0E0E56",
"email_button_text": "#ffffff",
"sidebar_background": "#0E0E56",
"sidebar_title_primary": "#FFC634",
"email_button_background": "#36367E",
"sidebar_title_secondary": "#ffffff",
"sidebar_title_background": "#36367E",
"email_logo_background_panel": "#36367E",
"sidebar_title_secondary_hover": "#ffffff"
},
"is_subscribed": true,
"regulatory_text": "Regulatory text",
"addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
"statement_frequency": "monthly",
"task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
"keep_deleted_files_for": 30,
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!"
},
"name": "Gareth Thompson",
"role": "client",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "bf2bb97b-eba2-4cfc-8cbb-a85ab52be1e2",
"colour": "#ef4582",
"created_at": "2024-11-20T13:24:00+00:00",
"updated_at": "2024-11-20T13:24:00+00:00"
}
],
"type": "client",
"uuid": "9d2d84b4-7cfd-496e-bfc8-cb3a69021f83",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "273eabfa-9645-432e-80cb-458e68280646",
"created_at": "2024-11-20T13:24:00+00:00",
"updated_at": "2024-11-20T13:24:00+00:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "189876a7-4d1b-4975-a11d-936484893216",
"description": "UUID of the account"
},
"email": {
"example": "gareth@codepotato.co.uk",
"description": "Email of the account"
},
"last_name": {
"example": "Thompson",
"description": "Last name of the account"
},
"first_name": {
"example": "Gareth",
"description": "First name of the account"
}
},
"participants_count": "3"
}
],
"owners": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "f803e5d2-0a2f-4d9c-96fb-129d2d99bc10",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-11-20T13:24:00+00:00",
"first_name": "Gareth",
"updated_at": "2024-11-20T13:24:00+00:00",
"with_login": true,
"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": "2024-11-20T13:24:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-11-20T13:24:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-11-20T13:24:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-11-20T13:24:00+00:00"
}
],
"last_name": "Thompson",
"created_at": "2024-11-20T13:24:00+00:00",
"first_name": "Gareth",
"updated_at": "2024-11-20T13:24:00+00:00",
"with_login": true,
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "2c7ce020-3f46-4a5b-8df6-fa3756f4b813",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2024-11-20T13:24:00+00:00",
"updated_at": "2024-11-20T13:24:00+00:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"introduced_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "5150d7c7-76c6-4a38-9fd4-43b4fd4b9546",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-11-20T13:24:00+00:00",
"first_name": "Gareth",
"updated_at": "2024-11-20T13:24:00+00:00",
"with_login": true,
"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": "2024-11-20T13:24:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-11-20T13:24:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-11-20T13:24:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-11-20T13:24:00+00:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "679b4645-0b48-4509-9ba9-6e757064df10",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2024-11-20T13:24:00+00:00",
"updated_at": "2024-11-20T13:24:00+00:00",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
},
"can_be_deleted": "false",
"assigned_adviser": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "846d3cb8-024b-4e32-b84a-b27ff2f8a1ff",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-11-20T13:24:00+00:00",
"first_name": "Gareth",
"updated_at": "2024-11-20T13:24:00+00:00",
"with_login": true,
"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": "2024-11-20T13:24:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-11-20T13:24:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-11-20T13:24:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-11-20T13:24:00+00:00"
},
"next_review_date": "2024-11-20T13:24:00+00:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "1bd39359-6860-423a-8c26-8cc2f78d09c1",
"end_date": "2024-11-20T13:24:00+00:00",
"is_active": "1",
"trackable": "Client",
"start_date": "2024-11-20T13:24:00+00:00"
},
"first_contact_date": "2024-11-20T13:24:00+00:00",
"external_references": [
{
"uuid": "079537ad-01f1-4776-9802-4d52543daf5a",
"reference": "AB123456",
"created_at": "2024-11-20T13:24:00+00:00",
"updated_at": "2024-11-20T13:24:00+00:00",
"third_party": "nucleus"
}
],
"assigned_paraplanner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "97258ad6-cc5c-4f61-8abe-f87c92740191",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-11-20T13:24:00+00:00",
"first_name": "Gareth",
"updated_at": "2024-11-20T13:24:00+00:00",
"with_login": true,
"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": "2024-11-20T13:24:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-11-20T13:24:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-11-20T13:24:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-11-20T13:24:00+00:00"
},
"previous_review_date": "2024-11-20T13:24:00+00:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "f779a7c4-d6dc-4a1c-aa16-9a2f2b0ed1d7",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2024-11-20T13:24:00+00:00",
"updated_at": "2024-11-20T13:24:00+00:00",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
},
"assigned_administrator": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "6c5c1815-cdc5-4c17-a6d6-bd1ac85dc999",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-11-20T13:24:00+00:00",
"first_name": "Gareth",
"updated_at": "2024-11-20T13:24:00+00:00",
"with_login": true,
"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": "2024-11-20T13:24:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-11-20T13:24:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-11-20T13:24:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-11-20T13:24:00+00:00"
},
"anniversary_review_date": "2024-11-20T13:24:00+00:00"
}