{ "info": { "name": "Harmoniq API", "description": "The company API in Harmoniq. Fill in the collection variables: base_url — your company's address (https://compania-mea.harmoniq.ro/api/v1) and api_key — a key created in Harmoniq (Access → API keys) with the rights you need. Every field is described in full at https://harmoniq.ro/en/api", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://compania-mea.harmoniq.ro/api/v1", "type": "string", "description": "Your company’s address in Harmoniq (the part before .harmoniq.ro)." }, { "key": "api_key", "value": "", "type": "string", "description": "The API key created in Harmoniq (Access → API keys). Keep it as the current value; do not share it in the collection." } ], "item": [ { "name": "Organisation", "item": [ { "name": "Geographic areas", "description": "The tree of countries, regions and zones the units belong to; it also sets area managers’ reach. Names are unique among siblings. Deleting one is refused while units or sub-areas use it.", "item": [ { "name": "List: Geographic areas", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/geo-areas?parent_id=&roots=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "geo-areas" ], "query": [ { "key": "parent_id", "value": "", "disabled": true, "description": "Only the areas directly under this one." }, { "key": "roots", "value": "", "disabled": true, "description": "true: only the top-level areas." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Geographic areas", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/geo-areas/:id", "host": [ "{{base_url}}" ], "path": [ "geo-areas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Geographic areas", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/geo-areas", "host": [ "{{base_url}}" ], "path": [ "geo-areas" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Nord-Vest\",\n \"level_label\": \"regiune\",\n \"parent_id\": 1,\n \"sort\": 0\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Geographic areas", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/geo-areas/:id", "host": [ "{{base_url}}" ], "path": [ "geo-areas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Nord-Vest\",\n \"level_label\": \"regiune\",\n \"parent_id\": 1,\n \"sort\": 0\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Geographic areas", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/geo-areas/:id", "host": [ "{{base_url}}" ], "path": [ "geo-areas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Work units", "description": "The company’s units: stores, pharmacies, offices, hotels. Deleting one is refused while people, documents or results still refer to it.", "item": [ { "name": "List: Work units", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/work-units?code=&geo_area_id=&is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "work-units" ], "query": [ { "key": "code", "value": "", "disabled": true, "description": "Exact code (case-insensitive)." }, { "key": "geo_area_id", "value": "", "disabled": true, "description": "Only in this area." }, { "key": "is_active", "value": "", "disabled": true, "description": "true or false." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Work units", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/work-units/:id", "host": [ "{{base_url}}" ], "path": [ "work-units", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Work units", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/work-units", "host": [ "{{base_url}}" ], "path": [ "work-units" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Farmacia Verde Centru\",\n \"code\": \"CJ01\",\n \"geo_area_id\": 3,\n \"address\": \"Str. Memorandumului 10\",\n \"opened_on\": \"2016-03-01\",\n \"is_active\": true,\n \"custom_fields\": {\n \"12\": \"XL\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Work units", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/work-units/:id", "host": [ "{{base_url}}" ], "path": [ "work-units", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Farmacia Verde Centru\",\n \"code\": \"CJ01\",\n \"geo_area_id\": 3,\n \"address\": \"Str. Memorandumului 10\",\n \"opened_on\": \"2016-03-01\",\n \"is_active\": true,\n \"custom_fields\": {\n \"12\": \"XL\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Work units", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/work-units/:id", "host": [ "{{base_url}}" ], "path": [ "work-units", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Departments", "description": "Company-wide functions (Sales, Logistics…) that can be nested. Deleting one is refused while placements or sub-departments use it.", "item": [ { "name": "List: Departments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/departments?code=&parent_id=&is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "departments" ], "query": [ { "key": "code", "value": "", "disabled": true, "description": "Exact code (case-insensitive)." }, { "key": "parent_id", "value": "", "disabled": true, "description": "Only the departments directly under this one." }, { "key": "is_active", "value": "", "disabled": true, "description": "true or false." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Departments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/departments/:id", "host": [ "{{base_url}}" ], "path": [ "departments", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Departments", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/departments", "host": [ "{{base_url}}" ], "path": [ "departments" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Farmacie\",\n \"code\": \"FARM\",\n \"is_active\": true,\n \"custom_fields\": {\n \"12\": \"XL\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Departments", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/departments/:id", "host": [ "{{base_url}}" ], "path": [ "departments", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Farmacie\",\n \"code\": \"FARM\",\n \"is_active\": true,\n \"custom_fields\": {\n \"12\": \"XL\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Departments", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/departments/:id", "host": [ "{{base_url}}" ], "path": [ "departments", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Positions", "description": "Job positions and their level (a higher number is a more senior position). Deleting one is refused while someone holds it.", "item": [ { "name": "List: Positions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/positions?code=&is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "positions" ], "query": [ { "key": "code", "value": "", "disabled": true, "description": "Exact code (case-insensitive)." }, { "key": "is_active", "value": "", "disabled": true, "description": "true or false." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Positions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/positions/:id", "host": [ "{{base_url}}" ], "path": [ "positions", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Positions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/positions", "host": [ "{{base_url}}" ], "path": [ "positions" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Farmacist\",\n \"code\": \"FA\",\n \"level\": 2,\n \"is_active\": true,\n \"custom_fields\": {\n \"12\": \"XL\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Positions", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/positions/:id", "host": [ "{{base_url}}" ], "path": [ "positions", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Farmacist\",\n \"code\": \"FA\",\n \"level\": 2,\n \"is_active\": true,\n \"custom_fields\": {\n \"12\": \"XL\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Positions", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/positions/:id", "host": [ "{{base_url}}" ], "path": [ "positions", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Teams", "description": "Groups of people across units (a project, a working group). Members are added and removed one by one with the actions below.", "item": [ { "name": "List: Teams", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teams?is_active=&employee_id=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "teams" ], "query": [ { "key": "is_active", "value": "", "disabled": true, "description": "true or false." }, { "key": "employee_id", "value": "", "disabled": true, "description": "Only the teams this employee is in." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Teams", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teams/:id", "host": [ "{{base_url}}" ], "path": [ "teams", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Teams", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teams", "host": [ "{{base_url}}" ], "path": [ "teams" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Proiect inventar\",\n \"is_active\": true,\n \"custom_fields\": {\n \"12\": \"XL\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Teams", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teams/:id", "host": [ "{{base_url}}" ], "path": [ "teams", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Proiect inventar\",\n \"is_active\": true,\n \"custom_fields\": {\n \"12\": \"XL\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Teams", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teams/:id", "host": [ "{{base_url}}" ], "path": [ "teams", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Adds an employee to the team (nothing changes if they are already in it). Body: {\"employee_id\": 345}.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teams/:id/add-member", "host": [ "{{base_url}}" ], "path": [ "teams", ":id", "add-member" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"employee_id\": 345\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Removes an employee from the team. Body: {\"employee_id\": 345}.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teams/:id/remove-member", "host": [ "{{base_url}}" ], "path": [ "teams", ":id", "remove-member" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"employee_id\": 345\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Custom fields", "description": "The fields the company added to its own records, read only: what each id in a record’s custom_fields means, its type and choices. Sensitive employee fields are listed only for a key with the sensitive scope. Fields are defined in the app.", "item": [ { "name": "List: Custom fields", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/custom-fields?entity=&is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "custom-fields" ], "query": [ { "key": "entity", "value": "", "disabled": true, "description": "Only the fields of this kind of record." }, { "key": "is_active", "value": "", "disabled": true, "description": "true or false." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Custom fields", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/custom-fields/:id", "host": [ "{{base_url}}" ], "path": [ "custom-fields", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] } ] }, { "name": "People and time", "item": [ { "name": "Employees", "description": "The company’s people. Creating one also creates their first placement; later moves go through /placements. The CNP (personal numeric code) is never read or written through the API. Logins are created in the app.", "item": [ { "name": "List: Employees", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees?status=&work_unit_id=&employee_number=&email=&q=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "employees" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "work_unit_id", "value": "", "disabled": true, "description": "Currently placed in this unit." }, { "key": "employee_number", "value": "", "disabled": true, "description": "Exact employee number." }, { "key": "email", "value": "", "disabled": true, "description": "Exact email." }, { "key": "q", "value": "", "disabled": true, "description": "Part of the name." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Employees", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:id", "host": [ "{{base_url}}" ], "path": [ "employees", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Employees", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees", "host": [ "{{base_url}}" ], "path": [ "employees" ] }, "body": { "mode": "raw", "raw": "{\n \"employee_number\": \"FV0012\",\n \"first_name\": \"Ana\",\n \"last_name\": \"Popescu\",\n \"email\": \"ana.popescu@example.com\",\n \"hire_date\": \"2024-02-01\",\n \"status\": \"active\",\n \"work_unit_id\": 12,\n \"custom_fields\": {\n \"12\": \"XL\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Employees", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:id", "host": [ "{{base_url}}" ], "path": [ "employees", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"employee_number\": \"FV0012\",\n \"first_name\": \"Ana\",\n \"last_name\": \"Popescu\",\n \"email\": \"ana.popescu@example.com\",\n \"hire_date\": \"2024-02-01\",\n \"status\": \"active\",\n \"work_unit_id\": 12,\n \"custom_fields\": {\n \"12\": \"XL\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Employees", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:id", "host": [ "{{base_url}}" ], "path": [ "employees", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Placements", "description": "Where each person works: unit, department and position, from when to when. A new main placement takes over from the previous one, which stays as a current secondary placement until it is ended.", "item": [ { "name": "List: Placements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/placements?employee_id=&work_unit_id=¤t=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "placements" ], "query": [ { "key": "employee_id", "value": "", "disabled": true, "description": "Only this person’s." }, { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only in this unit." }, { "key": "current", "value": "", "disabled": true, "description": "true: only placements in force today." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Placements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/placements/:id", "host": [ "{{base_url}}" ], "path": [ "placements", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Placements", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/placements", "host": [ "{{base_url}}" ], "path": [ "placements" ] }, "body": { "mode": "raw", "raw": "{\n \"employee_id\": 345,\n \"work_unit_id\": 12,\n \"is_primary\": true,\n \"valid_from\": \"2026-03-01\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Placements", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/placements/:id", "host": [ "{{base_url}}" ], "path": [ "placements", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Ends the placement on valid_to (not before it began).", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/placements/:id/end", "host": [ "{{base_url}}" ], "path": [ "placements", ":id", "end" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"valid_to\": \"2026-06-30\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Makes it the person’s main placement; the previous main one becomes secondary.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/placements/:id/make-primary", "host": [ "{{base_url}}" ], "path": [ "placements", ":id", "make-primary" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Leave types", "description": "The kinds of leave the company uses, as configured in the app. Read-only.", "item": [ { "name": "List: Leave types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/leave-types?is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "leave-types" ], "query": [ { "key": "is_active", "value": "", "disabled": true, "description": "true or false." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Leave types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/leave-types/:id", "host": [ "{{base_url}}" ], "path": [ "leave-types", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Leave requests", "description": "Leave requests, through the same rules as the app: the working days are counted, the balance and overlapping requests are checked, and the company’s approval flow starts. Approving and rejecting follow the request’s flow: the key’s creator must be an approver of the current step.", "item": [ { "name": "List: Leave requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/leave-requests?employee_id=&status=&from=&to=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "leave-requests" ], "query": [ { "key": "employee_id", "value": "", "disabled": true, "description": "Only this person’s." }, { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "from", "value": "", "disabled": true, "description": "Touching this day or later." }, { "key": "to", "value": "", "disabled": true, "description": "Touching this day or earlier." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Leave requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/leave-requests/:id", "host": [ "{{base_url}}" ], "path": [ "leave-requests", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Leave requests", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/leave-requests", "host": [ "{{base_url}}" ], "path": [ "leave-requests" ] }, "body": { "mode": "raw", "raw": "{\n \"employee_id\": 345,\n \"leave_type_id\": 1,\n \"starts_on\": \"2026-07-06\",\n \"ends_on\": \"2026-07-10\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Approves the current step (comment optional).", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/leave-requests/:id/approve", "host": [ "{{base_url}}" ], "path": [ "leave-requests", ":id", "approve" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"comment\": null\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Rejects the request; comment (the reason) required.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/leave-requests/:id/reject", "host": [ "{{base_url}}" ], "path": [ "leave-requests", ":id", "reject" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"comment\": \"text\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancels a pending or approved request.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/leave-requests/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "leave-requests", ":id", "cancel" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Leave balances", "description": "Each person’s yearly balance per leave type that counts days. Listing a year opens it for every active person, pro rata and with carry-over, as the app does; used, pending and available are computed. The entitlement, adjustment and carry-over can be changed — never for the key creator’s own record.", "item": [ { "name": "List: Leave balances", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/leave-balances?year=&employee_id=&leave_type_id=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "leave-balances" ], "query": [ { "key": "year", "value": "", "disabled": true, "description": "The year (default: this year)." }, { "key": "employee_id", "value": "", "disabled": true, "description": "Only this person." }, { "key": "leave_type_id", "value": "", "disabled": true, "description": "Only this leave type." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Leave balances", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/leave-balances/:id", "host": [ "{{base_url}}" ], "path": [ "leave-balances", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Change: Leave balances", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/leave-balances/:id", "host": [ "{{base_url}}" ], "path": [ "leave-balances", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"entitlement\": 21,\n \"adjustment\": 0,\n \"carried_over\": 3,\n \"carried_over_expires_on\": \"2026-03-31\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Calendar events", "description": "The company calendar. Participants (or the unit) are notified of a new event, a new time or a new place. A new event may repeat: each occurrence becomes its own event in one series and is changed, cancelled or deleted on its own.", "item": [ { "name": "List: Calendar events", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/calendar-events?from=&to=&work_unit_id=&cancelled=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "calendar-events" ], "query": [ { "key": "from", "value": "", "disabled": true, "description": "Ending on this day or later." }, { "key": "to", "value": "", "disabled": true, "description": "Starting on this day or earlier." }, { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only this unit’s." }, { "key": "cancelled", "value": "", "disabled": true, "description": "true: only cancelled ones; false: only the rest." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Calendar events", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/calendar-events/:id", "host": [ "{{base_url}}" ], "path": [ "calendar-events", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Calendar events", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/calendar-events", "host": [ "{{base_url}}" ], "path": [ "calendar-events" ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Inventar trimestrial\",\n \"description\": \"

Toată echipa.

\",\n \"starts_at\": \"2026-07-06T15:00:00Z\",\n \"ends_at\": \"2026-07-06T17:00:00Z\",\n \"visibility\": \"everyone\",\n \"participants\": [\n 345,\n 346\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Calendar events", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/calendar-events/:id", "host": [ "{{base_url}}" ], "path": [ "calendar-events", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Inventar trimestrial\",\n \"description\": \"

Toată echipa.

\",\n \"starts_at\": \"2026-07-06T15:00:00Z\",\n \"ends_at\": \"2026-07-06T17:00:00Z\",\n \"visibility\": \"everyone\",\n \"participants\": [\n 345,\n 346\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Calendar events", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/calendar-events/:id", "host": [ "{{base_url}}" ], "path": [ "calendar-events", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Cancels this occurrence; participants are told.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/calendar-events/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "calendar-events", ":id", "cancel" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Performance", "item": [ { "name": "KPI metrics", "description": "What the company measures: each metric’s key, unit, the subjects it is measured for (grain) and how often (period). Read only; metrics are defined in the app. Values can be sent through the API only to metrics whose source is “api”.", "item": [ { "name": "List: KPI metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/kpi-metrics?key=&source_type=&is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "kpi-metrics" ], "query": [ { "key": "key", "value": "", "disabled": true, "description": "Exact key (case-insensitive)." }, { "key": "source_type", "value": "", "disabled": true, "description": "Only metrics with this source." }, { "key": "is_active", "value": "", "disabled": true, "description": "true or false." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: KPI metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/kpi-metrics/:id", "host": [ "{{base_url}}" ], "path": [ "kpi-metrics", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "KPI values", "description": "The value of a metric for one subject in one period. Creating one writes it (or replaces the value already there for that subject and period); only metrics whose source is “api” accept values. A missing value (null) means “no data”, never zero. To send many values by business reference (employee number, unit code) use POST /metrics/{key}/values.", "item": [ { "name": "List: KPI values", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/metric-values?metric=&period=&subject_id=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "metric-values" ], "query": [ { "key": "metric", "value": "", "disabled": true, "description": "Only this metric’s values (its key)." }, { "key": "period", "value": "", "disabled": true, "description": "Only this period (needs metric)." }, { "key": "subject_id", "value": "", "disabled": true, "description": "Only this subject." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: KPI values", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/metric-values/:id", "host": [ "{{base_url}}" ], "path": [ "metric-values", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: KPI values", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/metric-values", "host": [ "{{base_url}}" ], "path": [ "metric-values" ] }, "body": { "mode": "raw", "raw": "{\n \"metric\": \"sales.api\",\n \"subject_id\": 345,\n \"period\": \"2026-09\",\n \"value\": \"1234.5\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Scorecards", "description": "Scorecards and every version of them (draft, published, archived): the parts a score is made of, their weights, and the levels a score falls into. Read only; scorecards are built in the app, and a published version never changes.", "item": [ { "name": "List: Scorecards", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/kpi-scorecards?status=&family=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "kpi-scorecards" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "Only versions with this status." }, { "key": "family", "value": "", "disabled": true, "description": "Only the versions of this scorecard." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Scorecards", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/kpi-scorecards/:id", "host": [ "{{base_url}}" ], "path": [ "kpi-scorecards", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "KPI results", "description": "Scores on the scorecards: the current result of each subject and period, the level it reaches, and each part’s value and points. A total or part without data is null, never zero. Read only; results are produced when a period is closed.", "item": [ { "name": "List: KPI results", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/kpi-results?scorecard_id=&period=&subject_type=&subject_id=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "kpi-results" ], "query": [ { "key": "scorecard_id", "value": "", "disabled": true, "description": "Only this scorecard version." }, { "key": "period", "value": "", "disabled": true, "description": "First day of the period (Y-m-d)." }, { "key": "subject_type", "value": "", "disabled": true, "description": "Only this kind of subject." }, { "key": "subject_id", "value": "", "disabled": true, "description": "Only this subject." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: KPI results", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/kpi-results/:id", "host": [ "{{base_url}}" ], "path": [ "kpi-results", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Objectives", "description": "Objectives under a rule (for example “focus products”): their period, parameters and unit targets. The rule and period are fixed once created. The record action stores what people or units achieved; they are scored when the period is scored. An objective already scored cannot be deleted.", "item": [ { "name": "List: Objectives", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/objectives?rule_id=&period_start=&external_ref=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "objectives" ], "query": [ { "key": "rule_id", "value": "", "disabled": true, "description": "Only under this rule." }, { "key": "period_start", "value": "", "disabled": true, "description": "First day of the period (Y-m-d)." }, { "key": "external_ref", "value": "", "disabled": true, "description": "Your exact reference." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Objectives", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/objectives/:id", "host": [ "{{base_url}}" ], "path": [ "objectives", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Objectives", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/objectives", "host": [ "{{base_url}}" ], "path": [ "objectives" ] }, "body": { "mode": "raw", "raw": "{\n \"rule_id\": 2,\n \"name\": \"Vitamin C 1000\",\n \"period\": \"2026-09\",\n \"params\": {\n \"bonus\": \"2\"\n },\n \"targets\": [\n {\n \"work_unit_id\": 12,\n \"target\": \"30\"\n }\n ],\n \"external_ref\": \"CAMP-2026-09\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Objectives", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/objectives/:id", "host": [ "{{base_url}}" ], "path": [ "objectives", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"rule_id\": 2,\n \"name\": \"Vitamin C 1000\",\n \"period\": \"2026-09\",\n \"params\": {\n \"bonus\": \"2\"\n },\n \"targets\": [\n {\n \"work_unit_id\": 12,\n \"target\": \"30\"\n }\n ],\n \"external_ref\": \"CAMP-2026-09\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Objectives", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/objectives/:id", "host": [ "{{base_url}}" ], "path": [ "objectives", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Record what subjects achieved: their measures replace what was recorded before; empty measures forget it (no data again).", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/objectives/:id/record", "host": [ "{{base_url}}" ], "path": [ "objectives", ":id", "record" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"achievements\": [\n {\n \"subject_id\": 345,\n \"measures\": {\n \"pieces\": \"34\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Evaluations", "description": "Evaluations given on the grids: whom, by whom, for which period, the points and result, and each criterion’s answer. Read only; evaluations are given in the app. Drafts are the evaluator’s work in progress and are never listed.", "item": [ { "name": "List: Evaluations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reviews?status=&employee_id=&form_id=&period_start=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "reviews" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "submitted or cancelled." }, { "key": "employee_id", "value": "", "disabled": true, "description": "Only this person." }, { "key": "form_id", "value": "", "disabled": true, "description": "Only this grid version." }, { "key": "period_start", "value": "", "disabled": true, "description": "First day of the period (Y-m-d)." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Evaluations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reviews/:id", "host": [ "{{base_url}}" ], "path": [ "reviews", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] } ] }, { "name": "Training, audits and health & safety", "item": [ { "name": "Courses", "description": "The course catalogue. Title and description are written in the company’s language (other languages are translated in the app); chapters and covers are written in the app. A course can be deleted only while nobody was ever assigned it — archive it otherwise.", "item": [ { "name": "List: Courses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/courses?status=&category_id=&q=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "courses" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "category_id", "value": "", "disabled": true, "description": "Only in this category." }, { "key": "q", "value": "", "disabled": true, "description": "Part of the title." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Courses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/courses/:id", "host": [ "{{base_url}}" ], "path": [ "courses", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Courses", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/courses", "host": [ "{{base_url}}" ], "path": [ "courses" ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Siguranța la incendiu\",\n \"status\": \"published\",\n \"estimated_minutes\": 20,\n \"validity_months\": 12,\n \"issues_certificate\": true,\n \"recertifies\": false,\n \"points\": 10\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Courses", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/courses/:id", "host": [ "{{base_url}}" ], "path": [ "courses", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Siguranța la incendiu\",\n \"status\": \"published\",\n \"estimated_minutes\": 20,\n \"validity_months\": 12,\n \"issues_certificate\": true,\n \"recertifies\": false,\n \"points\": 10\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Courses", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/courses/:id", "host": [ "{{base_url}}" ], "path": [ "courses", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Learning assignments", "description": "A published course (or a standalone test) given to people: everyone, a unit, an area, a department, a position or named employees. The people are enrolled at once. Deleted only while nobody has started.", "item": [ { "name": "List: Learning assignments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/learning-assignments?course_id=&test_id=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "learning-assignments" ], "query": [ { "key": "course_id", "value": "", "disabled": true, "description": "Only for this course." }, { "key": "test_id", "value": "", "disabled": true, "description": "Only for this test." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Learning assignments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/learning-assignments/:id", "host": [ "{{base_url}}" ], "path": [ "learning-assignments", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Learning assignments", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/learning-assignments", "host": [ "{{base_url}}" ], "path": [ "learning-assignments" ] }, "body": { "mode": "raw", "raw": "{\n \"course_id\": 7,\n \"available_from\": \"2026-05-01\",\n \"due_on\": \"2026-05-31\",\n \"enrolls_newcomers\": true,\n \"targets\": [\n {\n \"type\": \"work_unit\",\n \"id\": 12\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Learning assignments", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/learning-assignments/:id", "host": [ "{{base_url}}" ], "path": [ "learning-assignments", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Enrolments", "description": "Who is enrolled in which course or test, and how far they got. Actions: a later due date, one more attempt, excusing someone who has not started.", "item": [ { "name": "List: Enrolments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/enrollments?employee_id=&course_id=&test_id=&assignment_id=&status=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "enrollments" ], "query": [ { "key": "employee_id", "value": "", "disabled": true, "description": "Only this person." }, { "key": "course_id", "value": "", "disabled": true, "description": "Only this course." }, { "key": "test_id", "value": "", "disabled": true, "description": "Only this test." }, { "key": "assignment_id", "value": "", "disabled": true, "description": "Only this assignment." }, { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Enrolments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/enrollments/:id", "host": [ "{{base_url}}" ], "path": [ "enrollments", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Set a later due date.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/enrollments/:id/extend", "host": [ "{{base_url}}" ], "path": [ "enrollments", ":id", "extend" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"due_on\": \"2026-06-30\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Allow one more test attempt (not once passed).", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/enrollments/:id/grant-attempt", "host": [ "{{base_url}}" ], "path": [ "enrollments", ":id", "grant-attempt" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Excuse the person (only before they start).", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/enrollments/:id/excuse", "host": [ "{{base_url}}" ], "path": [ "enrollments", ":id", "excuse" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Certificates", "description": "Certificates earned on finishing a course, with the code anyone can check on the certificate page.", "item": [ { "name": "List: Certificates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/certificates?employee_id=&course_id=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "certificates" ], "query": [ { "key": "employee_id", "value": "", "disabled": true, "description": "Only this person." }, { "key": "course_id", "value": "", "disabled": true, "description": "Only this course." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Certificates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/certificates/:id", "host": [ "{{base_url}}" ], "path": [ "certificates", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Audits", "description": "Audits of the units with their findings, item by item. Read only: an audit is conducted in the app.", "item": [ { "name": "List: Audits", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/audits?work_unit_id=&status=&conducted_from=&conducted_to=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "audits" ], "query": [ { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only this unit." }, { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "conducted_from", "value": "", "disabled": true, "description": "Conducted on or after this date." }, { "key": "conducted_to", "value": "", "disabled": true, "description": "Conducted on or before this date." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Audits", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/audits/:id", "host": [ "{{base_url}}" ], "path": [ "audits", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Audit action plans", "description": "Corrective actions set after audits. They move on as on the audit page: marked done with a note, verified, reopened with a reason, or cancelled.", "item": [ { "name": "List: Audit action plans", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/audit-action-plans?audit_id=&status=&responsible_id=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "audit-action-plans" ], "query": [ { "key": "audit_id", "value": "", "disabled": true, "description": "Only for this audit." }, { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "responsible_id", "value": "", "disabled": true, "description": "Only for this person." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Audit action plans", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/audit-action-plans/:id", "host": [ "{{base_url}}" ], "path": [ "audit-action-plans", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Mark an open action done.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/audit-action-plans/:id/mark-done", "host": [ "{{base_url}}" ], "path": [ "audit-action-plans", ":id", "mark-done" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"note\": null\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Accept a done action.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/audit-action-plans/:id/verify", "host": [ "{{base_url}}" ], "path": [ "audit-action-plans", ":id", "verify" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send a done action back, with the reason.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/audit-action-plans/:id/reopen", "host": [ "{{base_url}}" ], "path": [ "audit-action-plans", ":id", "reopen" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"text\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel an open or done action.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/audit-action-plans/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "audit-action-plans", ":id", "cancel" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Health & safety types", "description": "The kinds of health and safety training and checks the company records, with how long each is valid.", "item": [ { "name": "List: Health & safety types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ssm-types?is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "ssm-types" ], "query": [ { "key": "is_active", "value": "", "disabled": true, "description": "true or false." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Health & safety types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ssm-types/:id", "host": [ "{{base_url}}" ], "path": [ "ssm-types", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Health & safety records", "description": "Who had which health and safety training or check, when, and until when it is valid (computed from the type). One record per call.", "item": [ { "name": "List: Health & safety records", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ssm-records?employee_id=&type_id=&valid_until_before=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "ssm-records" ], "query": [ { "key": "employee_id", "value": "", "disabled": true, "description": "Only this person." }, { "key": "type_id", "value": "", "disabled": true, "description": "Only this type." }, { "key": "valid_until_before", "value": "", "disabled": true, "description": "Valid until this date or earlier." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Health & safety records", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ssm-records/:id", "host": [ "{{base_url}}" ], "path": [ "ssm-records", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Health & safety records", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ssm-records", "host": [ "{{base_url}}" ], "path": [ "ssm-records" ] }, "body": { "mode": "raw", "raw": "{\n \"employee_id\": 345,\n \"type_id\": 2,\n \"done_on\": \"2026-04-15\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Health & safety records", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ssm-records/:id", "host": [ "{{base_url}}" ], "path": [ "ssm-records", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] } ] }, { "name": "Documents, requests, surveys and communication", "item": [ { "name": "Document categories", "description": "The categories documents are filed under, for the whole company or for units.", "item": [ { "name": "List: Document categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/document-categories?scope=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "document-categories" ], "query": [ { "key": "scope", "value": "", "disabled": true, "description": "Only company or only unit categories." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Document categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/document-categories/:id", "host": [ "{{base_url}}" ], "path": [ "document-categories", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Documents", "description": "Permits, contracts and rules, with their expiry. The API reads a document’s details and its current file’s name, size and type; the file itself is downloaded in the app. A file is sent as {\"name\", \"content_base64\"} (the same types as in the app — PDF, Office, images, ZIP — at most 50 MB); sending a file to an existing document adds a new version. Deleting moves the document to the trash, where it can be restored in the app.", "item": [ { "name": "List: Documents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/documents?work_unit_id=&category_id=&company=&expires_before=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "documents" ], "query": [ { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only this unit’s documents." }, { "key": "category_id", "value": "", "disabled": true, "description": "Only this category." }, { "key": "company", "value": "", "disabled": true, "description": "true: company documents only; false: unit documents only." }, { "key": "expires_before", "value": "", "disabled": true, "description": "Expiring on or before this date." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Documents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/documents/:id", "host": [ "{{base_url}}" ], "path": [ "documents", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Documents", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/documents", "host": [ "{{base_url}}" ], "path": [ "documents" ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Autorizație sanitară de funcționare\",\n \"category_id\": 4,\n \"work_unit_id\": 12,\n \"is_internal\": false,\n \"expires_on\": \"2026-12-31\",\n \"repeat_months\": 12,\n \"alert_days\": [\n 30,\n 7\n ],\n \"file\": {\n \"name\": \"document.pdf\",\n \"content_base64\": \"JVBERi0xLjQK…\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Documents", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/documents/:id", "host": [ "{{base_url}}" ], "path": [ "documents", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Autorizație sanitară de funcționare\",\n \"category_id\": 4,\n \"work_unit_id\": 12,\n \"is_internal\": false,\n \"expires_on\": \"2026-12-31\",\n \"repeat_months\": 12,\n \"alert_days\": [\n 30,\n 7\n ],\n \"file\": {\n \"name\": \"document.pdf\",\n \"content_base64\": \"JVBERi0xLjQK…\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Documents", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/documents/:id", "host": [ "{{base_url}}" ], "path": [ "documents", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Service categories", "description": "What service requests are about (maintenance, IT…), and whether they need approval first.", "item": [ { "name": "List: Service categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/service-categories?is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "service-categories" ], "query": [ { "key": "is_active", "value": "", "disabled": true, "description": "true or false." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Service categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/service-categories/:id", "host": [ "{{base_url}}" ], "path": [ "service-categories", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Service requests", "description": "Requests to fix or provide something in a unit, with their history. Filed for the person given in requested_by (who must be able to file requests for that unit), or for the key’s creator; the category’s approval flow applies. Moved along with the move action, as the key’s creator may on the screen.", "item": [ { "name": "List: Service requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/service-requests?status=&category_id=&work_unit_id=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "service-requests" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "category_id", "value": "", "disabled": true, "description": "Only this category." }, { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only this unit." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Service requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/service-requests/:id", "host": [ "{{base_url}}" ], "path": [ "service-requests", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Service requests", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/service-requests", "host": [ "{{base_url}}" ], "path": [ "service-requests" ] }, "body": { "mode": "raw", "raw": "{\n \"category_id\": 2,\n \"work_unit_id\": 12,\n \"title\": \"Frigiderul de vaccinuri nu mai răcește\",\n \"description\": \"text\",\n \"requested_by\": 17\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Move the request to another status (in_progress, resolved, unresolved, open, cancelled), as the key’s creator may. Unresolved and reopening need a comment.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/service-requests/:id/move", "host": [ "{{base_url}}" ], "path": [ "service-requests", ":id", "move" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"awaiting_approval\",\n \"comment\": null\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Materials", "description": "What units can ask for, with the stock held now when it is tracked.", "item": [ { "name": "List: Materials", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/materials?is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "materials" ], "query": [ { "key": "is_active", "value": "", "disabled": true, "description": "true or false." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Materials", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/materials/:id", "host": [ "{{base_url}}" ], "path": [ "materials", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Material requests", "description": "Requests for materials, with their items. Filed for the person in requested_by (or the key’s creator), for an active material and a unit they may file for; then taken, completed (which takes the stock out) or cancelled, as the key’s creator may on the screen.", "item": [ { "name": "List: Material requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/material-requests?status=&work_unit_id=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "material-requests" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only this unit." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Material requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/material-requests/:id", "host": [ "{{base_url}}" ], "path": [ "material-requests", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Material requests", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/material-requests", "host": [ "{{base_url}}" ], "path": [ "material-requests" ] }, "body": { "mode": "raw", "raw": "{\n \"work_unit_id\": 12,\n \"requested_by\": 17,\n \"items\": [\n {\n \"material_id\": 7,\n \"quantity\": 5\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Take a new request to handle.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/material-requests/:id/take", "host": [ "{{base_url}}" ], "path": [ "material-requests", ":id", "take" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Complete it: the stock of tracked materials goes down.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/material-requests/:id/complete", "host": [ "{{base_url}}" ], "path": [ "material-requests", ":id", "complete" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel a request not yet completed.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/material-requests/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "material-requests", ":id", "cancel" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Surveys", "description": "Published and closed surveys with their questions, and their results as totals only: how many chose each answer, a scale’s average, and how many answered a free-text question — never what they wrote. An anonymous survey’s results stay hidden while its answers are sealed and while it has fewer than 5 answers.", "item": [ { "name": "List: Surveys", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/surveys?status=&is_anonymous=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "surveys" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "published or closed." }, { "key": "is_anonymous", "value": "", "disabled": true, "description": "true or false." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Surveys", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/surveys/:id", "host": [ "{{base_url}}" ], "path": [ "surveys", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Survey answers", "description": "Answers to named surveys, one response per person with its answers. An anonymous survey’s answers are never given one by one — only its totals, in /surveys.", "item": [ { "name": "List: Survey answers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/survey-responses?survey_id=&employee_id=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "survey-responses" ], "query": [ { "key": "survey_id", "value": "", "disabled": true, "description": "Only this survey’s answers." }, { "key": "employee_id", "value": "", "disabled": true, "description": "Only this person’s answers." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Survey answers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/survey-responses/:id", "host": [ "{{base_url}}" ], "path": [ "survey-responses", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Posts", "description": "Social posts for the whole company (not in a group), published. Created by the key’s creator: a post, or news, an announcement, a promotion or a contest when they may announce; the body is plain text, a blank line between paragraphs.", "item": [ { "name": "List: Posts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/posts?type=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "posts" ], "query": [ { "key": "type", "value": "", "disabled": true, "description": "Only this type." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Posts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/posts/:id", "host": [ "{{base_url}}" ], "path": [ "posts", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Posts", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/posts", "host": [ "{{base_url}}" ], "path": [ "posts" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"announcement\",\n \"title\": \"Program de sărbători\",\n \"body\": \"Între 24 și 26 decembrie programul este 9–14.\",\n \"comments_enabled\": true\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Knowledge base articles", "description": "The knowledge base’s published articles (procedures, how-tos), with the body as plain text, in the language asked for (Accept-Language) or the company’s.", "item": [ { "name": "List: Knowledge base articles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/knowledge-articles?category_id=&is_featured=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "knowledge-articles" ], "query": [ { "key": "category_id", "value": "", "disabled": true, "description": "Only this topic." }, { "key": "is_featured", "value": "", "disabled": true, "description": "true or false." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Knowledge base articles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/knowledge-articles/:id", "host": [ "{{base_url}}" ], "path": [ "knowledge-articles", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] } ] }, { "name": "Customers (CRM)", "item": [ { "name": "Customers", "description": "The people the company serves — customers and leads. An email is unique in the company (a second one is refused). Marketing consent is never written with the record: it changes only through the consent action, which keeps its history (given or withdrawn, how, when, by whom). The erase action wipes a person’s data on their request and cannot be undone: name, email, phone, notes and what was written about them go, the figures (purchases, deal values, scores) stay, and the record can no longer be changed.", "item": [ { "name": "List: Customers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-contacts?q=&email=&phone=&status=&work_unit_id=&owner_id=&account_id=&tag=&consent=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "crm-contacts" ], "query": [ { "key": "q", "value": "", "disabled": true, "description": "Name, email or phone containing this." }, { "key": "email", "value": "", "disabled": true, "description": "This exact email (case does not matter)." }, { "key": "phone", "value": "", "disabled": true, "description": "This phone number (only its digits are compared)." }, { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only this unit’s." }, { "key": "owner_id", "value": "", "disabled": true, "description": "Only this user’s." }, { "key": "account_id", "value": "", "disabled": true, "description": "Only this organisation’s." }, { "key": "tag", "value": "", "disabled": true, "description": "Only with this tag." }, { "key": "consent", "value": "", "disabled": true, "description": "true: only those who agree to marketing; false: only those who do not." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Customers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-contacts/:id", "host": [ "{{base_url}}" ], "path": [ "crm-contacts", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Customers", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-contacts", "host": [ "{{base_url}}" ], "path": [ "crm-contacts" ] }, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Ioana\",\n \"last_name\": \"Pop\",\n \"email\": \"ioana.pop@example.com\",\n \"phone\": \"0722 111 222\",\n \"account_id\": 31,\n \"city\": \"Cluj-Napoca\",\n \"country\": \"RO\",\n \"locale\": \"ro\",\n \"status\": \"customer\",\n \"source\": \"walk_in\",\n \"work_unit_id\": 12,\n \"owner_id\": 17,\n \"tags\": [\n \"loyalty\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Customers", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-contacts/:id", "host": [ "{{base_url}}" ], "path": [ "crm-contacts", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Ioana\",\n \"last_name\": \"Pop\",\n \"email\": \"ioana.pop@example.com\",\n \"phone\": \"0722 111 222\",\n \"account_id\": 31,\n \"city\": \"Cluj-Napoca\",\n \"country\": \"RO\",\n \"locale\": \"ro\",\n \"status\": \"customer\",\n \"source\": \"walk_in\",\n \"work_unit_id\": 12,\n \"owner_id\": 17,\n \"tags\": [\n \"loyalty\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Customers", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-contacts/:id", "host": [ "{{base_url}}" ], "path": [ "crm-contacts", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Record that the person gave or withdrew their marketing consent, and how.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-contacts/:id/consent", "host": [ "{{base_url}}" ], "path": [ "crm-contacts", ":id", "consent" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"granted\": true,\n \"channel\": \"api\",\n \"note\": null\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Erase the person’s data at their request (GDPR). Irreversible.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-contacts/:id/erase", "host": [ "{{base_url}}" ], "path": [ "crm-contacts", ":id", "erase" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Customer organisations", "description": "The companies and institutions the business sells to. The name is unique in the company. Deleting one keeps its contacts and deals, without the link.", "item": [ { "name": "List: Customer organisations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-accounts?q=&work_unit_id=&owner_id=&tag=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "crm-accounts" ], "query": [ { "key": "q", "value": "", "disabled": true, "description": "Name containing this." }, { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only this unit’s." }, { "key": "owner_id", "value": "", "disabled": true, "description": "Only this user’s." }, { "key": "tag", "value": "", "disabled": true, "description": "Only with this tag." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Customer organisations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-accounts/:id", "host": [ "{{base_url}}" ], "path": [ "crm-accounts", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Customer organisations", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-accounts", "host": [ "{{base_url}}" ], "path": [ "crm-accounts" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Hotel Sigma SRL\",\n \"registration_number\": \"J12/345/2019\",\n \"vat_number\": \"RO12345678\",\n \"industry\": \"Hospitality\",\n \"email\": \"office@sigma.example\",\n \"phone\": \"0264 000 111\",\n \"city\": \"Cluj-Napoca\",\n \"country\": \"RO\",\n \"work_unit_id\": 12,\n \"owner_id\": 17,\n \"tags\": [\n \"corporate\",\n \"events\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Customer organisations", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-accounts/:id", "host": [ "{{base_url}}" ], "path": [ "crm-accounts", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Hotel Sigma SRL\",\n \"registration_number\": \"J12/345/2019\",\n \"vat_number\": \"RO12345678\",\n \"industry\": \"Hospitality\",\n \"email\": \"office@sigma.example\",\n \"phone\": \"0264 000 111\",\n \"city\": \"Cluj-Napoca\",\n \"country\": \"RO\",\n \"work_unit_id\": 12,\n \"owner_id\": 17,\n \"tags\": [\n \"corporate\",\n \"events\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Customer organisations", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-accounts/:id", "host": [ "{{base_url}}" ], "path": [ "crm-accounts", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Sales pipelines", "description": "The pipelines deals go through, with their stages (set up in the app). Every company has a default one. A stage is open (with the chance a deal there is won) or closes the deal as won or lost.", "item": [ { "name": "List: Sales pipelines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-pipelines?page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "crm-pipelines" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Sales pipelines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-pipelines/:id", "host": [ "{{base_url}}" ], "path": [ "crm-pipelines", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Deals", "description": "Sales, bookings or contracts being worked through a pipeline. The pipeline and stage are chosen on create (the default pipeline’s first open stage when left out); afterwards a deal changes stage only through move, win, lose and reopen. Its status always follows its stage, and closed_at is set when it is won or lost. Winning a deal makes its contact a customer.", "item": [ { "name": "List: Deals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-deals?status=&pipeline_id=&stage_id=&work_unit_id=&owner_id=&contact_id=&account_id=&closed_since=&closed_until=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "crm-deals" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "Only open, won or lost." }, { "key": "pipeline_id", "value": "", "disabled": true, "description": "Only this pipeline’s." }, { "key": "stage_id", "value": "", "disabled": true, "description": "Only on this stage." }, { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only this unit’s." }, { "key": "owner_id", "value": "", "disabled": true, "description": "Only this user’s." }, { "key": "contact_id", "value": "", "disabled": true, "description": "Only this customer’s." }, { "key": "account_id", "value": "", "disabled": true, "description": "Only this organisation’s." }, { "key": "closed_since", "value": "", "disabled": true, "description": "Closed on or after this date." }, { "key": "closed_until", "value": "", "disabled": true, "description": "Closed on or before this date." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Deals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-deals/:id", "host": [ "{{base_url}}" ], "path": [ "crm-deals", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Deals", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-deals", "host": [ "{{base_url}}" ], "path": [ "crm-deals" ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Corporate rates 2027\",\n \"pipeline_id\": 1,\n \"stage_id\": 3,\n \"contact_id\": 120,\n \"account_id\": 31,\n \"value\": 12500.5,\n \"currency\": \"RON\",\n \"expected_close_on\": \"2026-12-15\",\n \"source\": \"referral\",\n \"work_unit_id\": 12,\n \"owner_id\": 17\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Deals", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-deals/:id", "host": [ "{{base_url}}" ], "path": [ "crm-deals", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Corporate rates 2027\",\n \"pipeline_id\": 1,\n \"stage_id\": 3,\n \"contact_id\": 120,\n \"account_id\": 31,\n \"value\": 12500.5,\n \"currency\": \"RON\",\n \"expected_close_on\": \"2026-12-15\",\n \"source\": \"referral\",\n \"work_unit_id\": 12,\n \"owner_id\": 17\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Deals", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-deals/:id", "host": [ "{{base_url}}" ], "path": [ "crm-deals", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Move the deal to another stage (of its pipeline, or of another one — the deal moves with it).", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-deals/:id/move", "host": [ "{{base_url}}" ], "path": [ "crm-deals", ":id", "move" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"stage_id\": 4\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark the deal won (its pipeline’s won stage).", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-deals/:id/win", "host": [ "{{base_url}}" ], "path": [ "crm-deals", ":id", "win" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark the deal lost (its pipeline’s lost stage), with why.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-deals/:id/lose", "host": [ "{{base_url}}" ], "path": [ "crm-deals", ":id", "lose" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"lost_reason\": \"Price\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Take a closed deal back to its pipeline’s last open stage.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-deals/:id/reopen", "host": [ "{{base_url}}" ], "path": [ "crm-deals", ":id", "reopen" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Customer activities", "description": "What was done, or is to be done, with customers: call, meeting, visit, email, note, task and purchase. A task waits until completed; anything else is done when logged (at done_at when given). A purchase needs its amount and makes its contact a customer. An activity of a deal takes the deal’s customer, organisation and unit when they are not given.", "item": [ { "name": "List: Customer activities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-activities?type=&work_unit_id=&owner_id=&contact_id=&deal_id=&done=&due_before=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "crm-activities" ], "query": [ { "key": "type", "value": "", "disabled": true, "description": "Only this type." }, { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only this unit’s." }, { "key": "owner_id", "value": "", "disabled": true, "description": "Only this user’s." }, { "key": "contact_id", "value": "", "disabled": true, "description": "Only this customer’s." }, { "key": "deal_id", "value": "", "disabled": true, "description": "Only this deal’s." }, { "key": "done", "value": "", "disabled": true, "description": "true: only done; false: only still to do." }, { "key": "due_before", "value": "", "disabled": true, "description": "Due before this moment." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Customer activities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-activities/:id", "host": [ "{{base_url}}" ], "path": [ "crm-activities", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Customer activities", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-activities", "host": [ "{{base_url}}" ], "path": [ "crm-activities" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"purchase\",\n \"subject\": \"Receipt 1243\",\n \"contact_id\": 120,\n \"amount\": 240,\n \"due_at\": \"2026-11-03T09:00:00Z\",\n \"done_at\": \"2026-11-02T15:20:00Z\",\n \"work_unit_id\": 12,\n \"owner_id\": 17\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Customer activities", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-activities/:id", "host": [ "{{base_url}}" ], "path": [ "crm-activities", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"purchase\",\n \"subject\": \"Receipt 1243\",\n \"contact_id\": 120,\n \"amount\": 240,\n \"due_at\": \"2026-11-03T09:00:00Z\",\n \"done_at\": \"2026-11-02T15:20:00Z\",\n \"work_unit_id\": 12,\n \"owner_id\": 17\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Customer activities", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-activities/:id", "host": [ "{{base_url}}" ], "path": [ "crm-activities", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Mark a task done (now).", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-activities/:id/complete", "host": [ "{{base_url}}" ], "path": [ "crm-activities", ":id", "complete" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark it not done again (not for purchases).", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-activities/:id/reopen", "host": [ "{{base_url}}" ], "path": [ "crm-activities", ":id", "reopen" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Customer feedback", "description": "What customers said: feedback (a 0–10 score — how likely they are to recommend the business — and/or a comment) and complaints. Feedback needs a score or a comment. A complaint stays open until resolved with what was done; it can be reopened. The kind is set on create.", "item": [ { "name": "List: Customer feedback", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-feedback?kind=&status=&work_unit_id=&contact_id=&received_since=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "crm-feedback" ], "query": [ { "key": "kind", "value": "", "disabled": true, "description": "Only feedback or only complaints." }, { "key": "status", "value": "", "disabled": true, "description": "Only open or only resolved." }, { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only this unit’s." }, { "key": "contact_id", "value": "", "disabled": true, "description": "Only this customer’s." }, { "key": "received_since", "value": "", "disabled": true, "description": "Received on or after this date." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Customer feedback", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-feedback/:id", "host": [ "{{base_url}}" ], "path": [ "crm-feedback", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Customer feedback", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-feedback", "host": [ "{{base_url}}" ], "path": [ "crm-feedback" ] }, "body": { "mode": "raw", "raw": "{\n \"kind\": \"feedback\",\n \"contact_id\": 120,\n \"score\": 9,\n \"comment\": \"Quick and friendly service.\",\n \"channel\": \"in_person\",\n \"received_on\": \"2026-11-02\",\n \"work_unit_id\": 12,\n \"owner_id\": 17\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Customer feedback", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-feedback/:id", "host": [ "{{base_url}}" ], "path": [ "crm-feedback", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"kind\": \"feedback\",\n \"contact_id\": 120,\n \"score\": 9,\n \"comment\": \"Quick and friendly service.\",\n \"channel\": \"in_person\",\n \"received_on\": \"2026-11-02\",\n \"work_unit_id\": 12,\n \"owner_id\": 17\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Customer feedback", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-feedback/:id", "host": [ "{{base_url}}" ], "path": [ "crm-feedback", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Resolve a complaint, saying what was done.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-feedback/:id/resolve", "host": [ "{{base_url}}" ], "path": [ "crm-feedback", ":id", "resolve" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"resolution\": \"Called the customer and refunded the delivery.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reopen a resolved complaint.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm-feedback/:id/reopen", "host": [ "{{base_url}}" ], "path": [ "crm-feedback", ":id", "reopen" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "In-store spaces and shelf space", "item": [ { "name": "Partners", "description": "The producers and brands whose campaigns go into the company's display spaces and onto its shelves: one list for both modules. A name is unique in the company. Writing needs the key creator to hold \"Manage partners\".", "item": [ { "name": "List: Partners", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-partners?q=&is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "merch-partners" ], "query": [ { "key": "q", "value": "", "disabled": true, "description": "Name containing the text." }, { "key": "is_active", "value": "", "disabled": true, "description": "true: active ones only; false: inactive ones only." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Partners", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-partners/:id", "host": [ "{{base_url}}" ], "path": [ "merch-partners", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Partners", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-partners", "host": [ "{{base_url}}" ], "path": [ "merch-partners" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Dermalab\",\n \"code\": \"DLB\",\n \"contact_name\": \"Ana Ionescu\",\n \"contact_email\": \"ana@dermalab.example\",\n \"contact_phone\": \"0722 000 111\",\n \"crm_account_id\": 31,\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Partners", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-partners/:id", "host": [ "{{base_url}}" ], "path": [ "merch-partners", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Dermalab\",\n \"code\": \"DLB\",\n \"contact_name\": \"Ana Ionescu\",\n \"contact_email\": \"ana@dermalab.example\",\n \"contact_phone\": \"0722 000 111\",\n \"crm_account_id\": 31,\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Zone types", "description": "In-store spaces: the kinds of zone the company has in many locations (a click frame, a counter stand, a totem), with their usual measurements and capacity. The monthly price is written only by who sees money.", "item": [ { "name": "List: Zone types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/space-zone-types?is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "space-zone-types" ], "query": [ { "key": "is_active", "value": "", "disabled": true, "description": "true: in use only; false: retired only." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Zone types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/space-zone-types/:id", "host": [ "{{base_url}}" ], "path": [ "space-zone-types", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Zone types", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/space-zone-types", "host": [ "{{base_url}}" ], "path": [ "space-zone-types" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Ramă click A2\",\n \"width_cm\": 50,\n \"height_cm\": 70,\n \"faces\": 2,\n \"capacity\": 2,\n \"capacity_label\": \"afișe A2\",\n \"is_display\": true,\n \"monthly_price\": 150,\n \"is_active\": true,\n \"sort\": 10\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Zone types", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/space-zone-types/:id", "host": [ "{{base_url}}" ], "path": [ "space-zone-types", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Ramă click A2\",\n \"width_cm\": 50,\n \"height_cm\": 70,\n \"faces\": 2,\n \"capacity\": 2,\n \"capacity_label\": \"afișe A2\",\n \"is_display\": true,\n \"monthly_price\": 150,\n \"is_active\": true,\n \"sort\": 10\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Zones in locations", "description": "In-store spaces: each location's zones (where, how big, how much fits on each face), only in the locations the key's creator lays out. A zone stays in its location. A new zone of a type takes the type's measurements for what is missing. Fewer faces or less room than its running campaigns need is refused; a zone with campaigns cannot be deleted.", "item": [ { "name": "List: Zones in locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/space-zones?work_unit_id=&zone_type_id=&status=&is_display=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "space-zones" ], "query": [ { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only this location's." }, { "key": "zone_type_id", "value": "", "disabled": true, "description": "Only of this type." }, { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "is_display", "value": "", "disabled": true, "description": "true: display spaces only." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Zones in locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/space-zones/:id", "host": [ "{{base_url}}" ], "path": [ "space-zones", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Zones in locations", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/space-zones", "host": [ "{{base_url}}" ], "path": [ "space-zones" ] }, "body": { "mode": "raw", "raw": "{\n \"work_unit_id\": 12,\n \"zone_type_id\": 2,\n \"name\": \"Ramă click intrare\",\n \"width_cm\": 50,\n \"height_cm\": 70,\n \"faces\": 2,\n \"capacity\": 2,\n \"capacity_label\": \"afișe A2\",\n \"is_display\": true,\n \"monthly_price\": 150,\n \"status\": \"active\",\n \"sort\": 100\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Zones in locations", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/space-zones/:id", "host": [ "{{base_url}}" ], "path": [ "space-zones", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"work_unit_id\": 12,\n \"zone_type_id\": 2,\n \"name\": \"Ramă click intrare\",\n \"width_cm\": 50,\n \"height_cm\": 70,\n \"faces\": 2,\n \"capacity\": 2,\n \"capacity_label\": \"afișe A2\",\n \"is_display\": true,\n \"monthly_price\": 150,\n \"status\": \"active\",\n \"sort\": 100\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Zones in locations", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/space-zones/:id", "host": [ "{{base_url}}" ], "path": [ "space-zones", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Fixtures and rates", "description": "Shelf space: the kinds of fixture (a gondola, an end cap, a fridge) with the rate card — per product facing or per metre of shelf, a month. Rates are written only by who holds the shelf-prices right.", "item": [ { "name": "List: Fixtures and rates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-fixture-types?is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "shelf-fixture-types" ], "query": [ { "key": "is_active", "value": "", "disabled": true, "description": "true: in use only." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Fixtures and rates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-fixture-types/:id", "host": [ "{{base_url}}" ], "path": [ "shelf-fixture-types", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Fixtures and rates", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-fixture-types", "host": [ "{{base_url}}" ], "path": [ "shelf-fixture-types" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Gondolă\",\n \"face_price\": 25,\n \"is_active\": true,\n \"sort\": 10\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Fixtures and rates", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-fixture-types/:id", "host": [ "{{base_url}}" ], "path": [ "shelf-fixture-types", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Gondolă\",\n \"face_price\": 25,\n \"is_active\": true,\n \"sort\": 10\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Planograms", "description": "Shelf space: planograms described once — the fixture, the measurements, the shelves top to bottom with what fits on each (facings or centimetres) and its price factor. Sending shelves replaces the list of shelves; a shelf with campaigns cannot be taken away. A name is unique.", "item": [ { "name": "List: Planograms", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-planograms?fixture_type_id=&is_active=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "shelf-planograms" ], "query": [ { "key": "fixture_type_id", "value": "", "disabled": true, "description": "Only with this fixture." }, { "key": "is_active", "value": "", "disabled": true, "description": "true: active only." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Planograms", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-planograms/:id", "host": [ "{{base_url}}" ], "path": [ "shelf-planograms", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Planograms", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-planograms", "host": [ "{{base_url}}" ], "path": [ "shelf-planograms" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Capăt de raft vitamine\",\n \"code\": \"CR-VIT\",\n \"fixture_type_id\": 2,\n \"category\": \"Suplimente\",\n \"width_cm\": 100,\n \"height_cm\": 180,\n \"capacity_unit\": \"faces\",\n \"is_active\": true,\n \"shelves\": [\n {\n \"position\": 1,\n \"label\": null,\n \"capacity\": 8,\n \"price_factor\": 1.2\n },\n {\n \"position\": 2,\n \"label\": \"La nivelul ochilor\",\n \"capacity\": 8,\n \"price_factor\": 1.5\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Planograms", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-planograms/:id", "host": [ "{{base_url}}" ], "path": [ "shelf-planograms", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Capăt de raft vitamine\",\n \"code\": \"CR-VIT\",\n \"fixture_type_id\": 2,\n \"category\": \"Suplimente\",\n \"width_cm\": 100,\n \"height_cm\": 180,\n \"capacity_unit\": \"faces\",\n \"is_active\": true,\n \"shelves\": [\n {\n \"position\": 1,\n \"label\": null,\n \"capacity\": 8,\n \"price_factor\": 1.2\n },\n {\n \"position\": 2,\n \"label\": \"La nivelul ochilor\",\n \"capacity\": 8,\n \"price_factor\": 1.5\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Placed planograms", "description": "Shelf space: a planogram set up in a location, with its own label, note and costs, only in the locations the key's creator lays out. Deleting takes it out of the location: kept for its campaigns' history, or gone if it had none; never while a campaign runs on it. Costs are written only by who sees prices.", "item": [ { "name": "List: Placed planograms", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-placements?work_unit_id=&planogram_id=&status=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "shelf-placements" ], "query": [ { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only in this location." }, { "key": "planogram_id", "value": "", "disabled": true, "description": "Only this planogram." }, { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Placed planograms", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-placements/:id", "host": [ "{{base_url}}" ], "path": [ "shelf-placements", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Placed planograms", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-placements", "host": [ "{{base_url}}" ], "path": [ "shelf-placements" ] }, "body": { "mode": "raw", "raw": "{\n \"planogram_id\": 4,\n \"work_unit_id\": 12,\n \"label\": \"lângă casă\",\n \"installed_on\": \"2026-02-18\",\n \"monthly_cost\": 25\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Placed planograms", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-placements/:id", "host": [ "{{base_url}}" ], "path": [ "shelf-placements", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"planogram_id\": 4,\n \"work_unit_id\": 12,\n \"label\": \"lângă casă\",\n \"installed_on\": \"2026-02-18\",\n \"monthly_cost\": 25\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Placed planograms", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/shelf-placements/:id", "host": [ "{{base_url}}" ], "path": [ "shelf-placements", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } } ] }, { "name": "Campaigns", "description": "Campaigns of both modules (module: spaces — display zones; shelf — planogram shelves), written as the key's creator. A campaign starts as a draft: its locations (units) and the rules naming places in them (rules) become its places. The launch action checks room and sends it to each location; cancel stops it. A launched campaign keeps its dates and places; only its text, partner, money and photo requirement change. Value and cost are written only by who sees money.", "item": [ { "name": "List: Campaigns", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-campaigns?module=&status=&partner_id=&active_on=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "merch-campaigns" ], "query": [ { "key": "module", "value": "", "disabled": true, "description": "Only this module." }, { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "partner_id", "value": "", "disabled": true, "description": "Only this partner's." }, { "key": "active_on", "value": "", "disabled": true, "description": "Only those running on this day (YYYY-MM-DD)." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Campaigns", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-campaigns/:id", "host": [ "{{base_url}}" ], "path": [ "merch-campaigns", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Create: Campaigns", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-campaigns", "host": [ "{{base_url}}" ], "path": [ "merch-campaigns" ] }, "body": { "mode": "raw", "raw": "{\n \"module\": \"shelf\",\n \"title\": \"Dermalab – raftul de la ochi\",\n \"partner_id\": 3,\n \"starts_on\": \"2026-11-02\",\n \"ends_on\": \"2026-11-30\",\n \"implement_days\": 3,\n \"remove_days\": 2,\n \"proof_required\": true,\n \"value\": 9600,\n \"cost\": 0,\n \"units\": [\n 12,\n 13\n ],\n \"rules\": [\n {\n \"planogram_id\": 4,\n \"position\": 2,\n \"quantity\": 6,\n \"products\": \"Vitamina D3\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change: Campaigns", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-campaigns/:id", "host": [ "{{base_url}}" ], "path": [ "merch-campaigns", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"module\": \"shelf\",\n \"title\": \"Dermalab – raftul de la ochi\",\n \"partner_id\": 3,\n \"starts_on\": \"2026-11-02\",\n \"ends_on\": \"2026-11-30\",\n \"implement_days\": 3,\n \"remove_days\": 2,\n \"proof_required\": true,\n \"value\": 9600,\n \"cost\": 0,\n \"units\": [\n 12,\n 13\n ],\n \"rules\": [\n {\n \"planogram_id\": 4,\n \"position\": 2,\n \"quantity\": 6,\n \"products\": \"Vitamina D3\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete: Campaigns", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-campaigns/:id", "host": [ "{{base_url}}" ], "path": [ "merch-campaigns", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Launch the draft: check room and send it to each location.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-campaigns/:id/launch", "host": [ "{{base_url}}" ], "path": [ "merch-campaigns", ":id", "launch" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel a launched campaign: it does not start where it was not put up, and comes down where it is up.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-campaigns/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "merch-campaigns", ":id", "cancel" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Implementation in locations", "description": "A launched campaign in one location: who puts it up and by when, whether it is up, refused (with the reason), being taken down or done. Actions are done as the key's creator (who implements there or, for reopen, who runs the campaign). Photos are sent as base64 images; a campaign that asks for them cannot be confirmed without.", "item": [ { "name": "List: Implementation in locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-executions?campaign_id=&work_unit_id=&status=&module=&late=&page=&per_page=", "host": [ "{{base_url}}" ], "path": [ "merch-executions" ], "query": [ { "key": "campaign_id", "value": "", "disabled": true, "description": "Only this campaign's." }, { "key": "work_unit_id", "value": "", "disabled": true, "description": "Only in this location." }, { "key": "status", "value": "", "disabled": true, "description": "Only with this status." }, { "key": "module", "value": "", "disabled": true, "description": "Only this module." }, { "key": "late", "value": "", "disabled": true, "description": "true: late ones only." }, { "key": "page", "value": "", "disabled": true, "description": "" }, { "key": "per_page", "value": "", "disabled": true, "description": "" } ] } } }, { "name": "One record: Implementation in locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-executions/:id", "host": [ "{{base_url}}" ], "path": [ "merch-executions", ":id" ], "variable": [ { "key": "id", "value": "1" } ] } } }, { "name": "Confirm it is up (with photos, if asked).", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-executions/:id/confirm", "host": [ "{{base_url}}" ], "path": [ "merch-executions", ":id", "confirm" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"photos\": [\n {\n \"name\": \"raft.jpg\",\n \"content_base64\": \"/9j/4AAQ…\"\n }\n ],\n \"note\": null\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Say it cannot be put up, with the reason.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-executions/:id/refuse", "host": [ "{{base_url}}" ], "path": [ "merch-executions", ":id", "refuse" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Afișele nu au ajuns în locație.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Ask a location that refused again (who runs the campaign).", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-executions/:id/reopen", "host": [ "{{base_url}}" ], "path": [ "merch-executions", ":id", "reopen" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Confirm the materials were taken down.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/merch-executions/:id/removed", "host": [ "{{base_url}}" ], "path": [ "merch-executions", ":id", "removed" ], "variable": [ { "key": "id", "value": "1" } ] }, "body": { "mode": "raw", "raw": "{\n \"photos\": [\n {\n \"name\": \"raft.jpg\",\n \"content_base64\": \"/9j/4AAQ…\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "KPI values", "item": [ { "name": "The metrics that accept values through the API", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/metrics", "host": [ "{{base_url}}" ], "path": [ "metrics" ] } } }, { "name": "Push values for a metric and a period", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/metrics/:key/values", "host": [ "{{base_url}}" ], "path": [ "metrics", ":key", "values" ], "variable": [ { "key": "key", "value": "sales.actual" } ] }, "body": { "mode": "raw", "raw": "{\n \"period\": \"2026-09\",\n \"values\": [\n {\n \"subject\": \"CJ01\",\n \"value\": 1234.5\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }