{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https://api.vetllama.com" } ], "info": { "name": "VetLlama API Documentation", "_postman_id": "3e6b97b2-3bbd-4d0a-9f5d-16129f2be2c8", "description": "API documentation for the VetLlama white-label SaaS backend.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Admin", "description": "", "item": [ { "name": "Auth", "description": "", "item": [ { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api/admin/auth/login", "query": [], "raw": "{{baseUrl}}/api/admin/auth/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"admin@vetllama.test\",\"password\":\"LocalDevPassword123!\",\"device_token\":\"web-admin-device\"}" }, "description": "Authenticates a platform admin and returns an Admin-scoped JWT. Development seed example only: `admin@vetllama.test` / `LocalDevPassword123!`.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Logged in successfully.\",\n \"data\": {\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...\",\n \"token_type\": \"bearer\",\n \"guard\": \"admin\",\n \"expires_in\": 3600,\n \"user\": {\n \"id\": 1,\n \"name\": \"VetLlama Dev Admin\",\n \"email\": \"admin@vetllama.test\",\n \"is_active\": true,\n \"email_verified_at\": \"2026-05-17T00:00:00.000000Z\"\n }\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"email\": [\"Invalid email or password.\"]\n }\n}", "name": "" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api/admin/auth/logout", "query": [], "raw": "{{baseUrl}}/api/admin/auth/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Invalidates the current Admin JWT and closes the latest open auth activity session." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Logged out successfully.\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated.\"\n}", "name": "" } ] }, { "name": "Refresh Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api/admin/auth/refresh", "query": [], "raw": "{{baseUrl}}/api/admin/auth/refresh" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Exchanges a valid Admin JWT for a fresh Admin JWT." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Token refreshed successfully.\",\n \"data\": {\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...\",\n \"token_type\": \"bearer\",\n \"guard\": \"admin\",\n \"expires_in\": 3600,\n \"user\": {\n \"id\": 1,\n \"name\": \"VetLlama Dev Admin\",\n \"email\": \"admin@vetllama.test\",\n \"is_active\": true\n }\n }\n}", "name": "" } ] }, { "name": "Current Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api/admin/auth/me", "query": [], "raw": "{{baseUrl}}/api/admin/auth/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns the profile for the authenticated platform admin." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Profile fetched successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"VetLlama Dev Admin\",\n \"email\": \"admin@vetllama.test\",\n \"is_active\": true,\n \"email_verified_at\": \"2026-05-17T00:00:00.000000Z\"\n }\n}", "name": "" } ] } ] }, { "name": "Platform / System", "description": "", "item": [ { "name": "Health Check", "request": { "url": { "host": "{{baseUrl}}", "path": "api/health", "query": [], "raw": "{{baseUrl}}/api/health" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Confirms that the VetLlama API process is reachable.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"VetLlama API is available.\"\n}", "name": "" } ] } ] } ] }, { "name": "Tenant", "description": "", "item": [ { "name": "Public Auth", "description": "", "item": [ { "name": "Register Tenant Owner", "request": { "url": { "host": "{{baseUrl}}", "path": "api/public/tenant/auth/register", "query": [], "raw": "{{baseUrl}}/api/public/tenant/auth/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"owner_name\":\"Dr. Sarah Khan\",\"display_name\":\"Paws & Care\",\"business_name\":\"Paws & Care LLC\",\"email\":\"owner@demo.vetllama.test\",\"password\":\"LocalDevPassword123!\",\"accepted_terms\":true,\"phone\":\"+10000000000\",\"desired_subdomain\":\"paws-care\",\"password_confirmation\":\"LocalDevPassword123!\"}" }, "description": "Creates a draft tenant together with its primary tenant owner, initializes onboarding defaults, creates a primary subdomain host mapping, and returns a JWT so onboarding can start immediately. If `desired_subdomain` is omitted, the backend generates a unique subdomain from `display_name`.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Account created successfully. Onboarding started.\",\n \"data\": {\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...\",\n \"token_type\": \"bearer\",\n \"guard\": \"tenant_owner\",\n \"expires_in\": 3600,\n \"user\": {\n \"id\": 1,\n \"tenant_id\": 1,\n \"name\": \"Dr. Sarah Khan\",\n \"email\": \"owner@paws-care.test\",\n \"phone\": \"+10000000000\",\n \"is_primary\": true,\n \"is_active\": true,\n \"tenant\": {\n \"id\": 1,\n \"name\": \"Paws & Care\",\n \"slug\": \"paws-care\",\n \"status\": \"draft\",\n \"onboarding_status\": \"in_progress\",\n \"is_active\": true\n }\n }\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"email\": [\"The email has already been taken.\"]\n }\n}", "name": "" } ] } ] }, { "name": "Public Resolution", "description": "", "item": [ { "name": "Resolve Tenant By Host", "request": { "url": { "host": "{{baseUrl}}", "path": "api/public/tenant/resolve", "query": [ { "key": "host", "value": "paws-care.vetllama.test", "description": "Optional full host to resolve.", "disabled": false }, { "key": "domain", "value": "paws-care.com", "description": "Optional custom domain/full domain to resolve.", "disabled": false }, { "key": "subdomain", "value": "paws-care", "description": "Optional subdomain label to resolve against the configured tenant base domain.", "disabled": false } ], "raw": "{{baseUrl}}/api/public/tenant/resolve?host=paws-care.vetllama.test&domain=paws-care.com&subdomain=paws-care" }, "method": "GET", "header": [ { "key": "Host", "value": "demo.vetllama.test" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Resolves the active tenant from a mapped website host and returns the public configuration needed by the Angular frontend. By default, resolution uses the request Host header. For testing or frontend bootstrapping, you may also pass one explicit query input: `host`, `domain`, or `subdomain`.\nCustom domains must be active and verified before they resolve publicly. Managed subdomains resolve immediately once active.\n\nSubdomain examples resolve against `VETLLAMA_TENANT_BASE_DOMAIN`, such as `paws-care.vetllama.test` locally. Custom domain examples use the full mapped host, such as `paws-care.com`.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Tenant configuration resolved.\",\n \"data\": {\n \"tenant\": {\n \"id\": 1,\n \"name\": \"Demo Clinic\",\n \"slug\": \"demo-clinic\",\n \"status\": \"active\",\n \"is_active\": true\n },\n \"template\": {\n \"id\": 1,\n \"name\": \"Classic Practice\",\n \"slug\": \"classic-practice\",\n \"description\": \"Local development template for Classic Practice.\",\n \"preview_url\": \"https://example.com/templates/classic-practice\",\n \"is_active\": true,\n \"schema\": {\n \"sections\": [\"hero\", \"about\", \"banners\", \"services\", \"faq\", \"contact\"],\n \"required_fields\": [\"homepage_content.hero_title\", \"homepage_content.hero_subtitle\", \"contact_details.email\"]\n }\n },\n \"branding\": {\n \"primary_color\": \"#2563eb\",\n \"secondary_color\": \"#14b8a6\",\n \"logo_url\": \"https://example.com/demo/logo.png\",\n \"favicon_url\": \"https://example.com/demo/favicon.ico\",\n \"social_links\": {\n \"facebook\": \"https://facebook.com/demo\",\n \"instagram\": \"https://instagram.com/demo\"\n }\n },\n \"public_config\": {\n \"contact_details\": {\n \"email\": \"hello@demo.vetllama.test\",\n \"phone\": \"+10000000000\",\n \"address\": \"123 Demo Street\"\n },\n \"homepage_content\": {\n \"hero_title\": \"Care, scheduling, and client access in one place\",\n \"hero_subtitle\": \"A local-development tenant used to test public config.\"\n },\n \"banners\": [],\n \"faq\": [],\n \"services\": [],\n \"settings\": {\n \"booking_enabled\": false,\n \"telehealth_enabled\": false\n },\n \"is_published\": true\n }\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Tenant could not be resolved for this host.\"\n}", "name": "" } ] }, { "name": "List Public Services", "request": { "url": { "host": "{{baseUrl}}", "path": "api/public/tenant/services", "query": [ { "key": "host", "value": "pawscare.vetllama.test", "description": "Optional full host to resolve.", "disabled": false }, { "key": "domain", "value": "pawscare.test", "description": "Optional custom domain/full domain to resolve.", "disabled": false }, { "key": "subdomain", "value": "pawscare", "description": "Optional subdomain label to resolve.", "disabled": false } ], "raw": "{{baseUrl}}/api/public/tenant/services?host=pawscare.vetllama.test&domain=pawscare.test&subdomain=pawscare" }, "method": "GET", "header": [ { "key": "Host", "value": "pawscare.vetllama.test" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns all enabled tenant service offerings with their active duration and pricing options. Tenant is resolved from the Host header or explicit resolver query parameters.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Services fetched successfully.\",\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"telehealth\",\n \"name\": \"Telehealth Follow-up\",\n \"description\": \"Video consultation for follow-ups.\",\n \"delivery_mode\": \"video\",\n \"duration_options\": [\n {\n \"id\": 1,\n \"service_offering_id\": 1,\n \"duration_minutes\": 30,\n \"price\": \"69.00\",\n \"currency\": \"USD\",\n \"is_default\": true,\n \"is_active\": true\n }\n ]\n }\n ]\n}", "name": "" } ] }, { "name": "Get Public Service Detail", "request": { "url": { "host": "{{baseUrl}}", "path": "api/public/tenant/services/:service_id", "query": [], "raw": "{{baseUrl}}/api/public/tenant/services/:service_id", "variable": [ { "id": "service_id", "key": "service_id", "value": "16", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns one enabled public service with active duration and pricing options.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "List Public Locations", "request": { "url": { "host": "{{baseUrl}}", "path": "api/public/tenant/locations", "query": [], "raw": "{{baseUrl}}/api/public/tenant/locations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns active public locations for physical visit preparation.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get Public Policies", "request": { "url": { "host": "{{baseUrl}}", "path": "api/public/tenant/policies", "query": [], "raw": "{{baseUrl}}/api/public/tenant/policies" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns public booking policy, FAQ, terms, privacy, and contact blocks.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Preview Bookable Slots", "request": { "url": { "host": "{{baseUrl}}", "path": "api/public/tenant/slots", "query": [ { "key": "service_id", "value": "1", "description": "Active service ID.", "disabled": false }, { "key": "duration_id", "value": "1", "description": "Active duration ID.", "disabled": false }, { "key": "date", "value": "2026-05-21", "description": "Date in YYYY-MM-DD format.", "disabled": false }, { "key": "location_id", "value": "1", "description": "Optional active location ID for physical visits.", "disabled": false } ], "raw": "{{baseUrl}}/api/public/tenant/slots?service_id=1&duration_id=1&date=2026-05-21&location_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Generates available bookable slot previews for an active published tenant service. This does not create or reserve a booking.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get Public Tenant Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api/public/tenant/details", "query": [ { "key": "host", "value": "pawscare.vetllama.test", "description": "Optional full host to resolve.", "disabled": false }, { "key": "domain", "value": "pawscare.test", "description": "Optional custom domain/full domain to resolve.", "disabled": false }, { "key": "subdomain", "value": "pawscare", "description": "Optional subdomain label to resolve.", "disabled": false } ], "raw": "{{baseUrl}}/api/public/tenant/details?host=pawscare.vetllama.test&domain=pawscare.test&subdomain=pawscare" }, "method": "GET", "header": [ { "key": "Host", "value": "pawscare.vetllama.test" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns the full public tenant website/bootstrap payload, including tenant profile, template, branding, public content, active host mappings, active locations, enabled services, and active duration/pricing options.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Tenant details fetched successfully.\",\n \"data\": {\n \"tenant\": {\n \"id\": 1,\n \"name\": \"Paws & Care Veterinary Clinic\",\n \"slug\": \"paws-care-vet\",\n \"status\": \"active\",\n \"is_active\": true\n },\n \"template\": {},\n \"branding\": {},\n \"public_config\": {},\n \"domains\": [],\n \"locations\": [],\n \"services\": []\n }\n}", "name": "" } ] } ] }, { "name": "Auth", "description": "", "item": [ { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/auth/login", "query": [], "raw": "{{baseUrl}}/api/tenant/auth/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"owner@demo.vetllama.test\",\"password\":\"LocalDevPassword123!\",\"device_token\":\"web-owner-device\"}" }, "description": "Authenticates a tenant owner/operator and returns a TenantOwner-scoped JWT. Development seed example only: `owner@demo.vetllama.test` / `LocalDevPassword123!`.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Logged in successfully.\",\n \"data\": {\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...\",\n \"token_type\": \"bearer\",\n \"guard\": \"tenant_owner\",\n \"expires_in\": 3600,\n \"user\": {\n \"id\": 1,\n \"tenant_id\": 1,\n \"name\": \"Demo Tenant Owner\",\n \"email\": \"owner@demo.vetllama.test\",\n \"phone\": \"+10000000000\",\n \"is_primary\": true,\n \"is_active\": true,\n \"tenant\": {\n \"id\": 1,\n \"name\": \"Demo Clinic\",\n \"slug\": \"demo-clinic\",\n \"status\": \"active\",\n \"is_active\": true\n }\n }\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"email\": [\"Invalid email or password.\"]\n }\n}", "name": "" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/auth/logout", "query": [], "raw": "{{baseUrl}}/api/tenant/auth/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Invalidates the current TenantOwner JWT and closes the latest open auth activity session." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Logged out successfully.\",\n \"data\": null\n}", "name": "" } ] }, { "name": "Refresh Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/auth/refresh", "query": [], "raw": "{{baseUrl}}/api/tenant/auth/refresh" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Exchanges a valid TenantOwner JWT for a fresh TenantOwner JWT." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Token refreshed successfully.\",\n \"data\": {\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...\",\n \"token_type\": \"bearer\",\n \"guard\": \"tenant_owner\",\n \"expires_in\": 3600,\n \"user\": {\n \"id\": 1,\n \"tenant_id\": 1,\n \"email\": \"owner@demo.vetllama.test\"\n }\n }\n}", "name": "" } ] }, { "name": "Current Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/auth/me", "query": [], "raw": "{{baseUrl}}/api/tenant/auth/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns the authenticated tenant owner and their tenant summary." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Profile fetched successfully.\",\n \"data\": {\n \"id\": 1,\n \"tenant_id\": 1,\n \"name\": \"Demo Tenant Owner\",\n \"email\": \"owner@demo.vetllama.test\",\n \"phone\": \"+10000000000\",\n \"is_primary\": true,\n \"is_active\": true,\n \"tenant\": {\n \"id\": 1,\n \"name\": \"Demo Clinic\",\n \"slug\": \"demo-clinic\",\n \"status\": \"active\",\n \"is_active\": true\n }\n }\n}", "name": "" } ] } ] }, { "name": "Onboarding", "description": "Tenant owner onboarding and setup endpoints.", "item": [ { "name": "Templates", "description": "", "item": [ { "name": "List Templates", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/templates", "query": [], "raw": "{{baseUrl}}/api/tenant/templates" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Lists active website templates available for the tenant owner to select." }, "response": [] }, { "name": "Get Template Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/templates/:template_id", "query": [], "raw": "{{baseUrl}}/api/tenant/templates/:template_id", "variable": [ { "id": "template_id", "key": "template_id", "value": "16", "description": "The ID of the template." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns the selected template definition, including the schema used by the owner setup UI." }, "response": [] }, { "name": "Select Template", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/templates/selection", "query": [], "raw": "{{baseUrl}}/api/tenant/templates/selection" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"template_id\":\"architecto\"}" }, "description": "Assigns one active template to the authenticated tenant." }, "response": [] } ] }, { "name": "Profile", "description": "", "item": [ { "name": "Get Tenant Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/profile", "query": [], "raw": "{{baseUrl}}/api/tenant/profile" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns the authenticated tenant's basic profile and onboarding status fields." }, "response": [] }, { "name": "Update Tenant Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/profile", "query": [], "raw": "{{baseUrl}}/api/tenant/profile" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"business_name\":\"n\",\"slug\":\"g\",\"email\":\"rowan.gulgowski@example.com\",\"primary_phone\":\"d\",\"secondary_phone\":\"l\",\"short_bio\":\"architecto\",\"support_email\":\"zbailey@example.net\",\"support_phone\":\"i\",\"status\":\"pending\",\"onboarding_status\":\"in_progress\"}" }, "description": "Updates owner-facing business profile fields such as display name, slug, contact details, and onboarding status." }, "response": [] } ] }, { "name": "Branding", "description": "", "item": [ { "name": "Get Branding", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/branding", "query": [], "raw": "{{baseUrl}}/api/tenant/branding" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns tenant branding assets and colors used by the public website." }, "response": [] }, { "name": "Update Branding", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/branding", "query": [], "raw": "{{baseUrl}}/api/tenant/branding" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "primary_color", "value": "#2563eb", "type": "text", "description": "Primary brand color. Must not be greater than 20 characters." }, { "key": "secondary_color", "value": "#14b8a6", "type": "text", "description": "Secondary brand color. Must not be greater than 20 characters." }, { "key": "logo_url", "value": "http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html", "type": "text", "description": "Must not be greater than 2048 characters." }, { "key": "favicon_url", "value": "https://www.runte.com/ab-provident-perspiciatis-quo-omnis-nostrum-aut-adipisci", "type": "text", "description": "Must not be greater than 2048 characters." }, { "key": "profile_photo_url", "value": "https://cronin.com/incidunt-iure-odit-et-et-modi-ipsum.html", "type": "text", "description": "Must not be greater than 2048 characters." }, { "key": "social_links[instagram]", "value": "https://instagram.com/pawscare", "type": "text", "description": "" }, { "key": "logo", "src": [], "type": "file" }, { "key": "favicon", "src": [], "type": "file" }, { "key": "profile_photo", "src": [], "type": "file" }, { "key": "banner_files[]", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "Updates tenant colors, social links, and branding media. Send multipart/form-data\nwith logo, favicon, profile_photo, or banner_files to store assets on the configured\nfilesystem disk, typically S3." }, "response": [] }, { "name": "Update Branding", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/branding", "query": [], "raw": "{{baseUrl}}/api/tenant/branding" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "primary_color", "value": "#2563eb", "type": "text", "description": "Primary brand color. Must not be greater than 20 characters." }, { "key": "secondary_color", "value": "#14b8a6", "type": "text", "description": "Secondary brand color. Must not be greater than 20 characters." }, { "key": "logo_url", "value": "http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html", "type": "text", "description": "Must not be greater than 2048 characters." }, { "key": "favicon_url", "value": "https://www.runte.com/ab-provident-perspiciatis-quo-omnis-nostrum-aut-adipisci", "type": "text", "description": "Must not be greater than 2048 characters." }, { "key": "profile_photo_url", "value": "https://cronin.com/incidunt-iure-odit-et-et-modi-ipsum.html", "type": "text", "description": "Must not be greater than 2048 characters." }, { "key": "social_links[instagram]", "value": "https://instagram.com/pawscare", "type": "text", "description": "" }, { "key": "logo", "src": [], "type": "file" }, { "key": "favicon", "src": [], "type": "file" }, { "key": "profile_photo", "src": [], "type": "file" }, { "key": "banner_files[]", "src": [], "type": "file" } ] }, "description": "Updates tenant colors, social links, and branding media. Send multipart/form-data\nwith logo, favicon, profile_photo, or banner_files to store assets on the configured\nfilesystem disk, typically S3." }, "response": [] } ] }, { "name": "Public Config", "description": "", "item": [ { "name": "Get Public Config", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/public-config", "query": [], "raw": "{{baseUrl}}/api/tenant/public-config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns template-driven public website content such as homepage sections, FAQs, policies, SEO metadata, and public toggles." }, "response": [] }, { "name": "Update Public Config", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/public-config", "query": [], "raw": "{{baseUrl}}/api/tenant/public-config" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"contact_details\":{\"email\":\"gbailey@example.net\",\"phone\":\"m\"},\"is_published\":true,\"banners\":[{\"url\":\"https:\\/\\/www.gulgowski.com\\/nihil-accusantium-harum-mollitia-modi-deserunt\"}],\"faq\":[{\"question\":\"architecto\",\"answer\":\"architecto\"}]}" }, "description": "Updates flexible public website content for the authenticated tenant." }, "response": [] }, { "name": "Upload Public Config Media", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/public-config/media", "query": [], "raw": "{{baseUrl}}/api/tenant/public-config/media" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "section_key", "value": "about", "type": "text", "description": "Optional section key for uploaded section images. Must not be greater than 100 characters." }, { "key": "hero_image", "src": [], "type": "file" }, { "key": "banner_images[]", "src": [], "type": "file" }, { "key": "section_images[]", "src": [], "type": "file" } ] }, "description": "Uploads template-driven public website media such as hero, banner, and section images to the configured filesystem disk." }, "response": [] }, { "name": "Validate Required Fields", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/public-config/validate-required-fields", "query": [], "raw": "{{baseUrl}}/api/tenant/public-config/validate-required-fields" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Checks whether the current public content satisfies the selected template's required fields and returns any missing field keys." }, "response": [] } ] }, { "name": "Domains", "description": "", "item": [ { "name": "List Host Mappings", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/domains", "query": [], "raw": "{{baseUrl}}/api/tenant/domains" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Lists all website hosts mapped to the authenticated tenant, including multiple subdomains and multiple custom domains." }, "response": [] }, { "name": "Add Host Mapping", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/domains", "query": [], "raw": "{{baseUrl}}/api/tenant/domains" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"host\":\"paws-care.com\",\"domain\":\"b\",\"subdomain\":\"paws-care\",\"label\":\"n\",\"type\":\"subdomain\",\"is_primary\":true,\"is_active\":true}" }, "description": "Adds a tenant website host mapping. Use `type=subdomain` with `subdomain`, or `type=custom_domain` with `host`." }, "response": [] }, { "name": "Sync Host Mappings", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/domains/sync", "query": [], "raw": "{{baseUrl}}/api/tenant/domains/sync" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"subdomains\":[\"paws-care\",\"londonpets\"],\"domains\":[\"pawscare.com\",\"telepaws.co.uk\"],\"primary_host\":\"paws-care.vetllama.test\"}" }, "description": "Replaces the tenant's editable website host mappings from frontend-provided arrays. Existing mappings omitted from `subdomains` and `domains` are deactivated. Existing submitted mappings are reactivated." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Host mappings synced.\",\n \"data\": [\n {\n \"id\": 1,\n \"host\": \"paws-care.vetllama.test\",\n \"domain\": \"paws-care.vetllama.test\",\n \"label\": \"paws-care\",\n \"subdomain\": \"paws-care\",\n \"type\": \"subdomain\",\n \"is_primary\": true,\n \"is_active\": true,\n \"is_verified\": true\n },\n {\n \"id\": 2,\n \"host\": \"pawscare.com\",\n \"domain\": \"pawscare.com\",\n \"label\": null,\n \"subdomain\": null,\n \"type\": \"custom_domain\",\n \"is_primary\": false,\n \"is_active\": true,\n \"is_verified\": false\n }\n ]\n}", "name": "" } ] }, { "name": "Update Host Mapping", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/domains/:domain_id", "query": [], "raw": "{{baseUrl}}/api/tenant/domains/:domain_id", "variable": [ { "id": "domain_id", "key": "domain_id", "value": "16", "description": "The ID of the domain." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"host\":\"paws-care.com\",\"domain\":\"b\",\"subdomain\":\"paws-care\",\"label\":\"n\",\"type\":\"subdomain\",\"is_primary\":true,\"is_active\":true}" }, "description": "Updates host mapping status, verification metadata, or primary flag for a tenant-owned website host." }, "response": [] }, { "name": "Get Verification Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/domains/:domain_id/verification", "query": [], "raw": "{{baseUrl}}/api/tenant/domains/:domain_id/verification", "variable": [ { "id": "domain_id", "key": "domain_id", "value": "16", "description": "The ID of the domain." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns DNS TXT verification instructions and current status for a tenant custom domain." }, "response": [] }, { "name": "Check Domain Verification", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/domains/:domain_id/verification/check", "query": [], "raw": "{{baseUrl}}/api/tenant/domains/:domain_id/verification/check", "variable": [ { "id": "domain_id", "key": "domain_id", "value": "16", "description": "The ID of the domain." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Triggers a DNS TXT verification check for a tenant custom domain and updates its verification state." }, "response": [] }, { "name": "Set Primary Host Mapping", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/domains/:domain_id/primary", "query": [], "raw": "{{baseUrl}}/api/tenant/domains/:domain_id/primary", "variable": [ { "id": "domain_id", "key": "domain_id", "value": "16", "description": "The ID of the domain." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Marks this mapped host as the tenant's primary public host and clears other primary flags." }, "response": [] }, { "name": "Deactivate Host Mapping", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/domains/:domain_id", "query": [], "raw": "{{baseUrl}}/api/tenant/domains/:domain_id", "variable": [ { "id": "domain_id", "key": "domain_id", "value": "16", "description": "The ID of the domain." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Deactivates a tenant website host mapping without removing historical configuration." }, "response": [] } ] }, { "name": "Locations", "description": "", "item": [ { "name": "List Locations", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/locations", "query": [], "raw": "{{baseUrl}}/api/tenant/locations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Lists physical visit locations for the authenticated tenant." }, "response": [] }, { "name": "Create Location", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/locations", "query": [], "raw": "{{baseUrl}}/api/tenant/locations" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"address_line_1\":\"n\",\"address_line_2\":\"g\",\"city\":\"z\",\"state\":\"m\",\"country\":\"i\",\"postal_code\":\"y\",\"latitude\":-89,\"longitude\":-179,\"contact_phone\":\"l\",\"instructions\":\"architecto\",\"is_primary\":false,\"is_active\":false}" }, "description": "Creates a physical location that can be linked to physical visit services." }, "response": [] }, { "name": "Show Location", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/locations/:id", "query": [], "raw": "{{baseUrl}}/api/tenant/locations/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the location." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns one tenant-owned location." }, "response": [] }, { "name": "Update Location", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/locations/:id", "query": [], "raw": "{{baseUrl}}/api/tenant/locations/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the location." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"address_line_1\":\"n\",\"address_line_2\":\"g\",\"city\":\"z\",\"state\":\"m\",\"country\":\"i\",\"postal_code\":\"y\",\"latitude\":-89,\"longitude\":-179,\"contact_phone\":\"l\",\"instructions\":\"architecto\",\"is_primary\":true,\"is_active\":false}" }, "description": "Updates a tenant-owned physical location." }, "response": [] }, { "name": "Delete Location", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/locations/:id", "query": [], "raw": "{{baseUrl}}/api/tenant/locations/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the location." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Deactivates a tenant-owned location." }, "response": [] } ] }, { "name": "Services", "description": "", "item": [ { "name": "List Services", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/services", "query": [], "raw": "{{baseUrl}}/api/tenant/services" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Lists tenant service offerings, including their duration and pricing options." }, "response": [] }, { "name": "Create Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/services", "query": [], "raw": "{{baseUrl}}/api/tenant/services" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"physical_visit\",\"name\":\"b\",\"description\":\"Eius et animi quos velit et.\",\"is_enabled\":false,\"delivery_mode\":\"v\",\"sort_order\":42,\"status\":\"active\"}" }, "description": "Creates a service offering for physical visits, telehealth, or instant consult configuration." }, "response": [] }, { "name": "Show Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/services/:id", "query": [], "raw": "{{baseUrl}}/api/tenant/services/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns one tenant-owned service offering with duration and pricing options." }, "response": [] }, { "name": "Update Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/services/:id", "query": [], "raw": "{{baseUrl}}/api/tenant/services/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the service." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"instant_consult\",\"name\":\"b\",\"description\":\"Eius et animi quos velit et.\",\"is_enabled\":true,\"delivery_mode\":\"v\",\"sort_order\":42,\"status\":\"active\"}" }, "description": "Updates a tenant-owned service offering." }, "response": [] }, { "name": "Delete Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/services/:id", "query": [], "raw": "{{baseUrl}}/api/tenant/services/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the service." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Archives a tenant-owned service offering." }, "response": [] } ] }, { "name": "Service Durations & Pricing", "description": "", "item": [ { "name": "List Service Durations", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/services/:service_id/durations", "query": [], "raw": "{{baseUrl}}/api/tenant/services/:service_id/durations", "variable": [ { "id": "service_id", "key": "service_id", "value": "16", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Lists pricing and duration options for a tenant-owned service." }, "response": [] }, { "name": "Create Service Duration", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/services/:service_id/durations", "query": [], "raw": "{{baseUrl}}/api/tenant/services/:service_id/durations", "variable": [ { "id": "service_id", "key": "service_id", "value": "16", "description": "The ID of the service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"duration_minutes\":1,\"price\":39,\"currency\":\"gzm\",\"is_default\":false,\"is_active\":true}" }, "description": "Creates a pricing and duration option for a tenant-owned service." }, "response": [] }, { "name": "Update Service Duration", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/services/:service_id/durations/:duration_id", "query": [], "raw": "{{baseUrl}}/api/tenant/services/:service_id/durations/:duration_id", "variable": [ { "id": "service_id", "key": "service_id", "value": "16", "description": "The ID of the service." }, { "id": "duration_id", "key": "duration_id", "value": "16", "description": "The ID of the duration." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"duration_minutes\":1,\"price\":39,\"currency\":\"gzm\",\"is_default\":true,\"is_active\":true}" }, "description": "Updates a pricing and duration option for a tenant-owned service." }, "response": [] }, { "name": "Delete Service Duration", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/services/:service_id/durations/:duration_id", "query": [], "raw": "{{baseUrl}}/api/tenant/services/:service_id/durations/:duration_id", "variable": [ { "id": "service_id", "key": "service_id", "value": "16", "description": "The ID of the service." }, { "id": "duration_id", "key": "duration_id", "value": "16", "description": "The ID of the duration." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Deactivates a pricing and duration option." }, "response": [] } ] }, { "name": "Availability", "description": "", "item": [ { "name": "List Availability", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/availability", "query": [], "raw": "{{baseUrl}}/api/tenant/availability" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Lists weekly recurring availability windows for the authenticated tenant." }, "response": [] }, { "name": "Create Availability", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/availability", "query": [], "raw": "{{baseUrl}}/api/tenant/availability" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"day_of_week\":1,\"start_time\":\"11:23\",\"end_time\":\"2052-06-26\",\"timezone\":\"Asia\\/Ulaanbaatar\",\"is_active\":false}" }, "description": "Creates a weekly recurring availability window for a tenant, service, or location." }, "response": [] }, { "name": "Update Availability", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/availability/:id", "query": [], "raw": "{{baseUrl}}/api/tenant/availability/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the availability." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"day_of_week\":1,\"start_time\":\"11:23\",\"end_time\":\"2052-06-26\",\"timezone\":\"Asia\\/Ulaanbaatar\",\"is_active\":true}" }, "description": "Updates a weekly recurring availability window." }, "response": [] }, { "name": "Delete Availability", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/availability/:id", "query": [], "raw": "{{baseUrl}}/api/tenant/availability/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the availability." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Deactivates a weekly recurring availability window." }, "response": [] } ] }, { "name": "Availability Exceptions", "description": "", "item": [ { "name": "List Availability Exceptions", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/availability-exceptions", "query": [], "raw": "{{baseUrl}}/api/tenant/availability-exceptions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Lists blocked dates or one-off availability exceptions for the authenticated tenant." }, "response": [] }, { "name": "Create Availability Exception", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/availability-exceptions", "query": [], "raw": "{{baseUrl}}/api/tenant/availability-exceptions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"specific_date\":\"2026-06-03T11:23:05\",\"start_time\":\"11:23\",\"end_time\":\"2052-06-26\",\"reason\":\"n\",\"full_day\":false}" }, "description": "Creates a full-day or partial-day blocked date for a tenant, service, or location." }, "response": [] }, { "name": "Update Availability Exception", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/availability-exceptions/:id", "query": [], "raw": "{{baseUrl}}/api/tenant/availability-exceptions/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the availability exception." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"specific_date\":\"2026-06-03T11:23:05\",\"start_time\":\"11:23\",\"end_time\":\"2052-06-26\",\"reason\":\"n\",\"full_day\":false}" }, "description": "Updates a blocked date or availability exception." }, "response": [] }, { "name": "Delete Availability Exception", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/availability-exceptions/:id", "query": [], "raw": "{{baseUrl}}/api/tenant/availability-exceptions/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the availability exception." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Deletes a blocked date or availability exception." }, "response": [] } ] }, { "name": "Booking Policies", "description": "", "item": [ { "name": "Get Booking Policies", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/booking-policies", "query": [], "raw": "{{baseUrl}}/api/tenant/booking-policies" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns booking rule configuration for the authenticated tenant." }, "response": [] }, { "name": "Update Booking Policies", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/booking-policies", "query": [], "raw": "{{baseUrl}}/api/tenant/booking-policies" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"timezone\":\"Asia\\/Yekaterinburg\",\"min_advance_notice_minutes\":39,\"max_advance_booking_days\":7,\"buffer_before_minutes\":12,\"buffer_after_minutes\":77,\"cancellation_cutoff_hours\":8,\"reschedule_cutoff_hours\":76,\"slot_interval_minutes\":14,\"default_booking_status\":\"pending\",\"allow_cancellation\":false,\"allow_reschedule\":false}" }, "description": "Updates booking rule configuration such as advance notice, buffers, cancellation, and reschedule settings." }, "response": [] } ] }, { "name": "Licenses & Certifications", "description": "", "item": [ { "name": "List Licenses", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/licenses", "query": [], "raw": "{{baseUrl}}/api/tenant/licenses" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Lists tenant licenses, certifications, and prescribing eligibility metadata." }, "response": [] }, { "name": "Create License", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/licenses", "query": [], "raw": "{{baseUrl}}/api/tenant/licenses" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "professional", "type": "text", "description": "License or certification type. Must not be greater than 100 characters." }, { "key": "title", "value": "Veterinary Practice License", "type": "text", "description": "Display title for the license or certification. Must not be greater than 255 characters." }, { "key": "license_number", "value": "VET-2026-001", "type": "text", "description": "Optional license or certificate number. Must not be greater than 255 characters." }, { "key": "issuing_authority", "value": "b", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "issue_date", "value": "2026-06-03T11:23:05", "type": "text", "description": "Must be a valid date." }, { "key": "expiry_date", "value": "2052-06-26", "type": "text", "description": "Must be a valid date. Must be a date after or equal to issue_date." }, { "key": "can_prescribe", "value": "", "type": "text", "description": "" }, { "key": "notes", "value": "architecto", "type": "text", "description": "" }, { "key": "is_active", "value": "", "type": "text", "description": "" }, { "key": "verification_status", "value": "pending", "type": "text", "description": "Internal verification status." }, { "key": "file", "src": [], "type": "file" } ] }, "description": "Creates a tenant license or certification record. Send multipart/form-data\nwith file to upload a PDF or image document to the configured filesystem disk." }, "response": [] }, { "name": "Update License", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/licenses/:id", "query": [], "raw": "{{baseUrl}}/api/tenant/licenses/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the license." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "professional", "type": "text", "description": "License or certification type. Must not be greater than 100 characters." }, { "key": "title", "value": "Veterinary Practice License", "type": "text", "description": "Display title for the license or certification. Must not be greater than 255 characters." }, { "key": "license_number", "value": "VET-2026-001", "type": "text", "description": "Optional license or certificate number. Must not be greater than 255 characters." }, { "key": "issuing_authority", "value": "b", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "issue_date", "value": "2026-06-03T11:23:05", "type": "text", "description": "Must be a valid date." }, { "key": "expiry_date", "value": "2052-06-26", "type": "text", "description": "Must be a valid date. Must be a date after or equal to issue_date." }, { "key": "can_prescribe", "value": "1", "type": "text", "description": "" }, { "key": "notes", "value": "architecto", "type": "text", "description": "" }, { "key": "is_active", "value": "", "type": "text", "description": "" }, { "key": "verification_status", "value": "pending", "type": "text", "description": "Internal verification status." }, { "key": "file", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "Updates a tenant license or certification record. Send multipart/form-data\nwith file to replace the stored document." }, "response": [] }, { "name": "Delete License", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/licenses/:id", "query": [], "raw": "{{baseUrl}}/api/tenant/licenses/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the license." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Deactivates a tenant license or certification record." }, "response": [] }, { "name": "Update License", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/licenses/:license_id", "query": [], "raw": "{{baseUrl}}/api/tenant/licenses/:license_id", "variable": [ { "id": "license_id", "key": "license_id", "value": "16", "description": "The ID of the license." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "professional", "type": "text", "description": "License or certification type. Must not be greater than 100 characters." }, { "key": "title", "value": "Veterinary Practice License", "type": "text", "description": "Display title for the license or certification. Must not be greater than 255 characters." }, { "key": "license_number", "value": "VET-2026-001", "type": "text", "description": "Optional license or certificate number. Must not be greater than 255 characters." }, { "key": "issuing_authority", "value": "b", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "issue_date", "value": "2026-06-03T11:23:05", "type": "text", "description": "Must be a valid date." }, { "key": "expiry_date", "value": "2052-06-26", "type": "text", "description": "Must be a valid date. Must be a date after or equal to issue_date." }, { "key": "can_prescribe", "value": "1", "type": "text", "description": "" }, { "key": "notes", "value": "architecto", "type": "text", "description": "" }, { "key": "is_active", "value": "1", "type": "text", "description": "" }, { "key": "verification_status", "value": "pending", "type": "text", "description": "Internal verification status." }, { "key": "file", "src": [], "type": "file" } ] }, "description": "Updates a tenant license or certification record. Send multipart/form-data\nwith file to replace the stored document." }, "response": [] } ] }, { "name": "Payment Configuration", "description": "", "item": [ { "name": "Get Payment Configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/payment-config", "query": [], "raw": "{{baseUrl}}/api/tenant/payment-config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns tenant payment provider configuration and connection status." }, "response": [] }, { "name": "Update Payment Configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/payment-config", "query": [], "raw": "{{baseUrl}}/api/tenant/payment-config" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"provider\":\"b\",\"mode\":\"live\",\"connected_account_id\":\"n\",\"publishable_key\":\"g\",\"secret_key\":\"architecto\",\"webhook_secret\":\"architecto\",\"charges_enabled\":false,\"payouts_enabled\":true,\"details_submitted\":true,\"onboarding_completed_at\":\"2026-06-03T11:23:05\",\"status\":\"not_connected\"}" }, "description": "Updates payment provider configuration. Secrets are encrypted at rest and omitted from responses." }, "response": [] }, { "name": "Start Stripe Connect Onboarding", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/payment-config/stripe/connect", "query": [], "raw": "{{baseUrl}}/api/tenant/payment-config/stripe/connect" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"return_url\":\"https:\\/\\/owner.vetllama.test\\/settings\\/payments\\/return\",\"refresh_url\":\"https:\\/\\/owner.vetllama.test\\/settings\\/payments\\/refresh\",\"country\":\"US\"}" }, "description": "Creates or reuses a Stripe connected account and returns an onboarding URL." }, "response": [] }, { "name": "Get Stripe Connection Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/payment-config/stripe/status", "query": [], "raw": "{{baseUrl}}/api/tenant/payment-config/stripe/status" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns the locally stored Stripe connection status for this tenant." }, "response": [] }, { "name": "Refresh Stripe Connection Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/payment-config/stripe/refresh", "query": [], "raw": "{{baseUrl}}/api/tenant/payment-config/stripe/refresh" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Pulls the latest connected-account status from Stripe and stores it locally." }, "response": [] }, { "name": "Disconnect Stripe", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/payment-config/stripe/disconnect", "query": [], "raw": "{{baseUrl}}/api/tenant/payment-config/stripe/disconnect" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Clears the local Stripe connected-account state. This does not delete the Stripe account." }, "response": [] } ] }, { "name": "Onboarding Progress", "description": "", "item": [ { "name": "Get Onboarding Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/onboarding/status", "query": [], "raw": "{{baseUrl}}/api/tenant/onboarding/status" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns step-by-step onboarding completion status for the authenticated tenant." }, "response": [] }, { "name": "Get Publish Readiness", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/onboarding/publish-readiness", "query": [], "raw": "{{baseUrl}}/api/tenant/onboarding/publish-readiness" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns whether the authenticated tenant has completed the required setup to publish." }, "response": [] } ] }, { "name": "Publish Workflow", "description": "", "item": [ { "name": "Get Publish Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/publish/status", "query": [], "raw": "{{baseUrl}}/api/tenant/publish/status" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns current tenant publication state and publish readiness details." }, "response": [] }, { "name": "Publish Tenant", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/publish", "query": [], "raw": "{{baseUrl}}/api/tenant/publish" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Publishes the tenant website if all readiness requirements are satisfied." }, "response": [] }, { "name": "Unpublish Tenant", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/unpublish", "query": [], "raw": "{{baseUrl}}/api/tenant/unpublish" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Removes the tenant website from public published status without deleting configuration." }, "response": [] }, { "name": "Pause Tenant", "request": { "url": { "host": "{{baseUrl}}", "path": "api/tenant/pause", "query": [], "raw": "{{baseUrl}}/api/tenant/pause" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Pauses public tenant availability while keeping setup data intact." }, "response": [] } ] } ] } ] }, { "name": "User", "description": "", "item": [ { "name": "Auth", "description": "", "item": [ { "name": "Request Magic Link", "request": { "url": { "host": "{{baseUrl}}", "path": "api/user/auth/magic-link/request", "query": [], "raw": "{{baseUrl}}/api/user/auth/magic-link/request" }, "method": "POST", "header": [ { "key": "Host", "value": "demo.vetllama.test" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"jane@example.com\"}" }, "description": "Requests a one-time magic sign-in link for an existing EndUser under the resolved tenant. This endpoint never creates users and always returns a generic success response so email existence is not exposed.\n\nUse `Host: demo.vetllama.test` in local development when testing against seeded tenant data.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"If an account exists for that email, a sign-in link has been sent.\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Tenant could not be resolved for this host.\"\n}", "name": "" }, { "header": [], "code": 429, "body": "{\n \"message\": \"Too Many Attempts.\"\n}", "name": "" } ] }, { "name": "Verify Magic Link", "request": { "url": { "host": "{{baseUrl}}", "path": "api/user/auth/magic-link/verify", "query": [], "raw": "{{baseUrl}}/api/user/auth/magic-link/verify" }, "method": "POST", "header": [ { "key": "Host", "value": "demo.vetllama.test" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"jane@example.com\",\"token\":\"2dc9LW5MsHGpJmw9v72Uw0HppFWlNqHNrHuKxnjIuRtb2UZ2DFbpURkiN0Lr7qkg\",\"device_token\":\"web-user-device\"}" }, "description": "Consumes a valid, single-use, tenant-bound magic-link token and returns an EndUser-scoped JWT. Tokens are stored hashed, expire after 15 minutes, and cannot be reused.\n\nUse `Host: demo.vetllama.test` in local development when testing against seeded tenant data.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Logged in successfully.\",\n \"data\": {\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...\",\n \"token_type\": \"bearer\",\n \"guard\": \"end_user\",\n \"expires_in\": 3600,\n \"user\": {\n \"id\": 1,\n \"tenant_id\": 1,\n \"name\": \"Jane Customer\",\n \"email\": \"jane@example.com\",\n \"phone\": null,\n \"is_active\": true\n }\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"token\": [\"This magic link is invalid or has expired.\"]\n }\n}", "name": "" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api/user/auth/logout", "query": [], "raw": "{{baseUrl}}/api/user/auth/logout" }, "method": "POST", "header": [ { "key": "Host", "value": "demo.vetllama.test" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Invalidates the current EndUser JWT and closes the latest open auth activity session. Tenant host resolution is still required." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Logged out successfully.\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Unauthorized for this tenant.\"\n}", "name": "" } ] }, { "name": "Refresh Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api/user/auth/refresh", "query": [], "raw": "{{baseUrl}}/api/user/auth/refresh" }, "method": "POST", "header": [ { "key": "Host", "value": "demo.vetllama.test" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Exchanges a valid EndUser JWT for a fresh EndUser JWT. The token must belong to the tenant resolved from the Host header." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Token refreshed successfully.\",\n \"data\": {\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...\",\n \"token_type\": \"bearer\",\n \"guard\": \"end_user\",\n \"expires_in\": 3600,\n \"user\": {\n \"id\": 1,\n \"tenant_id\": 1,\n \"email\": \"jane@example.com\"\n }\n }\n}", "name": "" } ] }, { "name": "Current Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api/user/auth/me", "query": [], "raw": "{{baseUrl}}/api/user/auth/me" }, "method": "GET", "header": [ { "key": "Host", "value": "demo.vetllama.test" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": null, "description": "Returns the authenticated EndUser profile. The token must belong to the tenant resolved from the Host header." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Profile fetched successfully.\",\n \"data\": {\n \"id\": 1,\n \"tenant_id\": 1,\n \"name\": \"Jane Customer\",\n \"email\": \"jane@example.com\",\n \"phone\": null,\n \"is_active\": true\n }\n}", "name": "" } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }