GET /api/v1/firm/{uuid}
curl \
-X GET https://api.plannrcrm.com/api/v1/firm/uuid \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Response examples (200)
{
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "47596e9b-0fda-4a07-b23c-ab75f1b41ad2",
"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-10-16T11:10:12+01:00",
"updated_at": "2024-10-16T11:10:12+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": "099e5994-491d-4108-b1f7-3b7ea4e03546",
"addon": "App\\Http\\Resources\\Addons\\AddonResource",
"enabled": "true",
"created_at": "2024-10-16T11:10:12+01:00",
"updated_at": "2024-10-16T11:10:12+01:00"
}
],
"statement_frequency": "monthly",
"task_board_template": {
"name": "Task Board",
"uuid": "d4562209-9b3c-43e0-9f5a-b54ba6860a47",
"lists": "App\\Http\\Resources\\Board\\BoardListResource",
"modelable": "App\\Http\\Resources\\CasesResource",
"created_at": "2024-10-16T11:10:12+01:00",
"priorities": [
{
"name": "High",
"value": "high"
},
{
"name": "Low",
"value": "low"
}
],
"updated_at": "2024-10-16T11:10:12+01:00",
"is_editable": true,
"is_template": false,
"default_list_uuid": "5f71a2ee-ea15-43ce-ad3a-0fb7d53a1a75"
},
"keep_deleted_files_for": 30,
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!"
}