{worker_name}, geboren am {worker_birth_date}, {worker_address}<\/p>\\n
{organization_name}, {organization_address}<\/p>\\n
T\u00e4tigkeit: {job_title}
Einsatzort: {location}
Zeitraum: {start_date} \u2013 {end_date}
Entgelt (brutto\/Std.): {hourly_rate}
Kollektivvertrag: {collective_agreement}<\/p>\\n
F\u00fcr die Dauer der \u00dcberlassung gelten gem\u00e4\u00df \u00a7 10 A\u00dcG die im Besch\u00e4ftigerbetrieb f\u00fcr vergleichbare Arbeitnehmer geltenden wesentlichen Arbeits- und Besch\u00e4ftigungsbedingungen. Rechtsgrundlage: {legal_basis}.<\/p>\",\n \"version\": 0,\n \"is_active\": false,\n \"is_customized\": false\n },\n \"merge_fields\": [\n \"contract_number\",\n \"worker_name\",\n \"worker_birth_date\",\n \"worker_nationality\",\n \"worker_address\",\n \"organization_name\",\n \"organization_address\",\n \"job_title\",\n \"job_description\",\n \"location\",\n \"start_date\",\n \"end_date\",\n \"hourly_rate\",\n \"collective_agreement\",\n \"legal_basis\"\n ]\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Update Job Contract Template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/jobs\/:jobId\/contract-template", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/jobs\/:jobId\/contract-template", "variable": [ { "id": "jobId", "key": "jobId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Beispieltext\",\"body_html\":\"Bitte um Rueckmeldung zur naechsten Schicht.\",\"is_active\":true,\"inherit\":true}" }, "description": "Save (or reset) a job's contract template override. `inherit: true` deletes\nthe job-level row so the job falls back to the organisation default;\notherwise the body is upserted, seeded from the resolved parent (the\norganisation default, or the built-in body) the first time a job is\ncustomised." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"The contract template has been saved.\",\n \"data\": {\n \"template\": {\n \"name\": \"\u00dcberlassungsvertrag\",\n \"body_html\": \"
{worker_name}, geboren am {worker_birth_date}, {worker_address}<\/p>\\n
{organization_name}, {organization_address}<\/p>\\n
T\u00e4tigkeit: {job_title}
Einsatzort: {location}
Zeitraum: {start_date} \u2013 {end_date}
Entgelt (brutto\/Std.): {hourly_rate}
Kollektivvertrag: {collective_agreement}<\/p>\\n
F\u00fcr die Dauer der \u00dcberlassung gelten gem\u00e4\u00df \u00a7 10 A\u00dcG die im Besch\u00e4ftigerbetrieb f\u00fcr vergleichbare Arbeitnehmer geltenden wesentlichen Arbeits- und Besch\u00e4ftigungsbedingungen. Rechtsgrundlage: {legal_basis}.<\/p>\",\n \"version\": 0,\n \"is_active\": false,\n \"is_customized\": false\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Shortlist Applicant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/jobs\/:jobId\/applicants\/:applicationId\/shortlist", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/jobs\/:jobId\/applicants\/:applicationId\/shortlist", "variable": [ { "id": "jobId", "key": "jobId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." }, { "id": "applicationId", "key": "applicationId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Shortlist an applicant for consideration." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"messages.applicant_shortlisted\",\n \"data\": {\n \"application\": {\n \"id\": \"019fd2b8-76c6-72bb-a2d9-98ed4934fb02\",\n \"status\": \"shortlisted\",\n \"shortlisted_at\": \"2026-08-05 16:18\"\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Select Applicant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/jobs\/:jobId\/applicants\/:applicationId\/select", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/jobs\/:jobId\/applicants\/:applicationId\/select", "variable": [ { "id": "jobId", "key": "jobId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." }, { "id": "applicationId", "key": "applicationId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Select an applicant for the job and create their shifts." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"The applicant has been selected and assigned to shifts.\",\n \"data\": {\n \"application\": {\n \"id\": \"019fd2b8-76c6-72bb-a2d9-98ed4934fb02\",\n \"status\": \"selected\",\n \"selected_at\": \"2026-08-05 16:18\"\n },\n \"shifts_created\": 1,\n \"job_vacancies\": {\n \"total\": 3,\n \"filled\": 0,\n \"available\": 3\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Add To Waitlist", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/jobs\/:jobId\/applicants\/:applicationId\/waitlist", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/jobs\/:jobId\/applicants\/:applicationId\/waitlist", "variable": [ { "id": "jobId", "key": "jobId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." }, { "id": "applicationId", "key": "applicationId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"position\":1}" }, "description": "Add an applicant to the waitlist (standby)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"messages.applicant_added_to_waitlist\",\n \"data\": {\n \"application\": {\n \"id\": \"019fd2b8-7cd7-7331-a92c-cf1a3939282f\",\n \"status\": \"standby\",\n \"waitlist_position\": 1,\n \"added_to_waitlist_at\": \"2026-08-05 16:18\"\n },\n \"waitlist_summary\": {\n \"total\": 1,\n \"max_size\": 5,\n \"positions\": [\n {\n \"position\": 1,\n \"application_id\": \"019fd2b8-7cd7-7331-a92c-cf1a3939282f\",\n \"added_at\": \"2026-08-05 16:18\"\n }\n ]\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Reject Applicant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/jobs\/:jobId\/applicants\/:applicationId\/reject", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/jobs\/:jobId\/applicants\/:applicationId\/reject", "variable": [ { "id": "jobId", "key": "jobId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." }, { "id": "applicationId", "key": "applicationId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason_code\":\"position_filled\",\"internal_note\":\"Beispieltext\"}" }, "description": "Reject an applicant for the job." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"The applicant has been rejected.\",\n \"data\": {\n \"application\": {\n \"id\": \"019fd2b8-7cd7-7331-a92c-cf1a3939282f\",\n \"status\": \"rejected\",\n \"rejected_at\": \"2026-08-05 16:18\"\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Deassign Shift", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/jobs\/:jobId\/applicants\/:applicationId\/shifts\/:shiftId\/deassign", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/jobs\/:jobId\/applicants\/:applicationId\/shifts\/:shiftId\/deassign", "variable": [ { "id": "jobId", "key": "jobId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." }, { "id": "applicationId", "key": "applicationId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." }, { "id": "shiftId", "key": "shiftId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Krankheitsbedingt kurzfristig abgesagt.\"}" }, "description": "De-assign a worker from one of their chosen shifts." }, "response": [] } ] }, { "name": "Applicants", "description": "", "item": [ { "name": "Get a single applicant's profile.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/jobs\/:jobId\/applicants\/:applicationId", "query": [ { "key": "reveal", "value": "1", "description": "Unmask the applicant's identity. Requires `audit.view`; audited.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org\/jobs\/:jobId\/applicants\/:applicationId?reveal=1", "variable": [ { "id": "jobId", "key": "jobId", "value": "architecto", "description": "" }, { "id": "applicationId", "key": "applicationId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Per Austrian A\u00dcG (Arbeitskr\u00e4fte\u00fcberlassungsgesetz), client organizations\nmust be able to verify worker qualifications before assignment \u2014 but not\ntheir identity, which stays masked until the company selects them.\n\nPassing `reveal=true` unmasks it early. That requires the `audit.view`\npermission and writes an OrgPiiReveal audit entry before the data is\nreturned, so the record is made where the disclosure actually happens rather\nthan wherever a client chooses to report it." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"id\": \"019fd2b8-76c6-72bb-a2d9-98ed4934fb02\",\n \"status\": \"selected\",\n \"status_label\": \"Ausgew\u00e4hlt\",\n \"applied_at\": \"2026-08-05 16:18\",\n \"has_scheduling_conflict\": false,\n \"acknowledged_conflict\": false,\n \"shortlisted_at\": \"2026-08-05 16:18\",\n \"selected_at\": \"2026-08-05 16:18\",\n \"rejected_at\": null,\n \"notes\": null,\n \"chosen_shifts\": [\n {\n \"id\": \"019fd2b8-756e-70aa-a7ad-01157af79df0\",\n \"shift_date\": \"2026-08-12\",\n \"start_time\": \"08:00:00\",\n \"end_time\": \"16:00:00\"\n }\n ],\n \"cover_letter\": null,\n \"availability\": null,\n \"expected_hourly_rate\": null,\n \"application_documents\": [],\n \"user\": {\n \"id\": \"019fd2b8-7352-72bc-9514-ac7713e5c225\",\n \"display_name\": \"Fae Green\",\n \"first_name\": \"Fae\",\n \"last_name\": \"Green\",\n \"email\": \"ruthie17@example.com\",\n \"phone\": null,\n \"avatar_url\": null\n },\n \"profile\": {\n \"nationality\": \"AT\",\n \"city\": \"North Asa\",\n \"gender\": \"not_specified\",\n \"date_of_birth\": \"2007-02-21\",\n \"profile_completion_percentage\": 86,\n \"avg_rating\": 0,\n \"reliability_score\": 100,\n \"punctuality_percentage\": null,\n \"hours_worked\": 0,\n \"total_shifts_completed\": 0,\n \"no_shows_count\": 0,\n \"bio\": null,\n \"education\": null,\n \"skills\": [],\n \"languages\": [],\n \"certifications\": [],\n \"reviews\": [],\n \"documents\": []\n }\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 403, "body": "{\"status\":\"FORBIDDEN\",\"message\":\"You are not permitted to reveal applicant identities.\"}", "name": "Not permitted to reveal" } ] } ] }, { "name": "Shifts", "description": "", "item": [ { "name": "Get Shift Detail", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/:shiftId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/:shiftId", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a single shift slot with its worker assignments and each\nassignment's live check-in \/ clock state \u2014 backs the portal's live\nshift view page." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"shift\": {\n \"id\": \"019fd2b8-28d5-7103-b951-9f6ff1d94556\",\n \"job\": {\n \"id\": \"019fd2b8-28c4-732f-a94c-fb5a71a7d682\",\n \"title\": \"Accountant\"\n },\n \"shift_date\": \"2026-08-05\",\n \"start_time\": \"08:00:00\",\n \"end_time\": \"16:00:00\",\n \"break_minutes\": 30,\n \"workers_needed\": 2,\n \"notes\": null,\n \"status\": \"scheduled\",\n \"status_label\": \"Geplant\",\n \"shift_manager\": null,\n \"counts\": {\n \"needed\": 2,\n \"awaiting_signature\": 0,\n \"signed\": 0,\n \"checked_in\": 0,\n \"completed\": 0,\n \"no_show\": 0\n },\n \"assignments\": []\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Get Shift Contract Template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/:shiftId\/contract-template", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/:shiftId\/contract-template", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "A shift's contract template for the shift editor: the shift-level override\nwhen one exists (\"customized\"), otherwise the effective template inherited\nfrom the job override (or the organisation default, or the built-in body)\n\u2014 plus the merge fields." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"template\": {\n \"name\": \"\u00dcberlassungsvertrag\",\n \"body_html\": \"
{worker_name}, geboren am {worker_birth_date}, {worker_address}<\/p>\\n
{organization_name}, {organization_address}<\/p>\\n
T\u00e4tigkeit: {job_title}
Einsatzort: {location}
Zeitraum: {start_date} \u2013 {end_date}
Entgelt (brutto\/Std.): {hourly_rate}
Kollektivvertrag: {collective_agreement}<\/p>\\n
F\u00fcr die Dauer der \u00dcberlassung gelten gem\u00e4\u00df \u00a7 10 A\u00dcG die im Besch\u00e4ftigerbetrieb f\u00fcr vergleichbare Arbeitnehmer geltenden wesentlichen Arbeits- und Besch\u00e4ftigungsbedingungen. Rechtsgrundlage: {legal_basis}.<\/p>\",\n \"version\": 0,\n \"is_active\": false,\n \"is_customized\": false\n },\n \"merge_fields\": [\n \"contract_number\",\n \"worker_name\",\n \"worker_birth_date\",\n \"worker_nationality\",\n \"worker_address\",\n \"organization_name\",\n \"organization_address\",\n \"job_title\",\n \"job_description\",\n \"location\",\n \"start_date\",\n \"end_date\",\n \"hourly_rate\",\n \"collective_agreement\",\n \"legal_basis\"\n ]\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Update Shift Contract Template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/:shiftId\/contract-template", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/:shiftId\/contract-template", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Beispieltext\",\"body_html\":\"Bitte um Rueckmeldung zur naechsten Schicht.\",\"is_active\":true,\"inherit\":true}" }, "description": "Save (or reset) a shift's contract template override. `inherit: true`\ndeletes the shift-level row so the shift falls back to its job's template\n(or the organisation default); otherwise the body is upserted, seeded from\nthe resolved job-level body the first time a shift is customised." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"The contract template has been saved.\",\n \"data\": {\n \"template\": {\n \"name\": \"\u00dcberlassungsvertrag\",\n \"body_html\": \"
{worker_name}, geboren am {worker_birth_date}, {worker_address}<\/p>\\n
{organization_name}, {organization_address}<\/p>\\n
T\u00e4tigkeit: {job_title}
Einsatzort: {location}
Zeitraum: {start_date} \u2013 {end_date}
Entgelt (brutto\/Std.): {hourly_rate}
Kollektivvertrag: {collective_agreement}<\/p>\\n
F\u00fcr die Dauer der \u00dcberlassung gelten gem\u00e4\u00df \u00a7 10 A\u00dcG die im Besch\u00e4ftigerbetrieb f\u00fcr vergleichbare Arbeitnehmer geltenden wesentlichen Arbeits- und Besch\u00e4ftigungsbedingungen. Rechtsgrundlage: {legal_basis}.<\/p>\",\n \"version\": 0,\n \"is_active\": false,\n \"is_customized\": false\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Scan Check In Qr", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/scan-qr", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/scan-qr" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"qr_payload\":\"Beispieltext\",\"lat\":1,\"lng\":1,\"signature\":\"Beispieltext\"}" }, "description": "Scan an employee's QR code to record check-in\/check-out." }, "response": [] }, { "name": "Cancel Shift By Organisation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/:shiftId\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/:shiftId\/cancel", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Krankheitsbedingt kurzfristig abgesagt.\"}" }, "description": "Organization cancels a shift." }, "response": [] }, { "name": "Notify Shift Extension", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/:shiftId\/extend", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/:shiftId\/extend", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "9c3f5f3d-0123-4abc-b456-426614174000", "description": "UUID of the shift." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"extended_end_time\":\"20:00\",\"reason\":\"Production running late, need 2 more hours.\"}" }, "description": "Allows an organisation to extend an active shift \u2014 updating the end time\nand notifying the assigned employee via push notification.\n\nThe extension is only allowed when the shift is currently `in_progress`.\nThe organisation must provide a reason and the new end time must be later\nthan the current scheduled end time." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"message\": \"Schichtverl\u00e4ngerung wurde gemeldet.\",\n \"extended_end_time\": \"20:00\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 400, "body": "{\"status\":\"ERROR\",\"message\":\"Die Schicht ist nicht aktiv.\"}", "name": "" }, { "header": [], "code": 403, "body": "{\"status\":\"ERROR\",\"message\":\"Diese Schicht geh\u00f6rt nicht zu Ihrem Unternehmen.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"status\":\"ERROR\",\"message\":\"Schicht nicht gefunden.\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"status\":\"ERROR\",\"message\":\"The extended end time field is required.\"}", "name": "" } ] }, { "name": "Rate Employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/:shiftId\/rate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/:shiftId\/rate", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"overall_score\":1,\"punctuality_score\":1,\"professionalism_score\":1,\"communication_score\":1,\"work_quality_score\":1,\"comment\":\"Beispieltext\"}" }, "description": "Organization submits a rating for an employee after shift completion." }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Your rating has been submitted successfully.\",\n \"data\": {\n \"rating\": {\n \"id\": \"019fd2b8-45d9-707b-89cf-d4a026834fe3\",\n \"overall_score\": 1,\n \"created_at\": \"2026-08-05 16:18\"\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "List Shift Requests", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/requests", "query": [ { "key": "status", "value": "pending", "description": "Allowed: pending, approved, declined, withdrawn.", "disabled": false }, { "key": "type", "value": "overtime", "description": "Allowed: overtime, early_end, hours_correction, manual_check_in, absence_excuse, workplace_change.", "disabled": false }, { "key": "shift_id", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Only requests against this assignment.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Items per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org\/requests?status=pending&type=overtime&shift_id=019f9939-c4c3-70fb-a54e-5ebf63db36d2&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"declined\",\"type\":\"manual_check_in\",\"shift_id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",\"per_page\":7}" }, "description": "The company's inbox of worker requests. Pending ones come first regardless\nof sort, because they are the only ones that need an action \u2014 and until they\nare decided the shift is not settled and the worker is not paid." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"requests\": [],\n \"pending_count\": 0,\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 7,\n \"total\": 0\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Approve or Decline a Shift Request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/requests\/:requestId\/decide", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/requests\/:requestId\/decide", "variable": [ { "id": "requestId", "key": "requestId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "The request being decided." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"approve\":true,\"note\":\"Overtime was not authorised on site.\"}" }, "description": "The company's answer to a worker. Approving overtime raises what the shift\npays; declining leaves it at the capped amount. Either way the decision is\nstamped with whoever made it \u2014 the organisation account or the member \u2014 and\nwritten to the audit trail, because it changes what someone is paid.\n\nA decline must carry a reason. The worker sees it." }, "response": [ { "header": [], "code": 409, "body": "{\"status\":\"INVALID_OPERATION\",\"message\":\"This request has already been decided.\"}", "name": "Already decided" } ] }, { "name": "Open a Conversation About a Shift Request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/requests\/:requestId\/conversation", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/requests\/:requestId\/conversation", "variable": [ { "id": "requestId", "key": "requestId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "The request to discuss." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Starts (or returns) the thread between the company and the worker about one\nspecific request \u2014 for when a manager needs to ask something before\ndeciding, rather than approving or declining blind.\n\nScoped to the request, not the shift, so the exchange stays attached to the\ndecision it belongs to. Calling this twice returns the same thread." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"SUCCESS\",\"data\":{\"conversation_id\":\"019f...\",\"shift_request_id\":\"019f...\",\"subject\":\"\u00dcberstunden\"}}", "name": "Thread ready" } ] } ] }, { "name": "Notifications", "description": "", "item": [ { "name": "List Notifications", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/notifications", "query": [ { "key": "page", "value": "16", "description": "Defaults to 1.", "disabled": false }, { "key": "per_page", "value": "16", "description": "Defaults to 20 (max 100).", "disabled": false }, { "key": "unread_only", "value": "", "description": "nullable When true, returns only unread notifications.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/org\/notifications?page=16&per_page=16&unread_only=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated list of notifications for the authenticated organisation.\nIncludes an `unread_count` in `meta` for the inbox badge." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Notifications retrieved successfully.\",\n \"data\": [],\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"09377940-8cb9-4640-a522-b88869dfb7fe\",\n \"timestamp\": \"2026-08-05T16:18:38.542194Z\",\n \"current_page\": 16,\n \"per_page\": 16,\n \"total\": 0,\n \"last_page\": 1,\n \"unread_count\": 0\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Get Unread Notifications Count", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/notifications\/unread-count", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/notifications\/unread-count" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Success\",\n \"data\": {\n \"count\": 0\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"a0972d73-64ed-4c2d-a149-88962625ec88\",\n \"timestamp\": \"2026-08-05T16:18:38.548222Z\"\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Mark Notification As Read", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/notifications\/:notification\/read", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/notifications\/:notification\/read", "variable": [ { "id": "notification", "key": "notification", "value": "architecto", "description": "The notification." }, { "id": "id", "key": "id", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The notification UUID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Marks a single notification as read for the authenticated organisation." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"SUCCESS\",\"message\":\"Notification marked as read.\",\"data\":{\"id\":\"550e8400-e29b-41d4-a716-446655440000\",\"read_at\":\"2026-04-02T12:00:00+00:00\"},\"errors\":null,\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Success" }, { "header": [], "code": 404, "body": "{\"status\":\"NOT_FOUND\",\"message\":\"Notification not found.\",\"data\":null,\"errors\":null,\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Not Found" } ] }, { "name": "Mark All Notifications As Read", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/notifications\/read-all", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/notifications\/read-all" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Marks every unread notification of the authenticated organisation as read in a single call." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"All notifications marked as read.\",\n \"data\": {\n \"marked\": true\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"d6f09336-8a5c-476c-880f-8abb84800194\",\n \"timestamp\": \"2026-08-05T16:18:38.554649Z\"\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Get Notification Preferences", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/notification-preferences", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/notification-preferences" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns per-category notification preferences for the authenticated organisation.\nDefaults to email enabled \/ push disabled for every category." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"category\": \"jobs\",\n \"email\": true,\n \"push\": false\n },\n {\n \"category\": \"finance\",\n \"email\": true,\n \"push\": false\n },\n {\n \"category\": \"communication\",\n \"email\": true,\n \"push\": false\n },\n {\n \"category\": \"security\",\n \"email\": true,\n \"push\": false\n },\n {\n \"category\": \"system\",\n \"email\": true,\n \"push\": false\n },\n {\n \"category\": \"marketing\",\n \"email\": true,\n \"push\": false\n }\n ],\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"062e170a-40d4-47f4-a976-a64ae4b9bad4\",\n \"timestamp\": \"2026-08-05T16:18:38.560328Z\"\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Update Notification Preferences", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/notification-preferences", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/notification-preferences" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"category\":\"finance\",\"channel\":\"email\",\"enabled\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Notification preference updated.\",\n \"data\": {\n \"category\": \"finance\",\n \"email\": true,\n \"push\": false\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"7f992b80-e97b-48f0-a60d-8d3da4d4684e\",\n \"timestamp\": \"2026-08-05T16:18:38.567378Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"category\",\"message\":\"The selected category is invalid.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" } ] } ] }, { "name": "Auth", "description": "", "item": [ { "name": "Forgot Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/auth\/forgot-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/auth\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"boris@example.com\",\"guard\":\"user\"}" }, "description": "Sends a 4-digit password reset code to the given email address.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"If that email address is registered, a password reset code has been sent.\",\n \"data\": {\n \"email\": \"opal56@example.net\",\n \"code\": \"448891\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"04e13c3e-6945-4f40-bb63-a330434430e3\",\n \"timestamp\": \"2026-08-05T16:18:54.164086Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"guard\",\"message\":\"The guard field is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Verify Reset Code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/auth\/forgot-password\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/auth\/forgot-password\/verify" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"boris@example.com\",\"code\":\"123456\",\"guard\":\"user\"}" }, "description": "Validates the 4-digit password reset code for the given email and guard.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Reset code verified successfully.\",\n \"data\": {\n \"reset_token\": \"c97701d0-c4de-4755-b3c4-f7d1a803efc5\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"67df2724-9771-46b5-8d4d-71f98573d3e5\",\n \"timestamp\": \"2026-08-05T16:18:54.166696Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"RESET_CODE_INVALID\",\"message\":\"Invalid reset code.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Invalid reset code.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 410, "body": "{\"status\":\"RESET_CODE_EXPIRED\",\"message\":\"Reset code has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Reset code has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Code Expired" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The code field is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RESET_ATTEMPTS_EXHAUSTED\",\"message\":\"Too many failed attempts. Please request a new code.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Too many failed attempts. Please request a new code.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Too Many Attempts" } ] }, { "name": "Resend Reset Code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/auth\/forgot-password\/resend", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/auth\/forgot-password\/resend" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"boris@example.com\",\"guard\":\"user\"}" }, "description": "Re-sends a 4-digit password reset code for the given email and guard.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"If that email address is registered, a new password reset code has been sent.\",\n \"data\": {\n \"code\": \"443677\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"a265e26e-388c-4782-b9ce-bc4722cc5958\",\n \"timestamp\": \"2026-08-05T16:18:58.095803Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"guard\",\"message\":\"The guard field is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Reset Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/auth\/reset-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/auth\/reset-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"boris@example.com\",\"reset_token\":\"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\"password\":\"NewPassword123\",\"password_confirmation\":\"NewPassword123\",\"guard\":\"user\"}" }, "description": "Resets the password for any actor type and revokes all existing tokens.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Password has been reset successfully.\",\n \"data\": null,\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"85c34424-2c5f-4d2e-aa97-5edf63d5d429\",\n \"timestamp\": \"2026-08-05T16:18:54.626775Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 403, "body": "{\"status\":\"RESET_NOT_VERIFIED\",\"message\":\"Email not verified. Complete the verification step first.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Email not verified. Complete the verification step first.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Email Not Verified" }, { "header": [], "code": 404, "body": "{\"status\":\"ACCOUNT_NOT_FOUND\",\"message\":\"Account not found.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Account not found.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Account Not Found" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"password\",\"message\":\"The password must be at least 8 characters.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"password\",\"message\":\"You cannot reuse your last 3 passwords.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Password Reuse" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Two Factor Challenge", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/auth\/two-factor\/challenge", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/auth\/two-factor\/challenge" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\",\"recovery_code\":\"ABCD-1234-EFGH\"}" }, "description": "Completes the two-factor authentication challenge for any guard." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Two-factor authentication verified successfully.\",\n \"data\": {\n \"token\": \"42|wMrUbv7gI4CRWxcRbQIldttPzbyXBl2z181bI8Yt86612731\",\n \"refresh_token\": \"43|VPtqTDVPb3gY2MF4mIkms7vJcLWgUA47iwIxRI8e34e4f629\",\n \"expires_in\": 900,\n \"user\": {\n \"id\": \"019fd2b8-b86e-738d-8bfa-a29262a83558\",\n \"email\": \"hansen.mohammad@example.org\"\n }\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"0ff1a162-0832-4ffa-9700-d0f30d00a580\",\n \"timestamp\": \"2026-08-05T16:19:09.319799Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"TWO_FACTOR_CODE_INVALID\",\"message\":\"The provided code is invalid or has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The provided code is invalid or has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NOT_CONFIGURED\",\"message\":\"Two-factor authentication is not configured for this account.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Two-factor authentication is not configured for this account.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "2FA Not Configured" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Either code or recovery_code is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revokes the currently active Sanctum token for any guard." }, "response": [ { "header": [], "code": 204, "body": "", "name": "Success" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Enable Two Factor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/auth\/two-factor\/enable", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/auth\/two-factor\/enable" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"method\":\"totp\"}" }, "description": "Initiates the 2FA setup flow for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"SUCCESS\",\"message\":\"Two-factor authentication initiated.\",\"data\":{\"method\":\"email\"},\"errors\":null,\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Email" }, { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Scan the QR code with your authenticator app, then confirm with the generated code.\",\n \"data\": {\n \"method\": \"totp\",\n \"secret\": \"6RL4HDCP2F4CDU27SRQOWOS454GFGIL6\",\n \"qr_uri\": \"otpauth:\/\/totp\/Flexxer%20Backend:019fd2b8-b36f-7307-92fb-5d28e58ef9f2?secret=6RL4HDCP2F4CDU27SRQOWOS454GFGIL6&issuer=Flexxer%20Backend&algorithm=SHA1&digits=6&period=30\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"e9e9b449-d901-409b-a9b4-fd071002aa0e\",\n \"timestamp\": \"2026-08-05T16:19:07.791377Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"method\",\"message\":\"The selected method is invalid.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Confirm Two Factor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/auth\/two-factor\/confirm", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/auth\/two-factor\/confirm" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\"}" }, "description": "Confirms and activates 2FA after the user has verified their code." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Two-factor authentication has been enabled. Save your recovery codes in a safe place.\",\n \"data\": {\n \"recovery_codes\": [\n \"DTPLO-U2SCF\",\n \"MRWS1-IKBUY\",\n \"MVM4F-Z42ES\",\n \"AUSXU-FTDPK\",\n \"U7WHX-TIU99\",\n \"12AWU-NZVH6\",\n \"ZY5XK-4WOKJ\",\n \"47MAL-ZSDLU\"\n ]\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"315aafcb-764e-4f38-9faa-b9c4f45e3461\",\n \"timestamp\": \"2026-08-05T16:19:07.807225Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"TWO_FACTOR_CODE_INVALID\",\"message\":\"The provided code is invalid or has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The provided code is invalid or has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NO_PENDING_SETUP\",\"message\":\"No pending two-factor setup found. Please restart the setup process.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"No pending two-factor setup found. Please restart the setup process.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "No Pending Setup" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The code field is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Request Disable Two Factor Code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/auth\/two-factor\/disable\/request-code", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/auth\/two-factor\/disable\/request-code" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Dispatches a 6-digit OTP to the user's account email so they can\nconfirm a 2FA-disable request. No-op for TOTP accounts (the code\ncomes from the authenticator app directly) and for accounts without\nan enabled 2FA setting \u2014 both return 200 so the client's happy path\nis uniform." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"SUCCESS\",\"message\":\"Enter the current code from your authenticator app.\",\"data\":{\"method\":\"totp\"},\"errors\":null,\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "TOTP \u2014 use authenticator" }, { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Enter the current code from your authenticator app.\",\n \"data\": {\n \"method\": \"totp\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"0542b19f-0c0a-4bf3-93a4-d90bbac46f63\",\n \"timestamp\": \"2026-08-05T16:18:37.138042Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NOT_ENABLED\",\"message\":\"Two-factor authentication is not currently enabled.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Two-factor authentication is not currently enabled.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "Not Enabled" } ] }, { "name": "Disable Two Factor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/auth\/two-factor\/disable", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/auth\/two-factor\/disable" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\",\"recovery_code\":\"ABCD-1234-EFGH\"}" }, "description": "Disables 2FA for the authenticated user after verifying a current\nchallenge code \u2014 the same proof the user provides at login time." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Two-factor authentication has been disabled.\",\n \"data\": null,\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"255f0d6e-8c58-4e47-84a4-c47dd821febf\",\n \"timestamp\": \"2026-08-05T16:19:07.817111Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"TWO_FACTOR_CODE_INVALID\",\"message\":\"The provided code is invalid or has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The provided code is invalid or has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NOT_ENABLED\",\"message\":\"Two-factor authentication is not currently enabled.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Two-factor authentication is not currently enabled.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "Not Enabled" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Either code or recovery_code is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "Validation Error" } ] }, { "name": "Forgot Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/forgot-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"boris@example.com\",\"guard\":\"user\"}" }, "description": "Sends a 4-digit password reset code to the given email address.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"If that email address is registered, a password reset code has been sent.\",\n \"data\": {\n \"email\": \"opal56@example.net\",\n \"code\": \"448891\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"04e13c3e-6945-4f40-bb63-a330434430e3\",\n \"timestamp\": \"2026-08-05T16:18:54.164086Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"guard\",\"message\":\"The guard field is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Verify Reset Code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/forgot-password\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/forgot-password\/verify" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"boris@example.com\",\"code\":\"123456\",\"guard\":\"user\"}" }, "description": "Validates the 4-digit password reset code for the given email and guard.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Reset code verified successfully.\",\n \"data\": {\n \"reset_token\": \"c97701d0-c4de-4755-b3c4-f7d1a803efc5\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"67df2724-9771-46b5-8d4d-71f98573d3e5\",\n \"timestamp\": \"2026-08-05T16:18:54.166696Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"RESET_CODE_INVALID\",\"message\":\"Invalid reset code.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Invalid reset code.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 410, "body": "{\"status\":\"RESET_CODE_EXPIRED\",\"message\":\"Reset code has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Reset code has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Code Expired" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The code field is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RESET_ATTEMPTS_EXHAUSTED\",\"message\":\"Too many failed attempts. Please request a new code.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Too many failed attempts. Please request a new code.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Too Many Attempts" } ] }, { "name": "Resend Reset Code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/forgot-password\/resend", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/forgot-password\/resend" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"boris@example.com\",\"guard\":\"user\"}" }, "description": "Re-sends a 4-digit password reset code for the given email and guard.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"If that email address is registered, a new password reset code has been sent.\",\n \"data\": {\n \"code\": \"443677\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"a265e26e-388c-4782-b9ce-bc4722cc5958\",\n \"timestamp\": \"2026-08-05T16:18:58.095803Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"guard\",\"message\":\"The guard field is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Reset Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/reset-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/reset-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"boris@example.com\",\"reset_token\":\"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\"password\":\"NewPassword123\",\"password_confirmation\":\"NewPassword123\",\"guard\":\"user\"}" }, "description": "Resets the password for any actor type and revokes all existing tokens.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Password has been reset successfully.\",\n \"data\": null,\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"85c34424-2c5f-4d2e-aa97-5edf63d5d429\",\n \"timestamp\": \"2026-08-05T16:18:54.626775Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 403, "body": "{\"status\":\"RESET_NOT_VERIFIED\",\"message\":\"Email not verified. Complete the verification step first.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Email not verified. Complete the verification step first.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Email Not Verified" }, { "header": [], "code": 404, "body": "{\"status\":\"ACCOUNT_NOT_FOUND\",\"message\":\"Account not found.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Account not found.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Account Not Found" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"password\",\"message\":\"The password must be at least 8 characters.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"password\",\"message\":\"You cannot reuse your last 3 passwords.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Password Reuse" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Two Factor Challenge", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/two-factor\/challenge", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/two-factor\/challenge" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\",\"recovery_code\":\"ABCD-1234-EFGH\"}" }, "description": "Completes the two-factor authentication challenge for any guard." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Two-factor authentication verified successfully.\",\n \"data\": {\n \"token\": \"42|wMrUbv7gI4CRWxcRbQIldttPzbyXBl2z181bI8Yt86612731\",\n \"refresh_token\": \"43|VPtqTDVPb3gY2MF4mIkms7vJcLWgUA47iwIxRI8e34e4f629\",\n \"expires_in\": 900,\n \"user\": {\n \"id\": \"019fd2b8-b86e-738d-8bfa-a29262a83558\",\n \"email\": \"hansen.mohammad@example.org\"\n }\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"0ff1a162-0832-4ffa-9700-d0f30d00a580\",\n \"timestamp\": \"2026-08-05T16:19:09.319799Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"TWO_FACTOR_CODE_INVALID\",\"message\":\"The provided code is invalid or has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The provided code is invalid or has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NOT_CONFIGURED\",\"message\":\"Two-factor authentication is not configured for this account.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Two-factor authentication is not configured for this account.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "2FA Not Configured" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Either code or recovery_code is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Two Factor Challenge", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/member\/two-factor\/challenge", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/member\/two-factor\/challenge" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\",\"recovery_code\":\"ABCD-1234-EFGH\"}" }, "description": "Completes the two-factor authentication challenge for any guard." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Two-factor authentication verified successfully.\",\n \"data\": {\n \"token\": \"42|wMrUbv7gI4CRWxcRbQIldttPzbyXBl2z181bI8Yt86612731\",\n \"refresh_token\": \"43|VPtqTDVPb3gY2MF4mIkms7vJcLWgUA47iwIxRI8e34e4f629\",\n \"expires_in\": 900,\n \"user\": {\n \"id\": \"019fd2b8-b86e-738d-8bfa-a29262a83558\",\n \"email\": \"hansen.mohammad@example.org\"\n }\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"0ff1a162-0832-4ffa-9700-d0f30d00a580\",\n \"timestamp\": \"2026-08-05T16:19:09.319799Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"TWO_FACTOR_CODE_INVALID\",\"message\":\"The provided code is invalid or has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The provided code is invalid or has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NOT_CONFIGURED\",\"message\":\"Two-factor authentication is not configured for this account.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Two-factor authentication is not configured for this account.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "2FA Not Configured" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Either code or recovery_code is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Get Current Organization \/ Member", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the authenticated actor's profile alongside an ACL manifest.\n\nTwo actor types share this route (both pass the `guard:organization`\nmiddleware):\n\n - Organization (principal): synthetic manifest built from the\n `principal` preset; no rows in acl_actor_presets are consulted.\n - OrganizationMember: real manifest resolved from the member's stored\n presets via `Acl::manifest($member)`." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"SUCCESS\",\"message\":\"Success\",\"data\":{\"profile\":{\"id\":\"uuid\",\"name\":\"Jane Doe\",\"email\":\"jane@example.com\",\"role\":\"member\",\"organization_id\":\"org-uuid\",\"organization_name\":\"Acme e.V.\",\"is_primary_admin\":false},\"acl\":{\"scope\":\"org-member\",\"presets\":[\"viewer\"],\"permissions\":[\"profile.view\",\"team.view\"],\"conditional\":{},\"computed_at\":\"2026-05-12T10:00:00+00:00\"}}}", "name": "OrganizationMember" }, { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Success\",\n \"data\": {\n \"profile\": {\n \"id\": \"019fd2b7-f072-7154-8961-5b324cc6c46c\",\n \"name\": \"Caritas\",\n \"email\": \"caritas-portal@flexxr.eu.cc\",\n \"status\": \"active\",\n \"is_primary_admin\": true\n },\n \"acl\": {\n \"scope\": \"org-member\",\n \"presets\": [\n \"principal\"\n ],\n \"permissions\": [\n \"applicants.accept\",\n \"applicants.reject\",\n \"applicants.view\",\n \"assignments.manage\",\n \"assignments.view\",\n \"attendance.approve-hours\",\n \"attendance.report-noshow\",\n \"attendance.view\",\n \"audit.view\",\n \"gdpr.request\",\n \"invoices.download\",\n \"invoices.view\",\n \"jobs.configure-assignment\",\n \"jobs.create\",\n \"jobs.delete\",\n \"jobs.edit\",\n \"jobs.publish\",\n \"jobs.view\",\n \"messages.access\",\n \"notifications.preferences.manage\",\n \"payments.manage\",\n \"payments.view\",\n \"profile.edit\",\n \"profile.view\",\n \"ratings.create\",\n \"ratings.view\",\n \"reports.export\",\n \"reports.view\",\n \"requests.decide\",\n \"requests.view\",\n \"shifts.adjust\",\n \"shifts.cancel\",\n \"shifts.check-in\",\n \"shifts.dispute-time\",\n \"shifts.generate-qr\",\n \"shifts.report-signature-refusal\",\n \"shifts.view\",\n \"support.create-ticket\",\n \"support.view-tickets\",\n \"team.invite\",\n \"team.manage-roles\",\n \"team.remove\",\n \"team.view\"\n ],\n \"conditional\": {},\n \"computed_at\": \"2026-08-05T16:18:37+00:00\"\n }\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"e4ea4c8e-c454-4449-891f-5f615816a929\",\n \"timestamp\": \"2026-08-05T16:18:37.721087Z\"\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revokes the currently active Sanctum token for any guard." }, "response": [ { "header": [], "code": 204, "body": "", "name": "Success" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Enable Two Factor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/two-factor\/enable", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/two-factor\/enable" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"method\":\"totp\"}" }, "description": "Initiates the 2FA setup flow for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"SUCCESS\",\"message\":\"Two-factor authentication initiated.\",\"data\":{\"method\":\"email\"},\"errors\":null,\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Email" }, { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Scan the QR code with your authenticator app, then confirm with the generated code.\",\n \"data\": {\n \"method\": \"totp\",\n \"secret\": \"6RL4HDCP2F4CDU27SRQOWOS454GFGIL6\",\n \"qr_uri\": \"otpauth:\/\/totp\/Flexxer%20Backend:019fd2b8-b36f-7307-92fb-5d28e58ef9f2?secret=6RL4HDCP2F4CDU27SRQOWOS454GFGIL6&issuer=Flexxer%20Backend&algorithm=SHA1&digits=6&period=30\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"e9e9b449-d901-409b-a9b4-fd071002aa0e\",\n \"timestamp\": \"2026-08-05T16:19:07.791377Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"method\",\"message\":\"The selected method is invalid.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Confirm Two Factor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/two-factor\/confirm", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/two-factor\/confirm" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\"}" }, "description": "Confirms and activates 2FA after the user has verified their code." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Two-factor authentication has been enabled. Save your recovery codes in a safe place.\",\n \"data\": {\n \"recovery_codes\": [\n \"DTPLO-U2SCF\",\n \"MRWS1-IKBUY\",\n \"MVM4F-Z42ES\",\n \"AUSXU-FTDPK\",\n \"U7WHX-TIU99\",\n \"12AWU-NZVH6\",\n \"ZY5XK-4WOKJ\",\n \"47MAL-ZSDLU\"\n ]\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"315aafcb-764e-4f38-9faa-b9c4f45e3461\",\n \"timestamp\": \"2026-08-05T16:19:07.807225Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"TWO_FACTOR_CODE_INVALID\",\"message\":\"The provided code is invalid or has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The provided code is invalid or has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NO_PENDING_SETUP\",\"message\":\"No pending two-factor setup found. Please restart the setup process.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"No pending two-factor setup found. Please restart the setup process.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "No Pending Setup" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The code field is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Request Disable Two Factor Code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/two-factor\/disable-code", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/two-factor\/disable-code" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Dispatches a 6-digit OTP to the user's account email so they can\nconfirm a 2FA-disable request. No-op for TOTP accounts (the code\ncomes from the authenticator app directly) and for accounts without\nan enabled 2FA setting \u2014 both return 200 so the client's happy path\nis uniform." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"SUCCESS\",\"message\":\"Enter the current code from your authenticator app.\",\"data\":{\"method\":\"totp\"},\"errors\":null,\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "TOTP \u2014 use authenticator" }, { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Enter the current code from your authenticator app.\",\n \"data\": {\n \"method\": \"totp\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"0542b19f-0c0a-4bf3-93a4-d90bbac46f63\",\n \"timestamp\": \"2026-08-05T16:18:37.138042Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NOT_ENABLED\",\"message\":\"Two-factor authentication is not currently enabled.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Two-factor authentication is not currently enabled.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "Not Enabled" } ] }, { "name": "Disable Two Factor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/two-factor\/disable", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/two-factor\/disable" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\",\"recovery_code\":\"ABCD-1234-EFGH\"}" }, "description": "Disables 2FA for the authenticated user after verifying a current\nchallenge code \u2014 the same proof the user provides at login time." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Two-factor authentication has been disabled.\",\n \"data\": null,\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"255f0d6e-8c58-4e47-84a4-c47dd821febf\",\n \"timestamp\": \"2026-08-05T16:19:07.817111Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"TWO_FACTOR_CODE_INVALID\",\"message\":\"The provided code is invalid or has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The provided code is invalid or has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NOT_ENABLED\",\"message\":\"Two-factor authentication is not currently enabled.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Two-factor authentication is not currently enabled.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "Not Enabled" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Either code or recovery_code is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "Validation Error" } ] }, { "name": "Forgot Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/auth\/forgot-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/auth\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"boris@example.com\",\"guard\":\"user\"}" }, "description": "Sends a 4-digit password reset code to the given email address.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"If that email address is registered, a password reset code has been sent.\",\n \"data\": {\n \"email\": \"opal56@example.net\",\n \"code\": \"448891\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"04e13c3e-6945-4f40-bb63-a330434430e3\",\n \"timestamp\": \"2026-08-05T16:18:54.164086Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"guard\",\"message\":\"The guard field is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Verify Reset Code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/auth\/forgot-password\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/auth\/forgot-password\/verify" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"boris@example.com\",\"code\":\"123456\",\"guard\":\"user\"}" }, "description": "Validates the 4-digit password reset code for the given email and guard.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Reset code verified successfully.\",\n \"data\": {\n \"reset_token\": \"c97701d0-c4de-4755-b3c4-f7d1a803efc5\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"67df2724-9771-46b5-8d4d-71f98573d3e5\",\n \"timestamp\": \"2026-08-05T16:18:54.166696Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"RESET_CODE_INVALID\",\"message\":\"Invalid reset code.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Invalid reset code.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 410, "body": "{\"status\":\"RESET_CODE_EXPIRED\",\"message\":\"Reset code has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Reset code has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Code Expired" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The code field is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RESET_ATTEMPTS_EXHAUSTED\",\"message\":\"Too many failed attempts. Please request a new code.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Too many failed attempts. Please request a new code.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Too Many Attempts" } ] }, { "name": "Resend Reset Code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/auth\/forgot-password\/resend", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/auth\/forgot-password\/resend" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"boris@example.com\",\"guard\":\"user\"}" }, "description": "Re-sends a 4-digit password reset code for the given email and guard.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"If that email address is registered, a new password reset code has been sent.\",\n \"data\": {\n \"code\": \"443677\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"a265e26e-388c-4782-b9ce-bc4722cc5958\",\n \"timestamp\": \"2026-08-05T16:18:58.095803Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"guard\",\"message\":\"The guard field is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Reset Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/auth\/reset-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/auth\/reset-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"boris@example.com\",\"reset_token\":\"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\"password\":\"NewPassword123\",\"password_confirmation\":\"NewPassword123\",\"guard\":\"user\"}" }, "description": "Resets the password for any actor type and revokes all existing tokens.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Password has been reset successfully.\",\n \"data\": null,\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"85c34424-2c5f-4d2e-aa97-5edf63d5d429\",\n \"timestamp\": \"2026-08-05T16:18:54.626775Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 403, "body": "{\"status\":\"RESET_NOT_VERIFIED\",\"message\":\"Email not verified. Complete the verification step first.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Email not verified. Complete the verification step first.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Email Not Verified" }, { "header": [], "code": 404, "body": "{\"status\":\"ACCOUNT_NOT_FOUND\",\"message\":\"Account not found.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Account not found.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Account Not Found" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"password\",\"message\":\"The password must be at least 8 characters.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"password\",\"message\":\"You cannot reuse your last 3 passwords.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Password Reuse" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Two Factor Challenge", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/auth\/two-factor\/challenge", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/auth\/two-factor\/challenge" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\",\"recovery_code\":\"ABCD-1234-EFGH\"}" }, "description": "Completes the two-factor authentication challenge for any guard." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Two-factor authentication verified successfully.\",\n \"data\": {\n \"token\": \"42|wMrUbv7gI4CRWxcRbQIldttPzbyXBl2z181bI8Yt86612731\",\n \"refresh_token\": \"43|VPtqTDVPb3gY2MF4mIkms7vJcLWgUA47iwIxRI8e34e4f629\",\n \"expires_in\": 900,\n \"user\": {\n \"id\": \"019fd2b8-b86e-738d-8bfa-a29262a83558\",\n \"email\": \"hansen.mohammad@example.org\"\n }\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"0ff1a162-0832-4ffa-9700-d0f30d00a580\",\n \"timestamp\": \"2026-08-05T16:19:09.319799Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"TWO_FACTOR_CODE_INVALID\",\"message\":\"The provided code is invalid or has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The provided code is invalid or has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NOT_CONFIGURED\",\"message\":\"Two-factor authentication is not configured for this account.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Two-factor authentication is not configured for this account.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "2FA Not Configured" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Either code or recovery_code is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revokes the currently active Sanctum token for any guard." }, "response": [ { "header": [], "code": 204, "body": "", "name": "Success" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Enable Two Factor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/auth\/two-factor\/enable", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/auth\/two-factor\/enable" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"method\":\"totp\"}" }, "description": "Initiates the 2FA setup flow for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"SUCCESS\",\"message\":\"Two-factor authentication initiated.\",\"data\":{\"method\":\"email\"},\"errors\":null,\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Email" }, { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Scan the QR code with your authenticator app, then confirm with the generated code.\",\n \"data\": {\n \"method\": \"totp\",\n \"secret\": \"6RL4HDCP2F4CDU27SRQOWOS454GFGIL6\",\n \"qr_uri\": \"otpauth:\/\/totp\/Flexxer%20Backend:019fd2b8-b36f-7307-92fb-5d28e58ef9f2?secret=6RL4HDCP2F4CDU27SRQOWOS454GFGIL6&issuer=Flexxer%20Backend&algorithm=SHA1&digits=6&period=30\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"e9e9b449-d901-409b-a9b4-fd071002aa0e\",\n \"timestamp\": \"2026-08-05T16:19:07.791377Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"method\",\"message\":\"The selected method is invalid.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Confirm Two Factor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/auth\/two-factor\/confirm", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/auth\/two-factor\/confirm" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\"}" }, "description": "Confirms and activates 2FA after the user has verified their code." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Two-factor authentication has been enabled. Save your recovery codes in a safe place.\",\n \"data\": {\n \"recovery_codes\": [\n \"DTPLO-U2SCF\",\n \"MRWS1-IKBUY\",\n \"MVM4F-Z42ES\",\n \"AUSXU-FTDPK\",\n \"U7WHX-TIU99\",\n \"12AWU-NZVH6\",\n \"ZY5XK-4WOKJ\",\n \"47MAL-ZSDLU\"\n ]\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"315aafcb-764e-4f38-9faa-b9c4f45e3461\",\n \"timestamp\": \"2026-08-05T16:19:07.807225Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"TWO_FACTOR_CODE_INVALID\",\"message\":\"The provided code is invalid or has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The provided code is invalid or has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHORIZED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NO_PENDING_SETUP\",\"message\":\"No pending two-factor setup found. Please restart the setup process.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"No pending two-factor setup found. Please restart the setup process.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "No Pending Setup" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The code field is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "Disable Two Factor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/auth\/two-factor\/disable", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/auth\/two-factor\/disable" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\",\"recovery_code\":\"ABCD-1234-EFGH\"}" }, "description": "Disables 2FA for the authenticated user after verifying a current\nchallenge code \u2014 the same proof the user provides at login time." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Two-factor authentication has been disabled.\",\n \"data\": null,\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"255f0d6e-8c58-4e47-84a4-c47dd821febf\",\n \"timestamp\": \"2026-08-05T16:19:07.817111Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"TWO_FACTOR_CODE_INVALID\",\"message\":\"The provided code is invalid or has expired.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"The provided code is invalid or has expired.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "Invalid Code" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NOT_ENABLED\",\"message\":\"Two-factor authentication is not currently enabled.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Two-factor authentication is not currently enabled.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "Not Enabled" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"code\",\"message\":\"Either code or recovery_code is required.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "Validation Error" } ] }, { "name": "Request Disable Two Factor Code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/auth\/two-factor\/disable\/request-code", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/auth\/two-factor\/disable\/request-code" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Dispatches a 6-digit OTP to the user's account email so they can\nconfirm a 2FA-disable request. No-op for TOTP accounts (the code\ncomes from the authenticator app directly) and for accounts without\nan enabled 2FA setting \u2014 both return 200 so the client's happy path\nis uniform." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"SUCCESS\",\"message\":\"Enter the current code from your authenticator app.\",\"data\":{\"method\":\"totp\"},\"errors\":null,\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "TOTP \u2014 use authenticator" }, { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Enter the current code from your authenticator app.\",\n \"data\": {\n \"method\": \"totp\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"0542b19f-0c0a-4bf3-93a4-d90bbac46f63\",\n \"timestamp\": \"2026-08-05T16:18:37.138042Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 409, "body": "{\"status\":\"TWO_FACTOR_NOT_ENABLED\",\"message\":\"Two-factor authentication is not currently enabled.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Two-factor authentication is not currently enabled.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-22T12:00:00.000000Z\"}}", "name": "Not Enabled" } ] } ] }, { "name": "Sessions", "description": "", "item": [ { "name": "List Sessions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/sessions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/sessions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists the authenticated user's (or org's, or admin's) active\nSanctum sessions with their device metadata, sorted by last_used_at\ndescending so the most recently active device is first." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": 4,\n \"name\": \"docs\",\n \"device\": null,\n \"ip_address\": null,\n \"last_used_at\": \"2026-08-05T16:18:37+00:00\",\n \"expires_at\": null,\n \"created_at\": \"2026-08-05T16:18:33+00:00\",\n \"is_current\": true\n }\n ],\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"b9c7f080-de76-4ae2-92d4-98f5f9c63e35\",\n \"timestamp\": \"2026-08-05T16:18:37.159008Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHENTICATED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Unauthenticated" } ] }, { "name": "Revoke Other Sessions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/sessions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/sessions" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Logs out every OTHER active session of the authenticated caller,\nkeeping the current one alive (\"Alle anderen Ger\u00e4te abmelden\")." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Success\",\n \"data\": {\n \"revoked\": 0\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"99342b48-bea9-49b3-a788-41e38c4c0892\",\n \"timestamp\": \"2026-08-05T16:18:37.170260Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHENTICATED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-06-18T12:00:00.000000Z\"}}", "name": "Unauthenticated" } ] }, { "name": "Revoke Session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/sessions\/:tokenId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/sessions\/:tokenId", "variable": [ { "id": "tokenId", "key": "tokenId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." }, { "id": "sessionId", "key": "sessionId", "value": 16, "description": "The ID of the session to revoke." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revokes a single active session by id." }, "response": [ { "header": [], "code": 204, "body": "", "name": "Revoked" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHENTICATED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 404, "body": "{\"status\":\"NOT_FOUND\",\"message\":\"Session not found.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Session not found.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Not Found" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] }, { "name": "List Sessions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/sessions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/sessions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists the authenticated user's (or org's, or admin's) active\nSanctum sessions with their device metadata, sorted by last_used_at\ndescending so the most recently active device is first." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": 4,\n \"name\": \"docs\",\n \"device\": null,\n \"ip_address\": null,\n \"last_used_at\": \"2026-08-05T16:18:37+00:00\",\n \"expires_at\": null,\n \"created_at\": \"2026-08-05T16:18:33+00:00\",\n \"is_current\": true\n }\n ],\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"b9c7f080-de76-4ae2-92d4-98f5f9c63e35\",\n \"timestamp\": \"2026-08-05T16:18:37.159008Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHENTICATED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Unauthenticated" } ] }, { "name": "Revoke Other Sessions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/sessions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/sessions" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Logs out every OTHER active session of the authenticated caller,\nkeeping the current one alive (\"Alle anderen Ger\u00e4te abmelden\")." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Success\",\n \"data\": {\n \"revoked\": 0\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"99342b48-bea9-49b3-a788-41e38c4c0892\",\n \"timestamp\": \"2026-08-05T16:18:37.170260Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHENTICATED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-06-18T12:00:00.000000Z\"}}", "name": "Unauthenticated" } ] }, { "name": "Revoke Session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/sessions\/:tokenId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/sessions\/:tokenId", "variable": [ { "id": "tokenId", "key": "tokenId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." }, { "id": "sessionId", "key": "sessionId", "value": 16, "description": "The ID of the session to revoke." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revokes a single active session by id." }, "response": [ { "header": [], "code": 204, "body": "", "name": "Revoked" }, { "header": [], "code": 401, "body": "{\"status\":\"UNAUTHENTICATED\",\"message\":\"Unauthenticated.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Unauthenticated.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Unauthenticated" }, { "header": [], "code": 404, "body": "{\"status\":\"NOT_FOUND\",\"message\":\"Session not found.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Session not found.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Not Found" }, { "header": [], "code": 429, "body": "{\"status\":\"RATE_LIMITED\",\"message\":\"Too many requests.\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Too many requests.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T19:00:00.000000Z\"}}", "name": "Rate Limited" } ] } ] }, { "name": "Logo", "description": "", "item": [ { "name": "Upload Org Logo", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/profile\/logo", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/profile\/logo" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "logo", "src": [], "type": "file" } ] }, "description": "Stores a new logo file for the authenticated organisation, replacing any existing one and returning the updated profile." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Logo uploaded successfully.\",\n \"data\": {\n \"id\": \"019fd2b7-f072-7154-8961-5b324cc6c46c\",\n \"name\": \"Caritas\",\n \"slug\": \"caritas-4v1ues\",\n \"email\": \"caritas-portal@flexxr.eu.cc\",\n \"country_code\": \"+43\",\n \"phone_number\": \"6641234567\",\n \"contact_person_name\": null,\n \"contact_person_phone\": null,\n \"iso_country_code\": \"AT\",\n \"phone_e164\": \"+436641234567\",\n \"description\": \"Caritas test organisation used for end-to-end portal QA. Safe to delete.\",\n \"logo_url\": \"\/storage\/logos\/organizations\/LREuwBDCi9PVWwBEWq51HyvWGY2EpxnhjPCtkxMn.jpg\",\n \"website\": \"https:\/\/www.caritas.at\",\n \"address\": \"Albrechtskreithgasse 19-21\",\n \"address_line2\": null,\n \"postal_code\": null,\n \"city\": \"Vienna\",\n \"country\": \"Austria\",\n \"status\": \"active\",\n \"verified_at\": \"2026-08-05T16:18:17.000000Z\",\n \"is_verified\": true,\n \"total_raised\": null,\n \"created_at\": \"2026-08-05T16:18:17.000000Z\",\n \"platform_fee_flat_cents\": null,\n \"firmenbuchnummer\": null,\n \"uid_number\": null,\n \"uid_validation_status\": null,\n \"payout_method\": null,\n \"stripe_connect_account_id\": null,\n \"connect_charges_enabled\": null,\n \"connect_payouts_enabled\": null,\n \"connect_details_submitted\": null,\n \"connect_requirements_due\": null,\n \"connect_country_code\": null\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"f13486bc-77c2-4f13-8a66-6f45b8c5609f\",\n \"timestamp\": \"2026-08-05T16:18:37.762427Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"Validation failed.\",\"data\":null,\"errors\":[{\"field\":\"logo\",\"message\":\"Logo file is required and must be an image.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-02T12:00:00.000000Z\"}}", "name": "Validation Error" } ] }, { "name": "Delete Org Logo", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/profile\/logo", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/profile\/logo" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the authenticated organisation's logo from storage and clears the logo_url field." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Logo deleted successfully.\",\n \"data\": null,\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"6be9ac36-baba-4a55-aff3-f87b0f8d5c17\",\n \"timestamp\": \"2026-08-05T16:18:37.773548Z\"\n }\n}", "name": "Recorded from a live call" } ] } ] }, { "name": "Privacy & GDPR", "description": "", "item": [ { "name": "Lists GDPR Art. 12(3) requests submitted by the authenticated organisation.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/me\/gdpr-requests", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/me\/gdpr-requests" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Success\",\n \"data\": [],\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"c161e586-954d-48ca-928d-41bad21a8adf\",\n \"timestamp\": \"2026-08-05T16:18:38.479808Z\",\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 15,\n \"total\": 0\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Records a new GDPR Art. 12(3) request forwarded by an organisation on\nbehalf of a data subject. Persists the request, emits an audit event,\nand notifies all super-admins via in-app and email.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/me\/gdpr-requests", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/me\/gdpr-requests" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subject_email\":\"name@example.at\",\"request_type\":\"access\",\"message\":\"Bitte um Rueckmeldung zur naechsten Schicht.\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"CREATED\",\n \"message\": \"GDPR request submitted successfully.\",\n \"data\": {\n \"id\": \"019fd2b8-4116-7347-914a-230153f403ce\",\n \"request_type\": \"access\",\n \"request_type_label\": \"Access (Art. 15)\",\n \"subject_email\": \"name@example.at\",\n \"message\": \"Bitte um Rueckmeldung zur naechsten Schicht.\",\n \"status\": \"pending\",\n \"status_label\": \"Pending\",\n \"submitted_at\": \"2026-08-05T16:18:38.000000Z\",\n \"resolved_at\": null,\n \"platform_note\": null,\n \"created_at\": \"2026-08-05T16:18:38.000000Z\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"8f34c05d-27c1-4a19-b728-9442355514a1\",\n \"timestamp\": \"2026-08-05T16:18:38.490505Z\"\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "GDPR Art. 15 (Right of Access) \/ Art. 20 (Right to Data Portability).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/me\/data-export", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/me\/data-export" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a structured JSON export of the organisation's platform data:\ncampaigns (with images), donations received, recurring donations, and\nteam members. Donor PII is masked \u2014 only display names and masked\nemail addresses are included.\n\nAustrian DSG \u00a71(1) + GDPR Art. 12(3): response within one month,\ndelivered immediately here as structured JSON." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Data export generated.\",\n \"data\": {\n \"organisation\": {\n \"id\": \"019fd2b7-f072-7154-8961-5b324cc6c46c\",\n \"name\": \"Caritas\",\n \"legal_name\": null,\n \"legal_form\": null,\n \"tax_id\": null,\n \"email\": \"caritas-portal@flexxr.eu.cc\",\n \"phone\": \"+436641234567\",\n \"website\": \"https:\/\/www.caritas.at\",\n \"country\": \"Austria\",\n \"city\": \"Vienna\",\n \"address\": \"Albrechtskreithgasse 19-21\",\n \"postal_code\": null,\n \"created_at\": \"2026-08-05T16:18:17+00:00\"\n },\n \"team_members\": [\n {\n \"id\": \"019fd2b8-285e-707c-865a-ffbe4b08f730\",\n \"role\": \"admin\",\n \"is_active\": true,\n \"joined_at\": \"2026-08-05T16:18:32+00:00\"\n }\n ],\n \"exported_at\": \"2026-08-05T16:18:38+00:00\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"c29cdf34-d349-42b5-9f9b-af7de00d12c4\",\n \"timestamp\": \"2026-08-05T16:18:38.498181Z\"\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Lists GDPR Art. 12(3) requests submitted by the authenticated organisation.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/gdpr\/requests", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/gdpr\/requests" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Success\",\n \"data\": [],\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"c161e586-954d-48ca-928d-41bad21a8adf\",\n \"timestamp\": \"2026-08-05T16:18:38.479808Z\",\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 15,\n \"total\": 0\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Records a new GDPR Art. 12(3) request forwarded by an organisation on\nbehalf of a data subject. Persists the request, emits an audit event,\nand notifies all super-admins via in-app and email.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/gdpr\/requests", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/gdpr\/requests" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subject_email\":\"name@example.at\",\"request_type\":\"access\",\"message\":\"Bitte um Rueckmeldung zur naechsten Schicht.\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"CREATED\",\n \"message\": \"GDPR request submitted successfully.\",\n \"data\": {\n \"id\": \"019fd2b8-4116-7347-914a-230153f403ce\",\n \"request_type\": \"access\",\n \"request_type_label\": \"Access (Art. 15)\",\n \"subject_email\": \"name@example.at\",\n \"message\": \"Bitte um Rueckmeldung zur naechsten Schicht.\",\n \"status\": \"pending\",\n \"status_label\": \"Pending\",\n \"submitted_at\": \"2026-08-05T16:18:38.000000Z\",\n \"resolved_at\": null,\n \"platform_note\": null,\n \"created_at\": \"2026-08-05T16:18:38.000000Z\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"8f34c05d-27c1-4a19-b728-9442355514a1\",\n \"timestamp\": \"2026-08-05T16:18:38.490505Z\"\n }\n}", "name": "Recorded from a live call" } ] } ] }, { "name": "Privacy", "description": "", "item": [ { "name": "Consent History", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/me\/consent-history", "query": [ { "key": "per_page", "value": "25", "description": "nullable Results per page (min 1, max 100, default 25).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org\/me\/consent-history?per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of cookie-consent decisions recorded for the authenticated organisation.\nBacked by the immutable audit log (GDPR Art. 15 right of access)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Success\",\n \"data\": [],\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"a726ed83-b8fd-4332-9cfe-5ef5302a22f0\",\n \"timestamp\": \"2026-08-05T16:18:38.519100Z\",\n \"total\": 0,\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Record Cookie Consent", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/me\/consent", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/me\/consent" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"version\":\"2026-04-01\",\"choices\":{\"necessary\":true,\"analytics\":false,\"marketing\":false},\"timestamp\":\"2026-04-21T10:00:00.000Z\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Consent recorded.\",\n \"data\": {\n \"recorded_at\": \"2026-08-05T16:18:38+00:00\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"5a2c4cdb-a5b7-4ed0-adc0-6d872d01255a\",\n \"timestamp\": \"2026-08-05T16:18:38.527726Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"The given data was invalid.\",\"data\":null,\"errors\":[{\"field\":\"choices.necessary\",\"message\":\"The choices.necessary field must be accepted.\"}],\"meta\":{\"request_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"timestamp\":\"2026-04-21T10:00:00.000000Z\"}}", "name": "Validation Error" } ] } ] }, { "name": "Audit", "description": "", "item": [ { "name": "List Org Audit Log", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/audit-log", "query": [ { "key": "event", "value": "model.updated", "description": "nullable Filter by audit event value (must be in the allowed list).", "disabled": false }, { "key": "from", "value": "2026-01-01", "description": "nullable Inclusive ISO date.", "disabled": false }, { "key": "to", "value": "2026-12-31", "description": "nullable Inclusive ISO date.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Rows per page (1\u2013100, default 25).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org\/audit-log?event=model.updated&from=2026-01-01&to=2026-12-31&page=1&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"event\":\"architecto\",\"from\":\"2026-08-21T05:14:34\",\"to\":\"2052-09-13\",\"page\":22,\"per_page\":67}" }, "description": "A paginated view of everything the authenticated organisation did, had\ndone to it, or had done on its behalf. A row is in scope when any of the\nfollowing holds:\n\n a) the organisation is the actor;\n b) the organisation is the subject;\n c) the subject is one of its members; or\n d) one of its members is the actor \u2014 most of a company's work is done\n by the people it invited, so without this the log showed almost\n none of the company's real activity.\n\nThe event filter accepts a value from the allowed list, which excludes\nadmin-internal and user-PII events so they are never exposed here." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Audit log retrieved.\",\n \"data\": [],\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"24a91099-8b31-42b2-ae2c-6bcd6450f1fd\",\n \"timestamp\": \"2026-08-05T16:18:38.535487Z\",\n \"current_page\": 22,\n \"last_page\": 1,\n \"per_page\": 67,\n \"total\": 0\n }\n}", "name": "Recorded from a live call" } ] } ] }, { "name": "Security", "description": "", "item": [ { "name": "Get Two-Factor State", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/security\/two-factor", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/security\/two-factor" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Success\",\n \"data\": {\n \"enabled\": true,\n \"method\": \"totp\",\n \"confirmed_at\": \"2026-08-05T16:18:32+00:00\",\n \"recovery_codes_remaining\": 2\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"3f0ace2f-07fd-4e6e-9bd0-24b9619f2e8e\",\n \"timestamp\": \"2026-08-05T16:18:38.604346Z\"\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "List Login History", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/security\/login-history", "query": [ { "key": "limit", "value": "50", "description": "nullable Maximum entries to return (min 1, max 200, default 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org\/security\/login-history?limit=50" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Success\",\n \"data\": [],\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"a1ef4b94-6775-44ca-996f-3a02b14c2a73\",\n \"timestamp\": \"2026-08-05T16:18:38.610416Z\"\n }\n}", "name": "Recorded from a live call" } ] } ] }, { "name": "Kyc Status", "description": "", "item": [ { "name": "Get Organisation KYC Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/kyc-status", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/kyc-status" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the KYC checklist status for the authenticated organisation." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"KYC-Status erfolgreich abgerufen.\",\n \"data\": {\n \"organization\": {\n \"id\": \"019fd2b7-f072-7154-8961-5b324cc6c46c\",\n \"status\": \"active\",\n \"statusLabel\": \"Active\",\n \"rejectionReason\": null,\n \"verifiedAt\": \"2026-08-05T16:18:17+00:00\"\n },\n \"summary\": {\n \"requiredCount\": 5,\n \"uploadedCount\": 0,\n \"approvedCount\": 0,\n \"rejectedCount\": 0,\n \"missingCount\": 5,\n \"completionPercent\": 0,\n \"isReadyForReview\": false,\n \"nextAction\": \"upload_missing\"\n },\n \"checklist\": [\n {\n \"type\": \"gewerbeschein\",\n \"label\": \"Gewerbeschein\",\n \"description\": null,\n \"required\": true,\n \"source\": \"baseline\",\n \"status\": \"missing\",\n \"latestDocument\": null,\n \"historyCount\": 0,\n \"openRequestId\": null\n },\n {\n \"type\": \"firmenbuch_auszug\",\n \"label\": \"Firmenbuchauszug\",\n \"description\": null,\n \"required\": true,\n \"source\": \"baseline\",\n \"status\": \"missing\",\n \"latestDocument\": null,\n \"historyCount\": 0,\n \"openRequestId\": null\n },\n {\n \"type\": \"aueg_bewilligung\",\n \"label\": \"A\u00dcG-Bewilligung\",\n \"description\": null,\n \"required\": true,\n \"source\": \"baseline\",\n \"status\": \"missing\",\n \"latestDocument\": null,\n \"historyCount\": 0,\n \"openRequestId\": null\n },\n {\n \"type\": \"ausweis_gf\",\n \"label\": \"Ausweis Gesch\u00e4ftsf\u00fchrer\",\n \"description\": null,\n \"required\": true,\n \"source\": \"baseline\",\n \"status\": \"missing\",\n \"latestDocument\": null,\n \"historyCount\": 0,\n \"openRequestId\": null\n },\n {\n \"type\": \"unterschriftenprobe\",\n \"label\": \"Unterschriftenprobe\",\n \"description\": null,\n \"required\": true,\n \"source\": \"baseline\",\n \"status\": \"missing\",\n \"latestDocument\": null,\n \"historyCount\": 0,\n \"openRequestId\": null\n },\n {\n \"type\": \"uid_bestaetigung\",\n \"label\": \"UID-Best\u00e4tigung\",\n \"description\": null,\n \"required\": false,\n \"source\": \"baseline\",\n \"status\": \"missing\",\n \"latestDocument\": null,\n \"historyCount\": 0,\n \"openRequestId\": null\n }\n ],\n \"openRequests\": []\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"673ba49d-0208-4a7a-8bd6-ccba99d10ede\",\n \"timestamp\": \"2026-08-05T16:18:38.651604Z\"\n }\n}", "name": "Recorded from a live call" } ] } ] }, { "name": "Documents", "description": "", "item": [ { "name": "List Organization Documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/documents", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/documents" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists all non-deleted KYC documents belonging to the authenticated organisation." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Dokumente erfolgreich abgerufen.\",\n \"data\": [],\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"f421c038-b8cf-43c0-ab3b-142d37da1232\",\n \"timestamp\": \"2026-08-05T16:18:38.658086Z\"\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Upload Organization Document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/documents", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/documents" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "Beispieltext", "type": "text", "description": "" }, { "key": "document_request_id", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "type": "text", "description": "" }, { "key": "file", "src": [], "type": "file" } ] }, "description": "Accepts a KYC document upload from the authenticated organisation." }, "response": [] }, { "name": "Download Organization Document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/documents\/:document_id\/download", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/documents\/:document_id\/download", "variable": [ { "id": "document_id", "key": "document_id", "value": "019f34d3-5029-7158-a549-910ae39abad5", "description": "The ID of the document." }, { "id": "document", "key": "document", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Streams a KYC document back to the owning organisation." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 503, "body": "{\"status\":\"ERROR\",\"message\":\"Service Unavailable\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Service Unavailable\"}],\"meta\":{\"request_id\":\"b21dce97-33bd-4cbb-a28c-67af75128d72\",\"timestamp\":\"2026-08-21T05:14:34.591593Z\"}}", "name": "" } ] }, { "name": "Delete Organization Document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/documents\/:document_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/documents\/:document_id", "variable": [ { "id": "document_id", "key": "document_id", "value": "019f34d3-5029-7158-a549-910ae39abad5", "description": "The ID of the document." }, { "id": "document", "key": "document", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Soft-deletes a Pending KYC document belonging to the authenticated organisation." }, "response": [] } ] }, { "name": "Legal Documents", "description": "", "item": [ { "name": "List Organisation Legal Documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/legal-documents", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/legal-documents" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists the legal documents the organisation must accept, the current acceptance\nstate per type, and the full acceptance history (for the \"Legal documents\" page)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Rechtsdokumente erfolgreich abgerufen.\",\n \"data\": {\n \"documents\": [\n {\n \"type\": \"privacy_policy\",\n \"label\": \"Datenschutzerkl\u00e4rung\",\n \"locale\": \"de\",\n \"currentVersion\": 1,\n \"currentVersionId\": \"019fd2b7-ef68-7312-a1a3-6b14820cf9e2\",\n \"acceptedVersion\": 1,\n \"acceptedAt\": \"2026-08-05T16:18:32+00:00\",\n \"status\": \"accepted\",\n \"viewUrl\": \"http:\/\/localhost:8001\/legal\/privacy_policy\/de\/v\/1\"\n },\n {\n \"type\": \"terms_of_service\",\n \"label\": \"Allgemeine Gesch\u00e4ftsbedingungen\",\n \"locale\": \"de\",\n \"currentVersion\": 1,\n \"currentVersionId\": \"019fd2b7-ef6f-72ae-8c86-d9977da26ec0\",\n \"acceptedVersion\": 1,\n \"acceptedAt\": \"2026-08-05T16:18:32+00:00\",\n \"status\": \"accepted\",\n \"viewUrl\": \"http:\/\/localhost:8001\/legal\/terms_of_service\/de\/v\/1\"\n },\n {\n \"type\": \"data_processing\",\n \"label\": \"Auftragsverarbeitung\",\n \"locale\": \"de\",\n \"currentVersion\": 1,\n \"currentVersionId\": \"019fd2b7-ef76-73b5-a9c5-d7cca778324b\",\n \"acceptedVersion\": 1,\n \"acceptedAt\": \"2026-08-05T16:18:32+00:00\",\n \"status\": \"accepted\",\n \"viewUrl\": \"http:\/\/localhost:8001\/legal\/data_processing\/de\/v\/1\"\n },\n {\n \"type\": \"svnr_consent\",\n \"label\": \"Einwilligung zur SV-Nummer\",\n \"locale\": \"de\",\n \"currentVersion\": 1,\n \"currentVersionId\": \"019fd2b7-ef83-7298-a78c-af4b1e36b67b\",\n \"acceptedVersion\": 1,\n \"acceptedAt\": \"2026-08-05T16:18:32+00:00\",\n \"status\": \"accepted\",\n \"viewUrl\": \"http:\/\/localhost:8001\/legal\/svnr_consent\/de\/v\/1\"\n }\n ],\n \"history\": [\n {\n \"type\": \"svnr_consent\",\n \"label\": \"Einwilligung zur SV-Nummer\",\n \"version\": 1,\n \"acceptedAt\": \"2026-08-05T16:18:32+00:00\",\n \"withdrawnAt\": null\n },\n {\n \"type\": \"data_processing\",\n \"label\": \"Auftragsverarbeitung\",\n \"version\": 1,\n \"acceptedAt\": \"2026-08-05T16:18:32+00:00\",\n \"withdrawnAt\": null\n },\n {\n \"type\": \"terms_of_service\",\n \"label\": \"Allgemeine Gesch\u00e4ftsbedingungen\",\n \"version\": 1,\n \"acceptedAt\": \"2026-08-05T16:18:32+00:00\",\n \"withdrawnAt\": null\n },\n {\n \"type\": \"privacy_policy\",\n \"label\": \"Datenschutzerkl\u00e4rung\",\n \"version\": 1,\n \"acceptedAt\": \"2026-08-05T16:18:32+00:00\",\n \"withdrawnAt\": null\n }\n ]\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"5088afd2-6632-4150-9a93-7a8d53e7d090\",\n \"timestamp\": \"2026-08-05T16:18:38.691599Z\"\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Get Organisation Pending Legal Acceptances", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/legal-documents\/pending", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/legal-documents\/pending" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the legal document versions the organisation must still accept." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Ausstehende Rechtsdokumente erfolgreich abgerufen.\",\n \"data\": {\n \"pending\": []\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"8b96ae8c-9c5d-435e-a7ab-974f30899fbb\",\n \"timestamp\": \"2026-08-05T16:18:38.707936Z\"\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Accept Organisation Legal Document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/legal-documents\/:type\/accept", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/legal-documents\/:type\/accept", "variable": [ { "id": "type", "key": "type", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Records the organisation's acceptance of the current version of a legal\ndocument type, pinning the exact version for audit." }, "response": [] } ] }, { "name": "Contract Template", "description": "", "item": [ { "name": "Get Contract Template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/contract-template", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/contract-template" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The organisation's default contract template for the settings editor: the\nsaved organisation-level row when one exists, otherwise the built-in\ndefault body \u2014 plus the merge fields the editor can insert. Per-job and\nper-shift overrides have their own endpoints ({@see GetJobContractTemplateAction},\n{@see GetShiftContractTemplateAction}); this is always the organisation\ndefault level (job_id and shift_id both null)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"template\": {\n \"name\": \"\u00dcberlassungsvertrag\",\n \"body_html\": \"
{worker_name}, geboren am {worker_birth_date}, {worker_address}<\/p>\\n
{organization_name}, {organization_address}<\/p>\\n
T\u00e4tigkeit: {job_title}
Einsatzort: {location}
Zeitraum: {start_date} \u2013 {end_date}
Entgelt (brutto\/Std.): {hourly_rate}
Kollektivvertrag: {collective_agreement}<\/p>\\n
F\u00fcr die Dauer der \u00dcberlassung gelten gem\u00e4\u00df \u00a7 10 A\u00dcG die im Besch\u00e4ftigerbetrieb f\u00fcr vergleichbare Arbeitnehmer geltenden wesentlichen Arbeits- und Besch\u00e4ftigungsbedingungen. Rechtsgrundlage: {legal_basis}.<\/p>\",\n \"version\": 0,\n \"is_active\": false,\n \"is_customized\": false\n },\n \"merge_fields\": [\n \"contract_number\",\n \"worker_name\",\n \"worker_birth_date\",\n \"worker_nationality\",\n \"worker_address\",\n \"organization_name\",\n \"organization_address\",\n \"job_title\",\n \"job_description\",\n \"location\",\n \"start_date\",\n \"end_date\",\n \"hourly_rate\",\n \"collective_agreement\",\n \"legal_basis\"\n ]\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Update Contract Template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/contract-template", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/contract-template" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Beispieltext\",\"body_html\":\"Bitte um Rueckmeldung zur naechsten Schicht.\",\"is_active\":true}" }, "description": "Save the organisation's default contract template (job_id and shift_id both\nnull). Upserts the single per-org row, bumps its version, and strips active\ncontent (script\/style) from the HTML \u2014 the body is rendered into the\nworker's signed PDF unless a job or shift override applies." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"The contract template has been saved.\",\n \"data\": {\n \"template\": {\n \"name\": \"Beispieltext\",\n \"body_html\": \"Bitte um Rueckmeldung zur naechsten Schicht.\",\n \"version\": 1,\n \"is_active\": true,\n \"is_customized\": true\n }\n }\n}", "name": "Recorded from a live call" } ] } ] }, { "name": "Messages", "description": "", "item": [ { "name": "List Conversations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/messages\/conversations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/messages\/conversations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List conversations for organization staff." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"conversations\": [\n {\n \"id\": \"64c3f8d8-55d2-4457-b394-c3277a378bac\",\n \"participant\": {\n \"id\": \"019fd2b7-f271-73fd-8268-848be381e136\",\n \"name\": \"Anna Neuling\",\n \"avatar_url\": null\n },\n \"job\": null,\n \"last_message\": null,\n \"last_message_is_from_user\": null,\n \"last_message_at\": \"2026-08-05T16:18:32+00:00\",\n \"unread_count\": 0\n }\n ]\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Get Messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/messages\/conversations\/:conversation_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/messages\/conversations\/:conversation_id", "variable": [ { "id": "conversation_id", "key": "conversation_id", "value": "019fd51d-53c7-73d0-880d-8edee1800329", "description": "The ID of the conversation." }, { "id": "conversation", "key": "conversation", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get messages for a conversation." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"conversation\": {\n \"id\": \"64c3f8d8-55d2-4457-b394-c3277a378bac\",\n \"participant\": {\n \"id\": \"019fd2b7-f271-73fd-8268-848be381e136\",\n \"name\": \"Anna Neuling\",\n \"avatar_url\": null\n },\n \"job\": null\n },\n \"messages\": [],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 50,\n \"total\": 0\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Mark Conversation Read", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/messages\/conversations\/:conversation\/read", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/messages\/conversations\/:conversation\/read", "variable": [ { "id": "conversation", "key": "conversation", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mark a conversation as read by the organization." }, "response": [ { "header": [], "code": 200, "body": "{\"status\": \"SUCCESS\"}", "name": "Marked read" } ] }, { "name": "Upload a Message Attachment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/messages\/conversations\/:conversation\/attachments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/messages\/conversations\/:conversation\/attachments", "variable": [ { "id": "conversation", "key": "conversation", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "Identifier from the collection." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "src": [], "type": "file" } ] }, "description": "Upload a file attachment ahead of sending it with a message. The\nreturned attachment id is bound to a message when that message is sent." }, "response": [ { "header": [], "code": 201, "body": "{\"status\": \"SUCCESS\", \"data\": {\"attachment\": {\"id\": \"019f9939-c4c3-70fb-a54e-5ebf63db36d2\", \"name\": \"beleg.pdf\", \"mime_type\": \"application\/pdf\", \"file_size\": 48213}}}", "name": "Uploaded" } ] }, { "name": "Send Message", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/messages" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"019f9939-c4c3-70fb-a54e-5ebf63db36d2\",\"content\":\"Beispieltext\",\"job_id\":\"019f9939-c4c3-70fb-a54e-5ebf63db36d2\",\"shift_id\":\"019f9939-c4c3-70fb-a54e-5ebf63db36d2\",\"attachments\":null}" }, "description": "Send a message to an employee." }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"message\": {\n \"id\": \"019fd2b8-4623-72c9-81f4-41013427b344\",\n \"conversation_id\": \"019fd2b8-4620-7315-bdd5-20f236d38c04\",\n \"content\": \"Beispieltext\",\n \"created_at\": \"2026-08-05T16:18:39+00:00\"\n }\n }\n}", "name": "Recorded from a live call" } ] } ] }, { "name": "Audit Log", "description": "", "item": [ { "name": "Record Organisation Pii Reveal", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/audit-log\/pii-reveal", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/audit-log\/pii-reveal" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"Beispieltext\",\"context\":\"Beispieltext\",\"subject_type\":\"Frage zur Abrechnung\",\"subject_id\":\"019f9939-c4c3-70fb-a54e-5ebf63db36d2\",\"fields\":null}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"PII reveal has been audit logged.\"\n}", "name": "Recorded from a live call" } ] } ] }, { "name": "Support", "description": "", "item": [ { "name": "List Support Tickets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/support\/tickets", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/support\/tickets" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The tickets visible to the caller, newest first, optionally narrowed by status." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"tickets\": [\n {\n \"id\": \"019fd2b8-28b2-7322-b70c-bc7d76debfc3\",\n \"ticket_number\": \"TKT-717858\",\n \"subject\": \"Nihil autem neque blanditiis accusantium eaque.\",\n \"category\": \"general\",\n \"category_label\": \"Allgemein\",\n \"status\": \"open\",\n \"status_label\": \"Offen\",\n \"priority\": 3,\n \"requester_type\": \"company\",\n \"requester_name\": \"Caritas\",\n \"assignee_name\": null,\n \"message_count\": 0,\n \"last_message_at\": null,\n \"created_at\": \"2026-08-05T16:18:32+00:00\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Open a Support Ticket", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/support\/tickets", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/support\/tickets" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"category\":\"general\",\"subject\":\"Frage zur Abrechnung\",\"description\":\"Beispieltext\",\"related_entity_type\":\"shift\",\"related_entity_id\":\"019f9939-c4c3-70fb-a54e-5ebf63db36d2\"}" }, "description": "Raises a new support ticket with a subject and an opening message." }, "response": [] }, { "name": "Show a Support Ticket", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/support\/tickets\/:ticketId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/support\/tickets\/:ticketId", "variable": [ { "id": "ticketId", "key": "ticketId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "The ticket." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "One ticket with its message thread. Internal notes are never included." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"id\": \"019fd2b8-28b2-7322-b70c-bc7d76debfc3\",\n \"ticket_number\": \"TKT-717858\",\n \"subject\": \"Nihil autem neque blanditiis accusantium eaque.\",\n \"category\": \"general\",\n \"category_label\": \"Allgemein\",\n \"status\": \"open\",\n \"status_label\": \"Offen\",\n \"priority\": 3,\n \"requester_type\": \"company\",\n \"requester_name\": \"Caritas\",\n \"assignee_name\": null,\n \"message_count\": 0,\n \"last_message_at\": null,\n \"created_at\": \"2026-08-05T16:18:32+00:00\",\n \"description\": \"Quo necessitatibus et tempora esse nemo. Omnis et molestias sed expedita cupiditate.\\n\\nQuidem mollitia et reprehenderit enim quidem est. Temporibus et blanditiis iusto officia neque molestiae quidem. Adipisci suscipit sit temporibus voluptatum porro molestiae omnis. Rem fuga ratione ratione odio esse odio modi.\",\n \"resolution_notes\": null,\n \"related_entity_type\": null,\n \"related_entity_id\": null,\n \"assigned_to\": null,\n \"first_response_at\": null,\n \"resolved_at\": null,\n \"messages\": []\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Reply to a Support Ticket", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/support\/tickets\/:ticketId\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/support\/tickets\/:ticketId\/messages", "variable": [ { "id": "ticketId", "key": "ticketId", "value": "019f9939-c4c3-70fb-a54e-5ebf63db36d2", "description": "The ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"message\":\"Bitte um Rueckmeldung zur naechsten Schicht.\"}" }, "description": "Appends a message to an existing ticket." }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Your message has been sent.\",\n \"data\": {\n \"message\": {\n \"id\": \"019fd2b8-46aa-7182-9c38-e64d58e94097\",\n \"message\": \"Bitte um Rueckmeldung zur naechsten Schicht.\",\n \"sender_type\": \"company\",\n \"sender_name\": \"Caritas\",\n \"is_internal\": false,\n \"attachments\": null,\n \"created_at\": \"2026-08-05T16:18:39+00:00\"\n }\n }\n}", "name": "Recorded from a live call" } ] } ] } ] }, { "name": "Admin - Employees", "description": "Admin dashboard endpoints for platform management. Requires admin-level Bearer token authentication.", "item": [ { "name": "Employees", "description": "", "item": [ { "name": "Apply a sanction to a worker who was sent home or breached the rules. The\nadmin chooses the consequence: suspension days, a payment treatment\n(full \/ partial \/ none \/ goodwill) and\/or a warning (Ermahnung).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/employees\/:profileId\/sanction", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/employees\/:profileId\/sanction", "variable": [ { "id": "profileId", "key": "profileId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Wiederholtes Zusp\u00e4tkommen\",\"suspension_days\":7,\"payment_treatment\":\"partial\",\"issue_warning\":true,\"shift_id\":\"architecto\"}" }, "description": "" }, "response": [] } ] } ] }, { "name": "Admin - LHR Payroll", "description": "Admin dashboard endpoints for platform management. Requires admin-level Bearer token authentication.", "item": [ { "name": "Lhr", "description": "", "item": [ { "name": "Request Payroll Approval", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/lhr\/payroll\/approval-requests", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/lhr\/payroll\/approval-requests" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"period\":\"2026-06\"}" }, "description": "Opens a four-eyes approval request for a payroll period.\nA different admin with `admin.payroll.trigger` must then approve it\nbefore the payroll trigger endpoint will accept the approval_id." }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"CREATED\",\n \"message\": \"Approval request opened.\",\n \"data\": {\n \"id\": \"019fd2b8-53e2-72c9-afe8-17239fd1a8e1\",\n \"period\": \"2026-06\",\n \"status\": \"pending\",\n \"requested_by_id\": \"019fd2b7-edab-7280-b09f-b18f58a272ee\",\n \"created_at\": \"2026-08-05T16:18:43.000000Z\"\n },\n \"errors\": null,\n \"meta\": {\n \"request_id\": \"b7e77921-3f4d-4d85-83af-84afa8e7b97e\",\n \"timestamp\": \"2026-08-05T16:18:43.305161Z\"\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 409, "body": "{\"status\":\"CONFLICT\",\"message\":\"An open approval request already exists for this period.\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"This period has already been executed.\"}", "name": "" } ] }, { "name": "Approve Payroll Approval Request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/lhr\/payroll\/approval-requests\/:approval_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/lhr\/payroll\/approval-requests\/:approval_id", "variable": [ { "id": "approval_id", "key": "approval_id", "value": "architecto", "description": "The ID of the approval." }, { "id": "approval", "key": "approval", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "UUID of the approval request." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Approves a pending four-eyes payroll approval request.\nThe approver must be a different admin from the requester." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"SUCCESS\",\"message\":\"Approval granted.\",\"data\":{\"id\":\"uuid\",\"period\":\"2026-06\",\"status\":\"approved\",\"approved_by_id\":\"uuid\",\"approved_at\":\"2026-06-14T10:05:00.000000Z\"}}", "name": "" }, { "header": [], "code": 403, "body": "{\"status\":\"FORBIDDEN\",\"message\":\"The requester cannot approve their own request.\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"This approval request is not in a pending state.\"}", "name": "" } ] }, { "name": "Reject Payroll Approval Request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/lhr\/payroll\/approval-requests\/:approval_id\/reject", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/lhr\/payroll\/approval-requests\/:approval_id\/reject", "variable": [ { "id": "approval_id", "key": "approval_id", "value": "architecto", "description": "The ID of the approval." }, { "id": "approval", "key": "approval", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "UUID of the approval request." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Overtime for the Graz site is still unconfirmed.\"}" }, "description": "Declines a pending four-eyes payroll approval request, closing the period\nto payroll until a new request is raised. The reviewer must be a different\nadmin from the requester, and must say why \u2014 the requester needs to know\nwhat to change before asking again." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"SUCCESS\",\"message\":\"Approval rejected.\",\"data\":{\"id\":\"uuid\",\"period\":\"2026-06\",\"status\":\"rejected\",\"approved_by_id\":\"uuid\",\"approved_at\":\"2026-06-14T10:05:00.000000Z\",\"rejection_reason\":\"Overtime for the Graz site is still unconfirmed.\"}}", "name": "" }, { "header": [], "code": 403, "body": "{\"status\":\"FORBIDDEN\",\"message\":\"The requester cannot approve their own request.\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"This approval request is not in a pending state.\"}", "name": "" } ] }, { "name": "Trigger LHR payroll.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/lhr\/payroll\/trigger", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/lhr\/payroll\/trigger" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"period\":\"2026-01\",\"approval_id\":\"architecto\"}" }, "description": "Trigger monthly payroll calculation in LHR.\n\nRequires a pre-approved four-eyes approval record. The `approval_id`\nmust reference a PayrollApproval in `approved` state for the same\nperiod, approved by a different admin than the caller who requested it." }, "response": [ { "header": [], "code": 202, "body": "{\"status\":\"success\",\"message\":\"Payroll calculation triggered\",\"data\":{\"abrechnung_id\":\"abc-123\",\"period\":\"2026-01\",\"status\":\"queued\"}}", "name": "" }, { "header": [], "code": 422, "body": "{\"status\":\"VALIDATION_ERROR\",\"message\":\"Approval is not in an approved state.\"}", "name": "" }, { "header": [], "code": 503, "body": "{\"status\":\"error\",\"message\":\"LHR service unavailable\"}", "name": "" } ] }, { "name": "Get payroll calculation status from LHR.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/lhr\/payroll\/:abrechnungId\/status", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/lhr\/payroll\/:abrechnungId\/status", "variable": [ { "id": "abrechnungId", "key": "abrechnungId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 503, "body": "{\"status\":\"ERROR\",\"message\":\"Service Unavailable\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Service Unavailable\"}],\"meta\":{\"request_id\":\"83b111e4-96dc-4495-ba19-ba40d5076dc9\",\"timestamp\":\"2026-08-21T05:14:36.862690Z\"}}", "name": "" } ] }, { "name": "Get payroll results from LHR.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/lhr\/payroll\/:abrechnungId\/results", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/lhr\/payroll\/:abrechnungId\/results", "variable": [ { "id": "abrechnungId", "key": "abrechnungId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 503, "body": "{\"status\":\"ERROR\",\"message\":\"Service Unavailable\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Service Unavailable\"}],\"meta\":{\"request_id\":\"524f03f5-0c13-41af-82bd-26b21bef8af1\",\"timestamp\":\"2026-08-21T05:14:36.871506Z\"}}", "name": "" } ] }, { "name": "Sync employee data with LHR.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/lhr\/dienstnehmer\/sync", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/lhr\/dienstnehmer\/sync" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"019f9939-c4c3-70fb-a54e-5ebf63db36d2\"}" }, "description": "" }, "response": [] }, { "name": "List employee documents from LHR.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/lhr\/users\/:userId\/documents", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/lhr\/users\/:userId\/documents", "variable": [ { "id": "userId", "key": "userId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"documents\": []\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Download payslips from LHR.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/lhr\/users\/:userId\/payslip", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/lhr\/users\/:userId\/payslip", "variable": [ { "id": "userId", "key": "userId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 503, "body": "{\"status\":\"ERROR\",\"message\":\"Service Unavailable\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Service Unavailable\"}],\"meta\":{\"request_id\":\"25d24af1-490a-490e-878a-158c3d0a4b2e\",\"timestamp\":\"2026-08-21T05:14:36.907967Z\"}}", "name": "" } ] } ] } ] }, { "name": "Admin - Shifts", "description": "Admin dashboard endpoints for platform management. Requires admin-level Bearer token authentication.", "item": [ { "name": "Shifts", "description": "", "item": [ { "name": "Resolve an attendance hours dispute (conflict) raised during check-out.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/shifts\/:shiftId\/resolve-dispute", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/shifts\/:shiftId\/resolve-dispute", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resolution\":\"Stunden laut Anwesenheitsliste best\u00e4tigt.\"}" }, "description": "" }, "response": [] } ] } ] }, { "name": "Company - Assignments", "description": "Organization (Company Portal) endpoints for managing jobs, applicants, shifts, team, and organization profiles. Requires organization-level Bearer token. Some endpoints require approved organization status.", "item": [ { "name": "Shifts", "description": "", "item": [ { "name": "List all shift assignments for the organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/assignments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/assignments" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"assignments\": [\n {\n \"id\": \"019fd2b8-1636-72ac-b1d9-8d969732067e\",\n \"status\": \"signed\",\n \"status_label\": \"Unterschrieben\",\n \"shift_date\": \"2026-08-25\",\n \"scheduled_start_time\": \"08:00:00\",\n \"scheduled_end_time\": \"16:00:00\",\n \"location_name\": \"MuseumsQuartier Wien\",\n \"location_address\": \"Museumsplatz 1, 1070 Wien\",\n \"hourly_rate_gross\": \"14.00\",\n \"confirmed_at\": \"2026-08-22 00:00\",\n \"started_at\": null,\n \"completed_at\": null,\n \"job\": {\n \"id\": \"019fd2b8-1628-73ae-86e5-b232f0363a96\",\n \"title\": \"Event-Fotograf Assistent\",\n \"category\": \"Events\"\n },\n \"employee\": {\n \"id\": \"019fd2b8-0d32-71d1-98de-ce0b40a5b75d\",\n \"name\": \"Andreas Weber\",\n \"email\": \"andreas.weber12@demo-employee.at\",\n \"city\": \"Linz\"\n }\n },\n {\n \"id\": \"019fd2b8-18c6-71d1-9d10-c4ee02fbff17\",\n \"status\": \"signed\",\n \"status_label\": \"Unterschrieben\",\n \"shift_date\": \"2026-08-07\",\n \"scheduled_start_time\": \"08:00:00\",\n \"scheduled_end_time\": \"16:00:00\",\n \"location_name\": \"H&M Mariahilfer\",\n \"location_address\": \"Mariahilfer Stra\u00dfe 42, 1070 Wien\",\n \"hourly_rate_gross\": \"13.50\",\n \"confirmed_at\": \"2026-08-06 00:00\",\n \"started_at\": null,\n \"completed_at\": null,\n \"job\": {\n \"id\": \"019fd2b8-18bd-713e-8faf-09b99d95cb72\",\n \"title\": \"Kassiere*r Modegesch\u00e4ft\",\n \"category\": \"Einzelhandel\"\n },\n \"employee\": {\n \"id\": \"019fd2b8-02bf-72ff-a65c-330126050c95\",\n \"name\": \"Stefan M\u00fcller\",\n \"email\": \"stefan.m\u00fcller0@demo-employee.at\",\n \"city\": \"Wien\"\n }\n },\n {\n \"id\": \"019fd2b8-28d3-70d7-92eb-f1bb1577acaf\",\n \"status\": \"signed\",\n \"status_label\": \"Unterschrieben\",\n \"shift_date\": \"2026-08-06\",\n \"scheduled_start_time\": \"08:00:00\",\n \"scheduled_end_time\": \"16:00:00\",\n \"location_name\": \"Nolan-Roberts\",\n \"location_address\": \"4309 O'Reilly Way Suite 012\",\n \"hourly_rate_gross\": \"34.72\",\n \"confirmed_at\": null,\n \"started_at\": null,\n \"completed_at\": null,\n \"job\": {\n \"id\": \"019fd2b8-28c4-732f-a94c-fb5a71a7d682\",\n \"title\": \"Accountant\",\n \"category\": \"B\u00fcro\"\n },\n \"employee\": {\n \"id\": \"019fd2b7-f271-73fd-8268-848be381e136\",\n \"name\": \"Anna Neuling\",\n \"email\": \"pending@demo.flexxr.at\",\n \"city\": \"Linz\"\n }\n },\n {\n \"id\": \"019fd2b8-28d8-728d-a447-8de1a42eec83\",\n \"status\": \"checked_in\",\n \"status_label\": \"Eingecheckt\",\n \"shift_date\": \"2026-08-05\",\n \"scheduled_start_time\": \"11:58:00\",\n \"scheduled_end_time\": \"12:13:00\",\n \"location_name\": \"Goldner and Sons\",\n \"location_address\": \"30005 Prosacco Orchard\",\n \"hourly_rate_gross\": \"18.57\",\n \"confirmed_at\": null,\n \"started_at\": null,\n \"completed_at\": null,\n \"job\": {\n \"id\": \"019fd2b8-28c4-732f-a94c-fb5a71a7d682\",\n \"title\": \"Accountant\",\n \"category\": \"B\u00fcro\"\n },\n \"employee\": {\n \"id\": \"019fd2b7-f271-73fd-8268-848be381e136\",\n \"name\": \"Anna Neuling\",\n \"email\": \"pending@demo.flexxr.at\",\n \"city\": \"Linz\"\n }\n },\n {\n \"id\": \"019fd2b8-28df-7265-8b1e-cb5de026e4d7\",\n \"status\": \"completed\",\n \"status_label\": \"Abgeschlossen\",\n \"shift_date\": \"2026-08-03\",\n \"scheduled_start_time\": \"08:31:00\",\n \"scheduled_end_time\": \"05:12:00\",\n \"location_name\": \"Wehner Inc\",\n \"location_address\": \"45222 Hansen Gardens\",\n \"hourly_rate_gross\": \"18.25\",\n \"confirmed_at\": null,\n \"started_at\": null,\n \"completed_at\": null,\n \"job\": {\n \"id\": \"019fd2b8-28c4-732f-a94c-fb5a71a7d682\",\n \"title\": \"Accountant\",\n \"category\": \"B\u00fcro\"\n },\n \"employee\": {\n \"id\": \"019fd2b7-f271-73fd-8268-848be381e136\",\n \"name\": \"Anna Neuling\",\n \"email\": \"pending@demo.flexxr.at\",\n \"city\": \"Linz\"\n }\n }\n ],\n \"summary\": {\n \"total\": 5,\n \"by_status\": {\n \"confirmed\": 3,\n \"in_progress\": 1,\n \"completed\": 1\n },\n \"today\": 1,\n \"this_week\": 3\n }\n },\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 5\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Get the full audit trail for a single assignment (shift).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/assignments\/:assignmentId\/timeline", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/assignments\/:assignmentId\/timeline", "variable": [ { "id": "assignmentId", "key": "assignmentId", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the shift\/assignment." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the assignment summary (incl. contract status + download URL) and\na chronological event timeline covering the whole lifecycle: contract\nsigned\/countersigned, clock-in\/out, completion, hours confirm\/dispute,\nsignature refusal, no-show incidents and invoice lines." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"assignment\": {\n \"id\": \"019fd2b8-28d1-7112-b8e9-68bd79fbafb9\",\n \"status\": \"awaiting_signature\",\n \"status_label\": \"Unterschrift ausstehend\",\n \"shift_date\": \"2026-08-04\",\n \"scheduled_start_time\": \"16:57:00\",\n \"scheduled_end_time\": \"09:21:00\",\n \"location_name\": \"Buckridge-Collier\",\n \"location_address\": \"661 Cayla Unions Suite 344\",\n \"hourly_rate_gross\": \"27.68\",\n \"started_at\": null,\n \"completed_at\": null,\n \"job\": {\n \"id\": \"019fd2b8-28c4-732f-a94c-fb5a71a7d682\",\n \"title\": \"Accountant\"\n },\n \"employee\": {\n \"id\": \"019fd2b7-f271-73fd-8268-848be381e136\",\n \"name\": \"Anna Neuling\"\n },\n \"contract\": null,\n \"attendance\": null,\n \"rating\": null\n },\n \"timeline\": [\n {\n \"event_type\": \"assignment.created\",\n \"actor\": \"system\",\n \"title\": \"Assignment created\",\n \"description\": \"Assignment was created from job selection.\",\n \"occurred_at\": \"2026-08-05T16:18:32+00:00\",\n \"path\": \"\/hours\"\n }\n ]\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 404, "body": "{\"status\":\"NOT_FOUND\",\"message\":\"Assignment not found.\"}", "name": "Not Found" } ] } ] } ] }, { "name": "Company - Attendance", "description": "Organization (Company Portal) endpoints for managing jobs, applicants, shifts, team, and organization profiles. Requires organization-level Bearer token. Some endpoints require approved organization status.", "item": [ { "name": "Shifts", "description": "", "item": [ { "name": "List attendance records for shifts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/attendance", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/attendance" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"records\": [\n {\n \"id\": \"019fd2b8-28d8-728d-a447-8de1a42eec83\",\n \"shift_date\": \"2026-08-05\",\n \"scheduled_start_time\": \"11:58:00\",\n \"scheduled_end_time\": \"12:13:00\",\n \"status\": \"checked_in\",\n \"attendance_status\": \"checked_in\",\n \"attendance_status_label\": \"Eingecheckt\",\n \"started_at\": null,\n \"completed_at\": null,\n \"is_no_show\": false,\n \"no_show_reason\": null,\n \"location_name\": \"Goldner and Sons\",\n \"job\": {\n \"id\": \"019fd2b8-28c4-732f-a94c-fb5a71a7d682\",\n \"title\": \"Accountant\"\n },\n \"employee\": {\n \"id\": \"019fd2b7-f271-73fd-8268-848be381e136\",\n \"name\": \"Anna Neuling\",\n \"email\": \"pending@demo.flexxr.at\",\n \"phone\": \"+436769876543\"\n },\n \"contract_signed_at\": null,\n \"contract_in_force\": false,\n \"hourly_rate_gross\": \"18.57\"\n }\n ],\n \"summary\": {\n \"total\": 1,\n \"pending\": 0,\n \"checked_in\": 1,\n \"completed\": 0,\n \"no_show\": 0\n }\n },\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 50,\n \"total\": 1\n }\n}", "name": "Recorded from a live call" } ] } ] } ] }, { "name": "Company - Auth", "description": "Organization (Company Portal) endpoints for managing jobs, applicants, shifts, team, and organization profiles. Requires organization-level Bearer token. Some endpoints require approved organization status.", "item": [ { "name": "Authentication", "description": "", "item": [ { "name": "Confirm a company's email ownership by consuming the verification link token\n(Szenario Unternehmen \u2014 \"E-Mail-Adresse (Verifizierung)\").", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/verify-email\/confirm", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/verify-email\/confirm" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"kontakt@firma.at\",\"token\":\"abc123def456...\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Resend the company email-verification link. Always returns success to avoid\nleaking which addresses are registered.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/auth\/verify-email\/resend", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/auth\/verify-email\/resend" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"kontakt@firma.at\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"If this address has a pending verification, a new link has been sent.\",\n \"data\": {\n \"email\": \"kontakt@firma.at\"\n }\n}", "name": "Recorded from a live call" } ] } ] } ] }, { "name": "Company - Billing", "description": "Organization (Company Portal) endpoints for managing jobs, applicants, shifts, team, and organization profiles. Requires organization-level Bearer token. Some endpoints require approved organization status.", "item": [ { "name": "Invoices", "description": "", "item": [ { "name": "List invoices for the authenticated organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/invoices", "query": [ { "key": "status", "value": "paid", "description": "optional Filter by invoice status (draft, generated, sent, paid, overdue, cancelled, partially_paid).", "disabled": false }, { "key": "year", "value": "2026", "description": "optional Filter by billing year.", "disabled": false }, { "key": "month", "value": "5", "description": "optional Filter by billing month (1\u201312).", "disabled": false }, { "key": "per_page", "value": "20", "description": "optional Items per page (1\u2013100, default 20).", "disabled": false }, { "key": "page", "value": "1", "description": "optional Page number (default 1).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org\/invoices?status=paid&year=2026&month=5&per_page=20&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"invoices\": [],\n \"summary\": {\n \"total\": 1,\n \"paid\": 0,\n \"pending\": 1,\n \"overdue\": 0,\n \"total_paid_cents\": 0\n },\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 0\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Show a single invoice with line items.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/invoices\/:invoiceId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/invoices\/:invoiceId", "variable": [ { "id": "invoiceId", "key": "invoiceId", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the invoice." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"invoice\": {\n \"id\": \"3257a732-8d8a-4de5-8dee-a54e85c7e111\",\n \"invoice_number\": \"RE-2026-055747\",\n \"period\": \"2026-08\",\n \"status\": \"draft\",\n \"status_label\": \"Draft\",\n \"reference\": null,\n \"notes\": null,\n \"summary\": {\n \"subtotal_cents\": 55952,\n \"vat_rate_percent\": 20,\n \"vat_amount_cents\": 11190,\n \"platform_fee_cents\": 0,\n \"total_cents\": 67142,\n \"paid_amount_cents\": 0\n },\n \"dates\": {\n \"invoice_date\": \"2026-08-05\",\n \"due_date\": \"2026-08-19\",\n \"sent_at\": null,\n \"paid_at\": null\n },\n \"pdf_path\": null,\n \"line_items\": []\n }\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 404, "body": "{\"status\":\"NOT_FOUND\",\"message\":\"Invoice not found.\"}", "name": "Not Found" } ] } ] } ] }, { "name": "Company - Jobs", "description": "Organization (Company Portal) endpoints for managing jobs, applicants, shifts, team, and organization profiles. Requires organization-level Bearer token. Some endpoints require approved organization status.", "item": [ { "name": "Jobs", "description": "", "item": [ { "name": "Update a draft job listing for the organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/jobs\/:jobId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/jobs\/:jobId", "variable": [ { "id": "jobId", "key": "jobId", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the job to update." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Eventhelfer Messe Wien\",\"description\":\"Aufbau und Betreuung eines Messestands.\",\"hourly_rate_gross\":\"14.50\",\"location_name\":\"Messe Wien\",\"location_address\":\"Messeplatz 1\",\"location_city\":\"Wien\",\"location_postal_code\":\"1020\",\"location_lat\":\"48.2208\",\"location_lng\":\"16.4108\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"The job has been updated successfully.\",\n \"data\": {\n \"job\": {\n \"id\": \"019fd2b8-6bb5-7113-b62c-7434d5f44733\",\n \"title\": \"Lagermitarbeiter Nachtschicht (m\/w\/d)\",\n \"description\": \"Kommissionieren und Verr\u00e4umen im Zentrallager.\",\n \"location\": {\n \"name\": \"Zentrallager Wien\",\n \"address\": null,\n \"city\": \"Wien\",\n \"postal_code\": null,\n \"lat\": null,\n \"lng\": null\n },\n \"compensation\": {\n \"hourly_rate_gross\": 15.5,\n \"estimated_total_gross\": 372\n },\n \"timestamps\": {\n \"updated_at\": \"2026-08-05 16:18\"\n }\n }\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 404, "body": "{\"status\":\"NOT_FOUND\",\"message\":\"Job not found.\"}", "name": "Job Not Found" }, { "header": [], "code": 422, "body": "{\"status\":\"INVALID_OPERATION\",\"message\":\"Only draft jobs can be edited.\"}", "name": "Job Not Editable" }, { "header": [], "code": 422, "body": "{\"status\":\"ERROR\",\"message\":\"The title field must not be greater than 200 characters.\",\"errors\":{\"title\":[\"The title field must not be greater than 200 characters.\"]}}", "name": "Validation Error" } ] }, { "name": "Upload the optional cover image for a job listing (\"Optional kann ein Bild\nhochgeladen werden\").", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/jobs\/:jobId\/cover-image", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/jobs\/:jobId\/cover-image", "variable": [ { "id": "jobId", "key": "jobId", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the job." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "image", "src": [], "type": "file" } ] }, "description": "" }, "response": [] }, { "name": "Update assignment method and auto-reject settings for a job.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/jobs\/:jobId\/assignment-settings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/jobs\/:jobId\/assignment-settings", "variable": [ { "id": "jobId", "key": "jobId", "value": "architecto", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"assignment_method\":\"manual\",\"auto_reject_after_hours\":1}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"messages.assignment_settings_updated\",\n \"data\": {\n \"job_id\": \"019fd2b8-28c4-732f-a94c-fb5a71a7d682\",\n \"assignment_method\": \"manual\",\n \"auto_reject_after_hours\": 1\n }\n}", "name": "Recorded from a live call" } ] } ] } ] }, { "name": "Company - No-Show", "description": "Organization (Company Portal) endpoints for managing jobs, applicants, shifts, team, and organization profiles. Requires organization-level Bearer token. Some endpoints require approved organization status.", "item": [ { "name": "Shifts", "description": "", "item": [ { "name": "Request emergency replacement for a no-show incident.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/no-shows\/:incidentId\/replacement-request", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/no-shows\/:incidentId\/replacement-request", "variable": [ { "id": "incidentId", "key": "incidentId", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the no-show incident." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Dringender Ersatz ben\u00f6tigt - Standup beginnt in 30 Minuten.\"}" }, "description": "Allowed when the incident status is detected, confirmed, or disputed,\nand no replacement worker has been assigned yet.\nStatus transitions to `replacement_requested`." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"SUCCESS\",\"message\":\"Replacement requested.\",\"data\":{\"incident_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"status\":\"replacement_requested\",\"status_label\":\"Ersatz angefordert\",\"replacement_requested_at\":\"2026-05-10 08:15\"}}", "name": "Success" }, { "header": [], "code": 404, "body": "{\"status\":\"NOT_FOUND\",\"message\":\"No-show incident not found.\"}", "name": "Incident Not Found" }, { "header": [], "code": 422, "body": "{\"status\":\"INVALID_OPERATION\",\"message\":\"Replacement cannot be requested for this incident.\"}", "name": "Not Allowed" } ] } ] } ] }, { "name": "Company - No-Shows", "description": "Organization (Company Portal) endpoints for managing jobs, applicants, shifts, team, and organization profiles. Requires organization-level Bearer token. Some endpoints require approved organization status.", "item": [ { "name": "Shifts", "description": "", "item": [ { "name": "List no-show incidents for the organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/no-shows", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/no-shows" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"incidents\": [],\n \"summary\": {\n \"total\": 0,\n \"unresolved\": 0,\n \"excused\": 0,\n \"with_replacement\": 0\n }\n },\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 0\n }\n}", "name": "Recorded from a live call" } ] } ] } ] }, { "name": "Company - Reports", "description": "Organization (Company Portal) endpoints for managing jobs, applicants, shifts, team, and organization profiles. Requires organization-level Bearer token. Some endpoints require approved organization status.", "item": [ { "name": "Reports", "description": "", "item": [ { "name": "Get workforce reports summary for the organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/reports\/summary", "query": [ { "key": "date_from", "value": "2026-05-01", "description": "optional Start of the report period (YYYY-MM-DD). Defaults to first day of current month.", "disabled": false }, { "key": "date_to", "value": "2026-05-31", "description": "optional End of the report period (YYYY-MM-DD). Defaults to last day of current month.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org\/reports\/summary?date_from=2026-05-01&date_to=2026-05-31" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns shift statistics, hours metrics, worker engagement,\nfinancial overview, no-show analysis, compliance violations,\nand top workers for the specified date range.\nDefaults to the current calendar month when no dates are provided." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"period\": {\n \"date_from\": \"2026-05-01\",\n \"date_to\": \"2026-05-31\"\n },\n \"kpis\": {\n \"fill_rate_percent\": 0,\n \"total_hours\": 0,\n \"monthly_cost_cents\": 0,\n \"avg_hours_per_worker\": 0,\n \"repeat_rate_percent\": 0\n },\n \"attendance\": {\n \"pending\": 0,\n \"checked_in\": 0,\n \"completed\": 0,\n \"no_show\": 0,\n \"total\": 0\n },\n \"no_shows\": {\n \"total\": 0,\n \"excused\": 0,\n \"unresolved\": 0,\n \"with_replacement\": 0\n },\n \"compliance\": {\n \"score\": 100,\n \"critical_violations\": 0,\n \"open_violations\": 0,\n \"disputed_hours_entries\": 0\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Export compliance report data for the organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/reports\/compliance\/export", "query": [ { "key": "date_from", "value": "2026-05-01", "description": "optional Start of the export period (YYYY-MM-DD). Defaults to first day of current month.", "disabled": false }, { "key": "date_to", "value": "2026-05-31", "description": "optional End of the export period (YYYY-MM-DD). Defaults to last day of current month.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org\/reports\/compliance\/export?date_from=2026-05-01&date_to=2026-05-31" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a structured JSON dataset containing per-shift compliance\ninformation (hours worked, breaks, no-show flags, AZG\/ARG compliance).\nIntended for PDF\/CSV export by the frontend.\nDefaults to the current calendar month when no dates are provided." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Report export is ready.\",\n \"data\": {\n \"filename\": \"compliance-report-2026-05-01-to-2026-05-31.csv\",\n \"mime_type\": \"text\/csv; charset=UTF-8\",\n \"csv\": \"date,shift_id,job_title,employee_name,employee_email,scheduled_start,scheduled_end,worked_hours,break_minutes,no_show,no_show_status,attendance_dispute,azg_daily_hours_flag\\n\",\n \"rows\": 0,\n \"period\": {\n \"date_from\": \"2026-05-01\",\n \"date_to\": \"2026-05-31\"\n }\n }\n}", "name": "Recorded from a live call" } ] } ] } ] }, { "name": "Company - Shifts", "description": "Organization (Company Portal) endpoints for managing jobs, applicants, shifts, team, and organization profiles. Requires organization-level Bearer token. Some endpoints require approved organization status.", "item": [ { "name": "Shifts", "description": "", "item": [ { "name": "Resolve step of the smart QR flow: decodes the scanned code and returns\nthe assignment's info + terms + the single currently-valid action\n(check_in, check_out, or blocked-with-reason). Read-only \u2014 never burns\nthe QR's single-use nonce and never mutates state. Whoever scans (worker\nself-service or shift manager) sees this before confirming.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/scan-qr\/resolve", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/scan-qr\/resolve" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"qr_payload\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "Confirm step of the smart QR flow: burns the QR's 60-second single-use\nnonce and executes the freshly re-resolved smart action (check_in or\ncheck_out). The action is recomputed here, not trusted from the resolve\nresponse, so a state change between the two calls can't be bypassed.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/scan-qr\/confirm", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/scan-qr\/confirm" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"qr_payload\":\"architecto\",\"lat\":4326.41688,\"lng\":4326.41688,\"signature\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "Organization reports that an employee refused to sign the shift time record.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/:shiftId\/signature-refused", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/:shiftId\/signature-refused", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Krankheitsbedingt kurzfristig abgesagt.\"}" }, "description": "Sets dispute_type = 'signature_refused' on the shift attendance." }, "response": [] }, { "name": "Manager override: the shift manager (or an org admin\/owner) checks a\nworker in directly, no QR needed \u2014 how a worker gets checked in past the\nself-service window. Replaces the old \"start the shift\" step: check-in IS\nclock-in, there is no separate start.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/:shiftId\/assignments\/:assignmentId\/check-in", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/:shiftId\/assignments\/:assignmentId\/check-in", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "architecto", "description": "" }, { "id": "assignmentId", "key": "assignmentId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"lat\":1,\"lng\":1}" }, "description": "" }, "response": [] }, { "name": "Supervisor ends a worker's in-progress shift early (on-site initiated early\ncheckout \u2014 sickness, employer-ended, sent home, \u2026). Records the reason and\ncategory and clocks the worker out.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/:shiftId\/early-checkout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/:shiftId\/early-checkout", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Mitarbeiter erkrankt, nach Hause geschickt.\",\"category\":\"employer_ended\"}" }, "description": "" }, "response": [] }, { "name": "Company modifies an upcoming assigned shift \u2014 its scheduled time and\/or its\nlocation\/meeting point \u2014 and the assigned worker is notified accordingly\n(\"Schicht ge\u00e4ndert\" \/ \"Einsatzort ge\u00e4ndert\").", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/:shiftId\/modify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/:shiftId\/modify", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "9c3f5f3d-0123-4abc-b456-426614174000", "description": "UUID of the shift." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"shift_date\":\"2026-07-02\",\"scheduled_start_time\":\"09:00\",\"scheduled_end_time\":\"17:00\",\"location_name\":\"Messe Wien Halle B\",\"location_address\":\"Messeplatz 1\",\"location_lat\":\"48.2208\",\"location_lng\":\"16.4108\",\"reason\":\"Halle wurde verlegt.\"}" }, "description": "Only allowed before the shift starts (pending confirmation, confirmed or\nscheduled)." }, "response": [] }, { "name": "List shifts pending time confirmation.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/pending-confirmation", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/pending-confirmation" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"shifts\": [\n {\n \"id\": \"019fd2b8-28df-7265-8b1e-cb5de026e4d7\",\n \"job\": {\n \"id\": \"019fd2b8-28c4-732f-a94c-fb5a71a7d682\",\n \"title\": \"Accountant\"\n },\n \"employee\": {\n \"id\": \"019fd2b7-f271-73fd-8268-848be381e136\",\n \"name\": \"Anna Neuling\",\n \"lhr_synced\": false\n },\n \"date\": \"2026-08-03\",\n \"planned_start\": \"08:31\",\n \"planned_end\": \"05:12\",\n \"actual_check_in\": null,\n \"actual_check_out\": null,\n \"worked_minutes\": 0,\n \"break_minutes\": 0,\n \"status\": \"completed\",\n \"dispute_reason\": null,\n \"hourly_rate\": 18.25,\n \"gross_amount\": 0\n }\n ],\n \"summary\": {\n \"total_shifts\": 1,\n \"total_minutes\": 0,\n \"total_gross\": 0\n },\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Confirm shift worked time.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/:shiftId\/confirm", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/:shiftId\/confirm", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"actual_minutes\":1,\"break_minutes\":1,\"note\":\"Beispieltext\"}" }, "description": "When a company confirms the worked time, the payout process is triggered\nvia LHR (lohn.at). This is the critical step that initiates employee payment." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Shift time confirmed, payout initiated.\",\n \"data\": {\n \"shift_id\": \"019fd2b8-a5fe-72da-bca5-e12ff2951c28\",\n \"status\": \"hours_confirmed\",\n \"actual_minutes\": 480,\n \"gross_amount\": 263.36,\n \"payout_queued\": true\n }\n}", "name": "Recorded from a live call" }, { "header": [], "code": 422, "body": "{\"status\":\"INVALID_OPERATION\",\"message\":\"Diese Schicht hat noch offene Anfragen. Bitte zuerst alle Anfragen entscheiden.\",\"data\":{\"pending_requests\":[{\"id\":\"019f9939-c4c3-70fb-a54e-5ebf63db36d2\",\"type\":\"overtime\",\"type_label\":\"\u00dcberstunden\"}]}}", "name": "Open requests on the shift" } ] }, { "name": "Dispute shift worked time.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/shifts\/:shiftId\/dispute", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/shifts\/:shiftId\/dispute", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Krankheitsbedingt kurzfristig abgesagt.\",\"disputed_minutes\":1}" }, "description": "When a company disputes the worked time, the payout is held pending resolution.\nThe dispute must be resolved before the employee can be paid." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"The shift time has been disputed.\",\n \"data\": {\n \"shift_id\": \"019fd2b8-a9b8-7256-a83d-365a8c7761c8\",\n \"status\": \"disputed\",\n \"reason\": \"Die erfasste Zeit weicht von unserer Aufzeichnung ab.\"\n }\n}", "name": "Recorded from a live call" } ] } ] } ] }, { "name": "Company - Wallet", "description": "Organization (Company Portal) endpoints for managing jobs, applicants, shifts, team, and organization profiles. Requires organization-level Bearer token. Some endpoints require approved organization status.", "item": [ { "name": "Wallet", "description": "", "item": [ { "name": "Returns the authenticated organization's wallet summary, auto-creating\nthe wallet row on first access via {@see WalletService::walletFor()}.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/wallet", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/wallet" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"balance_cents\": 250000,\n \"blocked_cents\": 0,\n \"available_cents\": 250000,\n \"currency\": \"EUR\",\n \"has_payment_method\": false,\n \"withdrawable_cents\": 0\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Paginated wallet ledger, newest first. Auto-creates the wallet via\n{@see WalletService::walletFor()} so a fresh organization sees an empty\nlist instead of a 404.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/wallet\/transactions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/wallet\/transactions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"transactions\": [\n {\n \"id\": \"019fd2b8-c69e-714a-8069-e4d9c2c222ac\",\n \"type\": \"topup\",\n \"type_label\": \"Aufladung\",\n \"amount_cents\": 250000,\n \"balance_after_cents\": 250000,\n \"blocked_after_cents\": 0,\n \"description\": \"Guthaben f\u00fcr den Testlauf\",\n \"reference_type\": null,\n \"created_at\": \"2026-08-05T16:19:12+00:00\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Admin-configured top-up amounts with their fee preview, so the portal can\nrender top-up buttons without duplicating the fee formula client-side.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/wallet\/topup-options", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/wallet\/topup-options" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"options\": [\n {\n \"amount_cents\": 100000,\n \"platform_fee_cents\": 0,\n \"stripe_fee_cents\": 1525,\n \"vat_cents\": 0,\n \"total_charged_cents\": 101525\n },\n {\n \"amount_cents\": 200000,\n \"platform_fee_cents\": 0,\n \"stripe_fee_cents\": 3025,\n \"vat_cents\": 0,\n \"total_charged_cents\": 203025\n },\n {\n \"amount_cents\": 500000,\n \"platform_fee_cents\": 0,\n \"stripe_fee_cents\": 7525,\n \"vat_cents\": 0,\n \"total_charged_cents\": 507525\n }\n ]\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Creates a pending WalletTopup for one of the admin-configured amounts and,\nwhen Stripe is configured, opens a hosted Checkout Session for it. The\nwallet is only credited later \u2014 by App\\Http\\Controllers\\StripeWebhookController\nonce `checkout.session.completed` confirms payment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/wallet\/topup", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/wallet\/topup" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"amount_cents\":1}" }, "description": "" }, "response": [] }, { "name": "POST \/org\/wallet\/topup\/confirm \u2014 settle a top-up right on the checkout\nreturn instead of waiting for the async webhook. Looks the top-up up by its\ncheckout session id (scoped to the caller's organisation), asks Stripe for\nthe session's real state and settles it if paid. Idempotent: the shared\nsettle path means a later webhook or the reconcile cron can never\ndouble-credit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/wallet\/topup\/confirm", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/wallet\/topup\/confirm" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"session_id\":\"Beispieltext\"}" }, "description": "" }, "response": [] }, { "name": "POST \/org\/wallet\/topup\/cancel \u2014 close a top-up the instant the user returns\nfrom an abandoned checkout, instead of leaving it pending until the session\nexpires. Safety-first: if Stripe says the session was in fact paid (e.g. the\nuser paid in another tab then hit back), it's settled rather than failed.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/wallet\/topup\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/wallet\/topup\/cancel" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"session_id\":\"Beispieltext\"}" }, "description": "" }, "response": [] }, { "name": "Paginated top-up history, newest first, with the fee breakdown and\nwhether a receipt PDF is available for download.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/wallet\/topups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/wallet\/topups" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"topups\": [],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 0\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Streams the receipt PDF for a succeeded top-up. Guarded at the route by\nthe `invoices.download` ACL ability (see App\\Providers\\AclServiceProvider)\non top of the org-member auth\/2FA\/approved guard, and here by ownership +\nthe topup actually having a stored receipt.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/wallet\/topups\/:topupId\/receipt", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/wallet\/topups\/:topupId\/receipt", "variable": [ { "id": "topupId", "key": "topupId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 503, "body": "{\"status\":\"ERROR\",\"message\":\"Service Unavailable\",\"data\":null,\"errors\":[{\"field\":null,\"message\":\"Service Unavailable\"}],\"meta\":{\"request_id\":\"cecb0139-a407-44f0-afa8-04001609da18\",\"timestamp\":\"2026-08-21T05:14:35.364603Z\"}}", "name": "" } ] }, { "name": "POST \/org\/wallet\/withdraw \u2014 return available wallet balance to the card that\nfunded it (Stripe refund). Amounts up to the auto-approval threshold complete\ninstantly; larger ones come back `pending` for an admin to approve.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/wallet\/withdraw", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/wallet\/withdraw" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"amount_cents\":1}" }, "description": "" }, "response": [] }, { "name": "GET \/org\/wallet\/withdrawals \u2014 the company's withdrawal history, newest first.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/wallet\/withdrawals", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/wallet\/withdrawals" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"withdrawals\": [],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 0\n }\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "POST \/org\/wallet\/withdrawals\/{withdrawalId}\/cancel \u2014 a company withdraws its\nown still-pending (over-threshold, awaiting-admin-review) withdrawal request\nbefore it's reviewed, releasing the reserved funds back to its available\nbalance immediately.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org\/wallet\/withdrawals\/:withdrawalId\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/v1\/org\/wallet\/withdrawals\/:withdrawalId\/cancel", "variable": [ { "id": "withdrawalId", "key": "withdrawalId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] } ] }, { "name": "Employee - Shifts", "description": "Endpoints for the mobile application (employee users). All endpoints (except authentication) require a valid Bearer token with 2FA verification.", "item": [ { "name": "Shifts", "description": "", "item": [ { "name": "Download \/ retrieve a shift time record summary for the authenticated employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/shifts\/:shiftId\/time-record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/shifts\/:shiftId\/time-record", "variable": [ { "id": "shiftId", "key": "shiftId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns worked hours, break time, and a gross earnings estimate for the shift." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"shift_id\": \"019fd4e7-ff04-72e4-a010-3ff64e0d3e8f\",\n \"shift_date\": \"2026-08-06\",\n \"scheduled_start_time\": \"02:30:00\",\n \"scheduled_end_time\": \"10:30:00\",\n \"clock_in_at\": \"2026-08-06T02:30:01+00:00\",\n \"clock_out_at\": \"2026-08-06T10:30:01+00:00\",\n \"total_hours_worked\": 8,\n \"break_minutes\": 480,\n \"net_hours_worked\": 0,\n \"hourly_rate\": 22.64,\n \"gross_amount\": 0,\n \"dispute_type\": null\n }\n}", "name": "Recorded from a live call" } ] } ] } ] }, { "name": "Employee - Wallet", "description": "Endpoints for the mobile application (employee users). All endpoints (except authentication) require a valid Bearer token with 2FA verification.", "item": [ { "name": "Wallet", "description": "", "item": [ { "name": "Get the authenticated employee's wallet summary.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/wallet", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/wallet" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Aggregates earnings from completed\/confirmed shifts, separating\npending and paid amounts." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"total_earned_gross\": 0,\n \"pending_payout_gross\": 0,\n \"processing_payout_gross\": 0,\n \"paid_gross\": 0,\n \"shifts_completed\": 2,\n \"shifts_pending_payment\": 2,\n \"pending_payments\": [\n {\n \"shift_id\": \"019fd3d3-f998-72c7-affb-87f0986474d4\",\n \"shift_date\": \"2026-08-03\",\n \"job_title\": \"Communications Teacher\",\n \"organization_name\": \"Caritas\",\n \"gross_amount\": 0,\n \"payment_status\": \"pending\",\n \"expected_payout_by\": \"2026-08-17\"\n },\n {\n \"shift_id\": \"019fd3d3-f98a-70d2-83d5-eba7cae30f9a\",\n \"shift_date\": \"2026-08-06\",\n \"job_title\": \"Communications Teacher\",\n \"organization_name\": \"Caritas\",\n \"gross_amount\": 0,\n \"payment_status\": \"pending\",\n \"expected_payout_by\": \"2026-08-20\"\n }\n ],\n \"recent_payments\": []\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Paginated payment history for the authenticated worker \u2014 the full ledger of\npaid shifts, beyond the last-5 preview surfaced on the wallet summary.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/wallet\/payments", "query": [ { "key": "status", "value": "paid", "description": "Filter by payment status: paid|processing|pending.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Items per page (1-100, default 20).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/mobile\/wallet\/payments?status=paid&per_page=20&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 0\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Stream the authenticated worker's legally binding monthly Lohnzettel\n(Gehaltszettel) for a given period from lohn.at. Distinct from the per-shift\nVerdienstabrechnung \u2014 this is the official monthly payslip.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/wallet\/payslip", "query": [ { "key": "period", "value": "2026-05", "description": "The payroll period in YYYY-MM format.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/mobile\/wallet\/payslip?period=2026-05" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"period\":\"6425-59\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "PDF file download", "name": "" } ] } ] } ] }, { "name": "Mobile - Profile", "description": "Endpoints for the mobile application (employee users). All endpoints (except authentication) require a valid Bearer token with 2FA verification.", "item": [ { "name": "Education", "description": "", "item": [ { "name": "List the authenticated employee's education (Ausbildung) records.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/education", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/education" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"education\": []\n }\n}", "name": "Recorded from a live call" } ] }, { "name": "Add an education (Ausbildung) record for the authenticated employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/education", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/education" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"institution\":\"HTL Wien\",\"degree\":\"Matura\",\"field_of_study\":\"Elektrotechnik\",\"level\":\"Matura\",\"start_year\":2008,\"end_year\":2013,\"is_completed\":true,\"document_id\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "Update one of the authenticated employee's education records.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/education\/:educationId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/education\/:educationId", "variable": [ { "id": "educationId", "key": "educationId", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"institution\":\"Beispieltext\",\"degree\":\"Beispieltext\",\"field_of_study\":\"Beispieltext\",\"level\":\"Beispieltext\",\"start_year\":1,\"end_year\":1,\"is_completed\":true}" }, "description": "" }, "response": [] }, { "name": "Delete one of the authenticated employee's education records.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/mobile\/education\/:educationId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/mobile\/education\/:educationId", "variable": [ { "id": "educationId", "key": "educationId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }