Headers
-
Content-Type
string -
Accept
string
Path parameters
-
uuid
integer Required
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": "ee4de328-ad53-47cf-af15-6e8686957e0b",
"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-06-19T21:11:35+01:00",
"updated_at": "2025-06-19T21:11:35+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",
"portal_background": "#f6f6f6",
"portal_brand_title": "#323b4b",
"sidebar_background": "#0E0E56",
"portal_sidebar_icon": "#828994",
"portal_sidebar_text": "#323b4b",
"portal_account_email": "#828994",
"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_title": "#11151d",
"portal_sidebar_button_active": "#ffffff",
"sidebar_title_secondary_hover": "#ffffff",
"portal_sidebar_button_background": "#f6f6f6"
},
"is_subscribed": true,
"regulatory_text": "Regulatory text",
"addon_subscriptions": [
{
"uuid": "cded70a2-e22e-49fa-9f05-4914ed37978e",
"addon": "App\\Http\\Resources\\Addons\\AddonResource",
"enabled": "true",
"created_at": "2025-06-19T21:11:35+01:00",
"updated_at": "2025-06-19T21:11:35+01:00",
"trial_ends_at": "2025-07-03",
"trial_ends_in_days": 14,
"payment_confirmed_at": "2025-07-07"
}
],
"statement_frequency": "monthly",
"task_board_template": {
"name": "Task Board",
"uuid": "849ab220-6b23-451a-99c4-6ebb527e99d0",
"lists": "App\\Http\\Resources\\Board\\BoardListResource",
"modelable": "App\\Http\\Resources\\CasesResource",
"created_at": "2025-06-19T21:11:35+01:00",
"priorities": [
{
"name": "High",
"value": "high"
},
{
"name": "Low",
"value": "low"
}
],
"updated_at": "2025-06-19T21:11:35+01:00",
"is_editable": true,
"is_template": false,
"default_list_uuid": "bfefd496-60ce-466c-ace8-b5d7738e9bbd"
},
"keep_deleted_files_for": 30,
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!",
"show_fact_find_illustrations": true
}