{ "item": [ { "name": "api", "description": "", "item": [ { "name": "health", "description": "", "item": [ { "id": "808f84a7-c159-4f0e-bf70-3f436346d7a1", "name": "Health check", "request": { "name": "Health check", "description": {}, "url": { "path": [ "api", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e434ed6b-0c1f-4cf1-8d2c-a43ecbdcf8a1", "name": "Service healthy.", "originalRequest": { "url": { "path": [ "api", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": \"\",\n \"sweeper\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "codes", "description": "", "item": [ { "id": "663dc69e-c1af-4c57-b338-d0cb0b72ab75", "name": "List codes", "request": { "name": "List codes", "description": { "content": "Paginated list of codes in the caller's current scope (personal workspace or active team).", "type": "text/plain" }, "url": { "path": [ "api", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page_size", "value": "20" }, { "disabled": false, "description": { "content": "Free-text search over label / URL / tags.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "tag", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of active,paused,grace,expired)", "type": "text/plain" }, "key": "status", "value": "active" }, { "disabled": false, "description": { "content": "Filter by group id.", "type": "text/plain" }, "key": "group", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of recent,oldest,label,scans)", "type": "text/plain" }, "key": "sort", "value": "oldest" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a37b426e-1fd1-4fec-b6b0-3fd85fc073ad", "name": "List of codes.", "originalRequest": { "url": { "path": [ "api", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page_size", "value": "20" }, { "disabled": false, "description": { "content": "Free-text search over label / URL / tags.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "tag", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of active,paused,grace,expired)", "type": "text/plain" }, "key": "status", "value": "active" }, { "disabled": false, "description": { "content": "Filter by group id.", "type": "text/plain" }, "key": "group", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of recent,oldest,label,scans)", "type": "text/plain" }, "key": "sort", "value": "oldest" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"codes\": [\n {\n \"id\": \"\",\n \"shortcode\": \"\",\n \"short_url\": \"\",\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"status\": \"active\",\n \"group_id\": \"\",\n \"team_id\": \"\",\n \"qr_type\": \"\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grace_until\": \"\",\n \"print_cost_cents\": \"\",\n \"print_count\": \"\",\n \"lifetime_scans\": \"\",\n \"last_scan_day\": \"\",\n \"first_scan_day\": \"\",\n \"distinct_countries\": \"\"\n },\n {\n \"id\": \"\",\n \"shortcode\": \"\",\n \"short_url\": \"\",\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"status\": \"expired\",\n \"group_id\": \"\",\n \"team_id\": \"\",\n \"qr_type\": \"\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grace_until\": \"\",\n \"print_cost_cents\": \"\",\n \"print_count\": \"\",\n \"lifetime_scans\": \"\",\n \"last_scan_day\": \"\",\n \"first_scan_day\": \"\",\n \"distinct_countries\": \"\"\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"page_size\": \"\",\n \"total\": \"\",\n \"total_pages\": \"\",\n \"has_more\": \"\"\n },\n \"scope\": {\n \"type\": \"user\",\n \"team_id\": \"\",\n \"role\": \"\",\n \"workspace_label\": \"\"\n },\n \"plan\": \"\",\n \"plan_limit\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9714865-7d39-4b28-97a3-5adb3c23dcf9", "name": "Create a code", "request": { "name": "Create a code", "description": {}, "url": { "path": [ "api", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"qr_type\": \"url\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3091c0af-35fd-4125-8796-6c323e4e0756", "name": "Created.", "originalRequest": { "url": { "path": [ "api", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"qr_type\": \"url\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"shortcode\": \"\",\n \"short_url\": \"\",\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"status\": \"expired\",\n \"group_id\": \"\",\n \"team_id\": \"\",\n \"qr_type\": \"\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grace_until\": \"\",\n \"print_cost_cents\": \"\",\n \"print_count\": \"\",\n \"lifetime_scans\": \"\",\n \"last_scan_day\": \"\",\n \"first_scan_day\": \"\",\n \"distinct_countries\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "995345fd-6c70-4643-ad62-5241dbd416c5", "name": "Plan limit reached.", "originalRequest": { "url": { "path": [ "api", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"qr_type\": \"url\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "68d80d51-cfde-49b1-8aa1-465cb538156c", "name": "Get a code", "request": { "name": "Get a code", "description": {}, "url": { "path": [ "api", "codes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1523182d-6dab-4a60-83e8-779239dd4b15", "name": "The code.", "originalRequest": { "url": { "path": [ "api", "codes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"shortcode\": \"\",\n \"short_url\": \"\",\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"status\": \"expired\",\n \"group_id\": \"\",\n \"team_id\": \"\",\n \"qr_type\": \"\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grace_until\": \"\",\n \"print_cost_cents\": \"\",\n \"print_count\": \"\",\n \"lifetime_scans\": \"\",\n \"last_scan_day\": \"\",\n \"first_scan_day\": \"\",\n \"distinct_countries\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8895afc9-3b3c-4685-a3f6-1672140cd108", "name": "Not found.", "originalRequest": { "url": { "path": [ "api", "codes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "090657f0-cc8d-468f-bc7d-800f8e27acd4", "name": "Update a code", "request": { "name": "Update a code", "description": { "content": "Modify url, label, tags, status (active/paused), qr design fields, tag/group assignment, or move between scopes (team_id/null).", "type": "text/plain" }, "url": { "path": [ "api", "codes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"status\": \"active\",\n \"group_id\": \"\",\n \"team_id\": \"\",\n \"qr_type\": \"\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1c161ee7-cec7-4cfc-9148-39224df3cabd", "name": "Updated.", "originalRequest": { "url": { "path": [ "api", "codes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"status\": \"active\",\n \"group_id\": \"\",\n \"team_id\": \"\",\n \"qr_type\": \"\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b3af1e6-0ac0-4658-aa99-4986c3c697fa", "name": "Soft-delete a code (enters 90-day grace).", "request": { "name": "Soft-delete a code (enters 90-day grace).", "description": {}, "url": { "path": [ "api", "codes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "220d7413-4f32-48c0-bad0-224e8c77b109", "name": "Grace started.", "originalRequest": { "url": { "path": [ "api", "codes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "analytics", "description": "", "item": [ { "id": "7502efd5-f3be-497f-b61a-ce11e0e3cb48", "name": "Scan time-series", "request": { "name": "Scan time-series", "description": {}, "url": { "path": [ "api", "codes", ":id", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of 7d,30d,90d,1y)", "type": "text/plain" }, "key": "range", "value": "90d" }, { "disabled": false, "description": { "content": " (This can only be one of day,hour)", "type": "text/plain" }, "key": "granularity", "value": "hour" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f289602d-26ab-40b9-bc94-590b2e562d55", "name": "Time-series.", "originalRequest": { "url": { "path": [ "api", "codes", ":id", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of 7d,30d,90d,1y)", "type": "text/plain" }, "key": "range", "value": "90d" }, { "disabled": false, "description": { "content": " (This can only be one of day,hour)", "type": "text/plain" }, "key": "granularity", "value": "hour" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "analytics.csv", "description": "", "item": [ { "id": "f1b22adc-9539-4e85-9547-2053e29b190b", "name": "Scan time-series CSV export", "request": { "name": "Scan time-series CSV export", "description": {}, "url": { "path": [ "api", "codes", ":id", "analytics.csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "heatmaps", "description": "", "item": [ { "id": "3b0a4ac0-1c43-4461-b6d8-0ef1d6567cfb", "name": "Calendar + hour×dow + geo heatmap data", "request": { "name": "Calendar + hour×dow + geo heatmap data", "description": {}, "url": { "path": [ "api", "codes", ":id", "heatmaps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0668f002-8cea-44ae-a439-712745b823cc", "name": "Heatmap data.", "originalRequest": { "url": { "path": [ "api", "codes", ":id", "heatmaps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "lifetime", "description": "", "item": [ { "id": "5312b53e-351d-48a1-a5fd-dbeaff250e40", "name": "Campaign lifetime + ROI", "request": { "name": "Campaign lifetime + ROI", "description": {}, "url": { "path": [ "api", "codes", ":id", "lifetime" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "738573d0-1e5c-4665-8300-4f74c174d7be", "name": "Lifetime + ROI (if print cost recorded).", "originalRequest": { "url": { "path": [ "api", "codes", ":id", "lifetime" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a72cf8ea-ea64-4309-a8f9-fce40532d2ef", "name": "Set print cost + count for ROI", "request": { "name": "Set print cost + count for ROI", "description": {}, "url": { "path": [ "api", "codes", ":id", "lifetime" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"print_cost_cents\": \"\",\n \"print_count\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "49a78bde-312f-420b-9a9e-7d76b8828bda", "name": "Saved.", "originalRequest": { "url": { "path": [ "api", "codes", ":id", "lifetime" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"print_cost_cents\": \"\",\n \"print_count\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "deep-stats", "description": "", "item": [ { "id": "b2f97005-6fbf-4b29-bd6e-7e7eef788fab", "name": "Per-code deep analytics", "request": { "name": "Per-code deep analytics", "description": { "content": "Narrative + windows (7/30/90d) + projection + anomaly + velocity + bullet vs target + YoY + peer benchmark + day-of-life + top country.", "type": "text/plain" }, "url": { "path": [ "api", "codes", ":id", "deep-stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f35d1a0f-f443-482c-8400-d415a0ea1e10", "name": "Deep analytics.", "originalRequest": { "url": { "path": [ "api", "codes", ":id", "deep-stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "check-slug", "description": "", "item": [ { "id": "55b5f7c3-c0c9-4135-a2a7-cca4eaba0d70", "name": "Preflight custom-slug availability", "request": { "name": "Preflight custom-slug availability", "description": { "content": "Checks whether a custom shortcode is available to the current user. Used by UI for live input validation. Runs the same validation chain as POST /api/codes but performs no mutation. Cheap read-only endpoint; does not consume rate-limit quota. Returns `{ available: false, reason }` with one of: `invalid` (bad alphabet / hyphen hygiene / length), `plan_not_eligible` (Free or Keep-Alive), `tier_too_short` (slug below plan minimum; includes `min_length`), `cap_reached` (user hit MAX_CUSTOM_SLUGS; includes `max` + `used`), `reserved` (slug is in shortcode_reservations and not granted to this user), `taken` (already claimed).", "type": "text/plain" }, "url": { "path": [ "api", "codes", "check-slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Proposed custom shortcode. Lowercase + digits + hyphen, 1-32 chars, no leading/trailing/consecutive hyphens.", "type": "text/plain" }, "key": "slug", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "59104b93-2320-4f45-a447-19377872d19f", "name": "Availability decision. Status 200 regardless of availability — always inspect the `available` field.", "originalRequest": { "url": { "path": [ "api", "codes", "check-slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Proposed custom shortcode. Lowercase + digits + hyphen, 1-32 chars, no leading/trailing/consecutive hyphens.", "type": "text/plain" }, "key": "slug", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"available\": \"\",\n \"reason\": \"taken\",\n \"slug\": \"\",\n \"plan\": \"\",\n \"min_length\": \"\",\n \"max\": \"\",\n \"used\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bba9d15e-17f0-4c13-9a64-6cd13e68b651", "name": "Unauthenticated.", "originalRequest": { "url": { "path": [ "api", "codes", "check-slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Proposed custom shortcode. Lowercase + digits + hyphen, 1-32 chars, no leading/trailing/consecutive hyphens.", "type": "text/plain" }, "key": "slug", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "import", "description": "", "item": [ { "id": "279ff499-b679-429d-a393-807dc598774a", "name": "Bulk-import codes", "request": { "name": "Bulk-import codes", "description": { "content": "Accepts up to 500 codes in one request.", "type": "text/plain" }, "url": { "path": [ "api", "codes", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"codes\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"qr_type\": \"url\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"qr_type\": \"url\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e8c18ddf-00be-46b1-824b-78488044b2e3", "name": "Imported.", "originalRequest": { "url": { "path": [ "api", "codes", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"codes\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"qr_type\": \"url\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"tags\": \"\",\n \"qr_type\": \"url\",\n \"qr_data\": \"\",\n \"style_json\": \"\",\n \"logo_key\": \"\",\n \"logo_svg\": \"\",\n \"frame_style\": \"\",\n \"frame_text\": \"\",\n \"export_format\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "bulk", "description": "", "item": [ { "id": "e41b2e0d-7072-42be-be14-3344c790a8fb", "name": "Bulk operations", "request": { "name": "Bulk operations", "description": { "content": "One of: add_tag / remove_tag / set_tags / set_group / move / archive / restore. Max 500 code IDs per call.", "type": "text/plain" }, "url": { "path": [ "api", "codes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"set_group\",\n \"code_ids\": [\n \"\",\n \"\"\n ],\n \"tag\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"group_id\": \"\",\n \"team_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1d269dfc-a2ab-46fe-ac0f-6ad5fda65796", "name": "Applied.", "originalRequest": { "url": { "path": [ "api", "codes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"set_group\",\n \"code_ids\": [\n \"\",\n \"\"\n ],\n \"tag\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"group_id\": \"\",\n \"team_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "top", "description": "", "item": [ { "id": "df2dd73c-3b63-4790-9045-3b45d1c3b19f", "name": "Top codes by scans", "request": { "name": "Top codes by scans", "description": {}, "url": { "path": [ "api", "codes", "top" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "days", "value": "30" } ], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a5bbdd35-8e68-470a-903a-3a215c31b2ab", "name": "Top-N list.", "originalRequest": { "url": { "path": [ "api", "codes", "top" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "days", "value": "30" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "stale", "description": "", "item": [ { "id": "e3db75f6-0b3b-4c30-a096-5d015085aef6", "name": "Codes not scanned recently", "request": { "name": "Codes not scanned recently", "description": {}, "url": { "path": [ "api", "codes", "stale" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "days", "value": "90" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1f070b27-1d74-4c3f-b372-ac9a4f39e35b", "name": "Stale codes.", "originalRequest": { "url": { "path": [ "api", "codes", "stale" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "days", "value": "90" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "tags", "description": "", "item": [ { "id": "b7591433-2a13-4c68-9626-dc7c6d366c0d", "name": "List all tags in scope", "request": { "name": "List all tags in scope", "description": {}, "url": { "path": [ "api", "codes", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "630f8ced-ea18-4c22-9741-236776805469", "name": "Distinct tag list with code counts.", "originalRequest": { "url": { "path": [ "api", "codes", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "user", "description": "", "item": [ { "name": "scope-stats", "description": "", "item": [ { "id": "49dc1c5f-3cb7-4f11-a046-752d84805485", "name": "Scope-level rollup", "request": { "name": "Scope-level rollup", "description": { "content": "Full /stats/ page rollup: deltas, pareto, projection, anomalies, velocity, day-of-life, horizon, bump, cohort, heatmap, bullet, yoy, countries, streak, personal bests, milestones, scope-bullet, time-to-first-scan, top tags, concentration, new-vs-established. Cache-backed with 24h TTL.", "type": "text/plain" }, "url": { "path": [ "api", "user", "scope-stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "730e7eb4-ebca-4828-bd3e-cefb7bff8d8c", "name": "Rollup (with cache.hit flag).", "originalRequest": { "url": { "path": [ "api", "user", "scope-stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "workspace-stats", "description": "", "item": [ { "id": "8456b366-2a3c-4188-886d-a4b269168af1", "name": "Personal workspace rollup (without team scope)", "request": { "name": "Personal workspace rollup (without team scope)", "description": {}, "url": { "path": [ "api", "user", "workspace-stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fdb6298f-4ecc-4548-84fb-f95d2c317aa3", "name": "Workspace rollup.", "originalRequest": { "url": { "path": [ "api", "user", "workspace-stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "scan-usage", "description": "", "item": [ { "id": "3036de6d-bd50-434e-9cc0-19d8ee77c95a", "name": "Monthly scan-cap progress", "request": { "name": "Monthly scan-cap progress", "description": {}, "url": { "path": [ "api", "user", "scan-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4a6d43a1-ea12-49fc-8ed7-ae7157d3d0ec", "name": "{ month, count, cap, over }", "originalRequest": { "url": { "path": [ "api", "user", "scan-usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "weather-overlay", "description": "", "item": [ { "id": "f606511a-dfbd-4bc1-843e-295dbb8f7e24", "name": "Top-3 country weather × scan correlation", "request": { "name": "Top-3 country weather × scan correlation", "description": { "content": "Daily temperature + precipitation from open-meteo for the scope's top-3 scan countries. Pearson correlation coefficient with scan counts. 24h KV-cached.", "type": "text/plain" }, "url": { "path": [ "api", "user", "weather-overlay" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "days", "value": "30" } ], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3df5ed8b-a753-472c-ab4a-8a591ec8c971", "name": "Per-country series + correlations.", "originalRequest": { "url": { "path": [ "api", "user", "weather-overlay" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "days", "value": "30" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "export", "description": "", "item": [ { "id": "873d7e01-a8c0-435d-b8b1-8499df446ea0", "name": "Full data export (ZIP of codes.csv + scans.csv + README.txt)", "request": { "name": "Full data export (ZIP of codes.csv + scans.csv + README.txt)", "description": {}, "url": { "path": [ "api", "user", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "me", "description": "", "item": [ { "id": "04aa3456-b2f1-493a-9765-b90bc4868ab8", "name": "Delete account (enters 30-day hard-delete hold). Cookie-authenticated only — an API-key request returns 403 key_not_permitted.", "request": { "name": "Delete account (enters 30-day hard-delete hold). Cookie-authenticated only — an API-key request returns 403 key_not_permitted.", "description": {}, "url": { "path": [ "api", "user", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"confirm\": \"DELETE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0fb4a066-f309-4d76-b161-859d25a3b8da", "name": "Deletion scheduled.", "originalRequest": { "url": { "path": [ "api", "user", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"confirm\": \"DELETE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "workspace-label", "description": "", "item": [ { "id": "b966b965-c7da-4310-8f58-cad16f0509c2", "name": "Rename personal workspace", "request": { "name": "Rename personal workspace", "description": {}, "url": { "path": [ "api", "user", "workspace-label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2f9fb609-5832-4553-b51e-7601b2d1f7cd", "name": "Renamed.", "originalRequest": { "url": { "path": [ "api", "user", "workspace-label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "current-team", "description": "", "item": [ { "id": "b25c3170-9eb1-4af9-b3cb-574a36299d25", "name": "Switch active team. Cookie-authenticated only — an API-key request returns 403 key_not_permitted.", "request": { "name": "Switch active team. Cookie-authenticated only — an API-key request returns 403 key_not_permitted.", "description": {}, "url": { "path": [ "api", "user", "current-team" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"team_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e09c8308-0826-4e97-9914-39de8c443365", "name": "Switched.", "originalRequest": { "url": { "path": [ "api", "user", "current-team" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"team_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "groups", "description": "", "item": [ { "id": "442a2220-8350-44fd-80f1-438f7619cb9b", "name": "List groups in scope", "request": { "name": "List groups in scope", "description": {}, "url": { "path": [ "api", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1fb5d3ab-0bc5-42b0-a9cd-f2a8a1846ac8", "name": "Groups.", "originalRequest": { "url": { "path": [ "api", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fbb4c885-9574-4ee6-9d06-f03f4410ff9c", "name": "Create a group", "request": { "name": "Create a group", "description": {}, "url": { "path": [ "api", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"#60955F\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bd1bbc8a-d640-4c9e-b6a8-7ee2f8ef54d1", "name": "Created.", "originalRequest": { "url": { "path": [ "api", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"#60955F\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "c82577af-d6a2-4adc-b3ba-ddecf8eddaa0", "name": "Get a group", "request": { "name": "Get a group", "description": {}, "url": { "path": [ "api", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "beb9f17b-6a5a-42e2-917c-6000b026d292", "name": "The group.", "originalRequest": { "url": { "path": [ "api", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "223beb68-411a-4977-a4aa-2ec7b8181aef", "name": "Update a group", "request": { "name": "Update a group", "description": {}, "url": { "path": [ "api", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "PATCH", "body": {}, "auth": null }, "response": [ { "id": "d58520e3-abcc-49c7-aeea-addb9e2402e1", "name": "Updated.", "originalRequest": { "url": { "path": [ "api", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "031926c5-d514-455a-8a08-98b2a9df4d08", "name": "Delete a group (member codes become ungrouped)", "request": { "name": "Delete a group (member codes become ungrouped)", "description": {}, "url": { "path": [ "api", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "b705dffc-a9fe-4db2-b661-5c291d9a82cd", "name": "Deleted.", "originalRequest": { "url": { "path": [ "api", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "stats", "description": "", "item": [ { "id": "28efeeec-abc6-4b3c-bdc9-a25806d36308", "name": "Group-scoped rollup (same shape as /api/user/scope-stats filtered to group)", "request": { "name": "Group-scoped rollup (same shape as /api/user/scope-stats filtered to group)", "description": {}, "url": { "path": [ "api", "groups", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "aa9953dd-0b97-4d4e-bf03-78c63c9c00ec", "name": "Group rollup.", "originalRequest": { "url": { "path": [ "api", "groups", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "heatmaps", "description": "", "item": [ { "id": "7ed2b76a-aadb-47a5-90cf-f0a2994957b7", "name": "Group-scoped calendar + hour×dow + geo heatmap data", "request": { "name": "Group-scoped calendar + hour×dow + geo heatmap data", "description": {}, "url": { "path": [ "api", "groups", ":id", "heatmaps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "98560a4a-127b-442f-872e-b99edcedae1a", "name": "Heatmap data aggregated across every code in the group.", "originalRequest": { "url": { "path": [ "api", "groups", ":id", "heatmaps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "teams", "description": "", "item": [ { "id": "50fb0e8f-9064-44e5-a106-6c1dc3a99e9b", "name": "List teams the caller belongs to", "request": { "name": "List teams the caller belongs to", "description": {}, "url": { "path": [ "api", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "782517e7-94cd-491a-8204-3fbd4b6dcc12", "name": "Teams.", "originalRequest": { "url": { "path": [ "api", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e21563e6-1368-4d7d-bf5e-5f16b7bb19ec", "name": "Create a team", "request": { "name": "Create a team", "description": {}, "url": { "path": [ "api", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9deb5cf8-3af6-4eef-aea1-9ce523f72e56", "name": "Created.", "originalRequest": { "url": { "path": [ "api", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "a6883d04-664d-4707-868a-def4a3082849", "name": "Get a team", "request": { "name": "Get a team", "description": {}, "url": { "path": [ "api", "teams", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "505816e8-b95a-4c96-b0e3-713c9c904b7f", "name": "The team.", "originalRequest": { "url": { "path": [ "api", "teams", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1686ba97-93cf-42ea-9f75-ac8be9d585c9", "name": "Rename / update settings", "request": { "name": "Rename / update settings", "description": {}, "url": { "path": [ "api", "teams", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "PATCH", "body": {}, "auth": null }, "response": [ { "id": "d1d79808-7df4-4ee6-a083-cb157ac68287", "name": "Updated.", "originalRequest": { "url": { "path": [ "api", "teams", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "63a4221f-21c7-42c0-b1b5-fde385533a8a", "name": "Delete a team (owner only)", "request": { "name": "Delete a team (owner only)", "description": {}, "url": { "path": [ "api", "teams", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2f31ba9e-8c29-400a-abc2-83180182509c", "name": "Deleted.", "originalRequest": { "url": { "path": [ "api", "teams", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "stats", "description": "", "item": [ { "id": "fcd33af2-b387-4742-b849-c5d7057e0383", "name": "Team-scoped rollup", "request": { "name": "Team-scoped rollup", "description": {}, "url": { "path": [ "api", "teams", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "75d6b9bf-2105-47a0-a3a3-8986ef51457f", "name": "Team rollup.", "originalRequest": { "url": { "path": [ "api", "teams", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "heatmaps", "description": "", "item": [ { "id": "9bf2e4aa-5320-4eda-951b-35f2087d8792", "name": "Team-scoped calendar + hour×dow + geo heatmap data", "request": { "name": "Team-scoped calendar + hour×dow + geo heatmap data", "description": {}, "url": { "path": [ "api", "teams", ":id", "heatmaps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7af3fbdc-fc25-4c51-9f41-196c88bc8563", "name": "Heatmap data aggregated across every code in the team.", "originalRequest": { "url": { "path": [ "api", "teams", ":id", "heatmaps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "activity", "description": "", "item": [ { "id": "04680524-8fc2-4560-9454-17301186fc0d", "name": "Team audit log + leaderboard", "request": { "name": "Team audit log + leaderboard", "description": {}, "url": { "path": [ "api", "teams", ":id", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9af1e6ed-2686-4029-a7a8-27d5b9cb10ad", "name": "Activity feed + per-member leaderboard.", "originalRequest": { "url": { "path": [ "api", "teams", ":id", "activity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "members", "description": "", "item": [ { "id": "0061e92b-e9f3-4b81-9efa-cc9b60f256ae", "name": "List team members", "request": { "name": "List team members", "description": {}, "url": { "path": [ "api", "teams", ":id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5c6f7cce-2c3a-41d7-83ef-d2d3823bf654", "name": "Members.", "originalRequest": { "url": { "path": [ "api", "teams", ":id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{user_id}", "description": "", "item": [ { "id": "aa9646e4-6eed-48af-9bb5-b65e33bb45e6", "name": "Change a member's role", "request": { "name": "Change a member's role", "description": {}, "url": { "path": [ "api", "teams", ":id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"owner\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "971d2566-6786-40c0-ad92-83e312e051ea", "name": "Updated.", "originalRequest": { "url": { "path": [ "api", "teams", ":id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"owner\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1fe27fe-b2ca-41a3-8e6c-e05baf5cfc45", "name": "Remove a member", "request": { "name": "Remove a member", "description": {}, "url": { "path": [ "api", "teams", ":id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "46d1fbd4-7902-495f-a185-67bf977764dc", "name": "Removed.", "originalRequest": { "url": { "path": [ "api", "teams", ":id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "invites", "description": "", "item": [ { "id": "d98a44f4-af06-4a07-911a-a54924499da8", "name": "List pending invites", "request": { "name": "List pending invites", "description": {}, "url": { "path": [ "api", "teams", ":id", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8d57811d-fd1d-48a3-a260-29a1ee720a9a", "name": "Invites.", "originalRequest": { "url": { "path": [ "api", "teams", ":id", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aedc1ad0-f667-45f4-8754-15a1aece9aee", "name": "Invite a user", "request": { "name": "Invite a user", "description": {}, "url": { "path": [ "api", "teams", ":id", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"role\": \"member\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7af70cc4-25f3-4639-b7d4-cc164686b78e", "name": "Invite sent.", "originalRequest": { "url": { "path": [ "api", "teams", ":id", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"role\": \"member\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{invite_id}", "description": "", "item": [ { "id": "41a2a449-eabd-449b-8920-bf447972b4ec", "name": "Revoke a pending invite", "request": { "name": "Revoke a pending invite", "description": {}, "url": { "path": [ "api", "teams", ":id", "invites", ":invite_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "invite_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "01d141f1-0a6d-4159-ba43-0678a0c83e4e", "name": "Revoked.", "originalRequest": { "url": { "path": [ "api", "teams", ":id", "invites", ":invite_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "invite_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "webhooks", "description": "", "item": [ { "id": "aacc88f3-b0e9-4d86-b245-bf587dbc71e6", "name": "List webhooks", "request": { "name": "List webhooks", "description": {}, "url": { "path": [ "api", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8e6d0d0f-39a4-49c8-9acd-782bdbb2ce3a", "name": "Webhooks + available event types.", "originalRequest": { "url": { "path": [ "api", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7728153-aa61-47e3-a047-6834522c88f0", "name": "Register a webhook", "request": { "name": "Register a webhook", "description": { "content": "Signing secret is returned ONCE on creation.", "type": "text/plain" }, "url": { "path": [ "api", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"anomaly.surge\",\n \"anomaly.surge\"\n ],\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f8d23227-a909-4ff8-8990-2f10145120fc", "name": "Created. Response includes the signing secret.", "originalRequest": { "url": { "path": [ "api", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"anomaly.surge\",\n \"anomaly.surge\"\n ],\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "0a14b6df-607f-4fd8-b677-67fd11a76c61", "name": "Delete a webhook", "request": { "name": "Delete a webhook", "description": {}, "url": { "path": [ "api", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "5baa2cde-46ec-4269-b157-c603cafc9618", "name": "Deleted.", "originalRequest": { "url": { "path": [ "api", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "stats", "description": "", "item": [ { "name": "recent-scans", "description": "", "item": [ { "id": "25775006-f551-4460-b60c-5172934c034d", "name": "Recent scan events (daily, or hourly on Team+)", "request": { "name": "Recent scan events (daily, or hourly on Team+)", "description": {}, "url": { "path": [ "api", "stats", "recent-scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "hourly", "value": "" } ], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "30889c64-ff26-496b-876f-a77aab67ba50", "name": "Events.", "originalRequest": { "url": { "path": [ "api", "stats", "recent-scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "hourly", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "tag-rollups", "description": "", "item": [ { "id": "64270027-65a3-4fb2-bba1-ddb10ddd6013", "name": "Scans grouped by tag", "request": { "name": "Scans grouped by tag", "description": {}, "url": { "path": [ "api", "stats", "tag-rollups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "days", "value": "30" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "top", "value": "20" } ], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1fe9b579-f741-4da5-b52b-83a8b42e2607", "name": "Tag rollups.", "originalRequest": { "url": { "path": [ "api", "stats", "tag-rollups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "days", "value": "30" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "top", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "audit", "description": "", "item": [ { "id": "724449ab-2b26-449e-98fc-a85318a87ba9", "name": "Scoped audit-log feed for current user", "request": { "name": "Scoped audit-log feed for current user", "description": { "content": "Returns recent audit_log rows for the current scope (personal or team). Used by the federated /account/audit/ surface on abundera.ai (ADR 081).", "type": "text/plain" }, "url": { "path": [ "api", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "de76059c-b6e5-4f00-918d-cd882fdd0a7e", "name": "Audit entries for current scope", "originalRequest": { "url": { "path": [ "api", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"scope\": \"\",\n \"limit\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74bcd112-6b33-41f2-8589-4be256fc946f", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "api", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3e60845-1197-4175-b2a0-a27666cba97f", "name": "Server error", "originalRequest": { "url": { "path": [ "api", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "push", "description": "", "item": [ { "name": "vapid-key", "description": "", "item": [ { "id": "6d414666-8825-4e8b-a3eb-a34c2856a8a6", "name": "Return the VAPID public key used for Web Push subscriptions", "request": { "name": "Return the VAPID public key used for Web Push subscriptions", "description": {}, "url": { "path": [ "api", "push", "vapid-key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fbaf41b6-fe78-425e-b9ce-3ba3ae9e20d4", "name": "VAPID public key", "originalRequest": { "url": { "path": [ "api", "push", "vapid-key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "subscribe", "description": "", "item": [ { "id": "27f747c4-3379-4069-a39f-2ae229d093bb", "name": "Register a Web Push subscription for the current user", "request": { "name": "Register a Web Push subscription for the current user", "description": {}, "url": { "path": [ "api", "push", "subscribe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "e6e7b26a-4482-41dc-8b14-c1fcaf1ffb06", "name": "Subscription stored", "originalRequest": { "url": { "path": [ "api", "push", "subscribe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3383bb34-966f-48e6-96cc-62950169274b", "name": "Invalid subscription", "originalRequest": { "url": { "path": [ "api", "push", "subscribe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "592235c0-12d4-43b0-96a6-b60199354c16", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "api", "push", "subscribe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78d39b3c-167e-46fc-8469-bf605921a5d3", "name": "Remove a Web Push subscription for the current user", "request": { "name": "Remove a Web Push subscription for the current user", "description": {}, "url": { "path": [ "api", "push", "subscribe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "565b85e5-3a30-4cee-9337-a20f5ae81f20", "name": "Subscription removed", "originalRequest": { "url": { "path": [ "api", "push", "subscribe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e448535c-534a-4925-8460-cdc9e9f1f1fc", "name": "Endpoint required", "originalRequest": { "url": { "path": [ "api", "push", "subscribe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "807cb440-d30e-4d2d-8106-7b7ba65b7200", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "api", "push", "subscribe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "org", "description": "", "item": [ { "id": "79fa0c58-6bd4-4fef-8d0b-3ef7b5b1c71a", "name": "Get white-label org config", "request": { "name": "Get white-label org config", "description": { "content": "Returns the org config for the authenticated Enterprise user. Returns 404 for non-Enterprise accounts.", "type": "text/plain" }, "url": { "path": [ "api", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b743cf88-95bb-43f6-b05f-27f3e00ecae4", "name": "Org config", "originalRequest": { "url": { "path": [ "api", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eccb054b-9323-4123-be74-992d3bc9a444", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "api", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac887bc4-52bf-4952-b622-9229fa24fe61", "name": "No org on this account", "originalRequest": { "url": { "path": [ "api", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d939f57-f11f-4b35-9149-b21e8e361b30", "name": "Update org branding (self-serve)", "request": { "name": "Update org branding (self-serve)", "description": { "content": "Update name, support_email, brand_color, logo_url. Only the org owner may call this. Domain fields require admin API.", "type": "text/plain" }, "url": { "path": [ "api", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"support_email\": \"\",\n \"brand_color\": \"#3eAE2b\",\n \"logo_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "cc4e4da4-e7ff-44da-9b32-15a94cf5c803", "name": "Updated org config", "originalRequest": { "url": { "path": [ "api", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"support_email\": \"\",\n \"brand_color\": \"#3eAE2b\",\n \"logo_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac778ccf-0625-47a8-aacf-c060aa51c990", "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"support_email\": \"\",\n \"brand_color\": \"#3eAE2b\",\n \"logo_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f3e42f5c-dee9-44df-9e1a-3d224ce12abc", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "api", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"support_email\": \"\",\n \"brand_color\": \"#3eAE2b\",\n \"logo_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1cee9f30-b042-4597-a0df-57455bb8743a", "name": "Not org owner", "originalRequest": { "url": { "path": [ "api", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"support_email\": \"\",\n \"brand_color\": \"#3eAE2b\",\n \"logo_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "01785037-fb42-4767-adcd-23468b987076", "name": "No org on this account", "originalRequest": { "url": { "path": [ "api", "org" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"support_email\": \"\",\n \"brand_color\": \"#3eAE2b\",\n \"logo_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "brand", "description": "", "item": [ { "id": "16cd7276-e7a9-443e-acdc-713064646615", "name": "Public org brand config", "request": { "name": "Public org brand config", "description": { "content": "Returns brand name, accent color, and logo URL for a given org_id. Public endpoint — no auth required. Used by the login page to render with the org's branding.", "type": "text/plain" }, "url": { "path": [ "api", "org", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" } ], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "da8fe29b-b8a6-4145-9076-ecc640051f6b", "name": "Brand config", "originalRequest": { "url": { "path": [ "api", "org", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5948cb84-c4b1-49a0-8599-18ecb771a5c7", "name": "Org not found", "originalRequest": { "url": { "path": [ "api", "org", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "id", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "verify-domains", "description": "", "item": [ { "id": "9257582c-4a99-4107-a54b-bcbf6c485a69", "name": "Get domain verification status", "request": { "name": "Get domain verification status", "description": { "content": "Returns current verification status and required CNAME records for the org's custom domains.", "type": "text/plain" }, "url": { "path": [ "api", "org", "verify-domains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "db8cfb7b-2824-4e3b-9b1e-8916beea4e2d", "name": "Domain verification status", "originalRequest": { "url": { "path": [ "api", "org", "verify-domains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3a860176-8863-4126-bb5c-3c6d5358b225", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "api", "org", "verify-domains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42b19bb5-f53c-4ce7-8428-bcce10424132", "name": "No org on this account", "originalRequest": { "url": { "path": [ "api", "org", "verify-domains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6f8f91b-d9ad-4517-972a-d96ef83c11ef", "name": "Verify a custom domain and provision TLS", "request": { "name": "Verify a custom domain and provision TLS", "description": { "content": "Checks CNAME resolution and provisions a Cloudflare for SaaS Custom Hostname. Idempotent — safe to re-call.", "type": "text/plain" }, "url": { "path": [ "api", "org", "verify-domains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"dashboard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4260741a-a95e-4b33-bb43-b098458e26a2", "name": "Verification result (verified: true/false)", "originalRequest": { "url": { "path": [ "api", "org", "verify-domains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"dashboard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "476647c7-f4d8-475b-a835-18905b4a775d", "name": "Domain not set or invalid type", "originalRequest": { "url": { "path": [ "api", "org", "verify-domains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"dashboard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "27aa6653-a8f3-4838-8863-8423c3372b3a", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "api", "org", "verify-domains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"dashboard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f9b81812-5e98-4bf3-9e00-e2fa508fb559", "name": "Not org owner", "originalRequest": { "url": { "path": [ "api", "org", "verify-domains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"dashboard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f2221141-2701-454e-bb5a-2e1551b7c7dc", "name": "No org on this account", "originalRequest": { "url": { "path": [ "api", "org", "verify-domains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"dashboard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "logo", "description": "", "item": [ { "id": "ef2a477e-712c-49d3-b3a9-c1273c9120a6", "name": "Serve org logo from R2", "request": { "name": "Serve org logo from R2", "description": { "content": "Public endpoint — serves the org logo file from R2. No auth required.", "type": "text/plain" }, "url": { "path": [ "api", "org", "logo" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) R2 object key (org-logos//logo.)", "type": "text/plain" }, "key": "key", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "image/*" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "118123b2-cc3f-4f1f-93d9-afb62a29b6ad", "name": "Logo file", "originalRequest": { "url": { "path": [ "api", "org", "logo" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) R2 object key (org-logos//logo.)", "type": "text/plain" }, "key": "key", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "image/*" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "image/*" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb665be0-014b-4109-9944-7f38dfba2d21", "name": "Not found", "originalRequest": { "url": { "path": [ "api", "org", "logo" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) R2 object key (org-logos//logo.)", "type": "text/plain" }, "key": "key", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34ccfce3-d491-4f00-ac34-7f7641a16d84", "name": "Upload org logo to R2", "request": { "name": "Upload org logo to R2", "description": { "content": "Owner-only. Accepts base64-encoded image (PNG/JPG/SVG/WebP, max 1MB). Returns hosted logo_url.", "type": "text/plain" }, "url": { "path": [ "api", "org", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"mime_type\": \"image/webp\",\n \"data\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "de4e2369-5bfb-4786-b5d3-50f990935a6b", "name": "Logo uploaded", "originalRequest": { "url": { "path": [ "api", "org", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"mime_type\": \"image/webp\",\n \"data\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"logo_url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfa54aed-1365-4df4-bf45-ddeb8190f805", "name": "Invalid input", "originalRequest": { "url": { "path": [ "api", "org", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"mime_type\": \"image/webp\",\n \"data\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e635f6e5-eb9d-44ee-ba1d-b0386efe8267", "name": "File too large", "originalRequest": { "url": { "path": [ "api", "org", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"mime_type\": \"image/webp\",\n \"data\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://pro.qr.abundera.ai" } ], "info": { "_postman_id": "90a66fb6-0488-477f-a2c5-ee7ec7fc82e0", "name": "Abundera QR Pro API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Customer API for pro.qr.abundera.ai. Covers code management, analytics, groups, webhooks, team management, and user-scope data.\n\n## Not in this spec\n\n- Admin endpoints (`/api/admin/*`) — service-to-service only, authenticated via `X-Service-Secret` header.\n- Stripe webhook inbound (`/api/stripe/webhook`) — signed by Stripe, not customer-callable.\n- Invite accept-bridge (`/api/invites/:token/register-bridge`) — service-to-service from abundera.ai.\n- Share-page data endpoints (`/api/p/:token/*`, `/api/codes/:id/public-stats`) — power the public preview pages, not part of the programmatic API surface.\n- Session endpoints (`/api/auth/*`, `/api/billing/*`, `DELETE /api/user/me`, `PATCH /api/user/current-team`) — cookie-authenticated only, used by the dashboard; API keys do not authorize them.\n\n## Authentication\n\nPrimary: Bearer token with `abnd_qrpro_`-prefixed API key. Create at [abundera.ai/account/api-keys/](https://abundera.ai/account/api-keys/) (Business, Team, Agency plans) — keys are federated across every Abundera product (ADR 076). A key request to a cookie-only endpoint returns `403 key_not_permitted`.\n\nAlternative: session cookie (dashboard). API consumers should use the bearer token.\n\n## Scopes\n\nEvery API key is minted with an explicit scope set. Pro.qr enforces scopes at the middleware layer; a request with a valid key but the wrong scope returns `403 { \"error\": \"scope_missing\", \"required\": \"\" }`. Legal scopes: `codes:read`, `codes:write`, `stats:read`, `groups:write`, `webhooks:write`, `teams:read`, `teams:write`. An empty-scope key (legacy, pre-federation) has full access.\n\n## Account-state gate\n\nAPI keys stop working immediately when the account is terminated (`plan_status` = `expired` or `pending_delete`) — such requests return `401 { \"error\": \"account_inactive\", \"plan_status\": \"\" }`. Keys remain fully functional during the 90-day `grace` window so customers can export and migrate. Cookie sessions remain valid in all states so users can still reactivate or confirm deletion.\n\n## Rate limits\n\n- API-key requests: 1000/day (Business), 10000/day (Team), 50000/day (Agency).\n- Session-cookie requests: 60/minute.\n\nOn 429 responses: `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `Retry-After`.\n\n## Webhook delivery\n\nYou can register outbound webhooks at `/api/webhooks`. Deliveries are HMAC-SHA256-signed (Stripe-compatible format): `X-Abundera-Signature: t=,v1=`. Signed payload = `\"{timestamp}.{raw_body}\"`. See `components.securitySchemes.webhookSignature` for the scheme.\n\nContact Support:\n Name: Abundera support\n Email: support@abundera.ai", "type": "text/plain" } } }