{ "item": [ { "name": "status", "description": "", "item": [ { "name": "health", "description": "", "item": [ { "id": "a5ed7657-d6e4-40d4-b267-f8047b5ca364", "name": "Health check", "request": { "name": "Health check", "description": { "content": "Returns the current health status of the API.", "type": "text/plain" }, "url": { "path": [ "status", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "889b1e8e-4b9b-4275-900a-efdf9038048c", "name": "API is healthy.", "originalRequest": { "url": { "path": [ "status", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"healthy\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "session", "description": "", "item": [ { "id": "c13f64de-5dd2-465d-82c9-431f5c4be8e9", "name": "Request authentication nonce", "request": { "name": "Request authentication nonce", "description": { "content": "Generates a nonce for the given signer address. The returned dataHex must be signed by the wallet to complete authentication. When a scriptAddress is provided (multisig flow), it is included in the response.\n\n**Rate limit:** 5 requests per minute per IP.\n", "type": "text/plain" }, "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fb55a75f-88c5-4d16-9456-0e8b666823d1", "name": "Nonce generated successfully.", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"dataHex\": \"\",\n \"userId\": \"\",\n \"userIdHex\": \"\",\n \"signerAddressHex\": \"\",\n \"scriptAddress\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3630a9a-c821-4fe3-97cd-20f1d76c73f6", "name": "Invalid request. Possible reasons: missing or invalid signer address, script address errors.", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1a24444-2dbc-4775-bbb6-c9154e1aa0fe", "name": "Rate limit exceeded (5 requests per minute per IP).", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a764703d-b4e7-4a47-a183-c628b04b3527", "name": "Verify wallet signature", "request": { "name": "Verify wallet signature", "description": { "content": "Verifies the wallet signature against the previously issued nonce and returns a JWT token. The token is also set as an HTTP-only cookie. The nonce has a TTL of 5 minutes.\n\n**Rate limit:** 10 requests per minute per IP.\n", "type": "text/plain" }, "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"signature\": \"\",\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3c5c8e46-fe49-4c74-a4a3-dbf3e0a7ba40", "name": "Signature verified. A JWT token is returned in the body and set as an HTTP-only cookie.", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"signature\": \"\",\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"\",\n \"expiresIn\": \"\",\n \"userId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8049f692-3a4b-4b18-81aa-bfe74dd108af", "name": "Invalid request. Possible reasons: nonce expired (5-minute TTL), signature verification failed, script address errors.", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"signature\": \"\",\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ee0b4bf-dd33-498f-9108-1e9d726c1a1f", "name": "Rate limit exceeded (10 requests per minute per IP).", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"signature\": \"\",\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ea029e5-3e58-4509-b907-92ef4aa9a2dc", "name": "Check current session", "request": { "name": "Check current session", "description": { "content": "Returns information about the currently authenticated user.\n\n**Rate limit:** 60 requests per minute per IP.\n", "type": "text/plain" }, "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6e2faa29-706b-4246-9a21-16b171b753ff", "name": "Session is valid.", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"userId\": \"\",\n \"name\": \"\",\n \"adminVoteIds\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa5145a5-0291-43c2-8395-e8a65a0295d6", "name": "Not authenticated or session expired.", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c43b54d-317e-4398-8378-058d0c42f4d4", "name": "Rate limit exceeded (60 requests per minute per IP).", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfeaa1e1-310a-406e-a8f6-1d7c11dc1d28", "name": "Log out", "request": { "name": "Log out", "description": { "content": "Invalidates the current session and clears the authentication cookie.\n\n**Rate limit:** 20 requests per minute per IP.\n", "type": "text/plain" }, "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "23a66b59-09f6-4b00-a96d-ef6174147efb", "name": "Successfully logged out.", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9f09c58-3e4e-41f5-a2cd-6c20a447fb20", "name": "Not authenticated or session expired.", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dd16e6c-2c03-4550-b673-bfd8297e2199", "name": "Rate limit exceeded (20 requests per minute per IP).", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "votes", "description": "", "item": [ { "id": "0c6f4bb4-003d-44d9-bd2d-895becd0c93d", "name": "List vote cycles", "request": { "name": "List vote cycles", "description": { "content": "Returns a paginated list of vote cycles, sorted by createdAt descending. Supports search and slug filtering. Duplicate query parameters for search or slug are rejected.\n", "type": "text/plain" }, "url": { "path": [ "votes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search across vote cycle fields.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by vote cycle slug.", "type": "text/plain" }, "key": "slug", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8d49a872-1416-4d03-a83d-df26ef695046", "name": "Paginated list of vote cycles.", "originalRequest": { "url": { "path": [ "votes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search across vote cycle fields.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by vote cycle slug.", "type": "text/plain" }, "key": "slug", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"admins\": [\n \"\",\n \"\"\n ],\n \"submissionStartDate\": \"\",\n \"submissionEndDate\": \"\",\n \"feedbackStartDate\": \"\",\n \"feedbackEndDate\": \"\",\n \"reviewStartDate\": \"\",\n \"reviewEndDate\": \"\",\n \"form\": {},\n \"commentsEnabled\": \"\",\n \"depositOptions\": {\n \"treasuryDonation\": \"\",\n \"depositAddress\": \"\",\n \"depositAmount\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"votingUrl\": \"\"\n },\n {\n \"_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"admins\": [\n \"\",\n \"\"\n ],\n \"submissionStartDate\": \"\",\n \"submissionEndDate\": \"\",\n \"feedbackStartDate\": \"\",\n \"feedbackEndDate\": \"\",\n \"reviewStartDate\": \"\",\n \"reviewEndDate\": \"\",\n \"form\": {},\n \"commentsEnabled\": \"\",\n \"depositOptions\": {\n \"treasuryDonation\": \"\",\n \"depositAddress\": \"\",\n \"depositAmount\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"votingUrl\": \"\"\n }\n ],\n \"meta\": {\n \"page\": \"\",\n \"limit\": \"\",\n \"total\": \"\",\n \"totalPages\": \"\",\n \"hasNextPage\": \"\",\n \"hasPreviousPage\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c85fbfb2-e21c-4f66-85d4-d8963a34de48", "name": "Invalid request. Possible reasons: invalid pagination values, duplicate search or slug query parameters.", "originalRequest": { "url": { "path": [ "votes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search across vote cycle fields.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by vote cycle slug.", "type": "text/plain" }, "key": "slug", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd03ae77-6a03-4880-b179-482ef4e145c4", "name": "No vote cycles match the provided search or slug filter.", "originalRequest": { "url": { "path": [ "votes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search across vote cycle fields.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by vote cycle slug.", "type": "text/plain" }, "key": "slug", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{voteIdentifier}", "description": "", "item": [ { "id": "e9b7de08-dc39-4bf5-9ad6-2186e8bd64dc", "name": "Get a vote cycle", "request": { "name": "Get a vote cycle", "description": { "content": "Returns a single vote cycle by its ObjectId (24 hex characters) or by its slug. The API first attempts to match an ObjectId; if the parameter is not a valid ObjectId, it falls back to a slug lookup. The response includes filterOptions and searchOptions but excludes the validationScript.\n", "type": "text/plain" }, "url": { "path": [ "votes", ":voteIdentifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "voteIdentifier", "disabled": false, "description": { "content": "(Required) Vote cycle ObjectId (24 hex characters) or slug string.\n", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "05ff65f0-4ff9-4f9b-a5d1-d1ae55c5fcec", "name": "Vote cycle found.", "originalRequest": { "url": { "path": [ "votes", ":voteIdentifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Vote cycle ObjectId (24 hex characters) or slug string.\n", "type": "text/plain" }, "type": "any", "value": "", "key": "voteIdentifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"slug\": \"\",\n \"admins\": [\n \"\",\n \"\"\n ],\n \"submissionStartDate\": \"\",\n \"submissionEndDate\": \"\",\n \"feedbackStartDate\": \"\",\n \"feedbackEndDate\": \"\",\n \"reviewStartDate\": \"\",\n \"reviewEndDate\": \"\",\n \"form\": {},\n \"commentsEnabled\": \"\",\n \"depositOptions\": {\n \"treasuryDonation\": \"\",\n \"depositAddress\": \"\",\n \"depositAmount\": \"\"\n },\n \"sortOptions\": [],\n \"filterOptions\": [],\n \"searchOptions\": [],\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"votingUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aba3c0fb-1190-4ec8-a29f-36278f70124f", "name": "Vote cycle not found.", "originalRequest": { "url": { "path": [ "votes", ":voteIdentifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Vote cycle ObjectId (24 hex characters) or slug string.\n", "type": "text/plain" }, "type": "any", "value": "", "key": "voteIdentifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "proposals", "description": "", "item": [ { "id": "3fe8e4a9-5f21-424a-b31d-22e52e25f73a", "name": "Create a proposal", "request": { "name": "Create a proposal", "description": { "content": "Creates a new proposal within a vote cycle. The metaData object is validated dynamically against the vote cycle's current configuration (form schema). For example, the budget2026 vote may require fields such as proposerDetails, strategyFramework, milestones, etc.\n\nWhen the proposal status is \"live\" and the vote cycle has treasury donation configured, a unique and verified treasuryDonationTxHash is required in the body.\n\n**Rate limit:** 10 requests per minute per user.\n", "type": "text/plain" }, "url": { "path": [ "proposals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"86bc8f5F714F0e70C24C0d4C\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4a4880ba-ff53-4906-921a-7c683030c16d", "name": "Proposal created successfully.", "originalRequest": { "url": { "path": [ "proposals" ], "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: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"86bc8f5F714F0e70C24C0d4C\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"proposerId\": \"\",\n \"voteId\": \"\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"withdrawnByAdmin\",\n \"metaData\": {},\n \"version\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Policy violation\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n },\n \"versions\": [\n {\n \"_id\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"_id\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"currentProposalId\": \"\",\n \"submittedAt\": \"\",\n \"treasuryDonationTxHash\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1cf7f0a-512d-4be3-8147-9ed8dbf7f00c", "name": "Invalid request. Possible reasons: validation errors, invalid voteId format, metaData does not match vote configuration.", "originalRequest": { "url": { "path": [ "proposals" ], "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: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"86bc8f5F714F0e70C24C0d4C\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a153a7ee-61b7-42c9-be82-b9e59228b224", "name": "Not authenticated.", "originalRequest": { "url": { "path": [ "proposals" ], "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: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"86bc8f5F714F0e70C24C0d4C\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a90a5ad3-088e-4f78-8393-09a135cdd150", "name": "Vote cycle not found.", "originalRequest": { "url": { "path": [ "proposals" ], "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: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"86bc8f5F714F0e70C24C0d4C\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce7c54f4-c7fd-41b8-b86d-d8482768bee2", "name": "Rate limit exceeded (10 requests per minute per user).", "originalRequest": { "url": { "path": [ "proposals" ], "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: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"86bc8f5F714F0e70C24C0d4C\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d2f9b05-2cc5-4ba0-8445-5eed0feec1a8", "name": "List proposals", "request": { "name": "List proposals", "description": { "content": "Returns a paginated list of proposals for a given vote cycle. The vote query parameter is required. Draft proposals are only visible to the proposer or vote cycle admins.\n\n**List item projection is vote-configurable.** When the vote cycle defines a `listProjectionScript`, that script's `projectProposalListItem(proposal, { vote, isProposer, isAdmin })` is invoked per row and may add, omit, or reshape fields per the ballot's needs (for example, a budget cycle may expose `totalBudget` and a strategy-pillar summary that a generic cycle would not). When no projection script is configured (or the script throws), the fallback projection returns the full proposal minus internal-only fields (`withdrawalReason`, `signature`, `userId`) plus `commentCount`. Clients should treat `ProposalListItem` below as the conservative minimum and tolerate additional per-vote fields.\n", "type": "text/plain" }, "url": { "path": [ "proposals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Vote cycle ObjectId (24 hex characters).", "type": "text/plain" }, "key": "vote", "value": "3f2eFedDF6c1FFAE011abEaC" }, { "disabled": false, "description": { "content": "Free-text search across proposal title and summary.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by proposer address (bech32 stake1... or drep1... format).\n", "type": "text/plain" }, "key": "proposer", "value": "" }, { "disabled": false, "description": { "content": "Filter by proposal status. Defaults to \"live\". Draft access is restricted to the proposer or vote cycle admin.\n (This can only be one of draft,live,withdrawn)", "type": "text/plain" }, "key": "status", "value": "live" }, { "disabled": false, "description": { "content": "Filter by category. Accepts a comma-separated list of ObjectIds.\n", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "Sort field. Must be one of the vote cycle's sortOptions. Defaults to submittedAt.\n", "type": "text/plain" }, "key": "sort", "value": "submittedAt" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "374ada65-083a-40e6-a986-575c353064bc", "name": "Paginated list of proposals.", "originalRequest": { "url": { "path": [ "proposals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Vote cycle ObjectId (24 hex characters).", "type": "text/plain" }, "key": "vote", "value": "3f2eFedDF6c1FFAE011abEaC" }, { "disabled": false, "description": { "content": "Free-text search across proposal title and summary.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by proposer address (bech32 stake1... or drep1... format).\n", "type": "text/plain" }, "key": "proposer", "value": "" }, { "disabled": false, "description": { "content": "Filter by proposal status. Defaults to \"live\". Draft access is restricted to the proposer or vote cycle admin.\n (This can only be one of draft,live,withdrawn)", "type": "text/plain" }, "key": "status", "value": "live" }, { "disabled": false, "description": { "content": "Filter by category. Accepts a comma-separated list of ObjectIds.\n", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "Sort field. Must be one of the vote cycle's sortOptions. Defaults to submittedAt.\n", "type": "text/plain" }, "key": "sort", "value": "submittedAt" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"_id\": \"\",\n \"proposerId\": \"\",\n \"voteId\": \"\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"withdrawnByProposer\",\n \"metaData\": {\n \"proposerDetails\": {\n \"name\": \"\"\n },\n \"contractingParty\": {\n \"legalEntityType\": \"\"\n },\n \"strategyFramework\": {\n \"pillars\": [\n \"\",\n \"\"\n ]\n },\n \"conversionRate\": \"\",\n \"totalBudget\": \"\"\n },\n \"version\": \"\",\n \"commentCount\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Spam\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n },\n \"submittedAt\": \"\"\n },\n {\n \"_id\": \"\",\n \"proposerId\": \"\",\n \"voteId\": \"\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"archived\",\n \"metaData\": {\n \"proposerDetails\": {\n \"name\": \"\"\n },\n \"contractingParty\": {\n \"legalEntityType\": \"\"\n },\n \"strategyFramework\": {\n \"pillars\": [\n \"\",\n \"\"\n ]\n },\n \"conversionRate\": \"\",\n \"totalBudget\": \"\"\n },\n \"version\": \"\",\n \"commentCount\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Spam\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n },\n \"submittedAt\": \"\"\n }\n ],\n \"meta\": {\n \"page\": \"\",\n \"limit\": \"\",\n \"total\": \"\",\n \"totalPages\": \"\",\n \"hasNextPage\": \"\",\n \"hasPreviousPage\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "291b9f98-d0b9-4e73-b765-ea25451a6314", "name": "Invalid request. Possible reasons: missing vote parameter, invalid query parameters, unauthorized draft access.", "originalRequest": { "url": { "path": [ "proposals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Vote cycle ObjectId (24 hex characters).", "type": "text/plain" }, "key": "vote", "value": "3f2eFedDF6c1FFAE011abEaC" }, { "disabled": false, "description": { "content": "Free-text search across proposal title and summary.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by proposer address (bech32 stake1... or drep1... format).\n", "type": "text/plain" }, "key": "proposer", "value": "" }, { "disabled": false, "description": { "content": "Filter by proposal status. Defaults to \"live\". Draft access is restricted to the proposer or vote cycle admin.\n (This can only be one of draft,live,withdrawn)", "type": "text/plain" }, "key": "status", "value": "live" }, { "disabled": false, "description": { "content": "Filter by category. Accepts a comma-separated list of ObjectIds.\n", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "Sort field. Must be one of the vote cycle's sortOptions. Defaults to submittedAt.\n", "type": "text/plain" }, "key": "sort", "value": "submittedAt" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a94c537-7444-4866-b1ec-9153c99510d0", "name": "Vote cycle not found.", "originalRequest": { "url": { "path": [ "proposals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Vote cycle ObjectId (24 hex characters).", "type": "text/plain" }, "key": "vote", "value": "3f2eFedDF6c1FFAE011abEaC" }, { "disabled": false, "description": { "content": "Free-text search across proposal title and summary.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by proposer address (bech32 stake1... or drep1... format).\n", "type": "text/plain" }, "key": "proposer", "value": "" }, { "disabled": false, "description": { "content": "Filter by proposal status. Defaults to \"live\". Draft access is restricted to the proposer or vote cycle admin.\n (This can only be one of draft,live,withdrawn)", "type": "text/plain" }, "key": "status", "value": "live" }, { "disabled": false, "description": { "content": "Filter by category. Accepts a comma-separated list of ObjectIds.\n", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "Sort field. Must be one of the vote cycle's sortOptions. Defaults to submittedAt.\n", "type": "text/plain" }, "key": "sort", "value": "submittedAt" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{proposalId}", "description": "", "item": [ { "id": "ecf45c5b-67d2-4f32-85ce-6d2f27073bbd", "name": "Get a proposal", "request": { "name": "Get a proposal", "description": { "content": "Returns a single proposal by its ObjectId, including the full metaData and commentCount. Optional authentication enhances access to draft proposals. The exclude script is applied unless the requester is the proposer or a vote cycle admin.\n", "type": "text/plain" }, "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId", "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c39b5a12-0349-4f69-b06f-6849c033ca48", "name": "Proposal found.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"proposerId\": \"\",\n \"voteId\": \"\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"archived\",\n \"metaData\": {},\n \"version\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Inappropriate content\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n },\n \"versions\": [\n {\n \"_id\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"_id\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"currentProposalId\": \"\",\n \"submittedAt\": \"\",\n \"treasuryDonationTxHash\": \"\",\n \"commentCount\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2177c87a-42a0-4f86-9eba-e80c3299d723", "name": "Invalid proposal ID format.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fe9ed18-a034-4ab2-9bc0-bf117b6052db", "name": "Forbidden. Draft proposal is not accessible without proper authorization.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e390a01e-0ab8-4116-b5e4-f5c22bc12f3c", "name": "Proposal not found.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afe52d36-67e5-4e22-9873-5a1c0b2ed63b", "name": "Update a proposal", "request": { "name": "Update a proposal", "description": { "content": "Updates a proposal. Only the original proposer may update. Archived proposals are read-only. For live proposals, the status field is immutable, updates are locked after the vote cycle's reviewEndDate, and each update creates a new version entry. When transitioning from draft to live, treasury donation validation is applied if configured.\n\n**Rate limit:** 10 requests per minute per user.\n", "type": "text/plain" }, "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId", "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"4dF0d00e5FfDbAEb7859Abdd\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f4e198e8-eab7-4f25-9ce0-a412205ae525", "name": "Proposal updated successfully.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"4dF0d00e5FfDbAEb7859Abdd\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"proposerId\": \"\",\n \"voteId\": \"\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"withdrawnByAdmin\",\n \"metaData\": {},\n \"version\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Policy violation\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n },\n \"versions\": [\n {\n \"_id\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"_id\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"currentProposalId\": \"\",\n \"submittedAt\": \"\",\n \"treasuryDonationTxHash\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c279f7bc-3947-4f9e-87d3-126d7f49b372", "name": "Invalid request. Possible reasons: validation errors, proposal is archived, attempted status change on live proposal, update locked after reviewEndDate.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"4dF0d00e5FfDbAEb7859Abdd\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10e1bd9a-1a45-4589-adf4-069cf8c62ecb", "name": "Not authenticated.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"4dF0d00e5FfDbAEb7859Abdd\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6adca4ca-45de-440c-8114-6315180f27a1", "name": "Forbidden. Only the original proposer may update.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"4dF0d00e5FfDbAEb7859Abdd\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90b57927-b9bb-437c-abec-398c0683c220", "name": "Proposal not found.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"4dF0d00e5FfDbAEb7859Abdd\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce80be74-bbda-4d54-abee-069c82b2eab2", "name": "Rate limit exceeded (10 requests per minute per user).", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"voteId\": \"4dF0d00e5FfDbAEb7859Abdd\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"draft\",\n \"metaData\": {},\n \"treasuryDonationTxHash\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d320f507-3dcf-4c9f-a7df-8dd63b2b54d5", "name": "Delete a draft proposal", "request": { "name": "Delete a draft proposal", "description": { "content": "Permanently deletes a draft proposal. Only the original proposer may delete. Only proposals with status \"draft\" can be deleted.\n\n**Rate limit:** 10 requests per minute per user.\n", "type": "text/plain" }, "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId", "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b2516d7a-6648-440e-9845-64356ba0ece7", "name": "Proposal deleted successfully.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e949176-9e3e-49f2-8ccc-d911835d5f01", "name": "Invalid request. The proposal is not in draft status.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c46e3b77-b565-4700-a314-8351836ffdae", "name": "Not authenticated.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68408b1b-1847-4c81-b32a-5f34a1beb410", "name": "Forbidden. Only the original proposer may delete.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b77f0ca-ca4e-43d2-b0c6-5faad8380201", "name": "Proposal not found.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58b1825c-8492-4728-8afc-ef25a34fefab", "name": "Rate limit exceeded (10 requests per minute per user).", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "withdraw", "description": "", "item": [ { "id": "9e4dcfdb-e8f1-4b08-a7ca-08fe2d4f37bc", "name": "Withdraw a proposal", "request": { "name": "Withdraw a proposal", "description": { "content": "Withdraws a live proposal. The proposer may withdraw until the vote cycle's feedbackEndDate; a vote cycle admin may withdraw until the reviewEndDate. Sets the status to withdrawnByProposer or withdrawnByAdmin accordingly.\n\n**Rate limit:** 10 requests per minute per user.\n", "type": "text/plain" }, "url": { "path": [ "proposals", ":proposalId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId", "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5bbf739b-b447-452d-9915-bd7e9358d3ba", "name": "Proposal withdrawn successfully.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"proposerId\": \"\",\n \"voteId\": \"\",\n \"title\": \"\",\n \"summary\": \"\",\n \"status\": \"live\",\n \"metaData\": {},\n \"version\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Spam\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n },\n \"versions\": [\n {\n \"_id\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"_id\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"currentProposalId\": \"\",\n \"submittedAt\": \"\",\n \"treasuryDonationTxHash\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "453aed93-1a7c-49d0-b7f1-cf463d07c675", "name": "Invalid request. Possible reasons: proposal is not live, invalid withdrawal category, past the allowed withdrawal deadline.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aaf3e1a-d0a4-4c45-835f-ade56bfde184", "name": "Not authenticated.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25beab47-e49b-4b4f-b33b-aef9bd51351f", "name": "Forbidden. The requester is neither the proposer nor a vote cycle admin, or the withdrawal deadline has passed for the requester's role.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a6c2620-3087-4238-9f6e-a678402de895", "name": "Proposal not found.", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f97c39e-753b-4a63-9669-305ba56c85db", "name": "Rate limit exceeded (10 requests per minute per user).", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "comments", "description": "", "item": [ { "id": "537b17be-e5ca-4612-8d5f-b999d17c6cdf", "name": "List top-level comments", "request": { "name": "List top-level comments", "description": { "content": "Returns a paginated list of top-level comments (not replies) for a given proposal. Non-live status filters (withdrawn, withdrawnByAdmin) require vote cycle admin privileges.\n", "type": "text/plain" }, "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "key": "proposal", "value": "3f2eFedDF6c1FFAE011abEaC" }, { "disabled": false, "description": { "content": "Filter by comment status. Non-live statuses require admin privileges.\n (This can only be one of live,withdrawn,withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "withdrawn" }, { "disabled": false, "description": { "content": "Sort field for comments. (This can only be one of date,replycount,likecount)", "type": "text/plain" }, "key": "sort", "value": "date" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by author type. Accepts a comma-separated list of types (e.g. `proposer,admin,drep,user`). A top-level comment is returned when either the comment author matches the filter OR any reply within the same thread is by a matching author — this preserves replies-to-admin / replies-to-proposer visibility in filtered views.\n", "type": "text/plain" }, "key": "userType", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8584117f-33d4-4b63-b8d3-992c3121fa5c", "name": "Paginated list of comments.", "originalRequest": { "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "key": "proposal", "value": "3f2eFedDF6c1FFAE011abEaC" }, { "disabled": false, "description": { "content": "Filter by comment status. Non-live statuses require admin privileges.\n (This can only be one of live,withdrawn,withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "withdrawn" }, { "disabled": false, "description": { "content": "Sort field for comments. (This can only be one of date,replycount,likecount)", "type": "text/plain" }, "key": "sort", "value": "date" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by author type. Accepts a comma-separated list of types (e.g. `proposer,admin,drep,user`). A top-level comment is returned when either the comment author matches the filter OR any reply within the same thread is by a matching author — this preserves replies-to-admin / replies-to-proposer visibility in filtered views.\n", "type": "text/plain" }, "key": "userType", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"_id\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"type\": \"admin\",\n \"name\": \"\"\n },\n \"parentId\": \"\",\n \"userLiked\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Policy violation\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"type\": \"drep\",\n \"name\": \"\"\n },\n \"parentId\": \"\",\n \"userLiked\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Other\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n }\n }\n ],\n \"meta\": {\n \"page\": \"\",\n \"limit\": \"\",\n \"total\": \"\",\n \"totalPages\": \"\",\n \"hasNextPage\": \"\",\n \"hasPreviousPage\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aadfb041-242e-45ee-8dca-7a86041e3ca4", "name": "Invalid request. Possible reasons: missing proposal parameter, invalid query parameters, non-admin attempting to filter by non-live status.", "originalRequest": { "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "key": "proposal", "value": "3f2eFedDF6c1FFAE011abEaC" }, { "disabled": false, "description": { "content": "Filter by comment status. Non-live statuses require admin privileges.\n (This can only be one of live,withdrawn,withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "withdrawn" }, { "disabled": false, "description": { "content": "Sort field for comments. (This can only be one of date,replycount,likecount)", "type": "text/plain" }, "key": "sort", "value": "date" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by author type. Accepts a comma-separated list of types (e.g. `proposer,admin,drep,user`). A top-level comment is returned when either the comment author matches the filter OR any reply within the same thread is by a matching author — this preserves replies-to-admin / replies-to-proposer visibility in filtered views.\n", "type": "text/plain" }, "key": "userType", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fad95ce4-7bef-40b0-8870-8a5cbbb9f790", "name": "Proposal not found.", "originalRequest": { "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Proposal ObjectId (24 hex characters).", "type": "text/plain" }, "key": "proposal", "value": "3f2eFedDF6c1FFAE011abEaC" }, { "disabled": false, "description": { "content": "Filter by comment status. Non-live statuses require admin privileges.\n (This can only be one of live,withdrawn,withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "withdrawn" }, { "disabled": false, "description": { "content": "Sort field for comments. (This can only be one of date,replycount,likecount)", "type": "text/plain" }, "key": "sort", "value": "date" }, { "disabled": false, "description": { "content": "Sort direction. (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by author type. Accepts a comma-separated list of types (e.g. `proposer,admin,drep,user`). A top-level comment is returned when either the comment author matches the filter OR any reply within the same thread is by a matching author — this preserves replies-to-admin / replies-to-proposer visibility in filtered views.\n", "type": "text/plain" }, "key": "userType", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "80b3be64-42e6-4384-bb90-ad1fa1aed4c6", "name": "Create a comment", "request": { "name": "Create a comment", "description": { "content": "Creates a new comment on a live proposal. Comments can only be posted before the vote cycle's feedbackEndDate. Duplicate comments are rejected. To create a reply, include the parentId field.\n\n**Rate limit:** 5 requests per minute and 20 requests per hour per user.\n", "type": "text/plain" }, "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"proposalId\": \"EF03aBFeB7F85fA23427a7Bd\",\n \"content\": \"\",\n \"parentId\": \"E1D9fDEbD7fdc97F2C3aBfEf\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9c93f0bd-8df0-4f85-bcb7-32d5eb99931b", "name": "Comment created successfully.", "originalRequest": { "url": { "path": [ "comments" ], "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: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"proposalId\": \"EF03aBFeB7F85fA23427a7Bd\",\n \"content\": \"\",\n \"parentId\": \"E1D9fDEbD7fdc97F2C3aBfEf\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"type\": \"user\",\n \"name\": \"\"\n },\n \"parentId\": \"\",\n \"userLiked\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Policy violation\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7c919bd-c6a8-4344-9571-2bb2700f40bf", "name": "Invalid request. Possible reasons: missing required fields, content exceeds 2000 characters, proposal is not live, past feedbackEndDate, duplicate comment, replying to a withdrawn comment.", "originalRequest": { "url": { "path": [ "comments" ], "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: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"proposalId\": \"EF03aBFeB7F85fA23427a7Bd\",\n \"content\": \"\",\n \"parentId\": \"E1D9fDEbD7fdc97F2C3aBfEf\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "964df1a5-9d7a-48e6-8328-0f797436d0e4", "name": "Not authenticated.", "originalRequest": { "url": { "path": [ "comments" ], "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: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"proposalId\": \"EF03aBFeB7F85fA23427a7Bd\",\n \"content\": \"\",\n \"parentId\": \"E1D9fDEbD7fdc97F2C3aBfEf\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8232821c-5262-4d90-a101-4f77f4957b1b", "name": "Proposal or parent comment not found.", "originalRequest": { "url": { "path": [ "comments" ], "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: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"proposalId\": \"EF03aBFeB7F85fA23427a7Bd\",\n \"content\": \"\",\n \"parentId\": \"E1D9fDEbD7fdc97F2C3aBfEf\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d488ad6b-97da-45cd-99a8-3759917d4bc9", "name": "Rate limit exceeded (5 per minute or 20 per hour per user).", "originalRequest": { "url": { "path": [ "comments" ], "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: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"proposalId\": \"EF03aBFeB7F85fA23427a7Bd\",\n \"content\": \"\",\n \"parentId\": \"E1D9fDEbD7fdc97F2C3aBfEf\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{commentId}", "description": "", "item": [ { "id": "f88b839e-31b3-40d4-8e8a-9ceb2328adda", "name": "Get a single comment", "request": { "name": "Get a single comment", "description": { "content": "Returns a single comment by its ObjectId, including replyCount, likeCount, and author information. Optional authentication may enhance visibility of certain fields (e.g. userLiked).\n", "type": "text/plain" }, "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId", "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6e52552c-e864-40f9-8e46-409a83f0abf4", "name": "Comment found.", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"type\": \"user\",\n \"name\": \"\"\n },\n \"parentId\": \"\",\n \"userLiked\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Policy violation\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cc80d4c-fbb0-4232-bc0b-a14a72de5136", "name": "Invalid comment ID format.", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6925bb7-9243-4d67-8c72-1bd16a187fe8", "name": "Comment not found.", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83bd8c66-5430-4568-a4db-6d3d3db43c10", "name": "Update a comment", "request": { "name": "Update a comment", "description": { "content": "Updates the content of a comment. Only the original author may edit, and only within 15 minutes of creation.\n\n**Rate limit:** 5 requests per minute and 20 requests per hour per user.\n", "type": "text/plain" }, "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId", "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c33d85ec-78d8-4364-980a-936c03a6d1ee", "name": "Comment updated successfully.", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"type\": \"user\",\n \"name\": \"\"\n },\n \"parentId\": \"\",\n \"userLiked\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Policy violation\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "443c7565-ff71-4e1e-bf38-74396b280d2b", "name": "Invalid request. Possible reasons: content exceeds 2000 characters, edit window (15 minutes) has passed.", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "397572fc-a087-46c4-bb5f-3eb5aac17e2c", "name": "Not authenticated.", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f8016bf-1306-4289-afa0-a581a86f8495", "name": "Forbidden. Only the original author may edit.", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc1f9b7c-78fc-495e-a703-f4210594a69a", "name": "Comment not found.", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6ce58c5-010e-489d-80d1-1043c8d64267", "name": "Rate limit exceeded (5 per minute or 20 per hour per user).", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "replies", "description": "", "item": [ { "id": "69d68911-0111-4614-970d-ccc295260d66", "name": "List replies to a comment", "request": { "name": "List replies to a comment", "description": { "content": "Returns a paginated list of replies to a comment, sorted by createdAt ascending. The parent comment must be live.\n", "type": "text/plain" }, "url": { "path": [ "comments", ":commentId", "replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter replies by status. Non-live statuses require admin. (This can only be one of live,withdrawn,withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "withdrawn" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId", "disabled": false, "description": { "content": "(Required) Parent comment ObjectId (24 hex characters).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "93eddd47-14ff-4f44-9b97-db172c97ae61", "name": "Paginated list of replies.", "originalRequest": { "url": { "path": [ "comments", ":commentId", "replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter replies by status. Non-live statuses require admin. (This can only be one of live,withdrawn,withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "withdrawn" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Parent comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"_id\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"type\": \"admin\",\n \"name\": \"\"\n },\n \"parentId\": \"\",\n \"userLiked\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Policy violation\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"type\": \"drep\",\n \"name\": \"\"\n },\n \"parentId\": \"\",\n \"userLiked\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Other\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n }\n }\n ],\n \"meta\": {\n \"page\": \"\",\n \"limit\": \"\",\n \"total\": \"\",\n \"totalPages\": \"\",\n \"hasNextPage\": \"\",\n \"hasPreviousPage\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b2bdf81-0460-4f44-8469-432bdbcac1a7", "name": "Invalid request or comment ID format.", "originalRequest": { "url": { "path": [ "comments", ":commentId", "replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter replies by status. Non-live statuses require admin. (This can only be one of live,withdrawn,withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "withdrawn" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Parent comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5300275f-99a0-478c-877e-a6adb25e8bb9", "name": "Parent comment not found.", "originalRequest": { "url": { "path": [ "comments", ":commentId", "replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter replies by status. Non-live statuses require admin. (This can only be one of live,withdrawn,withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "withdrawn" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Parent comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "like", "description": "", "item": [ { "id": "520b6045-93fb-4245-8691-506d2db91b61", "name": "Toggle like on a comment", "request": { "name": "Toggle like on a comment", "description": { "content": "Toggles a like on a comment. If the user has not liked the comment, it adds a like (201). If the user has already liked it, the like is removed (200). Only works on live comments belonging to live proposals before the feedbackEndDate.\n\n**Rate limit:** 10 requests per minute per user.\n", "type": "text/plain" }, "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId", "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "794f8d1e-3f63-4475-b489-b1e070cf300c", "name": "Like removed (toggled off).", "originalRequest": { "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\",\n \"liked\": \"\",\n \"likeCount\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a596af0-cdf1-4ae5-8092-07a41bf69445", "name": "Like added (toggled on).", "originalRequest": { "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\",\n \"liked\": \"\",\n \"likeCount\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef9c0022-bd89-4434-9a5a-8a484ca625d3", "name": "Invalid request. Possible reasons: comment is not live, proposal is not live, past feedbackEndDate.", "originalRequest": { "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63acbc2d-e639-4f2d-91cb-0e0a64eff178", "name": "Not authenticated.", "originalRequest": { "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b7829fe-bdcb-4593-b20c-a45a39081433", "name": "Comment not found.", "originalRequest": { "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07b87d06-a2d2-44a0-adce-a4d4d4f71a5d", "name": "Rate limit exceeded (10 requests per minute per user).", "originalRequest": { "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "withdraw", "description": "", "item": [ { "id": "705a1f91-131e-4179-ad52-d0f138a367aa", "name": "Admin withdraw a comment", "request": { "name": "Admin withdraw a comment", "description": { "content": "Withdraws a comment as a vote cycle admin. Sets the status to withdrawnByAdmin. Only live comments on live proposals before the feedbackEndDate can be withdrawn.\n\n**Rate limit:** 10 requests per minute per user.\n", "type": "text/plain" }, "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId", "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "543ca325-d32b-43ef-a93b-ac9eaf04b59a", "name": "Comment withdrawn successfully.", "originalRequest": { "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"type\": \"user\",\n \"name\": \"\"\n },\n \"parentId\": \"\",\n \"userLiked\": \"\",\n \"withdrawalDetails\": {\n \"category\": \"Policy violation\",\n \"userId\": \"\",\n \"date\": \"\",\n \"comment\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "763f12c1-a205-4b11-8e86-c7ee3a82aaaf", "name": "Invalid request. Possible reasons: invalid category, comment is not live, past feedbackEndDate.", "originalRequest": { "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e1a14cc-ce39-4ee9-9f0d-4603adf99630", "name": "Not authenticated.", "originalRequest": { "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2efb142-46ff-4d2f-9c4a-84dee9c38c18", "name": "Forbidden. Only vote cycle admins may withdraw comments.", "originalRequest": { "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd7a24c6-4e43-4bfe-801f-9dad8d44f292", "name": "Comment not found.", "originalRequest": { "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e556280-8547-4ca0-86fc-046ff6656e5c", "name": "Rate limit exceeded (10 requests per minute per user).", "originalRequest": { "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Comment ObjectId (24 hex characters).", "type": "text/plain" }, "type": "any", "value": "3f2eFedDF6c1FFAE011abEaC", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Spam\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": 4511.468474275677,\n \"key_1\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://proposals.example.com" } ], "info": { "_postman_id": "8b840d22-b818-4ab4-a6d9-a09815e745c1", "name": "Ekklesia Proposals API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The Ekklesia Proposals API provides endpoints for decentralized governance proposal management on the Cardano blockchain. It supports session-based authentication via wallet signature verification, vote cycle management, proposal creation and editing, commenting with threaded replies and likes, and country reference data.\n\n\nContact Support:\n Name: Ekklesia API Support", "type": "text/plain" } } }