{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.schedulingkit.com" } ], "info": { "name": "SchedulingKit API Documentation", "_postman_id": "cce1c0a2-16dc-48d7-8168-1519b6a80dc2", "description": "RESTful API for managing bookings, event types, clients, invoices, and more.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Authentication", "description": "", "item": [ { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/login", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"user@example.com\",\"password\":\"password123\",\"device_name\":\"My App\"}" }, "description": "Authenticate with email and password to receive an API token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"token\": \"1|abc123...\",\n \"user\": {\n \"id\": 1,\n \"name\": \"Jane Smith\",\n \"email\": \"user@example.com\",\n \"phone\": \"+1234567890\",\n \"timezone\": \"America\/New_York\",\n \"current_team\": {\n \"id\": 1,\n \"name\": \"My Business\",\n \"slug\": \"my-business\"\n }\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"email\": [\"These credentials do not match our records.\"]\n }\n}", "name": "" } ] }, { "name": "Get authenticated user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the currently authenticated user's profile and team info." }, "response": [ { "header": [], "code": 200, "body": "{\n \"user\": {\n \"id\": 1,\n \"name\": \"Jane Smith\",\n \"email\": \"user@example.com\",\n \"phone\": \"+1234567890\",\n \"timezone\": \"America\/New_York\",\n \"current_team\": {\n \"id\": 1,\n \"name\": \"My Business\",\n \"slug\": \"my-business\"\n }\n }\n}", "name": "" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoke the current API token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Logged out successfully.\"\n}", "name": "" } ] } ] }, { "name": "Team", "description": "", "item": [ { "name": "Get current team details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/team", "query": [], "raw": "{{baseUrl}}\/api\/v1\/team" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve your current team including members, owner, and settings." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"name\": \"My Business\",\n \"slug\": \"my-business\",\n \"owner\": {\n \"id\": 1,\n \"name\": \"Jane Smith\",\n \"email\": \"jane@example.com\"\n },\n \"users\": []\n }\n}", "name": "" } ] }, { "name": "Update team details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/team", "query": [], "raw": "{{baseUrl}}\/api\/v1\/team" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"My Business\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Team updated successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"My Business\",\n \"slug\": \"my-business\"\n }\n}", "name": "" } ] } ] }, { "name": "Event Types", "description": "", "item": [ { "name": "List team's event types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/event-types", "query": [], "raw": "{{baseUrl}}\/api\/v1\/event-types" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"30-min Consultation\",\n \"slug\": \"30-min-consultation\",\n \"duration\": 30,\n \"color\": \"#3B82F6\",\n \"is_active\": true,\n \"requires_payment\": false\n }\n ]\n}", "name": "" } ] }, { "name": "Get a single event type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/event-types\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/event-types\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the event type." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"name\": \"30-min Consultation\",\n \"slug\": \"30-min-consultation\",\n \"duration\": 30,\n \"color\": \"#3B82F6\",\n \"is_active\": true,\n \"location_type\": \"zoom\",\n \"requires_payment\": false,\n \"price\": 0,\n \"increment_minutes\": 15\n }\n}", "name": "" } ] }, { "name": "Create a new event type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/event-types", "query": [], "raw": "{{baseUrl}}\/api\/v1\/event-types" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"30-min Consultation\",\"duration\":30,\"color\":\"#3B82F6\",\"location_type\":\"zoom\",\"increment_minutes\":15,\"requires_payment\":false,\"price\":50,\"currency\":\"USD\",\"is_active\":true,\"description\":\"A quick consultation to discuss your needs\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Event type created successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"30-min Consultation\",\n \"duration\": 30\n }\n}", "name": "" } ] }, { "name": "Update an event type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/event-types\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/event-types\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the event type." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"30-min Consultation\",\"duration\":30,\"color\":\"#3B82F6\",\"location_type\":\"zoom\",\"increment_minutes\":15,\"requires_payment\":false,\"price\":50,\"is_active\":true,\"description\":\"A quick consultation to discuss your needs\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Event type updated successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"30-min Consultation\",\n \"duration\": 30\n }\n}", "name": "" } ] }, { "name": "Delete an event type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/event-types\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/event-types\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the event type." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Event type deleted successfully.\"\n}", "name": "" } ] } ] }, { "name": "Events", "description": "", "item": [ { "name": "List all events", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/events", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of items per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/events?page=1&per_page=50" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a paginated list of all events (bookings) for your team." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"event_type_id\": 5,\n \"customer_id\": 10,\n \"date\": \"2026-02-15\",\n \"start_time\": \"2026-02-15T14:00:00Z\",\n \"end_time\": \"2026-02-15T15:00:00Z\",\n \"status\": \"scheduled\",\n \"invitee_name\": \"John Doe\",\n \"invitee_email\": \"john@example.com\",\n \"event_type\": {\n \"id\": 5,\n \"name\": \"Consultation\",\n \"duration\": 60\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"total\": 150,\n \"per_page\": 50\n }\n}", "name": "" } ] }, { "name": "Get a single event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/events\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/events\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the event." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve detailed information about a specific event including related data like customer, location, extras, and recurring occurrences." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"event_type_id\": 5,\n \"customer_id\": 10,\n \"date\": \"2026-02-15\",\n \"start_time\": \"2026-02-15T14:00:00Z\",\n \"end_time\": \"2026-02-15T15:00:00Z\",\n \"status\": \"scheduled\",\n \"invitee_name\": \"John Doe\",\n \"invitee_email\": \"john@example.com\",\n \"invitee_phone\": \"+1234567890\",\n \"notes\": \"Please bring ID\",\n \"is_recurring\": true,\n \"recurrence_frequency\": \"weekly\",\n \"event_type\": {\n \"id\": 5,\n \"name\": \"Consultation\",\n \"duration\": 60\n },\n \"customer\": {\n \"id\": 10,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n },\n \"location\": {\n \"id\": 2,\n \"name\": \"Main Office\"\n },\n \"extras\": [],\n \"occurrences\": []\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Event not found\"\n}", "name": "" } ] }, { "name": "Create a new event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/events", "query": [], "raw": "{{baseUrl}}\/api\/v1\/events" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"event_type_id\":5,\"start_time\":\"2026-02-15T14:00:00Z\",\"end_time\":\"2026-02-15T15:00:00Z\",\"invitee_name\":\"John Doe\",\"invitee_email\":\"john@example.com\",\"invitee_phone\":\"+1234567890\",\"notes\":\"Please bring ID\",\"invitee_timezone\":\"America\\\/New_York\",\"location_id\":2,\"staff_id\":3,\"meeting_type\":\"zoom\",\"extras\":[1,2],\"coupon_code\":\"SAVE20\",\"answers\":{\"1\":\"Answer to question 1\"},\"is_recurring\":true,\"recurrence_frequency\":\"weekly\",\"recurrence_days\":[1,3,5],\"recurrence_count\":10,\"recurrence_end_date\":\"2026-06-15\",\"recurring_payment_mode\":\"first_only\",\"payment_provider\":\"stripe\",\"payment_token\":\"tok_visa\"}" }, "description": "Create a new booking\/event. Supports both one-time and recurring events. If the event type requires payment, include payment details." }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Booking scheduled successfully\",\n \"data\": {\n \"id\": 1,\n \"event_type_id\": 5,\n \"start_time\": \"2026-02-15T14:00:00Z\",\n \"end_time\": \"2026-02-15T15:00:00Z\",\n \"status\": \"scheduled\",\n \"invitee_name\": \"John Doe\",\n \"invitee_email\": \"john@example.com\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Validation error\",\n \"errors\": {\n \"invitee_email\": [\"The invitee email field is required.\"]\n }\n}", "name": "" } ] }, { "name": "Update an event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/events\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/events\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the event." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Cancel an event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/events\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/events\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the event." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Schedule conflict\"}" }, "description": "Cancel a scheduled event. This will update the status to cancelled and send notifications." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Event cancelled successfully\",\n \"data\": {\n \"id\": 1,\n \"status\": \"cancelled\",\n \"cancellation_reason\": \"Schedule conflict\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Event not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Event is already cancelled\"\n}", "name": "" } ] }, { "name": "Get recurring event occurrences", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/events\/:id\/occurrences", "query": [], "raw": "{{baseUrl}}\/api\/v1\/events\/:id\/occurrences", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the event." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve all occurrences in a recurring event series. Only works for parent events in a recurring series." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 2,\n \"date\": \"2026-02-15\",\n \"start_time\": \"2026-02-15T14:00:00Z\",\n \"end_time\": \"2026-02-15T15:00:00Z\",\n \"status\": \"scheduled\"\n },\n {\n \"id\": 3,\n \"date\": \"2026-02-22\",\n \"start_time\": \"2026-02-22T14:00:00Z\",\n \"end_time\": \"2026-02-22T15:00:00Z\",\n \"status\": \"scheduled\"\n }\n ],\n \"meta\": {\n \"total_count\": 10,\n \"frequency\": \"weekly\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"This event is not a recurring series parent\"\n}", "name": "" } ] } ] }, { "name": "Clients", "description": "", "item": [ { "name": "List team's clients", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/clients?page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a paginated list of all clients for your team." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"+1234567890\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"total\": 25,\n \"per_page\": 50\n }\n}", "name": "" } ] }, { "name": "Get a single client", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the client." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"+1234567890\",\n \"notes\": \"VIP customer\"\n }\n}", "name": "" } ] }, { "name": "Create a new client", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"John Doe\",\"email\":\"john@example.com\",\"phone\":\"+1234567890\",\"notes\":\"VIP customer\",\"is_active\":true}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Client created successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"+1234567890\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Error\",\n \"errors\": {\n \"email\": [\"The email has already been taken.\"]\n }\n}", "name": "" } ] }, { "name": "Update a client", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the client." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"John Doe\",\"email\":\"john@example.com\",\"phone\":\"+1234567890\",\"notes\":\"VIP customer\",\"is_active\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Client updated successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n }\n}", "name": "" } ] }, { "name": "Delete a client", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the client." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Client deleted successfully.\"\n}", "name": "" } ] } ] }, { "name": "Locations", "description": "", "item": [ { "name": "List team's locations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/locations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Main Office\",\n \"address\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"is_active\": true\n }\n ]\n}", "name": "" } ] }, { "name": "Get a single location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/locations\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the location." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"name\": \"Main Office\",\n \"address\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"phone\": \"+1234567890\",\n \"is_active\": true\n }\n}", "name": "" } ] }, { "name": "Create a new location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/locations" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Main Office\",\"address\":\"123 Main St\",\"city\":\"New York\",\"state\":\"NY\",\"zip\":\"10001\",\"country\":\"US\",\"phone\":\"+1234567890\",\"is_active\":true}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Location created successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Main Office\",\n \"address\": \"123 Main St\",\n \"city\": \"New York\"\n }\n}", "name": "" } ] }, { "name": "Update a location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/locations\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "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\":\"Main Office\",\"address\":\"123 Main St\",\"city\":\"New York\",\"state\":\"NY\",\"zip\":\"10001\",\"country\":\"US\",\"phone\":\"+1234567890\",\"is_active\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Location updated successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Main Office\",\n \"address\": \"123 Main St\"\n }\n}", "name": "" } ] }, { "name": "Delete a location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/locations\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the location." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Location deleted successfully.\"\n}", "name": "" } ] } ] }, { "name": "Workflows", "description": "", "item": [ { "name": "List team's workflows", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workflows", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workflows" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Follow-up Email\",\n \"trigger_type\": \"after_event\",\n \"is_active\": true\n }\n ]\n}", "name": "" } ] }, { "name": "Get a single workflow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workflows\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workflows\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the workflow." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"name\": \"Follow-up Email\",\n \"trigger_type\": \"after_event\",\n \"trigger_time\": 60,\n \"is_active\": true,\n \"actions\": []\n }\n}", "name": "" } ] }, { "name": "Create a new workflow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workflows", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workflows" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Follow-up Email\",\"event_type_id\":5,\"trigger_type\":\"after_event\",\"trigger_time\":60,\"is_active\":true,\"actions\":[\"architecto\"]}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Workflow created successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Follow-up Email\",\n \"trigger_type\": \"after_event\"\n }\n}", "name": "" } ] }, { "name": "Update a workflow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workflows\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workflows\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the workflow." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Follow-up Email\",\"event_type_id\":5,\"trigger_type\":\"after_event\",\"trigger_time\":60,\"is_active\":true,\"actions\":[\"architecto\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Workflow updated successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Follow-up Email\",\n \"trigger_type\": \"after_event\"\n }\n}", "name": "" } ] }, { "name": "Delete a workflow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workflows\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workflows\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the workflow." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Workflow deleted successfully.\"\n}", "name": "" } ] } ] }, { "name": "Finance", "description": "", "item": [ { "name": "List team's invoices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/invoices?page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a paginated list of all invoices for your team." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"invoice_number\": \"INV-0001\",\n \"customer_name\": \"John Doe\",\n \"customer_email\": \"john@example.com\",\n \"total\": 150.00,\n \"status\": \"paid\",\n \"invoice_date\": \"2026-03-01\",\n \"due_date\": \"2026-03-15\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"total\": 25,\n \"per_page\": 50\n }\n}", "name": "" } ] }, { "name": "Get a single invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the invoice." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"invoice_number\": \"INV-0001\",\n \"customer_name\": \"John Doe\",\n \"customer_email\": \"john@example.com\",\n \"total\": 150.00,\n \"status\": \"paid\",\n \"invoice_date\": \"2026-03-01\",\n \"due_date\": \"2026-03-15\",\n \"items\": []\n }\n}", "name": "" } ] }, { "name": "Create a new invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"customer_name\":\"John Doe\",\"customer_email\":\"john@example.com\",\"invoice_date\":\"2026-03-01\",\"due_date\":\"2026-03-15\",\"currency\":\"USD\",\"items\":[\"architecto\"],\"tax_rate\":8.5,\"discount_amount\":0,\"notes\":\"Thank you for your business\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Invoice created successfully.\",\n \"data\": {\n \"id\": 1,\n \"invoice_number\": \"INV-0001\",\n \"total\": 150.00,\n \"status\": \"draft\"\n }\n}", "name": "" } ] }, { "name": "Update an invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the invoice." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"customer_name\":\"John Doe\",\"customer_email\":\"john@example.com\",\"due_date\":\"2026-03-15\",\"items\":[\"architecto\"],\"tax_rate\":15,\"discount_amount\":76,\"notes\":\"Thank you for your business\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Invoice updated successfully.\",\n \"data\": {\n \"id\": 1,\n \"invoice_number\": \"INV-0001\",\n \"total\": 150.00\n }\n}", "name": "" } ] }, { "name": "Delete an invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the invoice." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Invoice deleted successfully.\"\n}", "name": "" } ] }, { "name": "List team's transactions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false }, { "key": "status", "value": "completed", "description": "Filter by status (completed, pending, failed, refunded).", "disabled": false }, { "key": "type", "value": "payment", "description": "Filter by type.", "disabled": false }, { "key": "provider", "value": "stripe", "description": "Filter by payment provider (stripe, paypal).", "disabled": false }, { "key": "date_from", "value": "2026-01-01", "description": "Filter from date (YYYY-MM-DD).", "disabled": false }, { "key": "date_to", "value": "2026-03-31", "description": "Filter to date (YYYY-MM-DD).", "disabled": false }, { "key": "search", "value": "john", "description": "Search by customer name or email.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/transactions?page=1&status=completed&type=payment&provider=stripe&date_from=2026-01-01&date_to=2026-03-31&search=john" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a paginated list of all payment transactions for your team." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"amount\": 150.00,\n \"currency\": \"USD\",\n \"status\": \"completed\",\n \"provider\": \"stripe\",\n \"created_at\": \"2026-03-01T12:00:00Z\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"total\": 50,\n \"per_page\": 50\n }\n}", "name": "" } ] }, { "name": "Get a single transaction", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the transaction." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"amount\": 150.00,\n \"currency\": \"USD\",\n \"status\": \"completed\",\n \"provider\": \"stripe\",\n \"provider_transaction_id\": \"pi_abc123\",\n \"created_at\": \"2026-03-01T12:00:00Z\"\n }\n}", "name": "" } ] }, { "name": "List team's taxes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/taxes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/taxes" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Sales Tax\",\n \"rate\": 8.5,\n \"is_active\": true\n }\n ]\n}", "name": "" } ] }, { "name": "Get a single tax", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/taxes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/taxes\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the tax." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"name\": \"Sales Tax\",\n \"rate\": 8.5,\n \"is_active\": true\n }\n}", "name": "" } ] }, { "name": "Create a new tax", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/taxes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/taxes" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Sales Tax\",\"rate\":8.5,\"is_active\":true}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Tax created successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Sales Tax\",\n \"rate\": 8.5,\n \"is_active\": true\n }\n}", "name": "" } ] }, { "name": "Update a tax", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/taxes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/taxes\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the tax." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Sales Tax\",\"rate\":8.5,\"is_active\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Tax updated successfully.\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Sales Tax\",\n \"rate\": 8.5,\n \"is_active\": true\n }\n}", "name": "" } ] }, { "name": "Delete a tax", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/taxes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/taxes\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the tax." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Tax deleted successfully.\"\n}", "name": "" } ] } ] }, { "name": "Other", "description": "", "item": [ { "name": "Register a device push token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/device-token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/device-token" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"b\",\"platform\":\"fcm\",\"device_name\":\"n\"}" }, "description": "Stores or updates the Expo push token for the authenticated user.\nIf the token already exists for another user, it will be reassigned." }, "response": [] }, { "name": "Remove a device push token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/device-token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/device-token" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"architecto\"}" }, "description": "Deactivates the push token (used on logout)." }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }