Path parameters

  • account_uuid string Required
  • login_uuid string Required

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string
    • created_at string
    • updated_at string
    • expires_at string
    • has_write_permission boolean
    • has_delete_permission boolean
    • primary boolean
    • receives_unread_notifications_email boolean
    • wealth_enabled boolean
    • goals_enabled boolean
    • factfind_enabled boolean
    • tasks_enabled boolean
    • welcome_enabled boolean
    • first_name string
    • last_name string
    • email 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
      • 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
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • custom_fields string
      • external_references string
    • firm object
      Hide firm attributes Show firm attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • address_1 string
      • address_2 string
      • town_city string
      • county string
      • postcode string
      • country string
      • regulatory_text string
      • logo_icon string
      • brand_colours object
        Hide brand_colours attributes Show brand_colours attributes object
        • sidebar_background string
        • sidebar_accent string
        • sidebar_text string
        • sidebar_hover string
        • sidebar_active string
        • sidebar_title_background string
        • sidebar_title_primary string
        • sidebar_title_secondary string
        • sidebar_title_secondary_hover string
        • email_background string
        • email_logo_background_panel string
        • email_sub_text string
        • email_button_background string
        • email_button_text string
        • portal_sidebar_button_background string
        • portal_sidebar_button_hover string
        • portal_sidebar_button_active string
        • portal_brand_title string
        • portal_brand_sub_title string
        • portal_sidebar_title string
        • portal_sidebar_text string
        • portal_sidebar_text_hover string
        • portal_sidebar_text_active string
        • portal_sidebar_icon string
        • portal_sidebar_icon_hover string
        • portal_sidebar_icon_active string
        • portal_background string
        • portal_sidebar_account_title string
        • portal_sidebar_account_email string
        • portal_sidebar_divider string
        • portal_dashboard_bg_one string
        • portal_dashboard_bg_two string
        • portal_sidebar_collapse_button string
        • portal_sidebar_collapse_button_hover string
        • portal_sidebar_user_select_background string
        • portal_sidebar_user_select_hover string
        • portal_sidebar_user_select_text string
        • portal_sidebar_user_select_text_hover string
        • portal_sidebar_user_select_border string
        • portal_sidebar_user_select_border_hover string
      • is_subscribed boolean
      • addon_subscriptions string
      • keep_deleted_files_for integer
      • tax number
      • month_end integer
      • statement_frequency string
      • billing object
        Hide billing attributes Show billing attributes object
        • invoice_address_1 string
        • invoice_address_2 string
        • invoice_town_city string
        • invoice_county string
        • invoice_postcode string
        • invoice_country string
        • invoice_email string
      • task_board_template string
      • ip_whitelist array[string]
      • welcome_paragraph_html string
      • email_welcome_paragraph_html string
      • show_fact_find_illustrations boolean
      • cc_email_addresses array[string]
      • bcc_email_addresses array[string]
      • reply_to_email_address string
    • is_impersonated boolean
POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/account/6ff8f7f6-1eb3-3525-be4a-3932c805afed/login/6ff8f7f6-1eb3-3525-be4a-3932c805afed/expire' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "firm": {
      "tax": 17.5,
      "logo": "https://api.plannrcrm.com/images/plannr.jpg",
      "name": "Codepotato",
      "slug": "codepotato",
      "uuid": "90b76db5-7537-42c9-9d6f-bfd91384cb6c",
      "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": "2025-12-08T16:11:22+00:00",
      "updated_at": "2025-12-08T16:11:22+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",
        "portal_background": "#F6F6F6",
        "portal_brand_title": "#323B4B",
        "sidebar_background": "#0E0E56",
        "portal_sidebar_icon": "#828994",
        "portal_sidebar_text": "#323B4B",
        "portal_sidebar_title": "#11151D",
        "sidebar_title_primary": "#FFC634",
        "portal_brand_sub_title": "#828994",
        "portal_sidebar_divider": "#E3E5E9",
        "email_button_background": "#36367E",
        "portal_dashboard_bg_one": "#EF4583",
        "portal_dashboard_bg_two": "#FFC634",
        "sidebar_title_secondary": "#FFFFFF",
        "sidebar_title_background": "#36367E",
        "portal_sidebar_icon_hover": "#828994",
        "portal_sidebar_text_hover": "#323B4B",
        "portal_sidebar_icon_active": "#828994",
        "portal_sidebar_text_active": "#323B4B",
        "email_logo_background_panel": "#36367E",
        "portal_sidebar_button_hover": "#FFFFFF",
        "portal_sidebar_account_email": "#828994",
        "portal_sidebar_account_title": "#11151D",
        "portal_sidebar_button_active": "#FFFFFF",
        "sidebar_title_secondary_hover": "#FFFFFF",
        "portal_sidebar_collapse_button": "#828994",
        "portal_sidebar_user_select_text": "#323B4B",
        "portal_sidebar_button_background": "#F6F6F6",
        "portal_sidebar_user_select_hover": "#F6F6F6",
        "portal_sidebar_user_select_border": "#EEEEEE",
        "portal_sidebar_collapse_button_hover": "#B3B9C4",
        "portal_sidebar_user_select_background": "#F6F6F6",
        "portal_sidebar_user_select_text_hover": "#323B4B",
        "portal_sidebar_user_select_border_hover": "#828994"
      },
      "is_subscribed": true,
      "regulatory_text": "Regulatory text",
      "cc_email_addresses": [
        "jack@example.com",
        "jill@example.com"
      ],
      "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
      "bcc_email_addresses": [
        "jack@example.com",
        "jill@example.com"
      ],
      "statement_frequency": "monthly",
      "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
      "keep_deleted_files_for": 30,
      "reply_to_email_address": "jack@example.com",
      "welcome_paragraph_html": "<h1>Welcome.</h1>",
      "email_welcome_paragraph_html": "Welcome to Plannr!",
      "show_fact_find_illustrations": true
    },
    "uuid": "0bd8489e-9cdf-4b78-b2d4-3f062d4e6392",
    "email": "gareth@plannrcrm.com",
    "account": {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "2b15805e-5119-46aa-b391-6752ab122f3e",
      "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-12-08T16:11:22+00:00",
      "first_name": "Gareth",
      "updated_at": "2025-12-08T16:11:22+00:00",
      "with_login": true,
      "inactive_at": "2025-12-08",
      "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-12-08T16:11:22+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2025-12-08T16:11:22+00: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-12-08T16:11:22+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2025-12-08T16:11:22+00:00"
    },
    "primary": false,
    "last_name": "Thompson",
    "created_at": "2025-12-08T16:11:22+00:00",
    "expires_at": "2026-03-18T16:11:22+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-12-08T16:11:22+00:00",
    "goals_enabled": true,
    "tasks_enabled": true,
    "wealth_enabled": true,
    "is_impersonated": false,
    "welcome_enabled": true,
    "factfind_enabled": true,
    "has_write_permission": false,
    "has_delete_permission": false,
    "receives_unread_notifications_email": true
  }
]