{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/your-instance.bluerocktel.net" } ], "info": { "name": "BlueRockTEL Platform API", "_postman_id": "fed14604-39b0-4815-9bf9-a3879ffcc3a9", "description": "REST API for the BlueRockTEL BSS (Business Support System) platform. Manage customers, establishments, contacts, catalog items, quotes, invoices, payment plans, tickets, phone calls, PBX hosts, training, users and platform utilities. Generated from the published API reference at https:\/\/bluerocktel.com\/api-documentation.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Authentication", "description": "Authenticate with the BlueRockTEL API using Laravel Passport bearer tokens. Learn how to obtain and use API tokens.", "item": [ { "name": "Authenticate with email and password.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/login", "query": [], "raw": "{{baseUrl}}\/api\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"string\",\"password\":\"string\"}" }, "description": "Authenticate with email and password. Returns an API bearer token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"token\": \"...\",\n \"user\": { \"id\": 1, \"name\": \"...\", \"email\": \"...\", ... },\n \"teams\": [...],\n \"support_teams\": [...]\n}", "name": "" }, { "header": [], "code": 401, "body": "{}", "name": "Invalid credentials." } ] }, { "name": "Internal BlueRockTEL login via pre-existing API token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/brtel-login\/:token", "query": [], "raw": "{{baseUrl}}\/api\/brtel-login\/:token", "variable": [ { "id": "token", "key": "token", "value": "string", "description": "The user's `api_token` field value" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Internal BlueRockTEL login via pre-existing API token. Only available from whitelisted IP addresses.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{ \"token\": \"...\" }", "name": "" }, { "header": [], "code": 403, "body": "{}", "name": "IP not whitelisted." }, { "header": [], "code": 404, "body": "{}", "name": "Token not found." } ] }, { "name": "Get the currently authenticated user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user", "query": [], "raw": "{{baseUrl}}\/api\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the currently authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "User object." } ] } ] }, { "name": "Bank Details and GoCardless Mandates", "description": "Manage customer bank details and GoCardless direct debit mandates for automated payment collection.", "item": [ { "name": "Bank Details", "description": "", "item": [ { "name": "List bank details for a specific fileable entity.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/bank-details", "query": [], "raw": "{{baseUrl}}\/api\/v1\/bank-details" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List bank details for a specific fileable entity." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Bank detail object for the fileable (or `null` if none)." }, { "header": [], "code": 404, "body": "{}", "name": "Fileable entity not found." } ] }, { "name": "Create a new bank detail record.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/bank-details", "query": [ { "key": "fileable_type", "value": "string", "description": "PHP class name", "disabled": false }, { "key": "fileable_id", "value": "1", "description": "ID of the owning entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/bank-details?fileable_type=string&fileable_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"dt_of_sgntr\":\"string\",\"mandate_identification\":\"string\"}" }, "description": "Create a new bank detail record." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created (or updated) bank detail object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." }, { "header": [], "code": 500, "body": "{}", "name": "Server error." } ] }, { "name": "Get a single bank detail by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/bank-details\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/bank-details\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Bank detail ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single bank detail by ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Bank detail object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a bank detail record.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/bank-details\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/bank-details\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Bank detail ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a bank detail record." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated bank detail object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." }, { "header": [], "code": 422, "body": "{}", "name": "Error." }, { "header": [], "code": 500, "body": "{}", "name": "Error." } ] }, { "name": "Delete a bank detail record.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/bank-details\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/bank-details\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Bank detail ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a bank detail record." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "`{ \"message\": \"element deleted\" }`" }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "GoCardless Mandates", "description": "", "item": [ { "name": "List GoCardless mandates for a customer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/go-cardless-mandates", "query": [ { "key": "customer_id", "value": "1", "description": "Customer ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/go-cardless-mandates?customer_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List GoCardless mandates for a customer." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of mandate objects." }, { "header": [], "code": 404, "body": "{}", "name": "Customer not found." } ] }, { "name": "Create a new GoCardless mandate for a customer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/go-cardless-mandates", "query": [ { "key": "customer_id", "value": "1", "description": "Customer ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/go-cardless-mandates?customer_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new GoCardless mandate for a customer." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created mandate object." }, { "header": [], "code": 404, "body": "{}", "name": "Customer not found." }, { "header": [], "code": 422, "body": "{}", "name": "Error." }, { "header": [], "code": 500, "body": "{}", "name": "Error." } ] }, { "name": "Get a single GoCardless mandate by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/go-cardless-mandates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/go-cardless-mandates\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Mandate ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single GoCardless mandate by ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Mandate object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a GoCardless mandate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/go-cardless-mandates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/go-cardless-mandates\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Mandate ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a GoCardless mandate." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated mandate object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete a GoCardless mandate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/go-cardless-mandates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/go-cardless-mandates\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a GoCardless mandate." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] } ] }, { "name": "Catalog", "description": "Manage your product and service catalog including items, families, subfamilies, and bundles through the BlueRockTEL API.", "item": [ { "name": "Items", "description": "", "item": [ { "name": "List items with filtering, sorting, and pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/items", "query": [ { "key": "filter[description]", "value": "string", "description": "Filter by description", "disabled": false }, { "key": "filter[brand]", "value": "string", "description": "Filter by brand", "disabled": false }, { "key": "filter[id]", "value": "1", "description": "Filter by exact ID", "disabled": false }, { "key": "filter[family_id]", "value": "1", "description": "Filter by family", "disabled": false }, { "key": "filter[subfamily_id]", "value": "1", "description": "Filter by subfamily", "disabled": false }, { "key": "filter[internal_reference]", "value": "string", "description": "Filter by internal reference", "disabled": false }, { "key": "filter[active_for_initial_billing]", "value": "1", "description": "Filter items active for initial billing", "disabled": false }, { "key": "sort", "value": "string", "description": "Sort field", "disabled": false }, { "key": "include", "value": "string", "description": "Relations to include", "disabled": false }, { "key": "per_page", "value": "1", "description": "Items per page (default 10)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/items?filter%5Bdescription%5D=string&filter%5Bbrand%5D=string&filter%5Bid%5D=1&filter%5Bfamily_id%5D=1&filter%5Bsubfamily_id%5D=1&filter%5Binternal_reference%5D=string&filter%5Bactive_for_initial_billing%5D=1&sort=string&include=string&per_page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List items with filtering, sorting, and pagination. Non-admin\/tech users see only active catalog items." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of item objects with `family`, `subfamily`, `tax` relations and counts." } ] }, { "name": "Create a new catalog item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/items", "query": [], "raw": "{{baseUrl}}\/api\/v1\/items" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new catalog item. Requires `create` permission on `Item`." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created item object." }, { "header": [], "code": 403, "body": "{}", "name": "Insufficient permissions." }, { "header": [], "code": 422, "body": "{}", "name": "Error." }, { "header": [], "code": 500, "body": "{}", "name": "Error." } ] }, { "name": "Get a single item with `family`, `subfamily`, `tax` relations.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Item ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single item with `family`, `subfamily`, `tax` relations. The response also embeds the item's `selling_prices` and `supplier_prices`." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 42,\n \"description\": \"Fibre 1Gbps\",\n \"selling_price_without_tax\": \"49.99\",\n \"selling_prices\": [\n { \"id\": 1, \"item_id\": 42, \"currency\": \"EUR\", \"selling_price\": \"49.99\" }\n ],\n \"supplier_prices\": [\n { \"id\": 1, \"item_id\": 42, \"supplier_id\": 7, \"currency\": \"EUR\", \"buying_price\": \"29.99\", \"supplier_ref\": null, \"is_default\": true }\n ]\n}", "name": "Item object, e.g.:" }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a catalog item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Item ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a catalog item." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated item object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete a catalog item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a catalog item. Fails if the item is used in any customer file initials, recurrings, or licences." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." }, { "header": [], "code": 422, "body": "{}", "name": "Item is in use." } ] }, { "name": "Find an item by its internal reference code.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/items\/internal_reference\/:internal_reference", "query": [], "raw": "{{baseUrl}}\/api\/v1\/items\/internal_reference\/:internal_reference", "variable": [ { "id": "internal_reference", "key": "internal_reference", "value": "string", "description": "Internal reference string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Find an item by its internal reference code." }, "response": [ { "header": [], "code": 200, "body": "{ \"item_id\": 42 }", "name": "" }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Item Selling Prices", "description": "", "item": [ { "name": "List item selling prices with filtering, sorting, and pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/item-selling-prices", "query": [ { "key": "filter[item_id]", "value": "1", "description": "Filter by item", "disabled": false }, { "key": "filter[currency]", "value": "string", "description": "Filter by currency", "disabled": false }, { "key": "sort", "value": "string", "description": "Sort field", "disabled": false }, { "key": "include", "value": "string", "description": "Relations to include (`item`)", "disabled": false }, { "key": "per_page", "value": "1", "description": "Items per page (default 10)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/item-selling-prices?filter%5Bitem_id%5D=1&filter%5Bcurrency%5D=string&sort=string&include=string&per_page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List item selling prices with filtering, sorting, and pagination." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of item selling price objects." } ] }, { "name": "Create (or update, if the `item_id`\/`currency` pair already exists) a selling price for an item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/item-selling-prices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/item-selling-prices" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create (or update, if the `item_id`\/`currency` pair already exists) a selling price for an item." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created (or updated) item selling price object." }, { "header": [], "code": 422, "body": "{}", "name": "Error." }, { "header": [], "code": 500, "body": "{}", "name": "Error." } ] }, { "name": "Get a single item selling price.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/item-selling-prices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/item-selling-prices\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Item selling price ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single item selling price." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Item selling price object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update an item selling price.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/item-selling-prices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/item-selling-prices\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update an item selling price." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated item selling price object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete an item selling price.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/item-selling-prices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/item-selling-prices\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an item selling price." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Item Supplier Prices", "description": "", "item": [ { "name": "List item supplier prices with filtering, sorting, and pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/item-supplier-prices", "query": [ { "key": "filter[item_id]", "value": "1", "description": "Filter by item", "disabled": false }, { "key": "filter[supplier_id]", "value": "1", "description": "Filter by supplier", "disabled": false }, { "key": "filter[currency]", "value": "string", "description": "Filter by currency", "disabled": false }, { "key": "sort", "value": "string", "description": "Sort field", "disabled": false }, { "key": "include", "value": "string", "description": "Relations to include (`item`, `supplier`)", "disabled": false }, { "key": "per_page", "value": "1", "description": "Items per page (default 10)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/item-supplier-prices?filter%5Bitem_id%5D=1&filter%5Bsupplier_id%5D=1&filter%5Bcurrency%5D=string&sort=string&include=string&per_page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List item supplier prices with filtering, sorting, and pagination." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of item supplier price objects." } ] }, { "name": "Create (or update, if the `item_id`\/`supplier_id`\/`currency` triple already exists) a supplier price for an item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/item-supplier-prices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/item-supplier-prices" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create (or update, if the `item_id`\/`supplier_id`\/`currency` triple already exists) a supplier price for an item. A supplier ID must first be obtained via `GET \/v1\/suppliers` \u2014 suppliers are read-only via the API. Setting `is_default: true` automatically unsets `is_default` on every other supplier price for the same item; only one supplier price per item can be default." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created (or updated) item supplier price object." }, { "header": [], "code": 422, "body": "{}", "name": "Error." }, { "header": [], "code": 500, "body": "{}", "name": "Error." } ] }, { "name": "Get a single item supplier price.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/item-supplier-prices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/item-supplier-prices\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Item supplier price ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single item supplier price." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Item supplier price object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update an item supplier price.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/item-supplier-prices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/item-supplier-prices\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update an item supplier price. Setting `is_default: true` automatically unsets `is_default` on every other supplier price for the same item." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated item supplier price object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete an item supplier price.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/item-supplier-prices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/item-supplier-prices\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an item supplier price." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Bundles", "description": "", "item": [ { "name": "List all bundles with item counts (initial, licence, recurring).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/bundles", "query": [ { "key": "filter[name]", "value": "string", "description": "Filter by name", "disabled": false }, { "key": "filter[id]", "value": "1", "description": "Filter by exact ID", "disabled": false }, { "key": "sort", "value": "string", "description": "Sort field", "disabled": false }, { "key": "include", "value": "string", "description": "Relations (`items_initial`, `items_licence`, `items_recurring`)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/bundles?filter%5Bname%5D=string&filter%5Bid%5D=1&sort=string&include=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all bundles with item counts (initial, licence, recurring)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of bundle objects with item counts." } ] }, { "name": "Create a new bundle.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/bundles", "query": [], "raw": "{{baseUrl}}\/api\/v1\/bundles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new bundle. `user_id` is auto-set to authenticated user. Requires `create` permission on `Item`." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created bundle object." } ] }, { "name": "Get a single bundle with calculated price sums for each item type (initial, licence, recurring).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/bundles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/bundles\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Bundle ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single bundle with calculated price sums for each item type (initial, licence, recurring)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Bundle object with price summaries." } ] }, { "name": "Update a bundle.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/bundles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/bundles\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a bundle." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated bundle object." } ] }, { "name": "Delete a bundle.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/bundles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/bundles\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a bundle." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." } ] } ] }, { "name": "Suppliers", "description": "", "item": [ { "name": "List all suppliers.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/suppliers", "query": [], "raw": "{{baseUrl}}\/api\/v1\/suppliers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all suppliers. Read-only via API." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of supplier objects." } ] } ] } ] }, { "name": "Communication", "description": "Mass email newsletters, campaigns, and customer satisfaction surveys with branching logic and reply tracking.", "item": [ { "name": "Newsletters", "description": "", "item": [ { "name": "List all newsletters.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletters", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletters" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all newsletters." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of newsletter objects." } ] }, { "name": "Create a new newsletter.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletters", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletters" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new newsletter." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created newsletter object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Show a single newsletter.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletters\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletters\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a single newsletter." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Newsletter object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a newsletter.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletters\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletters\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a newsletter." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Updated newsletter object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Delete a newsletter.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletters\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletters\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a newsletter." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Send a test email for the newsletter to the authenticated user and record the send.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletters\/:id\/test", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletters\/:id\/test", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Send a test email for the newsletter to the authenticated user and record the send." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Success." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Newsletter Lists", "description": "", "item": [ { "name": "List all newsletter lists with their contacts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletter-lists", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletter-lists" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all newsletter lists with their contacts." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of list objects with `contacts` (including related data)." } ] }, { "name": "Create a newsletter list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletter-lists", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletter-lists" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a newsletter list." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created list object." } ] }, { "name": "Show a newsletter list with contacts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletter-lists\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletter-lists\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a newsletter list with contacts." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "List object with contacts." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a newsletter list and sync its contacts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletter-lists\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletter-lists\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a newsletter list and sync its contacts." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Updated list object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete a newsletter list.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletter-lists\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletter-lists\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a newsletter list." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Newsletter Campaigns", "description": "", "item": [ { "name": "List all campaigns.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletter-campaigns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletter-campaigns" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all campaigns." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of campaign objects." } ] }, { "name": "Create a campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletter-campaigns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletter-campaigns" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a campaign." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created campaign object." } ] }, { "name": "Show a campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletter-campaigns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletter-campaigns\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a campaign." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Campaign object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletter-campaigns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletter-campaigns\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a campaign." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Updated campaign object." } ] }, { "name": "Delete a campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/newsletter-campaigns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/newsletter-campaigns\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a campaign." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success." } ] } ] }, { "name": "Surveys", "description": "", "item": [ { "name": "List all surveys (lightweight resource).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/surveys", "query": [], "raw": "{{baseUrl}}\/api\/v1\/surveys" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all surveys (lightweight resource)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of survey objects (light format, without nested branches)." } ] }, { "name": "Create a survey.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/surveys", "query": [], "raw": "{{baseUrl}}\/api\/v1\/surveys" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subject\":\"string\",\"active\":true}" }, "description": "Create a survey. A default main branch is automatically created." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created survey object." } ] }, { "name": "Show a survey with branches.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/surveys\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/surveys\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a survey with branches." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Survey object with branches." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a survey.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/surveys\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/surveys\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a survey." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Updated survey object." } ] }, { "name": "Delete a survey.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/surveys\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/surveys\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a survey." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success." } ] } ] }, { "name": "Survey Branches", "description": "", "item": [ { "name": "List branches, optionally filtered by survey.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/survey-branches", "query": [ { "key": "survey_id", "value": "1", "description": "Filter by survey ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/survey-branches?survey_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List branches, optionally filtered by survey." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of branch objects with groups." } ] } ] }, { "name": "Survey Questions", "description": "", "item": [ { "name": "Get the list of available question types.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/survey-questions\/types", "query": [], "raw": "{{baseUrl}}\/api\/v1\/survey-questions\/types" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the list of available question types." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of question type strings." } ] }, { "name": "List questions, optionally filtered by `group_id`.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/survey-questions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/survey-questions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List questions, optionally filtered by `group_id`." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of question objects." } ] }, { "name": "Create a question.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/survey-questions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/survey-questions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"string\",\"label\":\"string\",\"group_id\":1}" }, "description": "Create a question. Validates the `type` against allowed question types." }, "response": [] } ] }, { "name": "Survey Reply Requests", "description": "", "item": [ { "name": "List reply requests with QueryBuilder filtering and sorting.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/survey-reply-requests", "query": [ { "key": "filter[score]", "value": "string", "description": "Filter by NPS score", "disabled": false }, { "key": "filter[replied]", "value": "1", "description": "Filter by whether the contact has replied", "disabled": false }, { "key": "filter[tries]", "value": "1", "description": "Filter by number of send attempts", "disabled": false }, { "key": "filter[created_at_from]", "value": "string", "description": "Filter records created after this date", "disabled": false }, { "key": "filter[created_at_to]", "value": "string", "description": "Filter records created before this date", "disabled": false }, { "key": "filter[updated_at_from]", "value": "string", "description": "Filter records updated after this date", "disabled": false }, { "key": "filter[updated_at_to]", "value": "string", "description": "Filter records updated before this date", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/survey-reply-requests?filter%5Bscore%5D=string&filter%5Breplied%5D=1&filter%5Btries%5D=1&filter%5Bcreated_at_from%5D=string&filter%5Bcreated_at_to%5D=string&filter%5Bupdated_at_from%5D=string&filter%5Bupdated_at_to%5D=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List reply requests with QueryBuilder filtering and sorting." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of reply request objects with polymorphic surveyable relationships (Contact, CustomerFile, Ticket)." } ] }, { "name": "List unique customers who have associated survey reply requests.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/survey-reply-requests\/customers", "query": [], "raw": "{{baseUrl}}\/api\/v1\/survey-reply-requests\/customers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List unique customers who have associated survey reply requests." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of customer objects." } ] }, { "name": "Export survey reply requests to an Excel file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/survey-reply-requests\/export", "query": [], "raw": "{{baseUrl}}\/api\/v1\/survey-reply-requests\/export" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Export survey reply requests to an Excel file." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Excel file download." } ] }, { "name": "Show a single reply request.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/survey-reply-requests\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/survey-reply-requests\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a single reply request." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Reply request object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] } ] }, { "name": "Contacts", "description": "Create and manage polymorphic contacts belonging to customers or prospects, with phone number lookup for call center integrations.", "item": [ { "name": "List contacts for a specific entity (customer or prospect).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts", "query": [ { "key": "contactable_type", "value": "string", "description": "PHP class name (e.g. `App\\Customer`, `App\\Prospect`)", "disabled": false }, { "key": "contactable_id", "value": "1", "description": "ID of the owning entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/contacts?contactable_type=string&contactable_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List contacts for a specific entity (customer or prospect). Results are ordered by `last_name`, `first_name`." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of contact objects." } ] }, { "name": "Create a new contact for an entity.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts", "query": [ { "key": "contactable_type", "value": "string", "description": "PHP class name", "disabled": false }, { "key": "contactable_id", "value": "1", "description": "ID of the owning entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/contacts?contactable_type=string&contactable_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new contact for an entity. Sets `sync_needed = true` and triggers reindexing of the contactable." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created contact object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Get a single contact with company info, `customer_account`, client permissions, and contactable metadata.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Contact ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single contact with company info, `customer_account`, client permissions, and contactable metadata." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Contact object with permissions." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Contact ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a contact. If a client account is linked, permissions are synced. Triggers contactable reindexing." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated contact object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Delete a contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Contact ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a contact." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Find a contact by phone number.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/numbers", "query": [ { "key": "phone_number", "value": "string", "description": "Phone number to search", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/contacts\/numbers?phone_number=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Find a contact by phone number. Used by 3CX call flow integrations." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": { ...contact object... }\n}", "name": "" }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Find all accounts (customers or prospects) sharing the same email address as this contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:id\/accounts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:id\/accounts", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Contact ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Find all accounts (customers or prospects) sharing the same email address as this contact." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of account objects." } ] }, { "name": "Get all contacts at the same organization as the given contact (same company\/domain).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:id\/coworkers", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:id\/coworkers", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Contact ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get all contacts at the same organization as the given contact (same company\/domain)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of contact objects." } ] } ] }, { "name": "Customer Files", "description": "Manage sales and billing dossiers with initial charges, recurring subscriptions, and licence line items.", "item": [ { "name": "Customer File (Main)", "description": "", "item": [ { "name": "List all files for a given fileable entity (customer or prospect).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files", "query": [ { "key": "fileable_type", "value": "string", "description": "`prospect` or `customer`", "disabled": false }, { "key": "fileable_id", "value": "1", "description": "ID of the owning entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/customer-files?fileable_type=string&fileable_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all files for a given fileable entity (customer or prospect)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of customer file objects." } ] }, { "name": "Create a new customer file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files", "query": [ { "key": "fileable_type", "value": "string", "description": "`prospect` or `customer`", "disabled": false }, { "key": "fileable_id", "value": "1", "description": "ID of the owning entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/customer-files?fileable_type=string&fileable_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new customer file. Auto-sets `fileable_type`, `fileable_id`, and `user_id`. Optionally syncs `contact_ids`." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created file object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Get a single customer file with all relations: `fileable`, `licences`, `initial`, `recurring`, `telephony lines`, `assig", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Customer file ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single customer file with all relations: `fileable`, `licences`, `initial`, `recurring`, `telephony lines`, `assigned users`, `contacts`." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Customer file with full relations." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a customer file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Customer file ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a customer file. Syncs `contact_ids` if provided. Sets `user_id` to current user." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated file object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Delete a customer file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Customer file ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a customer file." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Get all phone line resources for a customer file (from recurring items and telephony lines).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/:id\/resources", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/:id\/resources", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Customer file ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get all phone line resources for a customer file (from recurring items and telephony lines)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of phone line objects." } ] }, { "name": "Find a customer file by phone number.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/fileables\/number\/:number", "query": [], "raw": "{{baseUrl}}\/api\/v1\/fileables\/number\/:number", "variable": [ { "id": "number", "key": "number", "value": "string", "description": "Phone number" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Find a customer file by phone number." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Customer file object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Customer File Initials", "description": "", "item": [ { "name": "List initial items with filtering, sorting, and pagination (Spatie QueryBuilder).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/initials", "query": [ { "key": "filter[label]", "value": "string", "description": "Filter by label", "disabled": false }, { "key": "filter[id]", "value": "1", "description": "Filter by ID", "disabled": false }, { "key": "filter[customer_file_id]", "value": "1", "description": "Filter by customer file", "disabled": false }, { "key": "filter[item_id]", "value": "1", "description": "Filter by catalog item", "disabled": false }, { "key": "filter[invoice_id]", "value": "1", "description": "Filter by invoice", "disabled": false }, { "key": "filter[line_key]", "value": "string", "description": "Filter by line key", "disabled": false }, { "key": "filter[paused]", "value": "1", "description": "Filter paused items", "disabled": false }, { "key": "filter[quantity]", "value": "string", "description": "Quantity range filter", "disabled": false }, { "key": "filter[invoiced]", "value": "1", "description": "Invoiced scope", "disabled": false }, { "key": "sort", "value": "string", "description": "Field (`id`, `created_at`, `updated_at`, `quantity`, `buying_price_without_tax`, `selling_price_without_tax`)", "disabled": false }, { "key": "include", "value": "string", "description": "Comma-separated relations (`invoice`, `file`, `item`)", "disabled": false }, { "key": "per_page", "value": "1", "description": "Items per page (default 20)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/initials?filter%5Blabel%5D=string&filter%5Bid%5D=1&filter%5Bcustomer_file_id%5D=1&filter%5Bitem_id%5D=1&filter%5Binvoice_id%5D=1&filter%5Bline_key%5D=string&filter%5Bpaused%5D=1&filter%5Bquantity%5D=string&filter%5Binvoiced%5D=1&sort=string&include=string&per_page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List initial items with filtering, sorting, and pagination (Spatie QueryBuilder)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of initial items." } ] }, { "name": "Create a new initial line item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/initials", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/initials" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new initial line item." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created item." }, { "header": [], "code": 422, "body": "{}", "name": "Validation\/DB error." }, { "header": [], "code": 500, "body": "{}", "name": "Server error." } ] }, { "name": "Get a single initial item with relations (`file`, `invoice`, `item`).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/initials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/initials\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single initial item with relations (`file`, `invoice`, `item`)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Initial item object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update an initial line item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/initials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/initials\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update an initial line item." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated item." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete an initial line item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/initials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/initials\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an initial line item." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Customer File Recurrings", "description": "", "item": [ { "name": "List recurring items with filtering, sorting, and pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/recurrings", "query": [ { "key": "filter[label]", "value": "string", "description": "Filter by label", "disabled": false }, { "key": "filter[id]", "value": "1", "description": "Filter by ID", "disabled": false }, { "key": "filter[customer_file_id]", "value": "1", "description": "Filter by customer file", "disabled": false }, { "key": "filter[item_id]", "value": "1", "description": "Filter by catalog item", "disabled": false }, { "key": "filter[line_key]", "value": "string", "description": "Filter by line key", "disabled": false }, { "key": "filter[paused]", "value": "1", "description": "Filter paused items", "disabled": false }, { "key": "filter[active]", "value": "1", "description": "Filter active items", "disabled": false }, { "key": "filter[delivered]", "value": "1", "description": "Filter delivered items", "disabled": false }, { "key": "filter[billing_frequency]", "value": "string", "description": "Filter by billing frequency", "disabled": false }, { "key": "filter[quantity]", "value": "string", "description": "Quantity range filter", "disabled": false }, { "key": "sort", "value": "string", "description": "Field (`id`, `created_at`, `updated_at`, `quantity`, `buying_price_without_tax`, `selling_price_without_tax`)", "disabled": false }, { "key": "include", "value": "string", "description": "Relations (`file`, `item`, `sales`)", "disabled": false }, { "key": "per_page", "value": "1", "description": "Items per page (default 20)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/recurrings?filter%5Blabel%5D=string&filter%5Bid%5D=1&filter%5Bcustomer_file_id%5D=1&filter%5Bitem_id%5D=1&filter%5Bline_key%5D=string&filter%5Bpaused%5D=1&filter%5Bactive%5D=1&filter%5Bdelivered%5D=1&filter%5Bbilling_frequency%5D=string&filter%5Bquantity%5D=string&sort=string&include=string&per_page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List recurring items with filtering, sorting, and pagination." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of recurring items (includes sales count)." } ] }, { "name": "Create a new recurring line item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/recurrings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/recurrings" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new recurring line item." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created item." }, { "header": [], "code": 422, "body": "{}", "name": "Error." }, { "header": [], "code": 500, "body": "{}", "name": "Error." } ] }, { "name": "Get a single recurring item with relations (`file`, `item`, `sales`).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/recurrings\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/recurrings\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single recurring item with relations (`file`, `item`, `sales`)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Recurring item object." } ] }, { "name": "Update a recurring line item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/recurrings\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/recurrings\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a recurring line item." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated item." } ] }, { "name": "Delete a recurring line item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/recurrings\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/recurrings\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a recurring line item." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." } ] } ] }, { "name": "Customer File Licences", "description": "", "item": [ { "name": "List licence items with filtering, sorting, and pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/licences", "query": [ { "key": "filter[label]", "value": "string", "description": "Filter by label", "disabled": false }, { "key": "filter[item.description]", "value": "string", "description": "Filter by item description", "disabled": false }, { "key": "filter[id]", "value": "1", "description": "Filter by ID", "disabled": false }, { "key": "filter[item.id]", "value": "1", "description": "Filter by item ID", "disabled": false }, { "key": "filter[customer_file_id]", "value": "1", "description": "Filter by customer file", "disabled": false }, { "key": "filter[item_id]", "value": "1", "description": "Filter by catalog item", "disabled": false }, { "key": "filter[line_key]", "value": "string", "description": "Filter by line key", "disabled": false }, { "key": "filter[active]", "value": "1", "description": "Filter active licences", "disabled": false }, { "key": "filter[frequency]", "value": "string", "description": "Filter by frequency", "disabled": false }, { "key": "filter[quantity]", "value": "string", "description": "Quantity range filter", "disabled": false }, { "key": "sort", "value": "string", "description": "Field (`id`, `created_at`, `updated_at`, `quantity`, `buying_price_without_tax`, `selling_price_without_tax`)", "disabled": false }, { "key": "include", "value": "string", "description": "Relations (`invoice`, `file`, `item`, `sales`, `renewals`)", "disabled": false }, { "key": "per_page", "value": "1", "description": "Items per page (default 20)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/licences?filter%5Blabel%5D=string&filter%5Bitem.description%5D=string&filter%5Bid%5D=1&filter%5Bitem.id%5D=1&filter%5Bcustomer_file_id%5D=1&filter%5Bitem_id%5D=1&filter%5Bline_key%5D=string&filter%5Bactive%5D=1&filter%5Bfrequency%5D=string&filter%5Bquantity%5D=string&sort=string&include=string&per_page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List licence items with filtering, sorting, and pagination." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of licence items." } ] }, { "name": "Create a new licence line item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/licences", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/licences" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new licence line item." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created item." } ] }, { "name": "Get a single licence item with relations (`file`, `item`, `sales`).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/licences\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/licences\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single licence item with relations (`file`, `item`, `sales`)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Licence item object." } ] }, { "name": "Update a licence line item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/licences\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/licences\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a licence line item." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated item." } ] }, { "name": "Delete a licence line item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-files\/licences\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-files\/licences\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a licence line item." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." } ] } ] } ] }, { "name": "Customer Services", "description": "List available services, view customer assignments, and sync service sets for individual customers.", "item": [ { "name": "Customer Service Catalog", "description": "", "item": [ { "name": "List all customer services with filtering, sorting, and pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-services", "query": [ { "key": "filter[name]", "value": "string", "description": "Filter by name", "disabled": false }, { "key": "filter[key]", "value": "string", "description": "Filter by key", "disabled": false }, { "key": "sort", "value": "string", "description": "Sort field (`id`, `name`, `key`, `created_at`, `updated_at`)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/customer-services?filter%5Bname%5D=string&filter%5Bkey%5D=string&sort=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all customer services with filtering, sorting, and pagination." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list (10 per page) of customer service objects with the count of associated customers." } ] }, { "name": "Get a single customer service by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-services\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-services\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Customer service ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single customer service by ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Customer service object with associated customers (id, name, customer_account only)." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Customer-Specific Services", "description": "", "item": [ { "name": "List services assigned to a customer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customers\/:customer\/services", "query": [ { "key": "filter[name]", "value": "string", "description": "Filter by name", "disabled": false }, { "key": "filter[key]", "value": "string", "description": "Filter by key", "disabled": false }, { "key": "sort", "value": "string", "description": "Sort field (`id`, `name`, `key`, `created_at`, `updated_at`)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/customers\/:customer\/services?filter%5Bname%5D=string&filter%5Bkey%5D=string&sort=string", "variable": [ { "id": "customer", "key": "customer", "value": 1, "description": "Customer ID (route model binding)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List services assigned to a customer." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list (10 per page) of services assigned to the customer." } ] }, { "name": "Sync the full set of services for a customer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customers\/:customer\/services", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customers\/:customer\/services", "variable": [ { "id": "customer", "key": "customer", "value": 1, "description": "Customer ID (route model binding)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"services\":[\"string\"]}" }, "description": "Sync the full set of services for a customer. This replaces all existing service assignments." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Success message." } ] } ] } ] }, { "name": "Customers", "description": "Manage customer records, search by name or account number, and query consumption data via the BlueRockTEL API.", "item": [ { "name": "List all customers with pagination and sorting.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customers", "query": [ { "key": "nb", "value": "1", "description": "Items per page (default: varies)", "disabled": false }, { "key": "sort", "value": "string", "description": "Field to sort by", "disabled": false }, { "key": "direction", "value": "string", "description": "Sort direction (`asc` \/ `desc`)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/customers?nb=1&sort=string&direction=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all customers with pagination and sorting. Results are filtered based on the authenticated user's role." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of customer objects." } ] }, { "name": "Create a new customer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customers", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new customer. A `customer_account` is auto-generated (format: `CL` + zero-padded ID)." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created customer object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Get a single customer with related contacts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Customer ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single customer with related contacts." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Customer object with `contacts` relation." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a customer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Customer ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a customer. Resets the `quick_search_index` flag." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Updated customer object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Delete a customer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Customer ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a customer. Fails if the customer has invoices or customer files. Requires admin\/tech role." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 403, "body": "{}", "name": "Forbidden (insufficient role or ownership)." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Search customers by text query.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customers\/search", "query": [ { "key": "term", "value": "string", "description": "Search term", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/customers\/search?term=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search customers by text query. Returns up to 15 results." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of matching customer objects." } ] }, { "name": "Look up a customer by account number or phone number.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customers\/lookup", "query": [ { "key": "customer_account", "value": "string", "description": "Customer account number (e.g. `CL000123`)", "disabled": false }, { "key": "phone_number", "value": "string", "description": "Phone number", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/customers\/lookup?customer_account=string&phone_number=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Look up a customer by account number or phone number. Used by call center integrations." }, "response": [ { "header": [], "code": 200, "body": "{\n \"found\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"...\",\n \"customer_account\": \"CL000123\",\n \"vip\": false,\n \"on_call_duty\": false,\n \"setup_follow_up\": false,\n \"setup_follow_up_user\": null\n }\n}", "name": "" } ] }, { "name": "Get total consumption amount for a customer in a given billing month.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customers\/:id\/consumptions", "query": [ { "key": "month", "value": "string", "description": "Month in `YYYYMM` format", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/customers\/:id\/consumptions?month=string", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Customer ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get total consumption amount for a customer in a given billing month." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Total consumption amount (numeric)." } ] }, { "name": "Get the internal customer ID from a customer account string.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customers\/customer_accounts\/:customer_account", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customers\/customer_accounts\/:customer_account", "variable": [ { "id": "customer_account", "key": "customer_account", "value": "string", "description": "Account number (e.g. `CL000123`)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the internal customer ID from a customer account string." }, "response": [ { "header": [], "code": 200, "body": "{ \"customer_id\": 42 }", "name": "" } ] }, { "name": "Get the full customer object from a customer account string.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer_accounts\/:customer_account", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer_accounts\/:customer_account", "variable": [ { "id": "customer_account", "key": "customer_account", "value": "string", "description": "Account number (e.g. `CL000123`)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the full customer object from a customer account string." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Customer object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Documents", "description": "Upload, manage, and download polymorphic file attachments stored on OVH Swift object storage.", "item": [ { "name": "List all documents for a specific entity.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/documents", "query": [ { "key": "documentable_type", "value": "string", "description": "PHP class name of the entity (e.g. `App\\Customer`)", "disabled": false }, { "key": "documentable_id", "value": "1", "description": "ID of the owning entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/documents?documentable_type=string&documentable_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all documents for a specific entity." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of document metadata objects (`document_resource` collection)." } ] }, { "name": "Upload a new document and attach it to an entity.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/documents", "query": [ { "key": "documentable_type", "value": "string", "description": "PHP class name of the entity", "disabled": false }, { "key": "documentable_id", "value": "1", "description": "ID of the owning entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/documents?documentable_type=string&documentable_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "file_description", "value": "string", "type": "text", "description": "Description of the document" }, { "key": "tags[0]", "value": "string", "type": "text", "description": "" }, { "key": "shared", "value": "1", "type": "text", "description": "Whether document is shared" }, { "key": "user_id", "value": "1", "type": "text", "description": "Uploader user ID (defaults to authenticated user)" }, { "key": "file", "src": [], "type": "file" } ] }, "description": "Upload a new document and attach it to an entity. The file is stored on all configured disks (Swift storage)." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created document metadata object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Get a single document's metadata by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/documents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/documents\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Document ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single document's metadata by ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Document metadata (`document_resource`)." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Download the actual document file from Swift storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/documents\/:id\/content", "query": [], "raw": "{{baseUrl}}\/api\/v1\/documents\/:id\/content", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Document ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Download the actual document file from Swift storage." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "File content with correct `Content-Type` header." }, { "header": [], "code": 404, "body": "{}", "name": "File not found on storage." } ] }, { "name": "Update document metadata (description, shared status, tags).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/documents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/documents\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Document ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"file_description\":\"string\",\"shared\":true,\"tags\":[\"string\"]}" }, "description": "Update document metadata (description, shared status, tags). The file itself cannot be replaced." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated document metadata." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete a document record and remove the file from all storage disks.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/documents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/documents\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Document ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a document record and remove the file from all storage disks." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Establishments", "description": "Manage legal establishments (branches, subsidiaries) attached to a customer or prospect, each with its own registration number and address.", "item": [ { "name": "List all establishments for a given fileable entity.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/establishments", "query": [ { "key": "fileable_type", "value": "string", "description": "Short name of the owning entity: `customer` or `prospect`", "disabled": false }, { "key": "fileable_id", "value": "1", "description": "ID of the owning entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/establishments?fileable_type=string&fileable_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all establishments for a given fileable entity." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of establishment objects." } ] }, { "name": "Create a new establishment attached to a customer or prospect.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/establishments", "query": [ { "key": "fileable_type", "value": "string", "description": "Short name of the owning entity: `customer` or `prospect`", "disabled": false }, { "key": "fileable_id", "value": "1", "description": "ID of the owning entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/establishments?fileable_type=string&fileable_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"string\",\"registrationNumber\":\"string\",\"addressLine1\":\"string\",\"addressLine2\":\"string\",\"postalCode\":\"string\",\"city\":\"string\",\"country\":\"string\"}" }, "description": "Create a new establishment attached to a customer or prospect." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created establishment object." } ] }, { "name": "Get a single establishment by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/establishments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/establishments\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Establishment ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single establishment by ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Establishment object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update an establishment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/establishments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/establishments\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Establishment ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"string\",\"registrationNumber\":\"string\",\"addressLine1\":\"string\",\"addressLine2\":\"string\",\"postalCode\":\"string\",\"city\":\"string\",\"country\":\"string\"}" }, "description": "Update an establishment. Only address fields can be changed; `fileable_type` and `fileable_id` cannot be modified after creation." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated establishment object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete an establishment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/establishments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/establishments\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Establishment ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an establishment. Associated customer files that reference this establishment will have their `establishment_id` automatically set to `null` before deletion." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Hosts and Infrastructure", "description": "Manage server inventory with customer filtering, software assignments, network interfaces, and reference data for infrastructure management.", "item": [ { "name": "Hosts", "description": "", "item": [ { "name": "List hosts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts", "query": [ { "key": "filter[customer_id]", "value": "1", "description": "Filter by customer", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/hosts?filter%5Bcustomer_id%5D=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List hosts. Supports filtering by customer." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of host objects with relations: `customer`, `os`, `role`, `shell`, `type`, `infrastructure`." } ] }, { "name": "Create a new host.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hosts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new host." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created host object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Get a single host with all relations: `customer`, `datacenter`, `documents`, `softwares`, `interfaces`, `os`, `role`, `s", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hosts\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single host with all relations: `customer`, `datacenter`, `documents`, `softwares`, `interfaces`, `os`, `role`, `shell`, `supplier`, `type`, `sheets`, `tickets`." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Host object with full relations." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a host.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hosts\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a host. Date\/datetime fields are automatically converted." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated host object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete a host.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hosts\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a host." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Attach software(s) to a host (many-to-many, without detaching existing).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts\/:host\/soft_attach", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hosts\/:host\/soft_attach", "variable": [ { "id": "host", "key": "host", "value": 1, "description": "Host ID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"host_softwares\":[\"string\"]}" }, "description": "Attach software(s) to a host (many-to-many, without detaching existing)." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated host object." } ] }, { "name": "Detach specific software(s) from a host.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts\/:host\/soft_detach", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hosts\/:host\/soft_detach", "variable": [ { "id": "host", "key": "host", "value": 1, "description": "Host ID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"host_softwares\":[\"string\"]}" }, "description": "Detach specific software(s) from a host." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated host object." } ] } ] } ] }, { "name": "Incidents", "description": "Access public platform incident notices with status updates for real-time outage and degradation monitoring.", "item": [ { "name": "List all public, unresolved incidents.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incidents", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incidents" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all public, unresolved incidents." }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": 1,\n \"title\": \"...\",\n \"description\": \"...\",\n \"started_at\": \"2024-01-01T10:00:00Z\",\n \"resolved_at\": null,\n \"is_public\": true,\n \"scope\": { ... },\n \"severity\": { ... },\n \"state\": { ... }\n }\n]", "name": "Array of incident objects with `scope`, `severity`, and `state` relations." } ] }, { "name": "Get a single public incident by ID, including its updates.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incidents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incidents\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Incident ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single public incident by ID, including its updates." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Incident object with `scope`, `severity`, `state`, and `updates` relations." }, { "header": [], "code": 404, "body": "{}", "name": "Not found or not public." } ] } ] }, { "name": "Incoming Mails", "description": "Process incoming email messages, convert them to support tickets, and handle Mailgun webhook delivery events.", "item": [ { "name": "List incoming mails, with optional filtering.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incoming_mails", "query": [ { "key": "filter", "value": "string", "description": "Optional filter: `out_ticket` (mails without a ticket), `reply_to_closed_ticket` (replies to closed tickets)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/incoming_mails?filter=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List incoming mails, with optional filtering." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of incoming mail objects." } ] }, { "name": "Delete an incoming mail.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incoming_mails\/:incoming_mail", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incoming_mails\/:incoming_mail", "variable": [ { "id": "incoming_mail", "key": "incoming_mail", "value": 1, "description": "Incoming mail ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an incoming mail." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Convert an incoming mail into a new ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incoming_mails\/:incoming_mail\/ticket", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incoming_mails\/:incoming_mail\/ticket", "variable": [ { "id": "incoming_mail", "key": "incoming_mail", "value": 1, "description": "Incoming mail ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"customer_id\":1}" }, "description": "Convert an incoming mail into a new ticket." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created ticket object." }, { "header": [], "code": 400, "body": "{}", "name": "Validation error." }, { "header": [], "code": 404, "body": "{}", "name": "Mail or customer not found." } ] }, { "name": "Add an incoming mail as a reply to an existing ticket (determined by the mail's `ticket_id`).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incoming_mails\/:incoming_mail\/reply", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incoming_mails\/:incoming_mail\/reply", "variable": [ { "id": "incoming_mail", "key": "incoming_mail", "value": 1, "description": "Incoming mail ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Add an incoming mail as a reply to an existing ticket (determined by the mail's `ticket_id`)." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created reply (ticket) object." }, { "header": [], "code": 404, "body": "{}", "name": "Mail or ticket not found." } ] }, { "name": "Mail Report Webhook", "description": "", "item": [ { "name": "Receive a mail delivery report from external mail systems.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/mail-report", "query": [], "raw": "{{baseUrl}}\/api\/mail-report" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Receive a mail delivery report from external mail systems.", "auth": { "type": "noauth" } }, "response": [] } ] } ] }, { "name": "Information Collections", "description": "Manage onboarding forms for technical data collection including PBX configuration, with customer-facing token access.", "item": [ { "name": "List information collections, optionally filtered by status or customer file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/information-collections", "query": [ { "key": "status", "value": "string", "description": "Filter by status (e.g. `open`, `closed`)", "disabled": false }, { "key": "customer_file_id", "value": "1", "description": "Filter by customer file", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/information-collections?status=string&customer_file_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List information collections, optionally filtered by status or customer file." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of information collection objects." } ] }, { "name": "Create a new information collection for a customer file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/information-collections", "query": [ { "key": "customer_file_id", "value": "1", "description": "Customer file ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/information-collections?customer_file_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new information collection for a customer file. Only creates one if none already exists for that file." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Created information collection object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error or already exists." } ] }, { "name": "Get a single information collection by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/information-collections\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/information-collections\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Information collection ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single information collection by ID. Includes `customer_file` and `fileable` relations. Appends `front_url`." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Information collection object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update an information collection.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/information-collections\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/information-collections\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Information collection ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update an information collection." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." }, { "header": [], "code": 422, "body": "{}", "name": "Error." }, { "header": [], "code": 500, "body": "{}", "name": "Error." } ] }, { "name": "Delete an information collection.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/information-collections\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/information-collections\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Information collection ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an information collection." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "`{ \"message\": \"element deleted\" }`" } ] }, { "name": "Get the PBX configuration derived from an information collection.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/information-collections\/:id\/pbx-config", "query": [], "raw": "{{baseUrl}}\/api\/v1\/information-collections\/:id\/pbx-config", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Information collection ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the PBX configuration derived from an information collection. Returns the structured PBX config object." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "PBX configuration object (`pbx_configuration::fromInformationCollection()`)." } ] }, { "name": "Get available 3CX provider templates for use in information collection forms.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/information-collections\/providers-3cx", "query": [], "raw": "{{baseUrl}}\/api\/v1\/information-collections\/providers-3cx" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get available 3CX provider templates for use in information collection forms." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of 3CX provider template objects." } ] }, { "name": "Customer-Facing Token Endpoints", "description": "", "item": [ { "name": "Get an information collection by its public token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-information-collection\/:token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-information-collection\/:token", "variable": [ { "id": "token", "key": "token", "value": "string", "description": "Public access token" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get an information collection by its public token." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Information collection data." }, { "header": [], "code": 404, "body": "{}", "name": "Token not found." } ] }, { "name": "Update an information collection via public token (customer filling in the form).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-information-collection\/:token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-information-collection\/:token", "variable": [ { "id": "token", "key": "token", "value": "string", "description": "Public access token" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update an information collection via public token (customer filling in the form)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Updated information collection." } ] }, { "name": "Check if the information collection is valid and complete.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-information-collection\/:token\/validate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-information-collection\/:token\/validate", "variable": [ { "id": "token", "key": "token", "value": "string", "description": "token identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Check if the information collection is valid and complete." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Validation result." } ] }, { "name": "Close\/submit an information collection (mark as completed by customer).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-information-collection\/:token\/close", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-information-collection\/:token\/close", "variable": [ { "id": "token", "key": "token", "value": "string", "description": "token identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Close\/submit an information collection (mark as completed by customer)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Closed collection." } ] }, { "name": "Upload a file attachment to an information collection via public token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer-information-collection\/:token\/file", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer-information-collection\/:token\/file", "variable": [ { "id": "token", "key": "token", "value": "string", "description": "token identifier." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Upload a file attachment to an information collection via public token." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Stored file." } ] } ] } ] }, { "name": "Invoices", "description": "Access final, preprod, and proforma invoices. Download PDF content and publish proforma invoices through the API.", "item": [ { "name": "Invoices (Final)", "description": "", "item": [ { "name": "List invoices for a customer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices", "query": [ { "key": "customer_id", "value": "1", "description": "Filter by customer ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/invoices?customer_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List invoices for a customer." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of invoice objects (`invoice_light_resource` collection)." } ] }, { "name": "Get a single invoice with its `sales` relation.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Invoice ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single invoice with its `sales` relation." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Invoice object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Get the invoice PDF document.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices\/:id\/content", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices\/:id\/content", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Invoice ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the invoice PDF document." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "PDF file (`Content-Type: application\/pdf`)." }, { "header": [], "code": 404, "body": "{}", "name": "PDF not found." } ] } ] }, { "name": "Invoices Preprod", "description": "", "item": [ { "name": "List preprod invoices.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices-preprod", "query": [ { "key": "customer_id", "value": "1", "description": "Filter by customer ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/invoices-preprod?customer_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List preprod invoices. (Same interface as invoices.)" }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of preprod invoice objects." } ] }, { "name": "Get a single preprod invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices-preprod\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices-preprod\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single preprod invoice." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Preprod invoice object." } ] }, { "name": "Get the preprod invoice as a PDF (dynamically generated).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices-preprod\/:id\/content", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices-preprod\/:id\/content", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the preprod invoice as a PDF (dynamically generated)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "PDF file (`Content-Type: application\/pdf`)." } ] } ] }, { "name": "Proforma Invoices", "description": "", "item": [ { "name": "List proforma invoices for a customer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices-proforma", "query": [ { "key": "customer_id", "value": "1", "description": "Filter by customer ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/invoices-proforma?customer_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List proforma invoices for a customer." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of proforma invoice objects." } ] }, { "name": "Create a new proforma invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices-proforma", "query": [ { "key": "customer_id", "value": "1", "description": "Customer to create proforma for", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/invoices-proforma?customer_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new proforma invoice. Defaults: `total_without_tax: 0`, `tax: 0`, `total_with_tax: 0`, `credit: 0`, `net_to_pay: 0`, `automatic: false`, `date: now`." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created proforma invoice object." } ] }, { "name": "Get a single proforma invoice with its `sales` relation.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices-proforma\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices-proforma\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single proforma invoice with its `sales` relation." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Proforma invoice object." } ] }, { "name": "Get the proforma invoice as a PDF (dynamically generated).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices-proforma\/:id\/content", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices-proforma\/:id\/content", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the proforma invoice as a PDF (dynamically generated)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "PDF file (`Content-Type: application\/pdf`)." } ] }, { "name": "Delete a proforma invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices-proforma\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices-proforma\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a proforma invoice." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Publish a proforma invoice: converts it to a real invoice via the `publish_proforma_invoice` action.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices-proforma\/:id\/publish", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices-proforma\/:id\/publish", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Proforma invoice ID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"payment_term\":\"string\",\"credit\":\"string\",\"paymentMethod_id\":1,\"deposit_method\":\"string\"}" }, "description": "Publish a proforma invoice: converts it to a real invoice via the `publish_proforma_invoice` action." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Published invoice object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] } ] } ] }, { "name": "Notes", "description": "Attach polymorphic notes to any entity with automatic user attribution and timestamp management.", "item": [ { "name": "List all notes for a specific entity.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notes", "query": [ { "key": "noteable_type", "value": "string", "description": "PHP class name of the entity (e.g. `App\\Customer`)", "disabled": false }, { "key": "noteable_id", "value": "1", "description": "ID of the owning entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/notes?noteable_type=string¬eable_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all notes for a specific entity." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of note objects (`note_resource` collection)." } ] }, { "name": "Create a new note for an entity.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notes", "query": [ { "key": "noteable_type", "value": "string", "description": "PHP class name of the entity", "disabled": false }, { "key": "noteable_id", "value": "1", "description": "ID of the owning entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/notes?noteable_type=string¬eable_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"body\":\"string\"}" }, "description": "Create a new note for an entity." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created note object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Get a single note by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notes\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Note ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single note by ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Note object (`note_resource`)." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a note (body only; `id`, `created_at`, `updated_at` are excluded).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notes\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Note ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"body\":\"string\"}" }, "description": "Update a note (body only; `id`, `created_at`, `updated_at` are excluded)." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated note object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete a note.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notes\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Note ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a note." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Organisations and Brands", "description": "Retrieve and update top-level tenant organisations and manage brand settings including logos and invoice images.", "item": [ { "name": "Organisations", "description": "", "item": [ { "name": "List all organisations.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organisations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organisations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all organisations." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of organisation objects (`organisation_resource` collection, all records, no pagination)." } ] }, { "name": "Get a single organisation by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organisations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organisations\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Organisation ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single organisation by ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Organisation object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update an organisation.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organisations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organisations\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Organisation ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update an organisation. Only fields listed in `Organisation::updatable()` are updated." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated organisation object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." }, { "header": [], "code": 422, "body": "{}", "name": "Error." }, { "header": [], "code": 500, "body": "{}", "name": "Error." } ] } ] }, { "name": "Brands", "description": "", "item": [ { "name": "List all brands.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/brands", "query": [], "raw": "{{baseUrl}}\/api\/v1\/brands" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all brands." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of all brand objects." } ] }, { "name": "Get a single brand by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/brands\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/brands\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Brand ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single brand by ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Brand object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a brand.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/brands\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/brands\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Brand ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"logo\":\"string\",\"message_on_invoice\":\"string\"}" }, "description": "Update a brand. Handles image uploads: - `logo`: resized to max 500px width, stored on Swift and FTP disks. - `message_on_invoice`: resized to 2126x709px, stored on Swift and FTP disks." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated brand object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." }, { "header": [], "code": 422, "body": "{}", "name": "Error." }, { "header": [], "code": 500, "body": "{}", "name": "Error." } ] } ] } ] }, { "name": "PBX (3CX)", "description": "Manage 3CX phone system integrations including hosts, origins, call records, call logs, and audit trails.", "item": [ { "name": "3CX Hosts", "description": "", "item": [ { "name": "List all 3CX hosts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pbx3cx-hosts", "query": [ { "key": "customer_id", "value": "1", "description": "Filter by customer", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pbx3cx-hosts?customer_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all 3CX hosts." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of 3CX host objects." } ] }, { "name": "Look up a 3CX host by its hostname.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pbx3cx-hosts\/lookup", "query": [ { "key": "host_name", "value": "string", "description": "Hostname or FQDN of the 3CX instance (e.g. `acme.3cx.fr`)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pbx3cx-hosts\/lookup?host_name=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Look up a 3CX host by its hostname. Returns the host record with its associated customers. Use this to resolve a customer from a PBX alert when the monitoring system only knows the FQDN." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Host object with `customers` relation." }, { "header": [], "code": 400, "body": "{}", "name": "Missing `host_name`." }, { "header": [], "code": 404, "body": "{}", "name": "Host not found." } ] }, { "name": "List all 3CX hosts registered for a customer, identified by their account number.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pbx3cx-hosts\/lookup-by-customer", "query": [ { "key": "customer_account", "value": "string", "description": "Customer account code (e.g. `CL2385`)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pbx3cx-hosts\/lookup-by-customer?customer_account=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all 3CX hosts registered for a customer, identified by their account number." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "`{ \"data\": [ { host records } ] }`" }, { "header": [], "code": 400, "body": "{}", "name": "Missing `customer_account`." }, { "header": [], "code": 404, "body": "{}", "name": "Customer not found." } ] }, { "name": "Create a new 3CX host.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pbx3cx-hosts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pbx3cx-hosts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new 3CX host. A code is auto-generated." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created host object." } ] }, { "name": "Get a single 3CX host by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pbx3cx-hosts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pbx3cx-hosts\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single 3CX host by ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Host object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a 3CX host.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pbx3cx-hosts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pbx3cx-hosts\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a 3CX host." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated host object." } ] }, { "name": "Delete a 3CX host.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pbx3cx-hosts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pbx3cx-hosts\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a 3CX host." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Success message." } ] } ] }, { "name": "3CX Origins", "description": "", "item": [ { "name": "Get the available origins for a specific 3CX host.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pbx3cx\/:pbx3cx\/origins", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pbx3cx\/:pbx3cx\/origins", "variable": [ { "id": "pbx3cx", "key": "pbx3cx", "value": 1, "description": "3CX host ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the available origins for a specific 3CX host. Used for routing configuration." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of origin objects." } ] } ] }, { "name": "3CX Call Logs", "description": "", "item": [ { "name": "List all visible call log entries.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pbx3cx-call-logs", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pbx3cx-call-logs" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all visible call log entries." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of call log objects." } ] }, { "name": "Create a new call log entry.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pbx3cx-call-logs", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pbx3cx-call-logs" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new call log entry. Triggers a refresh of call log data." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created call log object." } ] }, { "name": "Get a single call log entry by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pbx3cx-call-logs\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pbx3cx-call-logs\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single call log entry by ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Call log object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "3CX Call Log Details", "description": "", "item": [ { "name": "Get detailed call log information for a specific call log ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pbx3cx-call-log-details\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pbx3cx-call-log-details\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Call log ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get detailed call log information for a specific call log ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Call log detail object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Helper: 3CX Countries", "description": "", "item": [ { "name": "Get the list of countries supported by 3CX (for PBX configuration).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/helpers\/3cxCountries", "query": [], "raw": "{{baseUrl}}\/api\/v1\/helpers\/3cxCountries" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the list of countries supported by 3CX (for PBX configuration).", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of country objects." } ] } ] }, { "name": "Helper: 3CX Open Destinations", "description": "", "item": [ { "name": "Get the list of open\/unrestricted destinations for 3CX routing.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/helpers\/3cxOpenDestinations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/helpers\/3cxOpenDestinations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the list of open\/unrestricted destinations for 3CX routing.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of destination objects." } ] } ] } ] }, { "name": "Payment Plans", "description": "Create and manage polymorphic payment plans with automatic IBAN mandate generation and audit history.", "item": [ { "name": "Get the payment plan for a fileable entity.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/fileable-payment-plan", "query": [ { "key": "fileable_type", "value": "string", "description": "PHP class name of the fileable entity", "disabled": false }, { "key": "fileable_id", "value": "1", "description": "ID of the fileable entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/fileable-payment-plan?fileable_type=string&fileable_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the payment plan for a fileable entity." }, "response": [ { "header": [], "code": 200, "body": "{\n \"payment_plan\": { ...payment plan object... }\n}", "name": "" } ] }, { "name": "Create or update the payment plan for a fileable entity.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/fileable-payment-plan", "query": [ { "key": "fileable_type", "value": "string", "description": "PHP class name of the fileable entity", "disabled": false }, { "key": "fileable_id", "value": "1", "description": "ID of the fileable entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/fileable-payment-plan?fileable_type=string&fileable_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"payment_method_id\":1,\"signature_date\":\"string\"}" }, "description": "Create or update the payment plan for a fileable entity. Note: this endpoint uses `POST` for both creation and update (not `PUT`)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"payment_plan\": { ...updated payment plan object... }\n}", "name": "" }, { "header": [], "code": 422, "body": "{}", "name": "Validation error (e.g. missing `payment_method_id` on creation)." } ] }, { "name": "Get the activity audit log (changelog) for a payment plan.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/fileable-payment-plan\/history", "query": [ { "key": "fileable_type", "value": "string", "description": "PHP class name of the fileable entity", "disabled": false }, { "key": "fileable_id", "value": "1", "description": "ID of the fileable entity", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/fileable-payment-plan\/history?fileable_type=string&fileable_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the activity audit log (changelog) for a payment plan." }, "response": [ { "header": [], "code": 200, "body": "{\n \"history\": [\n {\n \"id\": 1,\n \"event\": \"updated\",\n \"created_at\": \"2024-01-01T12:00:00Z\",\n \"causer\": { \"id\": 5, \"name\": \"...\" },\n \"properties\": { ... }\n }\n ]\n}", "name": "" } ] } ] }, { "name": "Phone Calls", "description": "Log and manage phone interactions with automatic note creation, ticket activity tracking, and call status management.", "item": [ { "name": "List phone calls with filtering, sorting, and pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/phone-calls", "query": [ { "key": "filter[id]", "value": "1", "description": "Filter by ID", "disabled": false }, { "key": "filter[user_id]", "value": "1", "description": "Filter by user", "disabled": false }, { "key": "filter[contact_id]", "value": "1", "description": "Filter by contact", "disabled": false }, { "key": "filter[status]", "value": "string", "description": "Filter by status", "disabled": false }, { "key": "filter[direction]", "value": "string", "description": "Filter by direction (`inbound` \/ `outbound`)", "disabled": false }, { "key": "filter[answered]", "value": "1", "description": "Filter answered calls", "disabled": false }, { "key": "filter[number_from]", "value": "string", "description": "Filter by origin number", "disabled": false }, { "key": "filter[number_to]", "value": "string", "description": "Filter by destination number", "disabled": false }, { "key": "filter[started_at]", "value": "string", "description": "Filter by start timestamp", "disabled": false }, { "key": "filter[ended_at]", "value": "string", "description": "Filter by end timestamp", "disabled": false }, { "key": "sort", "value": "string", "description": "Sort field", "disabled": false }, { "key": "per_page", "value": "1", "description": "Items per page (default 10)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/phone-calls?filter%5Bid%5D=1&filter%5Buser_id%5D=1&filter%5Bcontact_id%5D=1&filter%5Bstatus%5D=string&filter%5Bdirection%5D=string&filter%5Banswered%5D=1&filter%5Bnumber_from%5D=string&filter%5Bnumber_to%5D=string&filter%5Bstarted_at%5D=string&filter%5Bended_at%5D=string&sort=string&per_page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List phone calls with filtering, sorting, and pagination." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of phone call objects." } ] }, { "name": "Log a new phone call.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/phone-calls", "query": [], "raw": "{{baseUrl}}\/api\/v1\/phone-calls" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact_id\":1,\"customer_id\":1,\"ticket_id\":1,\"status\":\"string\",\"direction\":\"string\",\"answered\":true,\"number_from\":\"string\",\"number_to\":\"string\",\"started_at\":\"string\",\"ended_at\":\"string\"}" }, "description": "Log a new phone call. `user_id` is auto-assigned. Timestamps are parsed. Status and direction are converted to their enum values." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created phone call object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Get a single phone call by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/phone-calls\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/phone-calls\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Phone call ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single phone call by ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Phone call object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a phone call record.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/phone-calls\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/phone-calls\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Phone call ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a phone call record. Creates a ticket activity record if a ticket is linked and no activity exists yet." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated phone call object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete a phone call record.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/phone-calls\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/phone-calls\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Phone call ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a phone call record." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Prospects", "description": "Manage sales prospects with auto-generated account numbers, full-text search, and prospect-to-customer conversion.", "item": [ { "name": "List prospects with filtering, sorting, and pagination (Spatie QueryBuilder).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/prospects", "query": [ { "key": "filter[name]", "value": "string", "description": "Filter by name", "disabled": false }, { "key": "filter[id]", "value": "1", "description": "Filter by exact ID", "disabled": false }, { "key": "filter[term_match]", "value": "string", "description": "Full-text term match", "disabled": false }, { "key": "sort", "value": "string", "description": "Sort field (`id`, `created_at`, `updated_at`)", "disabled": false }, { "key": "per_page", "value": "1", "description": "Items per page", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/prospects?filter%5Bname%5D=string&filter%5Bid%5D=1&filter%5Bterm_match%5D=string&sort=string&per_page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List prospects with filtering, sorting, and pagination (Spatie QueryBuilder). Filtered by user role: role-5 users only see prospects visible to sales (`viewable_by_sale` scope)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of prospect objects." } ] }, { "name": "Create a new prospect.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/prospects", "query": [], "raw": "{{baseUrl}}\/api\/v1\/prospects" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new prospect. A `customer_account` is auto-generated (format: `PR` + zero-padded ID). Role-5 users automatically have their ID set as `representative_id`." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created prospect object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Get a single prospect with `payment_plan`, `contacts`, and `documents` loaded.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/prospects\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/prospects\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Prospect ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single prospect with `payment_plan`, `contacts`, and `documents` loaded. Authorization policy enforced." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Prospect object with relations." }, { "header": [], "code": 403, "body": "{}", "name": "Forbidden." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a prospect.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/prospects\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/prospects\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Prospect ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a prospect. Role-5 users cannot change `representative_id`. Auto-generates `customer_account` if empty." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated prospect object." }, { "header": [], "code": 403, "body": "{}", "name": "Forbidden (role-5 trying to change rep)." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Delete a prospect.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/prospects\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/prospects\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Prospect ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a prospect." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Quotes & Documents", "description": "Generate, send, and electronically sign commercial documents including quotes, proformas, and contracts.", "item": [ { "name": "Check if a customer file has quote documents, and list available types.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/quotes", "query": [ { "key": "customer_file_id", "value": "1", "description": "Customer file ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/quotes?customer_file_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Check if a customer file has quote documents, and list available types." }, "response": [ { "header": [], "code": 200, "body": "{\n \"has_quotes\": true,\n \"types\": [\"quote\", \"proforma\", \"contract\"]\n}", "name": "" } ] }, { "name": "Generate quote documents for a customer file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/quotes\/generate", "query": [ { "key": "customer_file_id", "value": "1", "description": "Customer file ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/quotes\/generate?customer_file_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Generate quote documents for a customer file. Runs the `generate_quote_documents` action." }, "response": [ { "header": [], "code": 201, "body": "{\n \"types\": [\"quote\", \"proforma\", \"contract\"]\n}", "name": "" }, { "header": [], "code": 422, "body": "{}", "name": "Error during generation." }, { "header": [], "code": 500, "body": "{}", "name": "Error during generation." } ] }, { "name": "Show (download) a specific quote document as a PDF.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/quotes\/show", "query": [ { "key": "customer_file_id", "value": "1", "description": "Customer file ID", "disabled": false }, { "key": "type", "value": "string", "description": "Document type: `quote`, `proforma`, or `contract`", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/quotes\/show?customer_file_id=1&type=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show (download) a specific quote document as a PDF." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "PDF file (`Content-Type: application\/pdf`)." }, { "header": [], "code": 404, "body": "{}", "name": "Document not found (no quotes generated)." } ] }, { "name": "Send a quote document by email to a recipient.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/quotes\/send", "query": [], "raw": "{{baseUrl}}\/api\/v1\/quotes\/send" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"customer_file_id\":1,\"email\":\"string\",\"type\":\"string\"}" }, "description": "Send a quote document by email to a recipient." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "`{ \"message\": \"success\" }`" }, { "header": [], "code": 400, "body": "{}", "name": "Quotes not yet generated." }, { "header": [], "code": 500, "body": "{}", "name": "Mail sending error." } ] }, { "name": "Send a contract for electronic signature via DocuSign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/quotes\/docusign", "query": [ { "key": "customer_file_id", "value": "1", "description": "Customer file ID", "disabled": false }, { "key": "type", "value": "string", "description": "Must be `contract`", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/quotes\/docusign?customer_file_id=1&type=string" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"string\",\"signers\":[\"string\"],\"cc\":[\"string\"],\"draft\":true}" }, "description": "Send a contract for electronic signature via DocuSign. Requires the DocuSign module to be enabled." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "DocuSign envelope data." }, { "header": [], "code": 400, "body": "{}", "name": "Module not enabled or validation error." }, { "header": [], "code": 500, "body": "{}", "name": "DocuSign API error." } ] } ] }, { "name": "Recruitment", "description": "Manage candidates, job openings, interviews, contracts, and employer details for internal HR and staffing use cases.", "item": [ { "name": "Candidates", "description": "", "item": [ { "name": "List candidates with pagination and sorting.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recruitment\/candidates", "query": [ { "key": "nb", "value": "1", "description": "Items per page", "disabled": false }, { "key": "sort", "value": "string", "description": "Sort field", "disabled": false }, { "key": "direction", "value": "string", "description": "Sort direction (`asc` \/ `desc`)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/recruitment\/candidates?nb=1&sort=string&direction=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List candidates with pagination and sorting." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of candidate objects." } ] }, { "name": "Search candidates by quick-search term.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recruitment\/candidates\/search", "query": [ { "key": "term", "value": "string", "description": "Search term", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/recruitment\/candidates\/search?term=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search candidates by quick-search term." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of matching candidates." } ] }, { "name": "Create a candidate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recruitment\/candidates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recruitment\/candidates" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a candidate." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created candidate object." } ] }, { "name": "Show a candidate with specialities, languages, marital status, candidate details, and contracts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recruitment\/candidates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recruitment\/candidates\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a candidate with specialities, languages, marital status, candidate details, and contracts." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Candidate object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a candidate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recruitment\/candidates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recruitment\/candidates\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a candidate. Supports the same relation fields as create." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Updated candidate object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete a candidate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recruitment\/candidates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recruitment\/candidates\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a candidate." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Candidate Queries", "description": "", "item": [ { "name": "Query candidates with advanced filters.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recruitment\/candidate-queries", "query": [ { "key": "filter[speciality_id]", "value": "1", "description": "Filter by speciality", "disabled": false }, { "key": "filter[available_in_country]", "value": "1", "description": "Available for in-country assignments", "disabled": false }, { "key": "filter[available_abroad]", "value": "1", "description": "Available for international assignments", "disabled": false }, { "key": "filter[available_housed]", "value": "1", "description": "Available to be housed on-site", "disabled": false }, { "key": "filter[available_on]", "value": "string", "description": "Available on a specific date", "disabled": false }, { "key": "filter[recruitment_filter_id]", "value": "1", "description": "Filter by recruitment filter ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/recruitment\/candidate-queries?filter%5Bspeciality_id%5D=1&filter%5Bavailable_in_country%5D=1&filter%5Bavailable_abroad%5D=1&filter%5Bavailable_housed%5D=1&filter%5Bavailable_on%5D=string&filter%5Brecruitment_filter_id%5D=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Query candidates with advanced filters." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Filtered array of candidate objects." } ] } ] }, { "name": "Recruitment Interviews", "description": "", "item": [ { "name": "Get the list of available interview statuses.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recruitment\/interviews\/statuses", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recruitment\/interviews\/statuses" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the list of available interview statuses." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of status strings." } ] }, { "name": "List interviews.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recruitment\/interviews", "query": [ { "key": "recruitment_id", "value": "1", "description": "Filter by recruitment", "disabled": false }, { "key": "candidate_id", "value": "1", "description": "Filter by candidate", "disabled": false }, { "key": "customer_id", "value": "1", "description": "Filter by customer", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/recruitment\/interviews?recruitment_id=1&candidate_id=1&customer_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List interviews." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of interview objects with related recruitment and customer data." } ] } ] } ] }, { "name": "Sales (Proforma Lines and Credits)", "description": "Manage proforma sales lines with automatic price calculation from catalog items, including credit applications.", "item": [ { "name": "Proforma Sales Lines", "description": "", "item": [ { "name": "List proforma sales for a specific proforma invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sales-proforma", "query": [ { "key": "invoice_proforma_id", "value": "1", "description": "Filter by proforma invoice ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/sales-proforma?invoice_proforma_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List proforma sales for a specific proforma invoice." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of proforma sale objects." } ] }, { "name": "Create a new proforma sale line.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sales-proforma", "query": [ { "key": "invoice_proforma_id", "value": "1", "description": "Proforma invoice to add the line to", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/sales-proforma?invoice_proforma_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"item_id\":1,\"bar_code\":\"string\",\"quantity\":\"string\",\"discount_rate\":\"string\"}" }, "description": "Create a new proforma sale line. Prices are auto-calculated: buying price, selling price, taxes, discounts. The item can be identified by `item_id` or `bar_code`." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created proforma sale object." }, { "header": [], "code": 422, "body": "{}", "name": "Invalid item or validation error." } ] }, { "name": "Get a single proforma sale line.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sales-proforma\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sales-proforma\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Proforma sale ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single proforma sale line." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Proforma sale object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a proforma sale line.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sales-proforma\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sales-proforma\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Proforma sale ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a proforma sale line. All pricing fields are recalculated." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated proforma sale object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete a proforma sale line.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sales-proforma\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sales-proforma\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Proforma sale ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a proforma sale line." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Sale Credit", "description": "", "item": [ { "name": "Apply a credit to a sale.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sales\/credit", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sales\/credit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Apply a credit to a sale. This endpoint does NOT require authentication (`auth:api` middleware is NOT applied)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Credit result." } ] } ] } ] }, { "name": "Tasks", "description": "List active tasks assigned to the authenticated user for action tracking and follow-up management.", "item": [ { "name": "List tasks for the authenticated user that are active and upcoming.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sales-tasks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sales-tasks" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List tasks for the authenticated user that are active and upcoming. Used by sales dashboards and CRM integrations." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of task objects." } ] } ] }, { "name": "Tickets", "description": "Full REST API for ticket lifecycle management, replies, time tracking, support contracts, teams, and analytics.", "item": [ { "name": "List open tickets, ordered by ID descending.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets", "query": [ { "key": "ticketable_type", "value": "string", "description": "Filter by ticketable type. If provided together with `ticketable_id`, returns all tickets for that entity regardless of open\/closed state", "disabled": false }, { "key": "ticketable_id", "value": "1", "description": "Filter by ticketable ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tickets?ticketable_type=string&ticketable_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List open tickets, ordered by ID descending." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of ticket objects with `ticketable`, `assignee` (id, name, email), `replies_count`, and `last_reply_seen_at`." } ] }, { "name": "Create a new ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets", "query": [ { "key": "ticketable_type", "value": "string", "description": "Polymorphic type (currently only `App\\Customer`)", "disabled": false }, { "key": "ticketable_id", "value": "1", "description": "ID of the entity to attach the ticket to", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tickets?ticketable_type=string&ticketable_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subject\":\"string\",\"body\":\"string\",\"priority_id\":1,\"ticket_category_id\":1,\"ticket_sub_category_id\":1,\"estimated_resolution_date\":\"string\",\"tags\":[\"string\"],\"team_id\":1,\"status_id\":1,\"assignee_id\":1,\"close\":true}" }, "description": "Create a new ticket. The authenticated user is set as the author and opener. The ticket is created unassigned unless an `assignee_id` is provided." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created ticket object." }, { "header": [], "code": 400, "body": "{}", "name": "Bad request (missing mandatory fields or invalid ticketable type)." }, { "header": [], "code": 404, "body": "{}", "name": "Ticketable entity not found, or `assignee_id` does not reference an active user." } ] }, { "name": "Get a single ticket with all related data.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single ticket with all related data." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Ticket object with `replies` (including `author`), `ticketable`, `contacts`, `category`, `sub_category`, `assignee`, `opener`, `attachments`, `has_unread_replies`. Template variables in reply bodies are resolved." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subject\":\"string\",\"body\":\"string\",\"ticketable_type\":\"string\",\"ticketable_id\":1,\"team_id\":1,\"priority_id\":1,\"ticket_category_id\":1,\"ticket_sub_category_id\":1,\"status_id\":1,\"tags\":[\"string\"],\"estimated_resolution_date\":\"string\",\"assignee_id\":1,\"opened_at\":\"string\",\"contract_id\":1,\"close\":true}" }, "description": "Update a ticket. Only the fields present in the body are updated." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated ticket object with replies." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Delete a ticket and all its replies.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a ticket and all its replies." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "`{\"response\": \"element deleted\"}`" }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Get ticket counts summary for the current day and week.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/counts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/counts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get ticket counts summary for the current day and week." }, "response": [ { "header": [], "code": 200, "body": "{\n \"total\": 150,\n \"open\": 42,\n \"unassigned\": 5,\n \"assigned_to_myself\": 12,\n \"daily\": 8,\n \"weekly\": 30,\n \"closed\": 108\n}", "name": "" } ] }, { "name": "Search and filter tickets using Spatie QueryBuilder.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/search", "query": [ { "key": "filter[number]", "value": "string", "description": "Filter by ticket number (partial match)", "disabled": false }, { "key": "filter[email]", "value": "string", "description": "Filter by email (partial match)", "disabled": false }, { "key": "filter[body]", "value": "string", "description": "Filter by body (partial match)", "disabled": false }, { "key": "filter[ticketable_type]", "value": "string", "description": "Exact match on ticketable type", "disabled": false }, { "key": "filter[ticketable_id]", "value": "1", "description": "Exact match on ticketable ID", "disabled": false }, { "key": "filter[assignee_id]", "value": "1", "description": "Exact match on assignee", "disabled": false }, { "key": "filter[status_id]", "value": "1", "description": "Exact match on status", "disabled": false }, { "key": "filter[priority_id]", "value": "1", "description": "Exact match on priority", "disabled": false }, { "key": "filter[team_id]", "value": "1", "description": "Exact match on team", "disabled": false }, { "key": "filter[open]", "value": "1", "description": "Scope: open tickets only", "disabled": false }, { "key": "filter[closed]", "value": "1", "description": "Scope: closed tickets only", "disabled": false }, { "key": "filter[my_tickets]", "value": "1", "description": "Scope: tickets assigned to the authenticated user", "disabled": false }, { "key": "filter[my_teams_tickets]", "value": "1", "description": "Scope: tickets belonging to the authenticated user's teams", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tickets\/search?filter%5Bnumber%5D=string&filter%5Bemail%5D=string&filter%5Bbody%5D=string&filter%5Bticketable_type%5D=string&filter%5Bticketable_id%5D=1&filter%5Bassignee_id%5D=1&filter%5Bstatus_id%5D=1&filter%5Bpriority_id%5D=1&filter%5Bteam_id%5D=1&filter%5Bopen%5D=1&filter%5Bclosed%5D=1&filter%5Bmy_tickets%5D=1&filter%5Bmy_teams_tickets%5D=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search and filter tickets using Spatie QueryBuilder." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Filtered array of ticket objects." } ] }, { "name": "Create a billing ticket (used to record time spent and deduct from a support contract).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/invoicing", "query": [ { "key": "ticketable_type", "value": "string", "description": "Currently only `App\\Customer`", "disabled": false }, { "key": "ticketable_id", "value": "1", "description": "Customer ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tickets\/invoicing?ticketable_type=string&ticketable_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"time\":1,\"reference\":\"string\",\"ticket_date\":\"string\",\"contact_id\":1}" }, "description": "Create a billing ticket (used to record time spent and deduct from a support contract). The ticket is created as already closed." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "`{\"response\": \"ticket created\", \"ticket\": {...}}`" } ] }, { "name": "Assign a ticket to a user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/assign\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/assign\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"assignee_id\":1}" }, "description": "Assign a ticket to a user." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Assignee user object." }, { "header": [], "code": 400, "body": "{}", "name": "Missing `assignee_id`." }, { "header": [], "code": 404, "body": "{}", "name": "Ticket or assignee not found." } ] }, { "name": "Remove the assignee from a ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/free\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/free\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove the assignee from a ticket." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "`{\"response\": \"ticket freed\"}`" }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Close a ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/close\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/close\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Close a ticket." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "`{\"response\": \"ticket closed\"}`" } ] }, { "name": "Re-open a ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/open\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/open\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Re-open a ticket. If the ticket has a pending closure, calls `reopen` instead (cancels the closure)." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "`{\"response\": \"ticket open\"}`" } ] }, { "name": "Reopen a ticket by cancelling any pending closure.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/reopen\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/reopen\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Reopen a ticket by cancelling any pending closure." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Refreshed ticket object." } ] }, { "name": "Amend the tracked time on a ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/amend\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/amend\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"time\":\"string\"}" }, "description": "Amend the tracked time on a ticket." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "`{\"response\": \"ticket time amended\"}`" } ] }, { "name": "Export tickets for a customer to an Excel file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/export\/:customer_id", "query": [ { "key": "with_segments", "value": "1", "description": "If `true`, includes time segments in the export", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tickets\/export\/:customer_id?with_segments=1", "variable": [ { "id": "customer_id", "key": "customer_id", "value": "string", "description": "customer_id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Export tickets for a customer to an Excel file." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Excel file download." }, { "header": [], "code": 404, "body": "{}", "name": "Customer not found." } ] }, { "name": "Mark all unread replies of a ticket as read (sets `seen_at = now()`).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/:id\/read-replies", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/:id\/read-replies", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mark all unread replies of a ticket as read (sets `seen_at = now()`)." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "`{\"success\": true}`" }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Get the customer linked to a ticket (follows the ticketable relationship chain).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/:id\/customer", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/:id\/customer", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the customer linked to a ticket (follows the ticketable relationship chain)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Customer object with contacts." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Manage the contacts associated with a ticket (attach and detach).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/:id\/associates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/:id\/associates", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"associated\":[\"string\"],\"unassociated\":[\"string\"]}" }, "description": "Manage the contacts associated with a ticket (attach and detach)." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "`{\"response\": \"N associated and M unassociated\"}`" } ] }, { "name": "List all replies for a ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/replies", "query": [ { "key": "ticket_id", "value": "1", "description": "Ticket ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/replies?ticket_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all replies for a ticket." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of reply objects." }, { "header": [], "code": 404, "body": "{}", "name": "Ticket not found." } ] }, { "name": "Add a reply to a ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/replies", "query": [ { "key": "ticket_id", "value": "1", "description": "Ticket ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/replies?ticket_id=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"body\":\"string\",\"close\":true,\"send_to_assignee\":true,\"send_to_contacts\":true}" }, "description": "Add a reply to a ticket." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created reply object." }, { "header": [], "code": 404, "body": "{}", "name": "Ticket not found." } ] } ] }, { "name": "Training", "description": "Learning management system (LMS) covering courses, programs, lessons, materials, quizzes, and student enrollment management.", "item": [ { "name": "Courses", "description": "", "item": [ { "name": "List all courses.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/courses", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/courses" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all courses." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of course objects." } ] }, { "name": "Create a course.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/courses", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/courses" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a course." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created course object." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Show a course with lessons, materials, quizzes, programs, and students.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/courses\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/courses\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a course with lessons, materials, quizzes, programs, and students." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Course object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a course.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/courses\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/courses\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a course." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Updated course object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." }, { "header": [], "code": 422, "body": "{}", "name": "Validation error." } ] }, { "name": "Delete a course.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/courses\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/courses\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a course." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Programs (Curricula)", "description": "", "item": [ { "name": "List all programs.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/programs", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/programs" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all programs." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of program objects." } ] }, { "name": "Create a program.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/programs", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/programs" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a program. Supports attaching courses with order via `courses` (array of IDs)." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created program object." } ] }, { "name": "Show a program with courses (with pivot `order`), materials, quizzes, and students.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/programs\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/programs\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a program with courses (with pivot `order`), materials, quizzes, and students." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Program object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a program.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/programs\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/programs\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a program." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Updated program object." } ] }, { "name": "Delete a program.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/programs\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/programs\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a program." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success." } ] } ] }, { "name": "Lessons", "description": "", "item": [ { "name": "List lessons.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/lessons", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/lessons" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List lessons. Filterable by `?course_id=`." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of lesson objects." } ] } ] }, { "name": "Training Materials", "description": "", "item": [ { "name": "List materials.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/materials", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/materials" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List materials. Filterable by `?course_id=`, `?lesson_id=`, or `?contact_id=`." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of material objects." } ] }, { "name": "Upload or create a material.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/materials", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/materials" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Upload or create a material." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created material object." } ] }, { "name": "Show a material.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/materials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/materials\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a material." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Material object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a material.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/materials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/materials\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a material. Supports updating course\/lesson\/contact associations." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Updated material object." } ] }, { "name": "Delete a material and remove its file from storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/materials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/materials\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a material and remove its file from storage." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success." } ] }, { "name": "Download the material file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/materials\/:id\/content", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/materials\/:id\/content", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Download the material file." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "File stream." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Quizzes", "description": "", "item": [ { "name": "List all quizzes.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/quizzes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/quizzes" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all quizzes." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of quiz objects." } ] }, { "name": "Create a quiz.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/quizzes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/quizzes" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a quiz. A default group is automatically created." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created quiz object." } ] }, { "name": "Show a quiz with groups and questions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/quizzes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/quizzes\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a quiz with groups and questions." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Quiz object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a quiz.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/quizzes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/quizzes\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a quiz." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Updated quiz object." } ] }, { "name": "Delete a quiz.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/quizzes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/quizzes\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a quiz." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success." } ] } ] }, { "name": "Quiz Questions", "description": "", "item": [ { "name": "Get the list of available question types.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/quiz-questions\/types", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/quiz-questions\/types" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the list of available question types." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of type strings. Available types: `single_choice`, `multiple_choice`, `true_false`, `short_answer`, `essay`." } ] }, { "name": "List questions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/quiz-questions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/quiz-questions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List questions. Filterable by `?group_id=`." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of question objects." } ] }, { "name": "Create a question.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/training\/quiz-questions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/training\/quiz-questions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"string\",\"label\":\"string\",\"group_id\":1,\"points\":\"string\"}" }, "description": "Create a question. `type` must be one of the allowed types." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created question object." } ] } ] } ] }, { "name": "Users and Teams", "description": "Manage user accounts with role-based filtering, team assignments, and admin impersonation capabilities.", "item": [ { "name": "Users", "description": "", "item": [ { "name": "List all users with filtering, sorting, and pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [ { "key": "filter[name]", "value": "string", "description": "Filter by name", "disabled": false }, { "key": "filter[email]", "value": "string", "description": "Filter by email", "disabled": false }, { "key": "filter[active]", "value": "1", "description": "Filter active\/inactive", "disabled": false }, { "key": "filter[role]", "value": "1", "description": "Filter by role level", "disabled": false }, { "key": "filter[phone]", "value": "string", "description": "Filter by phone", "disabled": false }, { "key": "filter[mobile_phone]", "value": "string", "description": "Filter by mobile phone", "disabled": false }, { "key": "filter[manager]", "value": "1", "description": "Filter managers", "disabled": false }, { "key": "filter[technical_manager]", "value": "1", "description": "Filter technical managers", "disabled": false }, { "key": "filter[sales]", "value": "1", "description": "Filter sales users", "disabled": false }, { "key": "filter[technical]", "value": "1", "description": "Filter technical users", "disabled": false }, { "key": "filter[support_team]", "value": "1", "description": "Filter support team members", "disabled": false }, { "key": "filter[sales_admin]", "value": "1", "description": "Filter sales admin users", "disabled": false }, { "key": "filter[admin]", "value": "1", "description": "Filter admin users", "disabled": false }, { "key": "filter[business_finder]", "value": "1", "description": "Filter business finders", "disabled": false }, { "key": "filter[term_match]", "value": "string", "description": "Full-text term match", "disabled": false }, { "key": "sort", "value": "string", "description": "Sort field (`id`, `name`, `role`, `created_at`, `updated_at`)", "disabled": false }, { "key": "per_page", "value": "1", "description": "Items per page (default 10)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/users?filter%5Bname%5D=string&filter%5Bemail%5D=string&filter%5Bactive%5D=1&filter%5Brole%5D=1&filter%5Bphone%5D=string&filter%5Bmobile_phone%5D=string&filter%5Bmanager%5D=1&filter%5Btechnical_manager%5D=1&filter%5Bsales%5D=1&filter%5Btechnical%5D=1&filter%5Bsupport_team%5D=1&filter%5Bsales_admin%5D=1&filter%5Badmin%5D=1&filter%5Bbusiness_finder%5D=1&filter%5Bterm_match%5D=string&sort=string&per_page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all users with filtering, sorting, and pagination." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Paginated list of user objects." } ] }, { "name": "Create a new user (standard resource route).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new user (standard resource route). Admin only." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created user object." } ] }, { "name": "Get a single user by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "User ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single user by ID. Includes `teams` and `support_teams` (if ticketing module enabled)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "User object with teams." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "User ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a user." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Updated user object." } ] }, { "name": "Delete a user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a user." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success message." } ] }, { "name": "Impersonate another user (admin only).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/impersonate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/impersonate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":1}" }, "description": "Impersonate another user (admin only)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Impersonation session established." } ] }, { "name": "Leave impersonation and return to original user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/impersonate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/impersonate" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Leave impersonation and return to original user." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Original session restored." } ] } ] }, { "name": "Teams", "description": "", "item": [ { "name": "List all teams ordered by name (no pagination).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all teams ordered by name (no pagination)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of all team objects." } ] }, { "name": "Create a new team.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new team." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created team object." }, { "header": [], "code": 400, "body": "{}", "name": "Validation error." } ] }, { "name": "Get a single team by ID with `users` relation.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:id", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "Team ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single team by ID with `users` relation." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Team object with users." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] }, { "name": "Update a team.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a team." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated team object." }, { "header": [], "code": 400, "body": "{}", "name": "Error." }, { "header": [], "code": 404, "body": "{}", "name": "Error." } ] }, { "name": "Delete a team.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/teams\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/teams\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a team." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Success message." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] } ] }, { "name": "Utilities and Helpers", "description": "Access helper endpoints for version checks, reference data, string formatting, quick search, and system configuration.", "item": [ { "name": "Version and Health", "description": "", "item": [ { "name": "Get API version and status information.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/version", "query": [], "raw": "{{baseUrl}}\/api\/version" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get API version and status information.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"version\": \"1.0\",\n \"status\": \"ok\",\n \"vendor\": \"blue_rock_tel\",\n \"url\": \"https:\/\/bluerocktel.com\"\n}", "name": "" } ] }, { "name": "Get external services configuration (BlueRockTEL, Hetzner, OVH Cloud, etc.).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/services", "query": [], "raw": "{{baseUrl}}\/api\/services" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get external services configuration (BlueRockTEL, Hetzner, OVH Cloud, etc.).", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "JSON object with services grouped by provider." } ] }, { "name": "Get the API base URL for a given client origin.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/base_url", "query": [], "raw": "{{baseUrl}}\/api\/base_url" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the API base URL for a given client origin. Used by frontend apps to resolve the correct API URL.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Object mapping origin to API base URL." }, { "header": [], "code": 404, "body": "{}", "name": "Origin not in config." } ] }, { "name": "Get an application health report.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/health-report", "query": [], "raw": "{{baseUrl}}\/api\/health-report" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get an application health report.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Health status data." } ] } ] }, { "name": "Date \/ Timezone Helper", "description": "", "item": [ { "name": "Test date\/timezone conversion.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/datetime", "query": [], "raw": "{{baseUrl}}\/api\/v1\/datetime" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Test date\/timezone conversion.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Converted datetime result." } ] } ] }, { "name": "Colors", "description": "", "item": [ { "name": "List available color options (for UI labeling).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/colors", "query": [], "raw": "{{baseUrl}}\/api\/v1\/colors" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List available color options (for UI labeling)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of color objects." } ] } ] }, { "name": "Payment Methods", "description": "", "item": [ { "name": "List all payment methods (seeded\/read-only).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/payment-methods", "query": [], "raw": "{{baseUrl}}\/api\/v1\/payment-methods" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all payment methods (seeded\/read-only)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of payment method objects." } ] }, { "name": "Get a single payment method by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/payment-methods\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/payment-methods\/:id", "variable": [ { "id": "id", "key": "id", "value": "string", "description": "id identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single payment method by ID." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Payment method object." }, { "header": [], "code": 404, "body": "{}", "name": "Not found." } ] } ] }, { "name": "Modules", "description": "", "item": [ { "name": "List all installed\/enabled application modules.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/modules", "query": [], "raw": "{{baseUrl}}\/api\/v1\/modules" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all installed\/enabled application modules.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of module objects." } ] } ] }, { "name": "Click-to-Call", "description": "", "item": [ { "name": "Get the target number for a click-to-call request.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/click-to-call\/to", "query": [], "raw": "{{baseUrl}}\/api\/v1\/click-to-call\/to" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the target number for a click-to-call request." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Target call number." } ] }, { "name": "Check if click-to-call is enabled for the authenticated user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/click-to-call\/enabled", "query": [], "raw": "{{baseUrl}}\/api\/v1\/click-to-call\/enabled" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Check if click-to-call is enabled for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Enabled status." } ] } ] }, { "name": "Text Transformer", "description": "", "item": [ { "name": "Correct spelling in a text string (AI-powered).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transformers\/correct-text-spelling", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transformers\/correct-text-spelling" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"text\":\"string\"}" }, "description": "Correct spelling in a text string (AI-powered)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Corrected text." } ] } ] }, { "name": "OVH Cloud", "description": "", "item": [ { "name": "List all OVH Cloud projects.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ovh-cloud-projects", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ovh-cloud-projects" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all OVH Cloud projects." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of OVH Cloud project objects." } ] }, { "name": "Get a single OVH Cloud project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ovh-cloud-projects\/:project", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ovh-cloud-projects\/:project", "variable": [ { "id": "project", "key": "project", "value": "string", "description": "project identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single OVH Cloud project." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Project object." } ] }, { "name": "List instances (servers) in an OVH Cloud project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ovh-cloud-projects\/:project\/instances", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ovh-cloud-projects\/:project\/instances", "variable": [ { "id": "project", "key": "project", "value": "string", "description": "project identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List instances (servers) in an OVH Cloud project." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of instance objects." } ] }, { "name": "List object storage containers in an OVH Cloud project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ovh-cloud-projects\/:project\/storages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ovh-cloud-projects\/:project\/storages", "variable": [ { "id": "project", "key": "project", "value": "string", "description": "project identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List object storage containers in an OVH Cloud project." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of storage objects." } ] }, { "name": "Get the BlueRockTEL entity (customer\/host) linked to an OVH Cloud project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ovh-cloud-projects\/:project\/entity", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ovh-cloud-projects\/:project\/entity", "variable": [ { "id": "project", "key": "project", "value": "string", "description": "project identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the BlueRockTEL entity (customer\/host) linked to an OVH Cloud project." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Entity object." } ] } ] }, { "name": "Quick Search", "description": "", "item": [ { "name": "Perform a quick global search across customers, contacts, etc.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/get_quick", "query": [ { "key": "term", "value": "string", "description": "Search term", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/get_quick?term=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Perform a quick global search across customers, contacts, etc." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Grouped search results." } ] } ] }, { "name": "Autocomplete (Customer)", "description": "", "item": [ { "name": "Get the current customer context for the authenticated session (used in web integrations).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customer", "query": [], "raw": "{{baseUrl}}\/api\/customer" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the current customer context for the authenticated session (used in web integrations)." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Customer data." } ] } ] }, { "name": "Customer Support Survey", "description": "", "item": [ { "name": "Store a customer support survey response.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/store_customer_support_survey_record", "query": [], "raw": "{{baseUrl}}\/api\/store_customer_support_survey_record" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Store a customer support survey response." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Created survey record." }, { "header": [], "code": 201, "body": "{}", "name": "Created survey record." } ] } ] }, { "name": "Admin: Invoice Units", "description": "", "item": [ { "name": "Admin utility to look up invoice unit data.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoice-units", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoice-units" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Admin utility to look up invoice unit data. Primarily for the BlueRockTEL internal team." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Invoice unit data." } ] } ] }, { "name": "SFTP Accounts", "description": "", "item": [ { "name": "List all SFTP accounts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sftp_accounts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sftp_accounts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all SFTP accounts." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of SFTP account objects." } ] }, { "name": "List available (unassigned) SFTP accounts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sftp_accounts\/available", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sftp_accounts\/available" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List available (unassigned) SFTP accounts." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of available SFTP account objects." } ] }, { "name": "Update an SFTP account.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sftp_accounts\/:sftp_account", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sftp_accounts\/:sftp_account", "variable": [ { "id": "sftp_account", "key": "sftp_account", "value": "string", "description": "sftp_account identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update an SFTP account." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Updated SFTP account." } ] } ] }, { "name": "Customer Concerns", "description": "", "item": [ { "name": "Search customer concerns.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer_concerns\/search", "query": [ { "key": "term", "value": "string", "description": "Search term", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/customer_concerns\/search?term=string" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search customer concerns." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Array of matching concern objects." } ] }, { "name": "Create a new customer concern.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/customer_concerns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/customer_concerns" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new customer concern." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Created concern." } ] } ] }, { "name": "TinyDrive (TinyMCE)", "description": "", "item": [ { "name": "Get a TinyMCE TinyDrive authentication token for the rich text editor.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tiny-drive", "query": [], "raw": "{{baseUrl}}\/api\/tiny-drive" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a TinyMCE TinyDrive authentication token for the rich text editor.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Token object." } ] } ] }, { "name": "Pictures", "description": "", "item": [ { "name": "Upload a picture\/image.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pictures", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pictures" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Upload a picture\/image." }, "response": [ { "header": [], "code": 201, "body": "{}", "name": "Stored picture URL\/object." } ] } ] }, { "name": "Bill Count", "description": "", "item": [ { "name": "Get a count of bills (internal use, likely for billing service health checks).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/count", "query": [], "raw": "{{baseUrl}}\/api\/count" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a count of bills (internal use, likely for billing service health checks).", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Count value." } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }