{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/horeca-hero.com" } ], "info": { "name": "HERO API Documentation", "_postman_id": "34fbe213-151c-4210-9ec4-377ad5b6b4c8", "description": "The HERO API provides a comprehensive and secure interface for integrating with our platform. This RESTful API enables seamless access to user management.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "User management", "description": "APIs for managing users", "item": [ { "name": "List users", "request": { "url": { "host": "{{baseUrl}}", "path": "api-clients\/v1\/employees", "query": [], "raw": "{{baseUrl}}\/api-clients\/v1\/employees" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "Content-Type", "value": "application\/json" } ], "body": null, "description": " Get a paginated list of users based on your client." }, "response": [ { "header": [], "code": 200, "body": " {\n \"data\": [\n {\n \"employee_id\": \"user_54322\",\n \"email\": \"john8@example.com\",\n \"first_name\": \"John8\",\n \"last_name\": \"Doe8\",\n \"status\": \"active\",\n \"businesses\": [\n {\n \"business_id\": \"FRAPQ\",\n \"role\": \"User\"\n },\n {\n \"business_id\": \"ZRHZQ\",\n \"role\": \"GM\"\n }\n ],\n \"created_at\": \"2025-06-02T06:20:25.000000Z\",\n \"updated_at\": \"2025-10-13T08:44:07.000000Z\"\n },\n {\n \"employee_id\": \"user_54321\",\n \"email\": \"john7@example.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"status\": \"active\",\n \"businesses\": [\n {\n \"business_id\": \"FRAPQ\",\n \"role\": \"User\"\n },\n {\n \"business_id\": \"ZRHZQ\",\n \"role\": \"User\"\n }\n ],\n \"created_at\": \"2025-05-09T10:07:34.000000Z\",\n \"updated_at\": \"2025-05-09T10:07:34.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/horeca-hero.com\/api-clients\/v1\/employees?page=1\",\n \"last\": \"https:\/\/horeca-hero.com\/api-clients\/v1\/employees?page=2\",\n \"prev\": null,\n \"next\": \"https:\/\/horeca-hero.com\/api-clients\/v1\/employees?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 2,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Zur\u00fcck\",\n \"active\": false\n },\n {\n \"url\": \"https:\/\/horeca-hero.com\/api-clients\/v1\/employees?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"https:\/\/horeca-hero.com\/api-clients\/v1\/employees?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"https:\/\/horeca-hero.com\/api-clients\/v1\/employees?page=2\",\n \"label\": \"Weiter »\",\n \"active\": false\n }\n ],\n \"path\": \"https:\/\/horeca-hero.com\/api-clients\/v1\/employees\",\n \"per_page\": 2,\n \"to\": 2,\n \"total\": 3\n }\n}", "name": "" } ] }, { "name": "Create user", "request": { "url": { "host": "{{baseUrl}}", "path": "api-clients\/v1\/employees", "query": [], "raw": "{{baseUrl}}\/api-clients\/v1\/employees" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"businesses\":[{\"business_id\":\"ZRHZQ\",\"role\":\"User\"}],\"employee_id\":\"user_54321\",\"email\":\"example@test.com\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"status\":\"active\"}" }, "description": " Create a user based on your body parameters." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"employee_id\": \"user_54322\",\n \"email\": \"john.doe.user-5432567.SOLWot@horeca-hero.com\",\n \"first_name\": \"John7\",\n \"last_name\": \"Doe7\",\n \"status\": \"active\",\n \"businesses\": [\n {\n \"business_id\": \"FRAPQ\",\n \"role\": \"User\"\n },\n {\n \"business_id\": \"ZRHZQ\",\n \"role\": \"GM\"\n }\n ],\n \"created_at\": \"2025-06-02T06:20:25.000000Z\",\n \"updated_at\": \"2025-10-13T08:44:07.000000Z\"\n }\n}", "name": "" } ] }, { "name": "Update user", "request": { "url": { "host": "{{baseUrl}}", "path": "api-clients\/v1\/employees\/:employee", "query": [], "raw": "{{baseUrl}}\/api-clients\/v1\/employees\/:employee", "variable": [ { "id": "employee", "key": "employee", "value": "user_54321", "description": "The ID of the user." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"businesses\":[{\"business_id\":\"ZRHZQ\",\"role\":\"User\"}],\"employee_id\":\"user_54321\",\"email\":\"example@test.com\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"status\":\"active\"}" }, "description": " Update a user based on your body parameters by the given client and user id." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"employee_id\": \"user_54322\",\n \"email\": \"john.doe.user-5432567.SOLWot@horeca-hero.com\",\n \"first_name\": \"John7\",\n \"last_name\": \"Doe7\",\n \"status\": \"active\",\n \"businesses\": [\n {\n \"business_id\": \"FRAPQ\",\n \"role\": \"User\"\n },\n {\n \"business_id\": \"ZRHZQ\",\n \"role\": \"GM\"\n }\n ],\n \"created_at\": \"2025-06-02T06:20:25.000000Z\",\n \"updated_at\": \"2025-10-13T08:44:07.000000Z\"\n }\n}", "name": "" } ] }, { "name": "Show user details", "request": { "url": { "host": "{{baseUrl}}", "path": "api-clients\/v1\/employees\/:employee", "query": [], "raw": "{{baseUrl}}\/api-clients\/v1\/employees\/:employee", "variable": [ { "id": "employee", "key": "employee", "value": "user_54321", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": " Show user details based on your client and user id." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"employee_id\": \"user_54322\",\n \"email\": \"john.doe.user-5432567.SOLWot@horeca-hero.com\",\n \"first_name\": \"John7\",\n \"last_name\": \"Doe7\",\n \"status\": \"active\",\n \"businesses\": [\n {\n \"business_id\": \"FRAPQ\",\n \"role\": \"User\"\n },\n {\n \"business_id\": \"ZRHZQ\",\n \"role\": \"GM\"\n }\n ],\n \"created_at\": \"2025-06-02T06:20:25.000000Z\",\n \"updated_at\": \"2025-10-13T08:44:07.000000Z\"\n }\n}", "name": "" } ] }, { "name": "Update user", "request": { "url": { "host": "{{baseUrl}}", "path": "api-clients\/v1\/employees\/:employee", "query": [], "raw": "{{baseUrl}}\/api-clients\/v1\/employees\/:employee", "variable": [ { "id": "employee", "key": "employee", "value": "user_54321", "description": "The ID of the user." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": " Delete a user based on the given client and user id.\n