{ "item": [ { "id": "1437c6fc-6373-4ba1-9924-3dcb83ebf148", "name": "Users", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ad473a28-353c-4242-91f2-2c4148736a53", "name": "Get user public profile", "request": { "name": "Get user public profile", "description": { "content": "Get user public profile with his Octopus ID or his id in your BI", "type": "text/plain" }, "url": { "path": [ "v1", "users", "profile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "octopusId", "value": "string", "description": "Octopus User ID" }, { "disabled": false, "key": "loginId", "value": "string", "description": "User ID in your BI" }, { "disabled": false, "key": "retrieveLatestPosts", "value": "true", "description": "Retrieve 5 user's latest posts if true. Default false." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "47ce1847-f723-446f-8319-287f3c953e37", "name": "Profile found", "originalRequest": { "url": { "path": [ "v1", "users", "profile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "octopusId", "value": "string" }, { "key": "loginId", "value": "string" }, { "key": "retrieveLatestPosts", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"firstPostsPage\": [\n {\n \"content\": {\n \"text\": \"string\",\n \"bridgeToAppObject\": null,\n \"button\": null,\n \"imageUrls\": null,\n \"originalLanguage\": null,\n \"poll\": null,\n \"videoUrl\": null\n },\n \"createdAt\": 9487,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 1059,\n \"createdBy\": null,\n \"metrics\": null\n },\n {\n \"content\": {\n \"text\": \"string\",\n \"bridgeToAppObject\": null,\n \"button\": null,\n \"imageUrls\": null,\n \"originalLanguage\": null,\n \"poll\": null,\n \"videoUrl\": null\n },\n \"createdAt\": 6866,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 6036,\n \"createdBy\": null,\n \"metrics\": null\n }\n ],\n \"profile\": {\n \"id\": \"string\",\n \"isAdmin\": false,\n \"nickname\": \"string\",\n \"accountAgeInDays\": null,\n \"avatarUrl\": null,\n \"bio\": null,\n \"gameLevel\": null,\n \"totalMessages\": null\n },\n \"cursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b51fe84-f5e5-4fe7-8c4d-a21f58aaecb8", "name": "Invalid parameter", "originalRequest": { "url": { "path": [ "v1", "users", "profile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "octopusId", "value": "string" }, { "key": "loginId", "value": "string" }, { "key": "retrieveLatestPosts", "value": "true" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "82740254-748c-41c7-a973-760d121a3b52", "name": "Feeds", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "85c5bb7c-a7e3-46d7-88b3-bedfeca01297", "name": "Get page of posts feed", "request": { "name": "Get page of posts feed", "description": { "content": "Get page of posts feed inside a specific topic. Provide topicId for first page", "type": "text/plain" }, "url": { "path": [ "v1", "feeds", "posts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "topicId", "value": "string", "description": "(Required) Topic id for first page" }, { "disabled": false, "key": "pageSize", "value": "string", "description": "Number of posts by page. Default 5, min 1 and max 20" }, { "disabled": false, "key": "order", "value": "string", "description": "Created date sort. Asc or Desc. Default Desc. Ignored if you provide a cursor" }, { "disabled": false, "key": "pageCursor", "value": "string", "description": "Keep it empty for first page or put cursor for next page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d0a0cab7-2c59-4caf-b175-847531f85c69", "name": "List of posts items", "originalRequest": { "url": { "path": [ "v1", "feeds", "posts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "topicId", "value": "string" }, { "key": "pageSize", "value": "string" }, { "key": "order", "value": "string" }, { "key": "pageCursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"posts\": [\n {\n \"content\": {\n \"text\": \"string\",\n \"bridgeToAppObject\": null,\n \"button\": null,\n \"imageUrls\": null,\n \"originalLanguage\": null,\n \"poll\": null,\n \"videoUrl\": null\n },\n \"createdAt\": 2808,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 6869,\n \"createdBy\": null,\n \"metrics\": null\n },\n {\n \"content\": {\n \"text\": \"string\",\n \"bridgeToAppObject\": null,\n \"button\": null,\n \"imageUrls\": null,\n \"originalLanguage\": null,\n \"poll\": null,\n \"videoUrl\": null\n },\n \"createdAt\": 3581,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 2873,\n \"createdBy\": null,\n \"metrics\": null\n }\n ],\n \"pageCursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f920429d-248e-4d2b-bfbd-affe9ce5a740", "name": "Invalid parameter", "originalRequest": { "url": { "path": [ "v1", "feeds", "posts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "topicId", "value": "string" }, { "key": "pageSize", "value": "string" }, { "key": "order", "value": "string" }, { "key": "pageCursor", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "817cd2cc-8b54-4fa7-b5a4-593909cd5528", "name": "Get page of comments feed", "request": { "name": "Get page of comments feed", "description": { "content": "Get page of comments feed inside a post. Provide postId for first page", "type": "text/plain" }, "url": { "path": [ "v1", "feeds", "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "postId", "value": "string", "description": "(Required) Post id for first page" }, { "disabled": false, "key": "pageSize", "value": "string", "description": "Number of comments by page. Default 5, min 1 and max 20" }, { "disabled": false, "key": "order", "value": "string", "description": "Created date sort. Asc or Desc. Default Desc. Ignored if you provide a cursor" }, { "disabled": false, "key": "pageCursor", "value": "string", "description": "Keep it empty for first page or put cursor for next page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "15294843-3bfd-4369-bd78-eb613abc6cf9", "name": "List of comments items", "originalRequest": { "url": { "path": [ "v1", "feeds", "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "postId", "value": "string" }, { "key": "pageSize", "value": "string" }, { "key": "order", "value": "string" }, { "key": "pageCursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"comments\": [\n {\n \"content\": {\n \"text\": \"string\",\n \"imageUrls\": null,\n \"originalLanguage\": null\n },\n \"createdAt\": 7971,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 5852,\n \"createdBy\": null,\n \"metrics\": null\n },\n {\n \"content\": {\n \"text\": \"string\",\n \"imageUrls\": null,\n \"originalLanguage\": null\n },\n \"createdAt\": 1738,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 9193,\n \"createdBy\": null,\n \"metrics\": null\n }\n ],\n \"pageCursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78888478-b7be-4a04-9c54-eb3e890ab37d", "name": "Invalid parameter", "originalRequest": { "url": { "path": [ "v1", "feeds", "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "postId", "value": "string" }, { "key": "pageSize", "value": "string" }, { "key": "order", "value": "string" }, { "key": "pageCursor", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df81bb8b-039d-4f0b-b3b0-f630e3ec0faf", "name": "Get page of replies feed", "request": { "name": "Get page of replies feed", "description": { "content": "Get page of replies feed inside a comment. Provide commentId for first page", "type": "text/plain" }, "url": { "path": [ "v1", "feeds", "replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "commentId", "value": "string", "description": "(Required) Comment id for first page" }, { "disabled": false, "key": "pageSize", "value": "string", "description": "Number of replies by page. Default 5, min 1 and max 20" }, { "disabled": false, "key": "order", "value": "string", "description": "Created date sort. Asc or Desc. Default Desc. Ignored if you provide a cursor" }, { "disabled": false, "key": "pageCursor", "value": "string", "description": "Keep it empty for first page or put cursor for next page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c00d0ebc-11db-4847-82e9-e34a6a1db29d", "name": "List of replies items", "originalRequest": { "url": { "path": [ "v1", "feeds", "replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "commentId", "value": "string" }, { "key": "pageSize", "value": "string" }, { "key": "order", "value": "string" }, { "key": "pageCursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"replies\": [\n {\n \"content\": {\n \"text\": \"string\",\n \"imageUrls\": null,\n \"originalLanguage\": null\n },\n \"createdAt\": 4668,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 1811,\n \"createdBy\": null,\n \"metrics\": null\n },\n {\n \"content\": {\n \"text\": \"string\",\n \"imageUrls\": null,\n \"originalLanguage\": null\n },\n \"createdAt\": 4866,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 5662,\n \"createdBy\": null,\n \"metrics\": null\n }\n ],\n \"pageCursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b338a348-6e7e-4d1b-9da4-d773c9c7b953", "name": "Invalid parameter", "originalRequest": { "url": { "path": [ "v1", "feeds", "replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "commentId", "value": "string" }, { "key": "pageSize", "value": "string" }, { "key": "order", "value": "string" }, { "key": "pageCursor", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb8eb1fc-a279-4e70-8e63-b97a6a4db161", "name": "Get page of user's posts feed", "request": { "name": "Get page of user's posts feed", "description": { "content": "Get page of user's posts feed. Provide feedId for first page", "type": "text/plain" }, "url": { "path": [ "v1", "feeds", "user", ":octopusId", "posts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "pageSize", "value": "string", "description": "Number of posts by page. Default 5, min 1 and max 20" }, { "disabled": false, "key": "order", "value": "string", "description": "Created date sort. Asc or Desc. Default Desc. Ignored if you provide a cursor" }, { "disabled": false, "key": "pageCursor", "value": "string", "description": "Keep it empty for first page or put cursor for next page" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "octopusId", "description": "(Required) Octopus User ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3e686563-7e48-46c2-bcc4-4bb6ce71118d", "name": "List of post items", "originalRequest": { "url": { "path": [ "v1", "feeds", "user", ":octopusId", "posts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "pageSize", "value": "string" }, { "key": "order", "value": "string" }, { "key": "pageCursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "octopusId", "description": "(Required) Octopus User ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"posts\": [\n {\n \"content\": {\n \"text\": \"string\",\n \"bridgeToAppObject\": null,\n \"button\": null,\n \"imageUrls\": null,\n \"originalLanguage\": null,\n \"poll\": null,\n \"videoUrl\": null\n },\n \"createdAt\": 2808,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 6869,\n \"createdBy\": null,\n \"metrics\": null\n },\n {\n \"content\": {\n \"text\": \"string\",\n \"bridgeToAppObject\": null,\n \"button\": null,\n \"imageUrls\": null,\n \"originalLanguage\": null,\n \"poll\": null,\n \"videoUrl\": null\n },\n \"createdAt\": 3581,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 2873,\n \"createdBy\": null,\n \"metrics\": null\n }\n ],\n \"pageCursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebf292d6-6975-4bbb-8fa4-29cd539cef09", "name": "Invalid parameter", "originalRequest": { "url": { "path": [ "v1", "feeds", "user", ":octopusId", "posts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "pageSize", "value": "string" }, { "key": "order", "value": "string" }, { "key": "pageCursor", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "octopusId", "description": "(Required) Octopus User ID" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "939ce7da-7c50-495e-93d9-43b30ce0c47f", "name": "Get latest posts", "request": { "name": "Get latest posts", "description": { "content": "Get page of posts sorted by creation date", "type": "text/plain" }, "url": { "path": [ "v1", "feeds", "posts", "all" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "originTime", "value": "2313", "description": "To start from a specific timestamp Ms. Ignored if you provide a cursor" }, { "disabled": false, "key": "order", "value": "string", "description": "Order to sort by created date. Can be 'Asc' or 'Desc'. If you provide a originTime, 'Asc' will retrieve all posts that are more recent than this date, and Desc will return all posts that have been created before the date. Default Desc. Ignored if you provide a cursor" }, { "disabled": false, "key": "direction", "value": "string", "description": "Direction of the item according to origin date provided. Can be 'After' or 'Before'. If you provide a originTime, 'After' will retrieve all posts that are more recent than this date, and 'Before' will return all posts that have been created before the date. Default 'Before'. Ignored if you provide a cursor" }, { "disabled": false, "key": "pageSize", "value": "string", "description": "Number of posts by page. Default 5, min 1 and max 20" }, { "disabled": false, "key": "pageCursor", "value": "string", "description": "Cursor to retrieve next page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3d3794e9-fae1-4acb-a92b-ead31d9b8bb3", "name": "List of posts items", "originalRequest": { "url": { "path": [ "v1", "feeds", "posts", "all" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "originTime", "value": "2313" }, { "key": "order", "value": "string" }, { "key": "direction", "value": "string" }, { "key": "pageSize", "value": "string" }, { "key": "pageCursor", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"posts\": [\n {\n \"content\": {\n \"text\": \"string\",\n \"bridgeToAppObject\": null,\n \"button\": null,\n \"imageUrls\": null,\n \"originalLanguage\": null,\n \"poll\": null,\n \"videoUrl\": null\n },\n \"createdAt\": 2808,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 6869,\n \"createdBy\": null,\n \"metrics\": null\n },\n {\n \"content\": {\n \"text\": \"string\",\n \"bridgeToAppObject\": null,\n \"button\": null,\n \"imageUrls\": null,\n \"originalLanguage\": null,\n \"poll\": null,\n \"videoUrl\": null\n },\n \"createdAt\": 3581,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 2873,\n \"createdBy\": null,\n \"metrics\": null\n }\n ],\n \"pageCursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a278fec-b0bd-48c1-bfdb-6683857b7a0b", "name": "Invalid parameter", "originalRequest": { "url": { "path": [ "v1", "feeds", "posts", "all" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "originTime", "value": "2313" }, { "key": "order", "value": "string" }, { "key": "direction", "value": "string" }, { "key": "pageSize", "value": "string" }, { "key": "pageCursor", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fad21a5c-e618-4287-b9f3-c44c9dd9c39c", "name": "Messages", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2a61eca4-7ed9-4d66-a45b-7aa6a2e89265", "name": "Get topics", "request": { "name": "Get topics", "description": { "content": "Get topics", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "topics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0bd93058-bbed-44b6-90e6-d45a2ef8fbdb", "name": "Topics found", "originalRequest": { "url": { "path": [ "v1", "messages", "topics" ], "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 {\n \"createdAt\": 8476,\n \"id\": \"string\",\n \"content\": null\n },\n {\n \"createdAt\": 8320,\n \"id\": \"string\",\n \"content\": null\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df05b338-6984-48b7-8e4b-31def7eba795", "name": "Get post details", "request": { "name": "Get post details", "description": { "content": "Get post details", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "post" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "postId", "value": "string", "description": "Octopus Post Id" }, { "disabled": false, "key": "clientObjectId", "value": "string", "description": "Your client object id related to a bridge post (the same id passed to the SDK when creating the bridge post)" }, { "disabled": false, "key": "retrieveLatestComments", "value": "false", "description": "Retrieve 5 latest comments if true. Default false." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "41536063-94b5-46f1-8bd0-286d4b9c7f83", "name": "Post found", "originalRequest": { "url": { "path": [ "v1", "messages", "post" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "postId", "value": "string" }, { "key": "clientObjectId", "value": "string" }, { "key": "retrieveLatestComments", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"firstCommentsPage\": [\n {\n \"content\": {\n \"text\": \"string\",\n \"imageUrls\": null,\n \"originalLanguage\": null\n },\n \"createdAt\": 5890,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 6538,\n \"createdBy\": null,\n \"metrics\": null\n },\n {\n \"content\": {\n \"text\": \"string\",\n \"imageUrls\": null,\n \"originalLanguage\": null\n },\n \"createdAt\": 4027,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 7255,\n \"createdBy\": null,\n \"metrics\": null\n }\n ],\n \"post\": {\n \"content\": {\n \"text\": \"string\",\n \"bridgeToAppObject\": null,\n \"button\": null,\n \"imageUrls\": null,\n \"originalLanguage\": null,\n \"poll\": null,\n \"videoUrl\": null\n },\n \"createdAt\": 255,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 8830,\n \"createdBy\": null,\n \"metrics\": null\n },\n \"cursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4b04af4-eea0-480d-b1b7-44a189a4818c", "name": "Invalid post id", "originalRequest": { "url": { "path": [ "v1", "messages", "post" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "postId", "value": "string" }, { "key": "clientObjectId", "value": "string" }, { "key": "retrieveLatestComments", "value": "true" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "190acce4-0195-46f2-bb88-bb1c46e9a190", "name": "Post not found", "originalRequest": { "url": { "path": [ "v1", "messages", "post" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "postId", "value": "string" }, { "key": "clientObjectId", "value": "string" }, { "key": "retrieveLatestComments", "value": "true" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8240e12d-7f21-418f-993d-9dded445640f", "name": "Get comment details", "request": { "name": "Get comment details", "description": { "content": "Get comment details", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "comment", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "retrieveLatestReplies", "value": "true", "description": "= Retrieve 5 latest replies if true. Default false." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commentId", "description": "(Required) Octopus Comment Id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5f5b40ef-f323-4aeb-9a58-5cf136906b33", "name": "Comment found", "originalRequest": { "url": { "path": [ "v1", "messages", "comment", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "retrieveLatestReplies", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commentId", "description": "(Required) Octopus Comment Id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"comment\": {\n \"content\": {\n \"text\": \"string\",\n \"imageUrls\": null,\n \"originalLanguage\": null\n },\n \"createdAt\": 5205,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 3830,\n \"createdBy\": null,\n \"metrics\": null\n },\n \"firstRepliesPage\": [\n {\n \"content\": {\n \"text\": \"string\",\n \"imageUrls\": null,\n \"originalLanguage\": null\n },\n \"createdAt\": 9713,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 3229,\n \"createdBy\": null,\n \"metrics\": null\n },\n {\n \"content\": {\n \"text\": \"string\",\n \"imageUrls\": null,\n \"originalLanguage\": null\n },\n \"createdAt\": 8665,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 4531,\n \"createdBy\": null,\n \"metrics\": null\n }\n ],\n \"cursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "766f6610-cf36-43bc-84c8-337be0583747", "name": "Invalid comment id", "originalRequest": { "url": { "path": [ "v1", "messages", "comment", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "retrieveLatestReplies", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commentId", "description": "(Required) Octopus Comment Id" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7222039b-ce8b-4517-8b23-84354760b885", "name": "Comment not found", "originalRequest": { "url": { "path": [ "v1", "messages", "comment", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "retrieveLatestReplies", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "commentId", "description": "(Required) Octopus Comment Id" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2393efdf-5c7a-4cd1-9db3-9f6c65569a44", "name": "Get reply details", "request": { "name": "Get reply details", "description": { "content": "Get reply details", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "reply", ":replyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "replyId", "description": "(Required) Octopus Reply Id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1f473f14-873c-4648-a20e-f4e39643d971", "name": "Reply found", "originalRequest": { "url": { "path": [ "v1", "messages", "reply", ":replyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "replyId", "description": "(Required) Octopus Reply Id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": {\n \"text\": \"string\",\n \"imageUrls\": null,\n \"originalLanguage\": null\n },\n \"createdAt\": 8095,\n \"id\": \"string\",\n \"parentId\": \"string\",\n \"updatedAt\": 6990,\n \"createdBy\": null,\n \"metrics\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b43e8a8-fa98-4965-9d38-1b861136076b", "name": "Invalid replyId", "originalRequest": { "url": { "path": [ "v1", "messages", "reply", ":replyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "replyId", "description": "(Required) Octopus Reply Id" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "41b4e2c3-543f-4d76-991d-41268093cc82", "name": "Reply not found", "originalRequest": { "url": { "path": [ "v1", "messages", "reply", ":replyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "replyId", "description": "(Required) Octopus Reply Id" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f01b00a-2e42-4971-9bb0-faf1c90d8b18", "name": "Get all translations of a message", "request": { "name": "Get all translations of a message", "description": { "content": "Get all translations of a message", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "translations", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "itemId", "description": "(Required) Can be id of topic, post, comment, reply" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8ccd375e-255c-4e03-91c7-dd950a99d48b", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "messages", "translations", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "itemId", "description": "(Required) Can be id of topic, post, comment, reply" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"originalLanguageCode\": \"string\",\n \"translations\": [\n {\n \"text\": {\n \"originalText\": \"string\",\n \"translatedText\": \"string\"\n },\n \"translationLanguageCode\": \"string\",\n \"catchPhrase\": null,\n \"ctaButton\": null,\n \"pollAnswers\": null\n },\n {\n \"text\": {\n \"originalText\": \"string\",\n \"translatedText\": \"string\"\n },\n \"translationLanguageCode\": \"string\",\n \"catchPhrase\": null,\n \"ctaButton\": null,\n \"pollAnswers\": null\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e34e0b69-9033-439a-acc1-14871184b05f", "name": "Invalid itemId", "originalRequest": { "url": { "path": [ "v1", "messages", "translations", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "itemId", "description": "(Required) Can be id of topic, post, comment, reply" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "db71a8dd-685d-4ebf-aa14-10203e09dc0f", "name": "Item not found", "originalRequest": { "url": { "path": [ "v1", "messages", "translations", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "itemId", "description": "(Required) Can be id of topic, post, comment, reply" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://connect.octopuscommunity.com", "type": "string" }, { "key": "API_KEY", "value": "", "type": "string", "description": "Your Octopus Connect API Key (obtain from Octopus team)" } ], "info": { "_postman_id": "d450e628-be97-4843-a64a-e93e4e7dc933", "name": "Octopus Community Connect API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "The Octopus REST API allows you to programmatically get information about your community. This is a read-only API.\n\nAuthentication: Pass your Connect API secret key using the `Authorization: Bearer ` header.\n\nBase URL: https://connect.octopuscommunity.com" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{API_KEY}}", "type": "string" } ] } }