Get a firm

GET /api/v1/firm/{uuid}

Personal access token & O auth2

Headers

Authorization string
Content-Type string
Accept string

Path parameters

uuid integer Required

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  Name of the firm
- slug string
  
  Slug of the firm
- address_1 string
  
  First line of the address
- address_2 string
  
  Second line of the address
- town_city string
  
  Town/City
- county string
  
  County
- postcode string
  
  Postcode
- country string
  
  Country
- regulatory_text string
  
  Regulatory text of the firm.
- logo string
  
  URL of your firm logo.
- logo_icon string
  
  URL of your firm logo icon.
- brand_colours object
  
  Firm branding colours.
- is_subscribed boolean
  
  Subscription status.
- addon_subscriptions array[object]
  
  All addons the firm is subscribed to.
- keep_deleted_files_for integer
  
  Number of days to keep deleted files for
- tax number
  
  Tax percent
- month_end integer
  
  Date of the month for the monthly income reconciliation statements to end
- statement_frequency string
  
  The frequency of the income reconciliation statements
- billing object
  
  Firm invoice details for billing
- task_board_template object
  
  The task board template that is used when every client or case is created
- ip_whitelist array[string]
  
  A list of IP Addresses a firm is allowed to log in from.
- welcome_paragraph_html string
  
  Custom welcome paragraph html for the branded auth welcome page
- email_welcome_paragraph_html string
  
  Custom welcome paragraph for the welcome/new user email
- show_fact_find_illustrations boolean
  
  Determines if the illustrations/graphics are displayed on the fact-find.

GET /api/v1/firm/{uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/firm/uuid' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json"

Response examples (200)

{
  "tax": 17.5,
  "logo": "https://api.plannrcrm.com/images/plannr.jpg",
  "name": "Codepotato",
  "slug": "codepotato",
  "uuid": "6d8c0c87-874b-4dac-8b13-e45f49f61bb0",
  "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-04-02T13:27:53+01:00",
  "updated_at": "2025-04-02T13:27:53+01: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": [
    {
      "uuid": "cb4eccf9-f7b4-409f-8b59-03eb6af4f21f",
      "addon": "App\\Http\\Resources\\Addons\\AddonResource",
      "enabled": "true",
      "created_at": "2025-04-02T13:27:53+01:00",
      "updated_at": "2025-04-02T13:27:53+01:00"
    }
  ],
  "statement_frequency": "monthly",
  "task_board_template": {
    "name": "Task Board",
    "uuid": "013db814-3b8f-40a1-82fe-b1d311d88adf",
    "lists": "App\\Http\\Resources\\Board\\BoardListResource",
    "modelable": "App\\Http\\Resources\\CasesResource",
    "created_at": "2025-04-02T13:27:53+01:00",
    "priorities": [
      {
        "name": "High",
        "value": "high"
      },
      {
        "name": "Low",
        "value": "low"
      }
    ],
    "updated_at": "2025-04-02T13:27:53+01:00",
    "is_editable": true,
    "is_template": false,
    "default_list_uuid": "d10f31d2-c046-46fd-ad19-c7bee9c350d0"
  },
  "keep_deleted_files_for": 30,
  "welcome_paragraph_html": "<h1>Welcome.</h1>",
  "email_welcome_paragraph_html": "Welcome to Plannr!",
  "show_fact_find_illustrations": true
}