{"info":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"10901144","collectionId":"eb48b80e-2608-4bf5-9779-12c421c47e79","publishedId":"2s9YymHQm2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-03T16:49:28.000Z"},"item":[{"name":"Tickets","item":[{"name":"Create a Ticket","id":"f9b03fc1-b9a8-4ac7-b3ad-6d0e84a7c8c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Ticket Title\", //REQUIRED\r\n \"message\": \"Ticket Message\", //OPTIONAL\r\n \"priority\": 3, //OPTIONAL- DEFAULTS TO 3 IF NOT SET (1-5)\r\n \"due\": \"2024-01-24 17:00:00\", //OPTIONAL- USE STRING FORMAT WITHOUT A TIMEZONE \r\n \"tasks\": [ //ONLY NEEDED IF YOU ARE SENDING TASK REALTED FIELDS WHICH ARE OPTIONAL\r\n {\r\n \"asset_or_location\": \"ELEMENT _ID\", //OPTIONAL\r\n \"participants\": [\r\n {\r\n \"member_id\": \"MEMBER _ID\" //OPTIONAL\r\n }\r\n ],\r\n \"checklist\": \"CHECKLIST _ID\", //OPTIONAL\r\n \"workflow_order\": 0\r\n }\r\n ],\r\n \"workflows\": [ //ONLY NEEDED IF YOU ARE SENDING TASK REALTED FIELDS\r\n {\r\n \"starts_at\": \"2024-01-22 08:00:00\", //OPTIONAL- USE STRING FORMAT WITHOUT A TIMEZONE \r\n \"anyone_or_everyone\": \"anyone\"\r\n }\r\n],\r\n \"state\": \"ACTIVE\",\r\n \"ticket_type_id\": \"TICKET_TYPE _ID\", //OPTIONAL- WILL USE ORG DEFAULT TICKET TYPE\r\n \"owner_id\": \"MEMBER _ID\", //OPTIONAL- DEFAULTS TO CREATOR _ID IF BLANK \r\n \"organization_id\": \"REQUIRED\" //REQUIRED FIELD\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/tickets/v1/issues/?organization_id=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["tickets","v1","issues",""],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Requiered field

\n","type":"text/plain"},"key":"organization_id","value":""}],"variable":[]}},"response":[],"_postman_id":"f9b03fc1-b9a8-4ac7-b3ad-6d0e84a7c8c3"},{"name":"Get All Tickets","id":"1432112a-1a5f-4b1c-a47b-752a0adeedef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.chekhub.com/tickets/v1/issues/?organization_id=&show_fields=title,status,state,priority,owner,start_datetime,due_datetime,number,ticket_number,overdue,created_at,created_by,modified_at","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["tickets","v1","issues",""],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required field

\n","type":"text/plain"},"key":"organization_id","value":""},{"description":{"content":"

Returns these fields for all tickets in the orgenization

\n","type":"text/plain"},"key":"show_fields","value":"title,status,state,priority,owner,start_datetime,due_datetime,number,ticket_number,overdue,created_at,created_by,modified_at"}],"variable":[]}},"response":[],"_postman_id":"1432112a-1a5f-4b1c-a47b-752a0adeedef"},{"name":"Get Individual Ticket","id":"f30bf622-65dc-4c17-9f7c-53fd429c0ed7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.chekhub.com/tickets/v1/issues/:ticket_id?organization_id=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["tickets","v1","issues",":ticket_id"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required field

\n","type":"text/plain"},"key":"organization_id","value":""}],"variable":[{"description":{"content":"

Required to get all ticket information on an individal ticket. The _id can be found from the Get All Tickets call. You can also find the _id in the url of the web application when you select a ticket.

\n","type":"text/plain"},"type":"any","value":"","key":"ticket_id"}]}},"response":[],"_postman_id":"f30bf622-65dc-4c17-9f7c-53fd429c0ed7"},{"name":"Create Comment","id":"bb6bc620-c1b1-405d-be34-da8892957421","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"Authorization","value":"{{vault:bearer-token}}"},{"key":"Cache-Control","value":"no-cache"},{"key":"Referer","value":"https://test.app.chekhub.com/dashboard?dialog=edit&ticket=6823ac0d6cd526b27801601c&type=issue"},{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"135\", \"Not-A.Brand\";v=\"8\", \"Chromium\";v=\"135\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"crossDomain","value":"true"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36"},{"key":"Accept","value":"application/json, text/plain, */*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": \"My Comment Message\",\n \"resource_type\": \"ticket\",\n \"resource_id\": \"{{ticket_id}}\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"name\": \"Kyler Besher\",\n \"resource_type\": \"member\"\n }\n ],\n \"organization_id\": \"{{organization_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/comments/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","comments",""],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb6bc620-c1b1-405d-be34-da8892957421"},{"name":"Add Attachment from Upload","id":"384f3274-880f-4bf5-ae3e-1cd35c94348e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"Authorization","value":"{{vault:bearer-token}}"},{"key":"Cache-Control","value":"no-cache"},{"key":"Referer","value":"https://test.app.chekhub.com/dashboard?dialog=edit&ticket=68236819262b3465ea37d210&type=issue"},{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"135\", \"Not-A.Brand\";v=\"8\", \"Chromium\";v=\"135\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"crossDomain","value":"true"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36"},{"key":"Accept","value":"application/json, text/plain, */*"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"diego-ph-fIq0tET6llw-unsplash.jpg"}]},"url":"https://api.chekhub.com/tickets/v1/issues/:ticket_id/attachments","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["tickets","v1","issues",":ticket_id","attachments"],"host":["api","chekhub","com"],"query":[],"variable":[{"type":"any","value":"","key":"ticket_id"}]}},"response":[],"_postman_id":"384f3274-880f-4bf5-ae3e-1cd35c94348e"},{"name":"Add Attachment from library","id":"a88c581d-9917-456d-aa1b-7b3954e569ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"Authorization","value":"{{vault:bearer-token}}"},{"key":"Cache-Control","value":"no-cache"},{"key":"Referer","value":"https://test.app.chekhub.com/dashboard?dialog=edit&ticket=68236819262b3465ea37d210&type=issue"},{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"135\", \"Not-A.Brand\";v=\"8\", \"Chromium\";v=\"135\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"crossDomain","value":"true"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36"},{"key":"Accept","value":"application/json, text/plain, */*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"resource_id\": \"{{ticket_id}}\",\n \"resource_type\": \"ticket\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/documents/v1/files/:file_id/attach_to","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["documents","v1","files",":file_id","attach_to"],"host":["api","chekhub","com"],"query":[],"variable":[{"type":"any","value":"","key":"file_id"}]}},"response":[],"_postman_id":"a88c581d-9917-456d-aa1b-7b3954e569ee"}],"id":"e8678ed3-8434-4eff-8703-a9c14c791e68","_postman_id":"e8678ed3-8434-4eff-8703-a9c14c791e68","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}}},{"name":"Ticket Templates","item":[{"name":"Get All Ticket Templates","id":"4349850f-7f2b-41c6-8099-ea59a69b97ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.chekhub.com/v3/ticket_templates/?organization_id=&show_fields=title,status,state,priority,owner,start_datetime,due_datetime,number,ticket_number,overdue,created_at,created_by,modified_at","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","ticket_templates",""],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required field

\n","type":"text/plain"},"key":"organization_id","value":""},{"description":{"content":"

Returns these fields for all tickets in the orgenization

\n","type":"text/plain"},"key":"show_fields","value":"title,status,state,priority,owner,start_datetime,due_datetime,number,ticket_number,overdue,created_at,created_by,modified_at"},{"disabled":true,"key":"show_all","value":"true"}],"variable":[]}},"response":[],"_postman_id":"4349850f-7f2b-41c6-8099-ea59a69b97ad"},{"name":"Get Individual Ticket Template","id":"4ff50df1-ef92-44bb-b0d3-c2052326f566","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.chekhub.com/v3/ticket_templates/:templateId?organization_id={{organization_id}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","ticket_templates",":templateId"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required field

\n","type":"text/plain"},"key":"organization_id","value":"{{organization_id}}"}],"variable":[{"type":"any","value":"","key":"templateId"}]}},"response":[],"_postman_id":"4ff50df1-ef92-44bb-b0d3-c2052326f566"}],"id":"a53ffe8d-a77b-4f87-a3b6-3775c569b635","_postman_id":"a53ffe8d-a77b-4f87-a3b6-3775c569b635","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}}},{"name":"Elements","item":[{"name":"{element_id}","item":[{"name":"Update Element","id":"7460bf25-0982-48ec-a50f-e13ef90204cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"\",\n \"template_id\": \"\",\n \"name\": \"\",\n \"resource_type\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"skills\": [\n \"\",\n \"\"\n ],\n \"properties\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"immutable\": \"\",\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"immutable\": \"\",\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"parameters\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"level\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"state\": \"\",\n \"pm_rule_ids\": [\n \"\",\n \"\"\n ],\n \"watchers\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/elements/v1/elements/:elementId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["elements","v1","elements",":elementId"],"host":["api","chekhub","com"],"query":[],"variable":[{"type":"any","value":"","key":"elementId"}]}},"response":[],"_postman_id":"7460bf25-0982-48ec-a50f-e13ef90204cf"}],"id":"233544b6-1e61-4ca5-a144-e1e35fd95b89","_postman_id":"233544b6-1e61-4ca5-a144-e1e35fd95b89","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}}},{"name":"List Elements","id":"f9d0dce7-cd6c-4734-9e8c-79c35978cba0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.chekhub.com/elements/v1/elements?organization_id=&path_ids=&resource_types=&show_fields=&states=ACTIVE&level=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["elements","v1","elements"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

(Required) The unique identifier of the organization

\n","type":"text/plain"},"key":"organization_id","value":""},{"description":{"content":"

Filter items with these path IDs. For example if you wanted all assets at a particular site you would enter the site id here

\n","type":"text/plain"},"key":"path_ids","value":""},{"description":{"content":"

\"aaset\" or \"location\"

\n","type":"text/plain"},"key":"resource_types","value":""},{"description":{"content":"

address,attachments,created_at,created_by,connections,description,is_site,level,location,latitude,longitude,geojson,media,modified_at,modified_by,name,organization,parent,path,parameters,pm_rules,properties,resource_type,rounds,sites,skills,state,status,tags,template,upstream,downstream,template_attachments,template_properties,timezone,watchers

\n","type":"text/plain"},"key":"show_fields","value":""},{"description":{"content":"

Filter items by these states

\n","type":"text/plain"},"key":"states","value":"ACTIVE"},{"description":{"content":"

Use this to return the \"sites\" only. Default site is level \"3\"

\n","type":"text/plain"},"key":"level","value":""}],"variable":[]}},"response":[],"_postman_id":"f9d0dce7-cd6c-4734-9e8c-79c35978cba0"},{"name":"Get Element By ID","id":"ccfbac65-5017-4da8-af20-db3fc5f83cbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.chekhub.com/elements/v1/elements/:element_id?organization_id=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["elements","v1","elements",":element_id"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

id of the organization

\n","type":"text/plain"},"key":"organization_id","value":""}],"variable":[{"description":{"content":"

id of the target element

\n","type":"text/plain"},"type":"any","value":"","key":"element_id"}]}},"response":[],"_postman_id":"ccfbac65-5017-4da8-af20-db3fc5f83cbe"},{"name":"Create Element","id":"88c83fcc-bcaf-45ac-89ea-13c154c2f314","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{vault:bearer-token}}w"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"\",\n \"template_id\": \"\",\n \"name\": \"\",\n \"resource_type\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"skills\": [\n \"\",\n \"\"\n ],\n \"properties\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"immutable\": \"\",\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"immutable\": \"\",\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"parameters\": [\n {\n \"type\": \"text\",\n \"order\": 0,\n \"immutable\": false,\n \"_id\": \"641cb16d6f4076d9210c9253\",\n \"name\": \"Asset Tag\",\n \"choices\": [],\n \"required\": false,\n \"value\": \"\"\n },\n {\n \"type\": \"text\",\n \"order\": 1,\n \"immutable\": false,\n \"_id\": \"641cb16f6f4076d9210c9254\",\n \"name\": \"Make\",\n \"choices\": [],\n \"required\": false,\n \"value\": \"\"\n },\n {\n \"type\": \"text\",\n \"order\": 2,\n \"immutable\": false,\n \"_id\": \"641cb1826f4076d9210c9255\",\n \"name\": \"Model\",\n \"choices\": [],\n \"required\": false,\n \"value\": \"\"\n },\n {\n \"type\": \"text\",\n \"order\": 3,\n \"immutable\": false,\n \"_id\": \"641cb18c6f4076d9210c925b\",\n \"name\": \"Serial Number\",\n \"choices\": [],\n \"required\": false,\n \"value\": \"\"\n },\n {\n \"type\": \"text\",\n \"order\": 4,\n \"immutable\": false,\n \"_id\": \"641cb1846f4076d9210c9256\",\n \"name\": \"Manufacturer\",\n \"choices\": [],\n \"required\": false,\n \"value\": \"\"\n },\n {\n \"type\": \"text\",\n \"order\": 5,\n \"immutable\": false,\n \"_id\": \"641cb18d6f4076d9210c925c\",\n \"name\": \"Hostname\",\n \"choices\": [],\n \"required\": false,\n \"value\": \"\"\n },\n {\n \"type\": \"text\",\n \"order\": 6,\n \"immutable\": false,\n \"_id\": \"641cb1906f4076d9210c925e\",\n \"name\": \"Size\",\n \"choices\": [],\n \"required\": false,\n \"value\": \"\"\n },\n {\n \"type\": \"text\",\n \"order\": 7,\n \"immutable\": false,\n \"_id\": \"641cb1936f4076d9210c925f\",\n \"name\": \"Capacity\",\n \"choices\": [],\n \"required\": false,\n \"value\": \"\"\n },\n {\n \"type\": \"date\",\n \"order\": 8,\n \"immutable\": false,\n \"_id\": \"641cb1896f4076d9210c9259\",\n \"name\": \"In Service Date\",\n \"choices\": [],\n \"required\": false,\n \"value\": \"\"\n },\n {\n \"type\": \"date\",\n \"order\": 9,\n \"immutable\": false,\n \"_id\": \"641cb18b6f4076d9210c925a\",\n \"name\": \"End of Life Date\",\n \"choices\": [],\n \"required\": false,\n \"value\": \"\"\n },\n {\n \"type\": \"text\",\n \"order\": 10,\n \"immutable\": false,\n \"_id\": \"641cb1866f4076d9210c9257\",\n \"name\": \"Purchase Price\",\n \"choices\": [],\n \"required\": false,\n \"value\": \"\"\n },\n {\n \"type\": \"single-choice\",\n \"order\": 11,\n \"immutable\": false,\n \"_id\": \"641cb1886f4076d9210c9258\",\n \"name\": \"Purchase Price Currency\",\n \"choices\": [\n \"USD\",\n \"AED\",\n \"AFN\",\n \"ALL\",\n \"AMD\",\n \"ANG\",\n \"AOA\",\n \"ARS\",\n \"AUD\",\n \"AWG\",\n \"AZN\",\n \"BAM\",\n \"BBD\",\n \"BDT\",\n \"BGN\",\n \"BIF\",\n \"BMD\",\n \"BND\",\n \"BOB\",\n \"BRL\",\n \"BSD\",\n \"BWP\",\n \"BYN\",\n \"BZD\",\n \"CAD\",\n \"CDF\",\n \"CHF\",\n \"CLP\",\n \"CNY\",\n \"COP\",\n \"CRC\",\n \"CVE\",\n \"CZK\",\n \"DJF\",\n \"DKK\",\n \"DOP\",\n \"DZD\",\n \"EGP\",\n \"ETB\",\n \"EUR\",\n \"FJD\",\n \"FKP\",\n \"GBP\",\n \"GEL\",\n \"GIP\",\n \"GMD\",\n \"GNF\",\n \"GTQ\",\n \"GYD\",\n \"HKD\",\n \"HNL\",\n \"HTG\",\n \"HUF\",\n \"IDR\",\n \"ILS\",\n \"INR\",\n \"ISK\",\n \"JMD\",\n \"JPY\",\n \"KES\",\n \"KGS\",\n \"KHR\",\n \"KMF\",\n \"KRW\",\n \"KYD\",\n \"KZT\",\n \"LAK\",\n \"LBP\",\n \"LKR\",\n \"LRD\",\n \"LSL\",\n \"MAD\",\n \"MDL\",\n \"MGA\",\n \"MKD\",\n \"MMK\",\n \"MNT\",\n \"MOP\",\n \"MRO\",\n \"MUR\",\n \"MVR\",\n \"MWK\",\n \"MXN\",\n \"MYR\",\n \"MZN\",\n \"NAD\",\n \"NGN\",\n \"NIO\",\n \"NOK\",\n \"NPR\",\n \"NZD\",\n \"PAB\",\n \"PEN\",\n \"PGK\",\n \"PHP\",\n \"PKR\",\n \"PLN\",\n \"PYG\",\n \"QAR\",\n \"RON\",\n \"RSD\",\n \"RUB\",\n \"RWF\",\n \"SAR\",\n \"SBD\",\n \"SCR\",\n \"SEK\",\n \"SGD\",\n \"SHP\",\n \"SLE\",\n \"SLL\",\n \"SOS\",\n \"SRD\",\n \"STD\",\n \"SZL\",\n \"THB\",\n \"TJS\",\n \"TOP\",\n \"TRY\",\n \"TTD\",\n \"TWD\",\n \"TZS\",\n \"UAH\",\n \"UGX\",\n \"UYU\",\n \"UZS\",\n \"VND\",\n \"VUV\",\n \"WST\",\n \"XAF\",\n \"XCD\",\n \"XOF\",\n \"XPF\",\n \"YER\",\n \"ZAR\",\n \"ZMW\"\n ],\n \"required\": false,\n \"value\": \"\"\n },\n {\n \"type\": \"text\",\n \"order\": 12,\n \"immutable\": false,\n \"_id\": \"641cb18f6f4076d9210c925d\",\n \"name\": \"Budgeted Annual Cost\",\n \"choices\": [],\n \"required\": false,\n \"value\": \"\"\n }\n ],\n \"level\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"state\": \"\",\n \"pm_rule_ids\": [\n \"\",\n \"\"\n ],\n \"watchers\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/elements/v1/elements","description":"

Assets and Locations are both generically called \"elements\" in Chekhub.

\n","urlObject":{"protocol":"https","path":["elements","v1","elements"],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"88c83fcc-bcaf-45ac-89ea-13c154c2f314"},{"name":"Create Multiple Elements","id":"326a79c1-4abb-432b-b6d1-d3fd8632178a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"starting_number\": \"\",\n \"count\": \"\",\n \"padding\": \"\",\n\n\n \"organization_id\": \"\",\n \"template_id\": \"\",\n \"name\": \"\",\n \"resource_type\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"skills\": [\n \"\",\n \"\"\n ],\n \"properties\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"parameters\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"level\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"state\": \"\",\n \"pm_rule_ids\": [\n \"\",\n \"\"\n ],\n \"watchers\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/elements/v1/elements/batch","description":"

Assets and Locations are both generically called \"elements\" in Chekhub.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["elements","v1","elements","batch"],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"326a79c1-4abb-432b-b6d1-d3fd8632178a"},{"name":"Update Element(s)","id":"69bef779-8616-4829-a48f-e135ec05c65b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"_ids\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"resource_type\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"skills\": [\n \"\",\n \"\"\n ],\n \"properties\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"parameters\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"level\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"state\": \"\",\n \"pm_rule_ids\": [\n \"\",\n \"\"\n ],\n \"watchers\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/elements/v1/elements/bulk_update","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["elements","v1","elements","bulk_update"],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"69bef779-8616-4829-a48f-e135ec05c65b"},{"name":"List Available Parameters","id":"d802e54c-13d8-43a7-82f5-e3e1856e8935","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.chekhub.com/elements/v1/parameters?resource_type=asset","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["elements","v1","parameters"],"host":["api","chekhub","com"],"query":[{"key":"resource_type","value":"asset"}],"variable":[]}},"response":[],"_postman_id":"d802e54c-13d8-43a7-82f5-e3e1856e8935"},{"name":"Create Asset","id":"e318b384-ceaf-4e88-845e-d404b05ae39a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{vault:bearer-token}}w"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"\",\n \"template_id\": \"\",\n \"name\": \"\",\n \"resource_type\": \"asset\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"skills\": [\n \"\",\n \"\"\n ],\n \"properties\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"immutable\": \"\",\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"immutable\": \"\",\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"parameters\": [\n {\n \"name\": \"Asset Tag\",\n \"_id\": \"641cb16d6f4076d9210c9253\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 0,\n \"value\": \"String\"\n },\n {\n \"name\": \"Budgeted Annual Cost\",\n \"_id\": \"641cb18f6f4076d9210c925d\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 12,\n \"value\": \"String\"\n },\n {\n \"name\": \"Capacity\",\n \"_id\": \"641cb1936f4076d9210c925f\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 7,\n \"value\": \"String\"\n },\n {\n \"name\": \"End of Life Date\",\n \"_id\": \"641cb18b6f4076d9210c925a\",\n \"type\": \"date\",\n \"choices\": [],\n \"order\": 9,\n \"value\": \"String\"\n },\n {\n \"name\": \"Hostname\",\n \"_id\": \"641cb18d6f4076d9210c925c\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 5,\n \"value\": \"String\"\n },\n {\n \"name\": \"In Service Date\",\n \"_id\": \"641cb1896f4076d9210c9259\",\n \"type\": \"date\",\n \"choices\": [],\n \"order\": 8,\n \"value\": \"String\"\n },\n {\n \"name\": \"Make\",\n \"_id\": \"641cb16f6f4076d9210c9254\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 1,\n \"value\": \"String\"\n },\n {\n \"name\": \"Manufacturer\",\n \"_id\": \"641cb1846f4076d9210c9256\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 4,\n \"value\": \"String\"\n },\n {\n \"name\": \"Model\",\n \"_id\": \"641cb1826f4076d9210c9255\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 2,\n \"value\": \"String\"\n },\n {\n \"name\": \"Purchase Price\",\n \"_id\": \"641cb1866f4076d9210c9257\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 10,\n \"value\": \"String\"\n },\n {\n \"name\": \"Purchase Price Currency\",\n \"_id\": \"641cb1886f4076d9210c9258\",\n \"type\": \"single-choice\",\n \"choices\": [\n \"USD\",\n \"AED\",\n \"AFN\",\n \"ALL\",\n \"AMD\",\n \"ANG\",\n \"AOA\",\n \"ARS\",\n \"AUD\",\n \"AWG\",\n \"AZN\",\n \"BAM\",\n \"BBD\",\n \"BDT\",\n \"BGN\",\n \"BIF\",\n \"BMD\",\n \"BND\",\n \"BOB\",\n \"BRL\",\n \"BSD\",\n \"BWP\",\n \"BYN\",\n \"BZD\",\n \"CAD\",\n \"CDF\",\n \"CHF\",\n \"CLP\",\n \"CNY\",\n \"COP\",\n \"CRC\",\n \"CVE\",\n \"CZK\",\n \"DJF\",\n \"DKK\",\n \"DOP\",\n \"DZD\",\n \"EGP\",\n \"ETB\",\n \"EUR\",\n \"FJD\",\n \"FKP\",\n \"GBP\",\n \"GEL\",\n \"GIP\",\n \"GMD\",\n \"GNF\",\n \"GTQ\",\n \"GYD\",\n \"HKD\",\n \"HNL\",\n \"HTG\",\n \"HUF\",\n \"IDR\",\n \"ILS\",\n \"INR\",\n \"ISK\",\n \"JMD\",\n \"JPY\",\n \"KES\",\n \"KGS\",\n \"KHR\",\n \"KMF\",\n \"KRW\",\n \"KYD\",\n \"KZT\",\n \"LAK\",\n \"LBP\",\n \"LKR\",\n \"LRD\",\n \"LSL\",\n \"MAD\",\n \"MDL\",\n \"MGA\",\n \"MKD\",\n \"MMK\",\n \"MNT\",\n \"MOP\",\n \"MRO\",\n \"MUR\",\n \"MVR\",\n \"MWK\",\n \"MXN\",\n \"MYR\",\n \"MZN\",\n \"NAD\",\n \"NGN\",\n \"NIO\",\n \"NOK\",\n \"NPR\",\n \"NZD\",\n \"PAB\",\n \"PEN\",\n \"PGK\",\n \"PHP\",\n \"PKR\",\n \"PLN\",\n \"PYG\",\n \"QAR\",\n \"RON\",\n \"RSD\",\n \"RUB\",\n \"RWF\",\n \"SAR\",\n \"SBD\",\n \"SCR\",\n \"SEK\",\n \"SGD\",\n \"SHP\",\n \"SLE\",\n \"SLL\",\n \"SOS\",\n \"SRD\",\n \"STD\",\n \"SZL\",\n \"THB\",\n \"TJS\",\n \"TOP\",\n \"TRY\",\n \"TTD\",\n \"TWD\",\n \"TZS\",\n \"UAH\",\n \"UGX\",\n \"UYU\",\n \"UZS\",\n \"VND\",\n \"VUV\",\n \"WST\",\n \"XAF\",\n \"XCD\",\n \"XOF\",\n \"XPF\",\n \"YER\",\n \"ZAR\",\n \"ZMW\"\n ],\n \"order\": 11,\n \"value\": \"String\"\n },\n {\n \"name\": \"Serial Number\",\n \"_id\": \"641cb18c6f4076d9210c925b\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 3,\n \"value\": \"String\"\n },\n {\n \"name\": \"Size\",\n \"_id\": \"641cb1906f4076d9210c925e\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 6,\n \"value\": \"String\"\n }\n ],\n \"level\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"state\": \"\",\n \"pm_rule_ids\": [\n \"\",\n \"\"\n ],\n \"watchers\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/elements/v1/elements","urlObject":{"protocol":"https","path":["elements","v1","elements"],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e318b384-ceaf-4e88-845e-d404b05ae39a"},{"name":"Create Location","id":"cb692760-efa5-4b74-bdec-18ff502c76fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{vault:bearer-token}}w"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"\",\n \"template_id\": \"\",\n \"name\": \"\",\n \"resource_type\": \"location\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"skills\": [\n \"\",\n \"\"\n ],\n \"properties\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"immutable\": \"\",\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"immutable\": \"\",\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"parameters\": [\n {\n \"name\": \"Floors/Levels\",\n \"_id\": \"641cf9cafb802f1208e02ab3\",\n \"type\": \"numeric\",\n \"choices\": [],\n \"order\": 0,\n \"value\": \"String\"\n },\n {\n \"name\": \"In Service Date\",\n \"_id\": \"641cf9cafb802f1208e02ab4\",\n \"type\": \"date\",\n \"choices\": [],\n \"order\": 1,\n \"value\": \"String\"\n },\n {\n \"name\": \"Square Footage\",\n \"_id\": \"641cf9cafb802f1208e02ab5\",\n \"type\": \"numeric\",\n \"choices\": [],\n \"order\": 2,\n \"value\": \"String\"\n }\n ],\n \"level\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"state\": \"\",\n \"pm_rule_ids\": [\n \"\",\n \"\"\n ],\n \"watchers\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/elements/v1/elements","urlObject":{"protocol":"https","path":["elements","v1","elements"],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb692760-efa5-4b74-bdec-18ff502c76fe"}],"id":"8128fa73-0e83-4447-8328-0eed75fc9d1b","_postman_id":"8128fa73-0e83-4447-8328-0eed75fc9d1b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}}},{"name":"Assets","item":[{"name":"{asset_id}","item":[{"name":"Update Asset","id":"f186d93d-3838-4872-9189-b0bedaf4a1d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"\",\n \"template_id\": \"\",\n \"name\": \"\",\n \"resource_type\": \"asset\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"skills\": [\n \"\",\n \"\"\n ],\n \"properties\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"immutable\": \"\",\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"immutable\": \"\",\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"parameters\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"level\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"state\": \"\",\n \"pm_rule_ids\": [\n \"\",\n \"\"\n ],\n \"watchers\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/elements/v1/elements/:elementId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["elements","v1","elements",":elementId"],"host":["api","chekhub","com"],"query":[],"variable":[{"type":"any","value":"","key":"elementId"}]}},"response":[],"_postman_id":"f186d93d-3838-4872-9189-b0bedaf4a1d2"}],"id":"8e04fdee-4126-47d9-b22e-e5b72af42820","_postman_id":"8e04fdee-4126-47d9-b22e-e5b72af42820","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}}},{"name":"List Assets","id":"75a219ed-cefb-47f8-a221-33adb5500d37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.chekhub.com/elements/v1/elements?organization_id=&path_ids=&resource_types=asset&show_fields=&states=ACTIVE&level=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["elements","v1","elements"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

(Required) The unique identifier of the organization

\n","type":"text/plain"},"key":"organization_id","value":""},{"description":{"content":"

Filter items with these path IDs. For example if you wanted all assets at a particular site you would enter the site id here

\n","type":"text/plain"},"key":"path_ids","value":""},{"description":{"content":"

\"aaset\" or \"location\"

\n","type":"text/plain"},"key":"resource_types","value":"asset"},{"description":{"content":"

address,attachments,created_at,created_by,connections,description,is_site,level,location,latitude,longitude,geojson,media,modified_at,modified_by,name,organization,parent,path,parameters,pm_rules,properties,resource_type,rounds,sites,skills,state,status,tags,template,upstream,downstream,template_attachments,template_properties,timezone,watchers

\n","type":"text/plain"},"key":"show_fields","value":""},{"description":{"content":"

Filter items by these states

\n","type":"text/plain"},"key":"states","value":"ACTIVE"},{"description":{"content":"

Use this to return the \"sites\" only. Default site is level \"3\"

\n","type":"text/plain"},"key":"level","value":""}],"variable":[]}},"response":[],"_postman_id":"75a219ed-cefb-47f8-a221-33adb5500d37"},{"name":"Get Asset By ID","id":"e255e28f-6e2e-485f-b20c-fd1f78ac4b0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.chekhub.com/elements/v1/elements/:element_id?organization_id=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["elements","v1","elements",":element_id"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

id of the organization

\n","type":"text/plain"},"key":"organization_id","value":""}],"variable":[{"id":"9f39d7c4-4cbf-4130-9218-8e8997a6d6dc","description":{"content":"

id of the target element

\n","type":"text/plain"},"type":"any","value":"","key":"element_id"}]}},"response":[],"_postman_id":"e255e28f-6e2e-485f-b20c-fd1f78ac4b0e"},{"name":"Create Asset","id":"a05fe9d2-98c3-439f-aa30-e129c6e60849","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{vault:bearer-token}}w"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"\",\n \"template_id\": \"\",\n \"name\": \"\",\n \"resource_type\": \"asset\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"skills\": [\n \"\",\n \"\"\n ],\n \"properties\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"immutable\": \"\",\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"immutable\": \"\",\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"parameters\": [\n {\n \"name\": \"Asset Tag\",\n \"_id\": \"641cb16d6f4076d9210c9253\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 0,\n \"value\": \"String\"\n },\n {\n \"name\": \"Budgeted Annual Cost\",\n \"_id\": \"641cb18f6f4076d9210c925d\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 12,\n \"value\": \"String\"\n },\n {\n \"name\": \"Capacity\",\n \"_id\": \"641cb1936f4076d9210c925f\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 7,\n \"value\": \"String\"\n },\n {\n \"name\": \"End of Life Date\",\n \"_id\": \"641cb18b6f4076d9210c925a\",\n \"type\": \"date\",\n \"choices\": [],\n \"order\": 9,\n \"value\": \"String\"\n },\n {\n \"name\": \"Hostname\",\n \"_id\": \"641cb18d6f4076d9210c925c\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 5,\n \"value\": \"String\"\n },\n {\n \"name\": \"In Service Date\",\n \"_id\": \"641cb1896f4076d9210c9259\",\n \"type\": \"date\",\n \"choices\": [],\n \"order\": 8,\n \"value\": \"String\"\n },\n {\n \"name\": \"Make\",\n \"_id\": \"641cb16f6f4076d9210c9254\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 1,\n \"value\": \"String\"\n },\n {\n \"name\": \"Manufacturer\",\n \"_id\": \"641cb1846f4076d9210c9256\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 4,\n \"value\": \"String\"\n },\n {\n \"name\": \"Model\",\n \"_id\": \"641cb1826f4076d9210c9255\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 2,\n \"value\": \"String\"\n },\n {\n \"name\": \"Purchase Price\",\n \"_id\": \"641cb1866f4076d9210c9257\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 10,\n \"value\": \"String\"\n },\n {\n \"name\": \"Purchase Price Currency\",\n \"_id\": \"641cb1886f4076d9210c9258\",\n \"type\": \"single-choice\",\n \"choices\": [\n \"USD\",\n \"AED\",\n \"AFN\",\n \"ALL\",\n \"AMD\",\n \"ANG\",\n \"AOA\",\n \"ARS\",\n \"AUD\",\n \"AWG\",\n \"AZN\",\n \"BAM\",\n \"BBD\",\n \"BDT\",\n \"BGN\",\n \"BIF\",\n \"BMD\",\n \"BND\",\n \"BOB\",\n \"BRL\",\n \"BSD\",\n \"BWP\",\n \"BYN\",\n \"BZD\",\n \"CAD\",\n \"CDF\",\n \"CHF\",\n \"CLP\",\n \"CNY\",\n \"COP\",\n \"CRC\",\n \"CVE\",\n \"CZK\",\n \"DJF\",\n \"DKK\",\n \"DOP\",\n \"DZD\",\n \"EGP\",\n \"ETB\",\n \"EUR\",\n \"FJD\",\n \"FKP\",\n \"GBP\",\n \"GEL\",\n \"GIP\",\n \"GMD\",\n \"GNF\",\n \"GTQ\",\n \"GYD\",\n \"HKD\",\n \"HNL\",\n \"HTG\",\n \"HUF\",\n \"IDR\",\n \"ILS\",\n \"INR\",\n \"ISK\",\n \"JMD\",\n \"JPY\",\n \"KES\",\n \"KGS\",\n \"KHR\",\n \"KMF\",\n \"KRW\",\n \"KYD\",\n \"KZT\",\n \"LAK\",\n \"LBP\",\n \"LKR\",\n \"LRD\",\n \"LSL\",\n \"MAD\",\n \"MDL\",\n \"MGA\",\n \"MKD\",\n \"MMK\",\n \"MNT\",\n \"MOP\",\n \"MRO\",\n \"MUR\",\n \"MVR\",\n \"MWK\",\n \"MXN\",\n \"MYR\",\n \"MZN\",\n \"NAD\",\n \"NGN\",\n \"NIO\",\n \"NOK\",\n \"NPR\",\n \"NZD\",\n \"PAB\",\n \"PEN\",\n \"PGK\",\n \"PHP\",\n \"PKR\",\n \"PLN\",\n \"PYG\",\n \"QAR\",\n \"RON\",\n \"RSD\",\n \"RUB\",\n \"RWF\",\n \"SAR\",\n \"SBD\",\n \"SCR\",\n \"SEK\",\n \"SGD\",\n \"SHP\",\n \"SLE\",\n \"SLL\",\n \"SOS\",\n \"SRD\",\n \"STD\",\n \"SZL\",\n \"THB\",\n \"TJS\",\n \"TOP\",\n \"TRY\",\n \"TTD\",\n \"TWD\",\n \"TZS\",\n \"UAH\",\n \"UGX\",\n \"UYU\",\n \"UZS\",\n \"VND\",\n \"VUV\",\n \"WST\",\n \"XAF\",\n \"XCD\",\n \"XOF\",\n \"XPF\",\n \"YER\",\n \"ZAR\",\n \"ZMW\"\n ],\n \"order\": 11,\n \"value\": \"String\"\n },\n {\n \"name\": \"Serial Number\",\n \"_id\": \"641cb18c6f4076d9210c925b\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 3,\n \"value\": \"String\"\n },\n {\n \"name\": \"Size\",\n \"_id\": \"641cb1906f4076d9210c925e\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 6,\n \"value\": \"String\"\n }\n ],\n \"level\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"state\": \"\",\n \"pm_rule_ids\": [\n \"\",\n \"\"\n ],\n \"watchers\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/elements/v1/elements","urlObject":{"protocol":"https","path":["elements","v1","elements"],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a05fe9d2-98c3-439f-aa30-e129c6e60849"},{"name":"Create Multiple Assets","id":"1d22f1ed-6770-4af7-a9cb-9bdb0f573e06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"starting_number\": \"\",\n \"count\": \"\",\n \"padding\": \"\",\n \"organization_id\": \"\",\n \"template_id\": \"\",\n \"name\": \"\",\n \"resource_type\": \"asset\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"skills\": [\n \"\",\n \"\"\n ],\n \"properties\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"parameters\": [\n {\n \"name\": \"Asset Tag\",\n \"_id\": \"641cb16d6f4076d9210c9253\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 0,\n \"value\": \"String\"\n },\n {\n \"name\": \"Budgeted Annual Cost\",\n \"_id\": \"641cb18f6f4076d9210c925d\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 12,\n \"value\": \"String\"\n },\n {\n \"name\": \"Capacity\",\n \"_id\": \"641cb1936f4076d9210c925f\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 7,\n \"value\": \"String\"\n },\n {\n \"name\": \"End of Life Date\",\n \"_id\": \"641cb18b6f4076d9210c925a\",\n \"type\": \"date\",\n \"choices\": [],\n \"order\": 9,\n \"value\": \"String\"\n },\n {\n \"name\": \"Hostname\",\n \"_id\": \"641cb18d6f4076d9210c925c\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 5,\n \"value\": \"String\"\n },\n {\n \"name\": \"In Service Date\",\n \"_id\": \"641cb1896f4076d9210c9259\",\n \"type\": \"date\",\n \"choices\": [],\n \"order\": 8,\n \"value\": \"String\"\n },\n {\n \"name\": \"Make\",\n \"_id\": \"641cb16f6f4076d9210c9254\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 1,\n \"value\": \"String\"\n },\n {\n \"name\": \"Manufacturer\",\n \"_id\": \"641cb1846f4076d9210c9256\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 4,\n \"value\": \"String\"\n },\n {\n \"name\": \"Model\",\n \"_id\": \"641cb1826f4076d9210c9255\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 2,\n \"value\": \"String\"\n },\n {\n \"name\": \"Purchase Price\",\n \"_id\": \"641cb1866f4076d9210c9257\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 10,\n \"value\": \"String\"\n },\n {\n \"name\": \"Purchase Price Currency\",\n \"_id\": \"641cb1886f4076d9210c9258\",\n \"type\": \"single-choice\",\n \"choices\": [\n \"USD\",\n \"AED\",\n \"AFN\",\n \"ALL\",\n \"AMD\",\n \"ANG\",\n \"AOA\",\n \"ARS\",\n \"AUD\",\n \"AWG\",\n \"AZN\",\n \"BAM\",\n \"BBD\",\n \"BDT\",\n \"BGN\",\n \"BIF\",\n \"BMD\",\n \"BND\",\n \"BOB\",\n \"BRL\",\n \"BSD\",\n \"BWP\",\n \"BYN\",\n \"BZD\",\n \"CAD\",\n \"CDF\",\n \"CHF\",\n \"CLP\",\n \"CNY\",\n \"COP\",\n \"CRC\",\n \"CVE\",\n \"CZK\",\n \"DJF\",\n \"DKK\",\n \"DOP\",\n \"DZD\",\n \"EGP\",\n \"ETB\",\n \"EUR\",\n \"FJD\",\n \"FKP\",\n \"GBP\",\n \"GEL\",\n \"GIP\",\n \"GMD\",\n \"GNF\",\n \"GTQ\",\n \"GYD\",\n \"HKD\",\n \"HNL\",\n \"HTG\",\n \"HUF\",\n \"IDR\",\n \"ILS\",\n \"INR\",\n \"ISK\",\n \"JMD\",\n \"JPY\",\n \"KES\",\n \"KGS\",\n \"KHR\",\n \"KMF\",\n \"KRW\",\n \"KYD\",\n \"KZT\",\n \"LAK\",\n \"LBP\",\n \"LKR\",\n \"LRD\",\n \"LSL\",\n \"MAD\",\n \"MDL\",\n \"MGA\",\n \"MKD\",\n \"MMK\",\n \"MNT\",\n \"MOP\",\n \"MRO\",\n \"MUR\",\n \"MVR\",\n \"MWK\",\n \"MXN\",\n \"MYR\",\n \"MZN\",\n \"NAD\",\n \"NGN\",\n \"NIO\",\n \"NOK\",\n \"NPR\",\n \"NZD\",\n \"PAB\",\n \"PEN\",\n \"PGK\",\n \"PHP\",\n \"PKR\",\n \"PLN\",\n \"PYG\",\n \"QAR\",\n \"RON\",\n \"RSD\",\n \"RUB\",\n \"RWF\",\n \"SAR\",\n \"SBD\",\n \"SCR\",\n \"SEK\",\n \"SGD\",\n \"SHP\",\n \"SLE\",\n \"SLL\",\n \"SOS\",\n \"SRD\",\n \"STD\",\n \"SZL\",\n \"THB\",\n \"TJS\",\n \"TOP\",\n \"TRY\",\n \"TTD\",\n \"TWD\",\n \"TZS\",\n \"UAH\",\n \"UGX\",\n \"UYU\",\n \"UZS\",\n \"VND\",\n \"VUV\",\n \"WST\",\n \"XAF\",\n \"XCD\",\n \"XOF\",\n \"XPF\",\n \"YER\",\n \"ZAR\",\n \"ZMW\"\n ],\n \"order\": 11,\n \"value\": \"String\"\n },\n {\n \"name\": \"Serial Number\",\n \"_id\": \"641cb18c6f4076d9210c925b\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 3,\n \"value\": \"String\"\n },\n {\n \"name\": \"Size\",\n \"_id\": \"641cb1906f4076d9210c925e\",\n \"type\": \"text\",\n \"choices\": [],\n \"order\": 6,\n \"value\": \"String\"\n }\n ],\n \"level\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"state\": \"\",\n \"pm_rule_ids\": [\n \"\",\n \"\"\n ],\n \"watchers\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/elements/v1/elements/batch","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["elements","v1","elements","batch"],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1d22f1ed-6770-4af7-a9cb-9bdb0f573e06"},{"name":"Update Asset(s)","id":"f5ce7786-aafe-4696-98de-cbac36fbea47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"_ids\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"resource_type\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"skills\": [\n \"\",\n \"\"\n ],\n \"properties\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"parameters\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"choices\": {},\n \"value\": {},\n \"required\": \"\",\n \"section\": \"\",\n \"default_value\": {},\n \"required_to_open\": \"\",\n \"required_to_assign\": \"\",\n \"required_to_close\": \"\",\n \"immutable\": \"\",\n \"show_children_if\": {\n \"input\": {},\n \"operator\": \"\",\n \"operand\": {}\n },\n \"order\": \"\",\n \"inherited_from\": {\n \"_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"level\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"state\": \"\",\n \"pm_rule_ids\": [\n \"\",\n \"\"\n ],\n \"watchers\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/elements/v1/elements/bulk_update","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["elements","v1","elements","bulk_update"],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5ce7786-aafe-4696-98de-cbac36fbea47"},{"name":"List Available Parameters","id":"c8a2146e-dd5d-4feb-a998-b2f442eb0739","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.chekhub.com/elements/v1/parameters?resource_type=asset","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["elements","v1","parameters"],"host":["api","chekhub","com"],"query":[{"key":"resource_type","value":"asset"}],"variable":[]}},"response":[],"_postman_id":"c8a2146e-dd5d-4feb-a998-b2f442eb0739"}],"id":"24e27bea-a87d-4e6e-8409-ba1aef3ced1c","_postman_id":"24e27bea-a87d-4e6e-8409-ba1aef3ced1c","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}}},{"name":"Members","item":[{"name":"List Members","id":"3356dfd5-f7c9-4eba-a49d-375c63630259","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.chekhub.com/accounts/v1/members?organization_id=&show_fields=name,email,teams,skills,role,role_object,first_name,last_name,access,preferences,accepted,is_owner,has_license,last_active,template_id,template_properties,properties,invited_by,invited_at,modified_at,image,state","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["accounts","v1","members"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required Field

\n","type":"text/plain"},"key":"organization_id","value":""},{"key":"show_fields","value":"name,email,teams,skills,role,role_object,first_name,last_name,access,preferences,accepted,is_owner,has_license,last_active,template_id,template_properties,properties,invited_by,invited_at,modified_at,image,state"}],"variable":[]}},"response":[],"_postman_id":"3356dfd5-f7c9-4eba-a49d-375c63630259"},{"name":"Get Member By ID","id":"48418193-bcc9-698d-eaed-6599b8f91d6f","request":{"method":"GET","header":[],"url":"https://api.chekhub.com/accounts/v1/members/:member_id?populate_teams=false","description":"

Retrieves a single member by its ID.

\n

You don't need to pass organization_id. The member's organization is resolved from the member itself.

\n

Path parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescription
member_idRequired. The member's _id, a 24-character hexadecimal ID (for example, from List Members).
\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDefaultDescription
populate_teamsbooleanfalseWhen true, teams returns full team objects instead of team IDs.
\n

This endpoint always returns the full member record. It doesn't support show_fields. To fetch only selected fields for one or more members, use List Members with show_fields.

\n

Access

\n
    \n
  • Send your API key in the apikey header (or a user bearer token in Authorization: Bearer <token>).
    • \n
  • To read any member of the organization, the API key or user needs the members/r privilege. Without it, you can only read your own member record.
    • \n
  • Members of a vendor organization connected to yours through an active Chekhub Connect vendor connection can also be read. The response then includes a connect object, and teams shows the vendor team(s) on your side.
    • \n
\n

Responses

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusWhen
200The member was found. The member record is in data.
401The API key or token is missing or invalid.
403The caller lacks members/r and is requesting a member other than itself.
404member/not-found: the ID is unknown, malformed, or belongs to a deleted member.
\n

Notes

\n
    \n
  • skills_awarded only includes awards that are approved or don't require approval. Pending and rejected awards are left out.
    • \n
  • role_object.privileges lists the privileges of the member's role.
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["accounts","v1","members",":member_id"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Optional. Boolean, default false. When true, each entry in teams is returned as a team object (_id, name, image, parent_id, is_vendor, is_customer, is_connect, template_id, template_properties, ticket_templates, connect_id, state, is_dispatcher, direct_member) instead of a team ID.

\n","type":"text/plain"},"key":"populate_teams","value":"false"}],"variable":[{"type":"any","key":"member_id"}]}},"response":[{"id":"7a90aff7-87da-abf3-6289-b8743c134844","name":"200 — Member found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.chekhub.com/accounts/v1/members/:member_id?populate_teams=false","protocol":"https","host":["api","chekhub","com"],"path":["accounts","v1","members",":member_id"],"query":[{"value":"false","description":"Optional. Boolean, default `false`. When `true`, each entry in `teams` is returned as a team object (`_id`, `name`, `image`, `parent_id`, `is_vendor`, `is_customer`, `is_connect`, `template_id`, `template_properties`, `ticket_templates`, `connect_id`, `state`, `is_dispatcher`, `direct_member`) instead of a team ID.","key":"populate_teams"}],"variable":[{"key":"member_id"}]},"description":"Retrieves a single member by its ID.\n\nYou don't need to pass `organization_id`. The member's organization is resolved from the member itself.\n\n### Path parameters\n\n| Parameter | Description |\n| --- | --- |\n| `member_id` | **Required.** The member's `_id`, a 24-character hexadecimal ID (for example, from **List Members**). |\n\n### Query parameters\n\n| Parameter | Type | Default | Description |\n| --- | --- | --- | --- |\n| `populate_teams` | boolean | `false` | When `true`, `teams` returns full team objects instead of team IDs. |\n\nThis endpoint always returns the full member record. It doesn't support `show_fields`. To fetch only selected fields for one or more members, use **List Members** with `show_fields`.\n\n### Access\n\n- Send your API key in the `apikey` header (or a user bearer token in `Authorization: Bearer `).\n- To read **any** member of the organization, the API key or user needs the `members/r` privilege. Without it, you can only read your **own** member record.\n- Members of a vendor organization connected to yours through an active Chekhub Connect vendor connection can also be read. The response then includes a `connect` object, and `teams` shows the vendor team(s) on your side.\n\n### Responses\n\n| Status | When |\n| --- | --- |\n| `200` | The member was found. The member record is in `data`. |\n| `401` | The API key or token is missing or invalid. |\n| `403` | The caller lacks `members/r` and is requesting a member other than itself. |\n| `404` | `member/not-found`: the ID is unknown, malformed, or belongs to a deleted member. |\n\n### Notes\n\n- `skills_awarded` only includes awards that are approved or don't require approval. Pending and rejected awards are left out.\n- `role_object.privileges` lists the privileges of the member's role."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"details\": \"Successfully retrieved the member\",\n \"type\": \"json\",\n \"data\": {\n \"_id\": \"650c1f2a9b3e4d0012a7c3e1\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"image\": null,\n \"state\": \"ACTIVE\",\n \"accepted\": true,\n \"has_license\": true,\n \"is_owner\": false,\n \"email_notifications\": true,\n \"organization\": {\n \"_id\": \"64a7b2c19d8e3f0011b2c4d5\",\n \"name\": \"Example Facilities Co.\"\n },\n \"role_id\": \"64a7b2c19d8e3f0011b2c4e0\",\n \"role_object\": {\n \"_id\": \"64a7b2c19d8e3f0011b2c4e0\",\n \"name\": \"Technician\",\n \"code\": \"technician\",\n \"system\": true,\n \"privileges\": [\n \"tickets/r\",\n \"tickets/u\",\n \"elements/r\"\n ]\n },\n \"teams\": [\n \"64a7b2c19d8e3f0011b2c5a1\"\n ],\n \"access\": [\n {\n \"location\": null,\n \"role_id\": \"64a7b2c19d8e3f0011b2c4e0\"\n }\n ],\n \"elements\": [\n {\n \"_id\": \"64a7b2c19d8e3f0011b2c6b2\",\n \"name\": \"Store 1042\",\n \"resource_type\": \"location\",\n \"path\": [\n {\n \"_id\": \"64a7b2c19d8e3f0011b2c6a0\",\n \"name\": \"Southeast Region\",\n \"resource_type\": \"location\"\n }\n ],\n \"state\": \"ACTIVE\",\n \"role\": \"member\",\n \"direct\": true\n }\n ],\n \"skills\": [\n \"HVAC\"\n ],\n \"skills_awarded\": [\n {\n \"_id\": \"66f0a1b2c3d4e5f601234567\",\n \"name\": \"HVAC Certification\",\n \"skill\": {\n \"_id\": \"66f0a1b2c3d4e5f601234500\",\n \"name\": \"HVAC\",\n \"resource_type\": \"skill\"\n },\n \"expired\": false,\n \"expiration_datetime\": null,\n \"approval_status\": \"approved\"\n }\n ],\n \"template_id\": null,\n \"template_properties\": [],\n \"properties\": [],\n \"locations\": [],\n \"created_at\": \"2023-09-21T14:05:30.000Z\",\n \"modified_at\": \"2026-09-30T18:22:11.000Z\"\n }\n}"},{"id":"f5e3ad56-0cfe-656a-1006-3397260329ec","name":"404 — Member not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.chekhub.com/accounts/v1/members/:member_id?populate_teams=false","protocol":"https","host":["api","chekhub","com"],"path":["accounts","v1","members",":member_id"],"query":[{"value":"false","description":"Optional. Boolean, default `false`. When `true`, each entry in `teams` is returned as a team object (`_id`, `name`, `image`, `parent_id`, `is_vendor`, `is_customer`, `is_connect`, `template_id`, `template_properties`, `ticket_templates`, `connect_id`, `state`, `is_dispatcher`, `direct_member`) instead of a team ID.","key":"populate_teams"}],"variable":[{"key":"member_id"}]},"description":"Retrieves a single member by its ID.\n\nYou don't need to pass `organization_id`. The member's organization is resolved from the member itself.\n\n### Path parameters\n\n| Parameter | Description |\n| --- | --- |\n| `member_id` | **Required.** The member's `_id`, a 24-character hexadecimal ID (for example, from **List Members**). |\n\n### Query parameters\n\n| Parameter | Type | Default | Description |\n| --- | --- | --- | --- |\n| `populate_teams` | boolean | `false` | When `true`, `teams` returns full team objects instead of team IDs. |\n\nThis endpoint always returns the full member record. It doesn't support `show_fields`. To fetch only selected fields for one or more members, use **List Members** with `show_fields`.\n\n### Access\n\n- Send your API key in the `apikey` header (or a user bearer token in `Authorization: Bearer `).\n- To read **any** member of the organization, the API key or user needs the `members/r` privilege. Without it, you can only read your **own** member record.\n- Members of a vendor organization connected to yours through an active Chekhub Connect vendor connection can also be read. The response then includes a `connect` object, and `teams` shows the vendor team(s) on your side.\n\n### Responses\n\n| Status | When |\n| --- | --- |\n| `200` | The member was found. The member record is in `data`. |\n| `401` | The API key or token is missing or invalid. |\n| `403` | The caller lacks `members/r` and is requesting a member other than itself. |\n| `404` | `member/not-found`: the ID is unknown, malformed, or belongs to a deleted member. |\n\n### Notes\n\n- `skills_awarded` only includes awards that are approved or don't require approval. Pending and rejected awards are left out.\n- `role_object.privileges` lists the privileges of the member's role."},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"member/not-found\",\n \"message\": \"Not Found\",\n \"details\": {\n \"_id\": \"000000000000000000000000\",\n \"resource_type\": \"members\"\n }\n}"}],"_postman_id":"48418193-bcc9-698d-eaed-6599b8f91d6f"}],"id":"3f660921-3e0f-4a9a-9f0b-2edf3f70ac08","_postman_id":"3f660921-3e0f-4a9a-9f0b-2edf3f70ac08","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}}},{"name":"Accounts","item":[{"name":"Create API Key","id":"49633126-c83e-4ad5-8b9d-ac2f8eef6c20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \"organization_id\": \"\", // the id of your organization\n \"name\": \"\", //the name of the api key, created_by will show name as \" - API Key\"\n \"description\": \"\", // the description of this api key\n \"role_id\": \"\", //the role to grant the api key, 5e848c7a274d693a983be889 is the admin role\n \"project_ids\": [], //a list of project ids for project based access control\n \"location_ids\": [] // a list of location ids for location based access control\n}\n// The api can be used by passing a header named `apikey` along with the value. ","options":{"raw":{"language":"json"}}},"url":"api.chekhub.com/accounts/v1/api_keys","description":"

This route will create an API Key that can be used across the system. The api key will be able to have a role along with project or location based access control. Once the key is generated, it can not be resent.

\n

Note: If your organization requires SSO and you don't have a password, please contact support@chekhub.com to request an API Key

\n","urlObject":{"path":["accounts","v1","api_keys"],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"49633126-c83e-4ad5-8b9d-ac2f8eef6c20"},{"name":"Log In","id":"8dab230d-257a-4cf6-bded-2b4e5655a011","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"api.chekhub.com/v2/system/login","description":"

A route for logging into the sytem with username and password to obtain an access token

\n","urlObject":{"path":["v2","system","login"],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8dab230d-257a-4cf6-bded-2b4e5655a011"}],"id":"2133e00a-d25c-4e0a-bc3f-bccc746e3df3","_postman_id":"2133e00a-d25c-4e0a-bc3f-bccc746e3df3","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}}},{"name":"Comments","item":[{"name":"Create Comment","id":"2b329328-8dd4-7cf3-c0d8-51b34ed99cca","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"resource_type\": \"ticket\",\n \"resource_id\": \"{{ticket_id}}\",\n \"message\": \"Replaced the filter — @members/{{member_id}} please confirm on your next visit.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ],\n \"request_uuid\": \"4c5b3720-e124-42d0-ac16-cf86c28f1172\",\n \"skip_integration_triggers\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/comments/","description":"

Adds a comment to a Chekhub record (ticket, PM, round, asset, location, …).

\n

Privilege: comments/c · Organization: organization_id in the body.

\n

Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredNotes
organization_idObjectIdyesThe organization that owns the record.
resource_typestringyesSingular type of the record the comment is on — e.g. ticket, pm_instance, pm_interval, pm_series, rounds_instance, rounds_series, asset, location, checklist, member.
resource_idObjectIdyesThe _id of that record. It must exist and not be deleted, or the call returns 404.
messagestringyesThe comment text (max 5000 characters). Mention a person or team inline with @members/<member_id> or @teams/<team_id> — mentioned members are notified and returned in mentions.
tagged_entitiesarraynoMembers/teams to tag without writing them into the text: [{ \"_id\": \"<id>\", \"resource_type\": \"member\" }] (member/members, team/teams). Names are resolved server-side.
request_uuidstringnoIdempotency key, max 64 chars — generate one per comment (a UUID). If a retry of the same create arrives with the same key, from the same author, on the same record, the API returns the comment created by the first attempt (201) instead of creating a duplicate. This holds even if that comment was deleted since. Recommended for any client that retries on timeout.
skip_integration_triggersbooleannoDefault false. When true, the comment is saved without firing the organization's configured integration triggers (e.g. pushing the comment to a connected work-order system).
integrationsarraynoIntegration reference data to store on the comment. Normally set by integrations, not by callers.
\n

Behaviour

\n
    \n
  • Watchers of tickets, PMs and rounds are notified of the new comment; mentioned and tagged members are notified on other record types.
    • \n
  • The record's comment count is incremented.
    • \n
\n

Response

\n

201 with the created comment in data.

\n

Authentication: your organization API key in the apikey header (see Accounts › Create API Key), or Authorization: Bearer <token>. Successful responses are { status, type, data, details, message, requested_at, responded_at }; errors are { status, code, message, details }.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","comments",""],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[{"id":"ea288f7a-e2be-264a-f83e-83989e9301b2","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"resource_type\": \"ticket\",\n \"resource_id\": \"{{ticket_id}}\",\n \"message\": \"Replaced the filter — @members/{{member_id}} please confirm on your next visit.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ],\n \"request_uuid\": \"3e9e5d2b-9c5e-474f-b0ed-cfd6822e463e\",\n \"skip_integration_triggers\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/comments/","description":"Adds a comment to a Chekhub record (ticket, PM, round, asset, location, …).\n\n**Privilege:** `comments/c` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | The organization that owns the record. |\n| `resource_type` | string | yes | Singular type of the record the comment is on — e.g. `ticket`, `pm_instance`, `pm_interval`, `pm_series`, `rounds_instance`, `rounds_series`, `asset`, `location`, `checklist`, `member`. |\n| `resource_id` | ObjectId | yes | The `_id` of that record. It must exist and not be deleted, or the call returns `404`. |\n| `message` | string | yes | The comment text (max 5000 characters). Mention a person or team inline with `@members/` or `@teams/` — mentioned members are notified and returned in `mentions`. |\n| `tagged_entities` | array | no | Members/teams to tag without writing them into the text: `[{ \"_id\": \"\", \"resource_type\": \"member\" }]` (`member`/`members`, `team`/`teams`). Names are resolved server-side. |\n| `request_uuid` | string | no | Idempotency key, max 64 chars — generate one per comment (a UUID). If a retry of the same create arrives with the same key, from the same author, on the same record, the API returns the comment created by the first attempt (`201`) instead of creating a duplicate. This holds even if that comment was deleted since. Recommended for any client that retries on timeout. |\n| `skip_integration_triggers` | boolean | no | Default `false`. When `true`, the comment is saved without firing the organization's configured integration triggers (e.g. pushing the comment to a connected work-order system). |\n| `integrations` | array | no | Integration reference data to store on the comment. Normally set by integrations, not by callers. |\n\n### Behaviour\n- Watchers of tickets, PMs and rounds are notified of the new comment; mentioned and tagged members are notified on other record types.\n- The record's comment count is incremented.\n\n### Response\n`201` with the created comment in `data`.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"type\": \"json\",\n \"data\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60005\",\n \"organization\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60001\",\n \"name\": \"Example Facilities Co.\"\n },\n \"entered_at\": \"2026-09-29T14:03:11.482Z\",\n \"message\": \"Replaced the filter — @members/64b7f0c2a1b2c3d4e5f60004 please confirm on your next visit.\",\n \"skip_reason\": false,\n \"references\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60002\",\n \"name\": \"Rooftop unit 3 not cooling\",\n \"resource_type\": \"ticket\"\n }\n ],\n \"attachments\": [],\n \"mentions\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60004\",\n \"name\": \"Sam Lee\",\n \"image\": null,\n \"resource_type\": \"members\"\n }\n ],\n \"tagged_entities\": [],\n \"request_uuid\": \"5b1f7a52-6c0e-4b8e-9d7e-2f4a1c9e0b33\",\n \"created_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"created_at\": \"2026-09-29T14:03:11.482Z\",\n \"modified_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"modified_at\": \"2026-09-29T14:03:11.482Z\",\n \"state\": \"ACTIVE\",\n \"integrations\": []\n },\n \"details\": \"Successfully created the comment\",\n \"message\": \"OK\",\n \"requested_at\": \"2026-09-29 14:03:11.301\",\n \"responded_at\": \"2026-09-29 14:03:11.517\"\n}"},{"id":"e31ffe74-545c-c1cb-dc5d-90d37990dc0b","name":"400 Missing field","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"resource_type\": \"ticket\",\n \"resource_id\": \"{{ticket_id}}\",\n \"message\": \"Replaced the filter — @members/{{member_id}} please confirm on your next visit.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ],\n \"request_uuid\": \"c6fd8466-c61b-40aa-9de9-ee89ce6a555f\",\n \"skip_integration_triggers\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/comments/","description":"Adds a comment to a Chekhub record (ticket, PM, round, asset, location, …).\n\n**Privilege:** `comments/c` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | The organization that owns the record. |\n| `resource_type` | string | yes | Singular type of the record the comment is on — e.g. `ticket`, `pm_instance`, `pm_interval`, `pm_series`, `rounds_instance`, `rounds_series`, `asset`, `location`, `checklist`, `member`. |\n| `resource_id` | ObjectId | yes | The `_id` of that record. It must exist and not be deleted, or the call returns `404`. |\n| `message` | string | yes | The comment text (max 5000 characters). Mention a person or team inline with `@members/` or `@teams/` — mentioned members are notified and returned in `mentions`. |\n| `tagged_entities` | array | no | Members/teams to tag without writing them into the text: `[{ \"_id\": \"\", \"resource_type\": \"member\" }]` (`member`/`members`, `team`/`teams`). Names are resolved server-side. |\n| `request_uuid` | string | no | Idempotency key, max 64 chars — generate one per comment (a UUID). If a retry of the same create arrives with the same key, from the same author, on the same record, the API returns the comment created by the first attempt (`201`) instead of creating a duplicate. This holds even if that comment was deleted since. Recommended for any client that retries on timeout. |\n| `skip_integration_triggers` | boolean | no | Default `false`. When `true`, the comment is saved without firing the organization's configured integration triggers (e.g. pushing the comment to a connected work-order system). |\n| `integrations` | array | no | Integration reference data to store on the comment. Normally set by integrations, not by callers. |\n\n### Behaviour\n- Watchers of tickets, PMs and rounds are notified of the new comment; mentioned and tagged members are notified on other record types.\n- The record's comment count is incremented.\n\n### Response\n`201` with the created comment in `data`.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"message\": \"Bad Request\",\n \"details\": [\n {\n \"message\": \"\\\"resource_id\\\" is required\",\n \"path\": [\n \"resource_id\"\n ],\n \"type\": \"any.required\",\n \"context\": {\n \"label\": \"resource_id\",\n \"key\": \"resource_id\"\n }\n }\n ]\n}"},{"id":"6dd3a62e-d5db-949d-75ab-9b778a4bb189","name":"404 Record not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"resource_type\": \"ticket\",\n \"resource_id\": \"{{ticket_id}}\",\n \"message\": \"Replaced the filter — @members/{{member_id}} please confirm on your next visit.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ],\n \"request_uuid\": \"86138b7a-a23e-47b3-8fd3-8f0dfc3f588f\",\n \"skip_integration_triggers\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/comments/","description":"Adds a comment to a Chekhub record (ticket, PM, round, asset, location, …).\n\n**Privilege:** `comments/c` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | The organization that owns the record. |\n| `resource_type` | string | yes | Singular type of the record the comment is on — e.g. `ticket`, `pm_instance`, `pm_interval`, `pm_series`, `rounds_instance`, `rounds_series`, `asset`, `location`, `checklist`, `member`. |\n| `resource_id` | ObjectId | yes | The `_id` of that record. It must exist and not be deleted, or the call returns `404`. |\n| `message` | string | yes | The comment text (max 5000 characters). Mention a person or team inline with `@members/` or `@teams/` — mentioned members are notified and returned in `mentions`. |\n| `tagged_entities` | array | no | Members/teams to tag without writing them into the text: `[{ \"_id\": \"\", \"resource_type\": \"member\" }]` (`member`/`members`, `team`/`teams`). Names are resolved server-side. |\n| `request_uuid` | string | no | Idempotency key, max 64 chars — generate one per comment (a UUID). If a retry of the same create arrives with the same key, from the same author, on the same record, the API returns the comment created by the first attempt (`201`) instead of creating a duplicate. This holds even if that comment was deleted since. Recommended for any client that retries on timeout. |\n| `skip_integration_triggers` | boolean | no | Default `false`. When `true`, the comment is saved without firing the organization's configured integration triggers (e.g. pushing the comment to a connected work-order system). |\n| `integrations` | array | no | Integration reference data to store on the comment. Normally set by integrations, not by callers. |\n\n### Behaviour\n- Watchers of tickets, PMs and rounds are notified of the new comment; mentioned and tagged members are notified on other record types.\n- The record's comment count is incremented.\n\n### Response\n`201` with the created comment in `data`.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"comment/not-found\",\n \"message\": \"Not Found\",\n \"details\": \"The specified resource could not be found\"\n}"},{"id":"916b9f2d-15d1-43d1-3215-56441d983b77","name":"403 Missing privilege","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"resource_type\": \"ticket\",\n \"resource_id\": \"{{ticket_id}}\",\n \"message\": \"Replaced the filter — @members/{{member_id}} please confirm on your next visit.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ],\n \"request_uuid\": \"507d6b36-bfb9-4e98-aa12-0cac62ead66f\",\n \"skip_integration_triggers\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/comments/","description":"Adds a comment to a Chekhub record (ticket, PM, round, asset, location, …).\n\n**Privilege:** `comments/c` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | The organization that owns the record. |\n| `resource_type` | string | yes | Singular type of the record the comment is on — e.g. `ticket`, `pm_instance`, `pm_interval`, `pm_series`, `rounds_instance`, `rounds_series`, `asset`, `location`, `checklist`, `member`. |\n| `resource_id` | ObjectId | yes | The `_id` of that record. It must exist and not be deleted, or the call returns `404`. |\n| `message` | string | yes | The comment text (max 5000 characters). Mention a person or team inline with `@members/` or `@teams/` — mentioned members are notified and returned in `mentions`. |\n| `tagged_entities` | array | no | Members/teams to tag without writing them into the text: `[{ \"_id\": \"\", \"resource_type\": \"member\" }]` (`member`/`members`, `team`/`teams`). Names are resolved server-side. |\n| `request_uuid` | string | no | Idempotency key, max 64 chars — generate one per comment (a UUID). If a retry of the same create arrives with the same key, from the same author, on the same record, the API returns the comment created by the first attempt (`201`) instead of creating a duplicate. This holds even if that comment was deleted since. Recommended for any client that retries on timeout. |\n| `skip_integration_triggers` | boolean | no | Default `false`. When `true`, the comment is saved without firing the organization's configured integration triggers (e.g. pushing the comment to a connected work-order system). |\n| `integrations` | array | no | Integration reference data to store on the comment. Normally set by integrations, not by callers. |\n\n### Behaviour\n- Watchers of tickets, PMs and rounds are notified of the new comment; mentioned and tagged members are notified on other record types.\n- The record's comment count is incremented.\n\n### Response\n`201` with the created comment in `data`.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"forbidden\",\n \"message\": \"Forbidden\",\n \"details\": \"You are forbidden from performing this function\"\n}"}],"_postman_id":"2b329328-8dd4-7cf3-c0d8-51b34ed99cca"},{"name":"List Comments","id":"4dccd8f1-558f-a8d8-e8da-ee556edf02bc","request":{"method":"GET","header":[],"url":"https://api.chekhub.com/chat/v1/comments/?organization_id={{organization_id}}&reference_ids={{ticket_id}}&limit=100&reverse=true","description":"

Returns comments for your organization, usually scoped to one or more records with reference_ids.

\n

Privilege: comments/r · Organization: organization_id query parameter.

\n

Deleted comments are never returned. Without reference_ids, only comments written by your own organization are returned.

\n

Paging

\n

Results are ordered by entered_at (oldest first; reverse=true for newest first). To page, send limit, then pass the last item's index back as skip.

\n

Response

\n

200 with an array of comments in data.

\n

Authentication: your organization API key in the apikey header (see Accounts › Create API Key), or Authorization: Bearer <token>. Successful responses are { status, type, data, details, message, requested_at, responded_at }; errors are { status, code, message, details }.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","comments",""],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required. Your organization.

\n","type":"text/plain"},"key":"organization_id","value":"{{organization_id}}"},{"description":{"content":"

Comma-separated _ids of the records whose comments you want. When set, comments written by organizations you are actively connected to (Chekhub Connect customer/vendor) on those records are included too.

\n","type":"text/plain"},"key":"reference_ids","value":"{{ticket_id}}"},{"description":{"content":"

Max results. Default 1000, minimum 1.

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

Default false (oldest first). true returns newest first.

\n","type":"text/plain"},"key":"reverse","value":"true"},{"disabled":true,"description":{"content":"

Cursor for the next page: pass the index value of the last comment from the previous page (index is included whenever limit or skip is sent).

\n","type":"text/plain"},"key":"skip","value":""},{"disabled":true,"description":{"content":"

Comma-separated fields to order by. Default entered_at.

\n","type":"text/plain"},"key":"sort","value":""},{"disabled":true,"description":{"content":"

Comma-separated fields to return, e.g. message,created_by,created_at,attachments. Default returns every field.

\n","type":"text/plain"},"key":"show_fields","value":""},{"disabled":true,"description":{"content":"

Comma-separated states. Default ACTIVE.

\n","type":"text/plain"},"key":"states","value":""},{"disabled":true,"description":{"content":"

ISO 8601 datetime. Also: created_before, modified_after, modified_before, entered_after, entered_before.

\n","type":"text/plain"},"key":"created_after","value":""},{"disabled":true,"description":{"content":"

Accepted but not currently applied as a filter.

\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[{"id":"c8cc0565-3167-50f9-2829-fc24765bf80b","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.chekhub.com/chat/v1/comments/?organization_id={{organization_id}}&reference_ids={{ticket_id}}&limit=100&reverse=true","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","comments",""],"query":[{"key":"organization_id","value":"{{organization_id}}","description":"Required. Your organization."},{"key":"reference_ids","value":"{{ticket_id}}","description":"Comma-separated `_id`s of the records whose comments you want. When set, comments written by organizations you are actively connected to (Chekhub Connect customer/vendor) on those records are included too."},{"key":"limit","value":"100","description":"Max results. Default 1000, minimum 1."},{"key":"reverse","value":"true","description":"Default `false` (oldest first). `true` returns newest first."},{"key":"skip","value":"","description":"Cursor for the next page: pass the `index` value of the last comment from the previous page (`index` is included whenever `limit` or `skip` is sent).","disabled":true},{"key":"sort","value":"","description":"Comma-separated fields to order by. Default `entered_at`.","disabled":true},{"key":"show_fields","value":"","description":"Comma-separated fields to return, e.g. `message,created_by,created_at,attachments`. Default returns every field.","disabled":true},{"key":"states","value":"","description":"Comma-separated states. Default `ACTIVE`.","disabled":true},{"key":"created_after","value":"","description":"ISO 8601 datetime. Also: `created_before`, `modified_after`, `modified_before`, `entered_after`, `entered_before`.","disabled":true},{"key":"search","value":"","description":"Accepted but not currently applied as a filter.","disabled":true}]},"description":"Returns comments for your organization, usually scoped to one or more records with `reference_ids`.\n\n**Privilege:** `comments/r` · **Organization:** `organization_id` query parameter.\n\nDeleted comments are never returned. Without `reference_ids`, only comments written by your own organization are returned.\n\n### Paging\nResults are ordered by `entered_at` (oldest first; `reverse=true` for newest first). To page, send `limit`, then pass the last item's `index` back as `skip`.\n\n### Response\n`200` with an array of comments in `data`.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"type\": \"json\",\n \"data\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60005\",\n \"organization\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60001\",\n \"name\": \"Example Facilities Co.\"\n },\n \"entered_at\": \"2026-09-29T14:03:11.482Z\",\n \"message\": \"Replaced the filter — @members/64b7f0c2a1b2c3d4e5f60004 please confirm on your next visit.\",\n \"skip_reason\": false,\n \"references\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60002\",\n \"name\": \"Rooftop unit 3 not cooling\",\n \"resource_type\": \"ticket\"\n }\n ],\n \"attachments\": [],\n \"mentions\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60004\",\n \"name\": \"Sam Lee\",\n \"image\": null,\n \"resource_type\": \"members\"\n }\n ],\n \"tagged_entities\": [],\n \"request_uuid\": \"5b1f7a52-6c0e-4b8e-9d7e-2f4a1c9e0b33\",\n \"created_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"created_at\": \"2026-09-29T14:03:11.482Z\",\n \"modified_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"modified_at\": \"2026-09-29T14:03:11.482Z\",\n \"state\": \"ACTIVE\",\n \"integrations\": [],\n \"index\": \"2026-09-29T14:03:11.482Z64b7f0c2a1b2c3d4e5f60005\"\n }\n ],\n \"details\": \"Successfully retrieved the comments\",\n \"message\": \"OK\",\n \"requested_at\": \"2026-09-29 14:03:11.301\",\n \"responded_at\": \"2026-09-29 14:03:11.517\"\n}"}],"_postman_id":"4dccd8f1-558f-a8d8-e8da-ee556edf02bc"},{"name":"Update Comment","id":"11c4f4c3-3727-ae20-f005-ea743b6df161","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"message\": \"Replaced the filter and reset the thermostat.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/comments/:comment_id","description":"

Edits a comment's text or tags. Only the comment's author can edit it.

\n

Privilege: comments/u · Organization: organization_id in the body.

\n

Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredNotes
organization_idObjectIdyesYour organization.
messagestringnoNew text (max 5000 characters). Omit to keep the current text. Mentions (@members/<id>, @teams/<id>) are recalculated from the new text.
tagged_entitiesarraynoReplaces the tagged members/teams. Omit to keep the current tags.
\n

Response

\n

200 with the updated comment in data. 403 if you are not the author, 404 if the comment doesn't exist or was deleted.

\n

Authentication: your organization API key in the apikey header (see Accounts › Create API Key), or Authorization: Bearer <token>. Successful responses are { status, type, data, details, message, requested_at, responded_at }; errors are { status, code, message, details }.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","comments",":comment_id"],"host":["api","chekhub","com"],"query":[],"variable":[{"type":"any","key":"comment_id"}]}},"response":[{"id":"786d87e0-fd0f-bb0d-ec3a-c403a94529be","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"message\": \"Replaced the filter and reset the thermostat.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.chekhub.com/chat/v1/comments/:comment_id","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","comments",":comment_id"],"variable":[{"key":"comment_id"}]},"description":"Edits a comment's text or tags. Only the comment's author can edit it.\n\n**Privilege:** `comments/u` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | Your organization. |\n| `message` | string | no | New text (max 5000 characters). Omit to keep the current text. Mentions (`@members/`, `@teams/`) are recalculated from the new text. |\n| `tagged_entities` | array | no | Replaces the tagged members/teams. Omit to keep the current tags. |\n\n### Response\n`200` with the updated comment in `data`. `403` if you are not the author, `404` if the comment doesn't exist or was deleted.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"type\": \"json\",\n \"data\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60005\",\n \"organization\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60001\",\n \"name\": \"Example Facilities Co.\"\n },\n \"entered_at\": \"2026-09-29T14:03:11.482Z\",\n \"message\": \"Replaced the filter and reset the thermostat.\",\n \"skip_reason\": false,\n \"references\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60002\",\n \"name\": \"Rooftop unit 3 not cooling\",\n \"resource_type\": \"ticket\"\n }\n ],\n \"attachments\": [],\n \"mentions\": [],\n \"tagged_entities\": [],\n \"request_uuid\": \"5b1f7a52-6c0e-4b8e-9d7e-2f4a1c9e0b33\",\n \"created_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"created_at\": \"2026-09-29T14:03:11.482Z\",\n \"modified_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"modified_at\": \"2026-09-29T15:20:44.019Z\",\n \"state\": \"ACTIVE\",\n \"integrations\": []\n },\n \"details\": \"Successfully updated the comment\",\n \"message\": \"OK\",\n \"requested_at\": \"2026-09-29 15:20:43.870\",\n \"responded_at\": \"2026-09-29 15:20:44.052\"\n}"},{"id":"563a961c-3bbf-b66d-c608-660a23a83124","name":"403 Not the author","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"message\": \"Replaced the filter and reset the thermostat.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.chekhub.com/chat/v1/comments/:comment_id","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","comments",":comment_id"],"variable":[{"key":"comment_id"}]},"description":"Edits a comment's text or tags. Only the comment's author can edit it.\n\n**Privilege:** `comments/u` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | Your organization. |\n| `message` | string | no | New text (max 5000 characters). Omit to keep the current text. Mentions (`@members/`, `@teams/`) are recalculated from the new text. |\n| `tagged_entities` | array | no | Replaces the tagged members/teams. Omit to keep the current tags. |\n\n### Response\n`200` with the updated comment in `data`. `403` if you are not the author, `404` if the comment doesn't exist or was deleted.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"comment/forbidden\",\n \"message\": \"Forbidden\",\n \"details\": \"You are not the author, you cannot update/delete comment\"\n}"},{"id":"7667b2b2-02f5-9d76-9851-c0d2f2083df7","name":"404 Not found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"message\": \"Replaced the filter and reset the thermostat.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.chekhub.com/chat/v1/comments/:comment_id","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","comments",":comment_id"],"variable":[{"key":"comment_id"}]},"description":"Edits a comment's text or tags. Only the comment's author can edit it.\n\n**Privilege:** `comments/u` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | Your organization. |\n| `message` | string | no | New text (max 5000 characters). Omit to keep the current text. Mentions (`@members/`, `@teams/`) are recalculated from the new text. |\n| `tagged_entities` | array | no | Replaces the tagged members/teams. Omit to keep the current tags. |\n\n### Response\n`200` with the updated comment in `data`. `403` if you are not the author, `404` if the comment doesn't exist or was deleted.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"comment/not-found\",\n \"message\": \"Not Found\",\n \"details\": \"The specified resource could not be found\"\n}"}],"_postman_id":"11c4f4c3-3727-ae20-f005-ea743b6df161"},{"name":"Delete Comment","id":"d6de9415-ff0f-1f9a-8b0d-0e47824cd695","request":{"method":"DELETE","header":[],"url":"https://api.chekhub.com/chat/v1/comments/:comment_id?organization_id={{organization_id}}&resource_type=ticket","description":"

Deletes a comment. Only the comment's author can delete it. The comment is soft-deleted (state: DELETED) and no longer appears in lists.

\n

Privilege: comments/d · Organization: organization_id query parameter.

\n

Response

\n

200 with the deleted comment in data. 403 if you are not the author, 404 if it doesn't exist or is already deleted.

\n

Authentication: your organization API key in the apikey header (see Accounts › Create API Key), or Authorization: Bearer <token>. Successful responses are { status, type, data, details, message, requested_at, responded_at }; errors are { status, code, message, details }.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","comments",":comment_id"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required. Your organization.

\n","type":"text/plain"},"key":"organization_id","value":"{{organization_id}}"},{"description":{"content":"

Recommended. The type of the record the comment is on (same value used on create). Used to decrement that record's comment count; if omitted the comment is still deleted but the count is not updated.

\n","type":"text/plain"},"key":"resource_type","value":"ticket"}],"variable":[{"type":"any","key":"comment_id"}]}},"response":[{"id":"92bcf45f-12ae-8774-d775-3ad0576480aa","name":"200 OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chekhub.com/chat/v1/comments/:comment_id?organization_id={{organization_id}}&resource_type=ticket","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","comments",":comment_id"],"query":[{"value":"{{organization_id}}","description":"Required. Your organization.","key":"organization_id"},{"value":"ticket","description":"Recommended. The type of the record the comment is on (same value used on create). Used to decrement that record's comment count; if omitted the comment is still deleted but the count is not updated.","key":"resource_type"}],"variable":[{"key":"comment_id"}]},"description":"Deletes a comment. Only the comment's author can delete it. The comment is soft-deleted (`state: DELETED`) and no longer appears in lists.\n\n**Privilege:** `comments/d` · **Organization:** `organization_id` query parameter.\n\n### Response\n`200` with the deleted comment in `data`. `403` if you are not the author, `404` if it doesn't exist or is already deleted.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"type\": \"json\",\n \"data\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60005\",\n \"organization\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60001\",\n \"name\": \"Example Facilities Co.\"\n },\n \"entered_at\": \"2026-09-29T14:03:11.482Z\",\n \"message\": \"Replaced the filter — @members/64b7f0c2a1b2c3d4e5f60004 please confirm on your next visit.\",\n \"skip_reason\": false,\n \"references\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60002\",\n \"name\": \"Rooftop unit 3 not cooling\",\n \"resource_type\": \"ticket\"\n }\n ],\n \"attachments\": [],\n \"mentions\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60004\",\n \"name\": \"Sam Lee\",\n \"image\": null,\n \"resource_type\": \"members\"\n }\n ],\n \"tagged_entities\": [],\n \"request_uuid\": \"5b1f7a52-6c0e-4b8e-9d7e-2f4a1c9e0b33\",\n \"created_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"created_at\": \"2026-09-29T14:03:11.482Z\",\n \"modified_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"modified_at\": \"2026-09-29T14:03:11.482Z\",\n \"state\": \"DELETED\",\n \"integrations\": []\n },\n \"details\": \"Successfully deleted the comment\",\n \"message\": \"OK\",\n \"requested_at\": \"2026-09-29 14:03:11.301\",\n \"responded_at\": \"2026-09-29 14:03:11.517\"\n}"},{"id":"44a87bbd-8cb4-f58d-dbe4-b16f95ecc7dc","name":"403 Not the author","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chekhub.com/chat/v1/comments/:comment_id?organization_id={{organization_id}}&resource_type=ticket","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","comments",":comment_id"],"query":[{"value":"{{organization_id}}","description":"Required. Your organization.","key":"organization_id"},{"value":"ticket","description":"Recommended. The type of the record the comment is on (same value used on create). Used to decrement that record's comment count; if omitted the comment is still deleted but the count is not updated.","key":"resource_type"}],"variable":[{"key":"comment_id"}]},"description":"Deletes a comment. Only the comment's author can delete it. The comment is soft-deleted (`state: DELETED`) and no longer appears in lists.\n\n**Privilege:** `comments/d` · **Organization:** `organization_id` query parameter.\n\n### Response\n`200` with the deleted comment in `data`. `403` if you are not the author, `404` if it doesn't exist or is already deleted.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"comment/forbidden\",\n \"message\": \"Forbidden\",\n \"details\": \"You are not the author, you cannot update/delete comment\"\n}"}],"_postman_id":"d6de9415-ff0f-1f9a-8b0d-0e47824cd695"},{"name":"Add Comment Attachment","id":"d461a022-5743-ad54-dfc3-914526c76d6f","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"type":"file","description":"

Required. The file to attach (multipart field name file).

\n","value":"","key":"file"},{"type":"text","description":"

Optional boolean. Send true when attaching files as part of creating the comment, so the comment's modified-by/modified-at are left as the original create.

\n","value":"true","key":"initial_comment"}]},"url":"https://api.chekhub.com/chat/v1/comments/:comment_id/attachments?organization_id={{organization_id}}","description":"

Uploads a file and attaches it to a comment. Only the comment's author can add attachments.

\n

Privilege: comments/c · Organization: organization_id query parameter. Send as multipart/form-data.

\n

Typical flow: Create Comment first, then call this once per file with initial_comment=true.

\n

The uploaded file is also stored in the organization's media library, referenced to the comment and its record.

\n

Response

\n

201 with the updated comment in data; the new file is in attachments (its _id is the attachment_id for Delete Comment Attachment). 406 if no file is sent.

\n

Authentication: your organization API key in the apikey header (see Accounts › Create API Key), or Authorization: Bearer <token>. Successful responses are { status, type, data, details, message, requested_at, responded_at }; errors are { status, code, message, details }.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","comments",":comment_id","attachments"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required. Your organization.

\n","type":"text/plain"},"key":"organization_id","value":"{{organization_id}}"}],"variable":[{"type":"any","key":"comment_id"}]}},"response":[{"id":"587e6c9a-7d51-88af-bd17-2baace949046","name":"201 Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"type":"file","description":"Required. The file to attach (multipart field name `file`).","value":"","key":"file"},{"type":"text","description":"Optional boolean. Send `true` when attaching files as part of creating the comment, so the comment's modified-by/modified-at are left as the original create.","value":"true","key":"initial_comment"}]},"url":{"raw":"https://api.chekhub.com/chat/v1/comments/:comment_id/attachments?organization_id={{organization_id}}","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","comments",":comment_id","attachments"],"query":[{"description":"Required. Your organization.","key":"organization_id","value":"{{organization_id}}"}],"variable":[{"key":"comment_id"}]},"description":"Uploads a file and attaches it to a comment. Only the comment's author can add attachments.\n\n**Privilege:** `comments/c` · **Organization:** `organization_id` query parameter. Send as `multipart/form-data`.\n\nTypical flow: **Create Comment** first, then call this once per file with `initial_comment=true`.\n\nThe uploaded file is also stored in the organization's media library, referenced to the comment and its record.\n\n### Response\n`201` with the updated comment in `data`; the new file is in `attachments` (its `_id` is the `attachment_id` for **Delete Comment Attachment**). `406` if no file is sent.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"type\": \"json\",\n \"data\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60005\",\n \"organization\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60001\",\n \"name\": \"Example Facilities Co.\"\n },\n \"entered_at\": \"2026-09-29T14:03:11.482Z\",\n \"message\": \"Replaced the filter — @members/64b7f0c2a1b2c3d4e5f60004 please confirm on your next visit.\",\n \"skip_reason\": false,\n \"references\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60002\",\n \"name\": \"Rooftop unit 3 not cooling\",\n \"resource_type\": \"ticket\"\n }\n ],\n \"attachments\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60006\",\n \"name\": \"filter-photo.jpg\",\n \"extension\": \"jpg\",\n \"modified_at\": \"2026-09-29T14:03:11.482Z\",\n \"created_at\": \"2026-09-29T14:03:11.482Z\",\n \"created_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"modified_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n }\n }\n ],\n \"mentions\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60004\",\n \"name\": \"Sam Lee\",\n \"image\": null,\n \"resource_type\": \"members\"\n }\n ],\n \"tagged_entities\": [],\n \"request_uuid\": \"5b1f7a52-6c0e-4b8e-9d7e-2f4a1c9e0b33\",\n \"created_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"created_at\": \"2026-09-29T14:03:11.482Z\",\n \"modified_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"modified_at\": \"2026-09-29T14:03:11.482Z\",\n \"state\": \"ACTIVE\",\n \"integrations\": []\n },\n \"details\": \"Successfully added the attachment\",\n \"message\": \"OK\",\n \"requested_at\": \"2026-09-29 14:03:11.301\",\n \"responded_at\": \"2026-09-29 14:03:11.517\"\n}"},{"id":"cb8046c5-902a-7f30-333a-0510c7d80195","name":"406 No file","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"type":"file","description":"Required. The file to attach (multipart field name `file`).","value":"","key":"file"},{"type":"text","description":"Optional boolean. Send `true` when attaching files as part of creating the comment, so the comment's modified-by/modified-at are left as the original create.","value":"true","key":"initial_comment"}]},"url":{"raw":"https://api.chekhub.com/chat/v1/comments/:comment_id/attachments?organization_id={{organization_id}}","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","comments",":comment_id","attachments"],"query":[{"description":"Required. Your organization.","key":"organization_id","value":"{{organization_id}}"}],"variable":[{"key":"comment_id"}]},"description":"Uploads a file and attaches it to a comment. Only the comment's author can add attachments.\n\n**Privilege:** `comments/c` · **Organization:** `organization_id` query parameter. Send as `multipart/form-data`.\n\nTypical flow: **Create Comment** first, then call this once per file with `initial_comment=true`.\n\nThe uploaded file is also stored in the organization's media library, referenced to the comment and its record.\n\n### Response\n`201` with the updated comment in `data`; the new file is in `attachments` (its `_id` is the `attachment_id` for **Delete Comment Attachment**). `406` if no file is sent.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"Not Acceptable","code":406,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 406,\n \"code\": \"teams/comments/attachments/bad-request\",\n \"message\": \"Missing required request parameters\",\n \"details\": \"Missing required parameters to process the request\"\n}"}],"_postman_id":"d461a022-5743-ad54-dfc3-914526c76d6f"},{"name":"Delete Comment Attachment","id":"0ce0e9d2-23b1-731b-8415-07e97de5f7a9","request":{"method":"DELETE","header":[],"url":"https://api.chekhub.com/chat/v1/comments/:comment_id/attachments/:attachment_id?organization_id={{organization_id}}","description":"

Removes a file from a comment. Only the comment's author can remove attachments.

\n

Privilege: comments/d · Organization: organization_id query parameter.

\n

Response

\n

200 with the updated comment in data. 404 if the comment or the attachment doesn't exist.

\n

Authentication: your organization API key in the apikey header (see Accounts › Create API Key), or Authorization: Bearer <token>. Successful responses are { status, type, data, details, message, requested_at, responded_at }; errors are { status, code, message, details }.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","comments",":comment_id","attachments",":attachment_id"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required. Your organization.

\n","type":"text/plain"},"key":"organization_id","value":"{{organization_id}}"}],"variable":[{"type":"any","key":"comment_id"},{"type":"any","key":"attachment_id"}]}},"response":[{"id":"00a8248f-e96e-23b2-9a91-505780ae4449","name":"200 OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chekhub.com/chat/v1/comments/:comment_id/attachments/:attachment_id?organization_id={{organization_id}}","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","comments",":comment_id","attachments",":attachment_id"],"query":[{"description":"Required. Your organization.","value":"{{organization_id}}","key":"organization_id"}],"variable":[{"key":"comment_id"},{"key":"attachment_id"}]},"description":"Removes a file from a comment. Only the comment's author can remove attachments.\n\n**Privilege:** `comments/d` · **Organization:** `organization_id` query parameter.\n\n### Response\n`200` with the updated comment in `data`. `404` if the comment or the attachment doesn't exist.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"type\": \"json\",\n \"data\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60005\",\n \"organization\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60001\",\n \"name\": \"Example Facilities Co.\"\n },\n \"entered_at\": \"2026-09-29T14:03:11.482Z\",\n \"message\": \"Replaced the filter — @members/64b7f0c2a1b2c3d4e5f60004 please confirm on your next visit.\",\n \"skip_reason\": false,\n \"references\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60002\",\n \"name\": \"Rooftop unit 3 not cooling\",\n \"resource_type\": \"ticket\"\n }\n ],\n \"attachments\": [],\n \"mentions\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60004\",\n \"name\": \"Sam Lee\",\n \"image\": null,\n \"resource_type\": \"members\"\n }\n ],\n \"tagged_entities\": [],\n \"request_uuid\": \"5b1f7a52-6c0e-4b8e-9d7e-2f4a1c9e0b33\",\n \"created_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"created_at\": \"2026-09-29T14:03:11.482Z\",\n \"modified_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"modified_at\": \"2026-09-29T14:03:11.482Z\",\n \"state\": \"ACTIVE\",\n \"integrations\": []\n },\n \"details\": \"Successfully removed the attachment\",\n \"message\": \"OK\",\n \"requested_at\": \"2026-09-29 14:03:11.301\",\n \"responded_at\": \"2026-09-29 14:03:11.517\"\n}"},{"id":"e576584c-4032-5217-db52-2d256547f879","name":"404 Attachment not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chekhub.com/chat/v1/comments/:comment_id/attachments/:attachment_id?organization_id={{organization_id}}","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","comments",":comment_id","attachments",":attachment_id"],"query":[{"description":"Required. Your organization.","value":"{{organization_id}}","key":"organization_id"}],"variable":[{"key":"comment_id"},{"key":"attachment_id"}]},"description":"Removes a file from a comment. Only the comment's author can remove attachments.\n\n**Privilege:** `comments/d` · **Organization:** `organization_id` query parameter.\n\n### Response\n`200` with the updated comment in `data`. `404` if the comment or the attachment doesn't exist.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`.\n"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"comment/attachment-not-found\",\n \"message\": \"Not Found\",\n \"details\": \"The specified comment attachment could not be found\"\n}"}],"_postman_id":"0ce0e9d2-23b1-731b-8415-07e97de5f7a9"}],"id":"4727e6f8-6ba3-42fa-bcd4-866fdcb53054","_postman_id":"4727e6f8-6ba3-42fa-bcd4-866fdcb53054","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}}},{"name":"Notes","item":[{"name":"Create Note","id":"cfe36745-190f-ebc8-0f6e-5dad4ff20648","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"resource_type\": \"ticket\",\n \"resource_id\": \"{{ticket_id}}\",\n \"message\": \"Replaced the filter — @members/{{member_id}} please confirm on your next visit.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ],\n \"request_uuid\": \"79c6b672-75a4-448e-a253-14e09f34a61a\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/notes/","description":"

Adds a note to a Chekhub record (ticket, PM, round, asset, location, …).

\n

Privilege: notes/c · Organization: organization_id in the body.

\n

Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredNotes
organization_idObjectIdyesThe organization that owns the record.
resource_typestringyesSingular type of the record the note is on — e.g. ticket, pm_instance, pm_interval, pm_series, rounds_instance, rounds_series, asset, location, checklist, member.
resource_idObjectIdyesThe _id of that record. It must exist and not be deleted, or the call returns 404.
messagestringyesThe note text (max 5000 characters). Mention a person or team inline with @members/<member_id> or @teams/<team_id> — mentioned members are notified and returned in mentions.
tagged_entitiesarraynoMembers/teams to tag without writing them into the text: [{ \"_id\": \"<id>\", \"resource_type\": \"member\" }] (member/members, team/teams). Names are resolved server-side.
request_uuidstringnoIdempotency key, max 64 chars — generate one per note (a UUID). If a retry of the same create arrives with the same key, from the same author, on the same record, the API returns the note created by the first attempt (201) instead of creating a duplicate. This holds even if that note was deleted since. Recommended for any client that retries on timeout.
\n

Behaviour

\n
    \n
  • Watchers of tickets, PMs and rounds are notified of the new note; mentioned and tagged members are notified on other record types.
    • \n
  • The record's note count is incremented.
    • \n
\n

Response

\n

201 with the created note in data.

\n

Authentication: your organization API key in the apikey header (see Accounts › Create API Key), or Authorization: Bearer <token>. Successful responses are { status, type, data, details, message, requested_at, responded_at }; errors are { status, code, message, details }. Notes share the comment error codes (comment/not-found, comment/forbidden, …).

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","notes",""],"host":["api","chekhub","com"],"query":[],"variable":[]}},"response":[{"id":"ba0b500a-486d-21d9-05db-b1171540a8e1","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"resource_type\": \"ticket\",\n \"resource_id\": \"{{ticket_id}}\",\n \"message\": \"Replaced the filter — @members/{{member_id}} please confirm on your next visit.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ],\n \"request_uuid\": \"b8960fd0-3ed4-41ce-8b9d-38a848a0e70f\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/notes/","description":"Adds a note to a Chekhub record (ticket, PM, round, asset, location, …).\n\n**Privilege:** `notes/c` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | The organization that owns the record. |\n| `resource_type` | string | yes | Singular type of the record the note is on — e.g. `ticket`, `pm_instance`, `pm_interval`, `pm_series`, `rounds_instance`, `rounds_series`, `asset`, `location`, `checklist`, `member`. |\n| `resource_id` | ObjectId | yes | The `_id` of that record. It must exist and not be deleted, or the call returns `404`. |\n| `message` | string | yes | The note text (max 5000 characters). Mention a person or team inline with `@members/` or `@teams/` — mentioned members are notified and returned in `mentions`. |\n| `tagged_entities` | array | no | Members/teams to tag without writing them into the text: `[{ \"_id\": \"\", \"resource_type\": \"member\" }]` (`member`/`members`, `team`/`teams`). Names are resolved server-side. |\n| `request_uuid` | string | no | Idempotency key, max 64 chars — generate one per note (a UUID). If a retry of the same create arrives with the same key, from the same author, on the same record, the API returns the note created by the first attempt (`201`) instead of creating a duplicate. This holds even if that note was deleted since. Recommended for any client that retries on timeout. |\n\n### Behaviour\n- Watchers of tickets, PMs and rounds are notified of the new note; mentioned and tagged members are notified on other record types.\n- The record's note count is incremented.\n\n### Response\n`201` with the created note in `data`.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"type\": \"json\",\n \"data\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60005\",\n \"organization\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60001\",\n \"name\": \"Example Facilities Co.\"\n },\n \"entered_at\": \"2026-09-29T14:03:11.482Z\",\n \"message\": \"Replaced the filter — @members/64b7f0c2a1b2c3d4e5f60004 please confirm on your next visit.\",\n \"skip_reason\": false,\n \"references\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60002\",\n \"name\": \"Rooftop unit 3 not cooling\",\n \"resource_type\": \"ticket\"\n }\n ],\n \"attachments\": [],\n \"mentions\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60004\",\n \"name\": \"Sam Lee\",\n \"image\": null,\n \"resource_type\": \"members\"\n }\n ],\n \"tagged_entities\": [],\n \"request_uuid\": \"5b1f7a52-6c0e-4b8e-9d7e-2f4a1c9e0b33\",\n \"created_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"created_at\": \"2026-09-29T14:03:11.482Z\",\n \"modified_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"modified_at\": \"2026-09-29T14:03:11.482Z\",\n \"state\": \"ACTIVE\"\n },\n \"details\": \"Successfully created the note\",\n \"message\": \"OK\",\n \"requested_at\": \"2026-09-29 14:03:11.301\",\n \"responded_at\": \"2026-09-29 14:03:11.517\"\n}"},{"id":"fe6d4430-e3bb-68e1-e540-33e3437bee3a","name":"400 Missing field","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"resource_type\": \"ticket\",\n \"resource_id\": \"{{ticket_id}}\",\n \"message\": \"Replaced the filter — @members/{{member_id}} please confirm on your next visit.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ],\n \"request_uuid\": \"c28e1c23-03ff-4279-89f0-e199039459b9\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/notes/","description":"Adds a note to a Chekhub record (ticket, PM, round, asset, location, …).\n\n**Privilege:** `notes/c` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | The organization that owns the record. |\n| `resource_type` | string | yes | Singular type of the record the note is on — e.g. `ticket`, `pm_instance`, `pm_interval`, `pm_series`, `rounds_instance`, `rounds_series`, `asset`, `location`, `checklist`, `member`. |\n| `resource_id` | ObjectId | yes | The `_id` of that record. It must exist and not be deleted, or the call returns `404`. |\n| `message` | string | yes | The note text (max 5000 characters). Mention a person or team inline with `@members/` or `@teams/` — mentioned members are notified and returned in `mentions`. |\n| `tagged_entities` | array | no | Members/teams to tag without writing them into the text: `[{ \"_id\": \"\", \"resource_type\": \"member\" }]` (`member`/`members`, `team`/`teams`). Names are resolved server-side. |\n| `request_uuid` | string | no | Idempotency key, max 64 chars — generate one per note (a UUID). If a retry of the same create arrives with the same key, from the same author, on the same record, the API returns the note created by the first attempt (`201`) instead of creating a duplicate. This holds even if that note was deleted since. Recommended for any client that retries on timeout. |\n\n### Behaviour\n- Watchers of tickets, PMs and rounds are notified of the new note; mentioned and tagged members are notified on other record types.\n- The record's note count is incremented.\n\n### Response\n`201` with the created note in `data`.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"message\": \"Bad Request\",\n \"details\": [\n {\n \"message\": \"\\\"resource_id\\\" is required\",\n \"path\": [\n \"resource_id\"\n ],\n \"type\": \"any.required\",\n \"context\": {\n \"label\": \"resource_id\",\n \"key\": \"resource_id\"\n }\n }\n ]\n}"},{"id":"51d602d2-3a91-9c3a-a045-12e3cdff8876","name":"404 Record not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"resource_type\": \"ticket\",\n \"resource_id\": \"{{ticket_id}}\",\n \"message\": \"Replaced the filter — @members/{{member_id}} please confirm on your next visit.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ],\n \"request_uuid\": \"ebdc4f6c-7d23-4024-a174-b1c3235769ef\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/notes/","description":"Adds a note to a Chekhub record (ticket, PM, round, asset, location, …).\n\n**Privilege:** `notes/c` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | The organization that owns the record. |\n| `resource_type` | string | yes | Singular type of the record the note is on — e.g. `ticket`, `pm_instance`, `pm_interval`, `pm_series`, `rounds_instance`, `rounds_series`, `asset`, `location`, `checklist`, `member`. |\n| `resource_id` | ObjectId | yes | The `_id` of that record. It must exist and not be deleted, or the call returns `404`. |\n| `message` | string | yes | The note text (max 5000 characters). Mention a person or team inline with `@members/` or `@teams/` — mentioned members are notified and returned in `mentions`. |\n| `tagged_entities` | array | no | Members/teams to tag without writing them into the text: `[{ \"_id\": \"\", \"resource_type\": \"member\" }]` (`member`/`members`, `team`/`teams`). Names are resolved server-side. |\n| `request_uuid` | string | no | Idempotency key, max 64 chars — generate one per note (a UUID). If a retry of the same create arrives with the same key, from the same author, on the same record, the API returns the note created by the first attempt (`201`) instead of creating a duplicate. This holds even if that note was deleted since. Recommended for any client that retries on timeout. |\n\n### Behaviour\n- Watchers of tickets, PMs and rounds are notified of the new note; mentioned and tagged members are notified on other record types.\n- The record's note count is incremented.\n\n### Response\n`201` with the created note in `data`.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"comment/not-found\",\n \"message\": \"Not Found\",\n \"details\": \"The specified resource could not be found\"\n}"},{"id":"4e786026-6b21-2ff3-bdb3-c0b3af9d5cf5","name":"403 Missing privilege","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"resource_type\": \"ticket\",\n \"resource_id\": \"{{ticket_id}}\",\n \"message\": \"Replaced the filter — @members/{{member_id}} please confirm on your next visit.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ],\n \"request_uuid\": \"08098945-d4f7-4ab3-8ddf-1ead27dce336\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/notes/","description":"Adds a note to a Chekhub record (ticket, PM, round, asset, location, …).\n\n**Privilege:** `notes/c` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | The organization that owns the record. |\n| `resource_type` | string | yes | Singular type of the record the note is on — e.g. `ticket`, `pm_instance`, `pm_interval`, `pm_series`, `rounds_instance`, `rounds_series`, `asset`, `location`, `checklist`, `member`. |\n| `resource_id` | ObjectId | yes | The `_id` of that record. It must exist and not be deleted, or the call returns `404`. |\n| `message` | string | yes | The note text (max 5000 characters). Mention a person or team inline with `@members/` or `@teams/` — mentioned members are notified and returned in `mentions`. |\n| `tagged_entities` | array | no | Members/teams to tag without writing them into the text: `[{ \"_id\": \"\", \"resource_type\": \"member\" }]` (`member`/`members`, `team`/`teams`). Names are resolved server-side. |\n| `request_uuid` | string | no | Idempotency key, max 64 chars — generate one per note (a UUID). If a retry of the same create arrives with the same key, from the same author, on the same record, the API returns the note created by the first attempt (`201`) instead of creating a duplicate. This holds even if that note was deleted since. Recommended for any client that retries on timeout. |\n\n### Behaviour\n- Watchers of tickets, PMs and rounds are notified of the new note; mentioned and tagged members are notified on other record types.\n- The record's note count is incremented.\n\n### Response\n`201` with the created note in `data`.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"forbidden\",\n \"message\": \"Forbidden\",\n \"details\": \"You are forbidden from performing this function\"\n}"}],"_postman_id":"cfe36745-190f-ebc8-0f6e-5dad4ff20648"},{"name":"List Notes","id":"4e4c5f7c-ef9a-aea0-4472-c441e96fc621","request":{"method":"GET","header":[],"url":"https://api.chekhub.com/chat/v1/notes/?organization_id={{organization_id}}&reference_ids={{ticket_id}}&limit=100&reverse=true","description":"

Returns notes for your organization, usually scoped to one or more records with reference_ids.

\n

Privilege: notes/r · Organization: organization_id query parameter.

\n

Deleted notes are never returned. Without reference_ids, only notes written by your own organization are returned.

\n

Paging

\n

Results are ordered by entered_at (oldest first; reverse=true for newest first). To page, send limit, then pass the last item's index back as skip.

\n

Response

\n

200 with an array of notes in data.

\n

Authentication: your organization API key in the apikey header (see Accounts › Create API Key), or Authorization: Bearer <token>. Successful responses are { status, type, data, details, message, requested_at, responded_at }; errors are { status, code, message, details }. Notes share the comment error codes (comment/not-found, comment/forbidden, …).

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","notes",""],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required. Your organization.

\n","type":"text/plain"},"key":"organization_id","value":"{{organization_id}}"},{"description":{"content":"

Comma-separated _ids of the records whose notes you want. When set, notes written by organizations you are actively connected to (Chekhub Connect customer/vendor) on those records are included too.

\n","type":"text/plain"},"key":"reference_ids","value":"{{ticket_id}}"},{"description":{"content":"

Max results. Default 1000, minimum 1.

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

Default false (oldest first). true returns newest first.

\n","type":"text/plain"},"key":"reverse","value":"true"},{"disabled":true,"description":{"content":"

Cursor for the next page: pass the index value of the last note from the previous page (index is included whenever limit or skip is sent).

\n","type":"text/plain"},"key":"skip","value":""},{"disabled":true,"description":{"content":"

Comma-separated fields to order by. Default entered_at.

\n","type":"text/plain"},"key":"sort","value":""},{"disabled":true,"description":{"content":"

Comma-separated fields to return, e.g. message,created_by,created_at,attachments. Default returns every field.

\n","type":"text/plain"},"key":"show_fields","value":""},{"disabled":true,"description":{"content":"

Comma-separated states. Default ACTIVE.

\n","type":"text/plain"},"key":"states","value":""},{"disabled":true,"description":{"content":"

ISO 8601 datetime. Also: created_before, modified_after, modified_before, entered_after, entered_before.

\n","type":"text/plain"},"key":"created_after","value":""},{"disabled":true,"description":{"content":"

Accepted but not currently applied as a filter.

\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[{"id":"80120b58-8976-7b9e-0740-44eab79a51b9","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.chekhub.com/chat/v1/notes/?organization_id={{organization_id}}&reference_ids={{ticket_id}}&limit=100&reverse=true","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","notes",""],"query":[{"key":"organization_id","description":"Required. Your organization.","value":"{{organization_id}}"},{"key":"reference_ids","description":"Comma-separated `_id`s of the records whose notes you want. When set, notes written by organizations you are actively connected to (Chekhub Connect customer/vendor) on those records are included too.","value":"{{ticket_id}}"},{"key":"limit","description":"Max results. Default 1000, minimum 1.","value":"100"},{"key":"reverse","description":"Default `false` (oldest first). `true` returns newest first.","value":"true"},{"key":"skip","description":"Cursor for the next page: pass the `index` value of the last note from the previous page (`index` is included whenever `limit` or `skip` is sent).","value":"","disabled":true},{"key":"sort","description":"Comma-separated fields to order by. Default `entered_at`.","value":"","disabled":true},{"key":"show_fields","description":"Comma-separated fields to return, e.g. `message,created_by,created_at,attachments`. Default returns every field.","value":"","disabled":true},{"key":"states","description":"Comma-separated states. Default `ACTIVE`.","value":"","disabled":true},{"key":"created_after","description":"ISO 8601 datetime. Also: `created_before`, `modified_after`, `modified_before`, `entered_after`, `entered_before`.","value":"","disabled":true},{"key":"search","description":"Accepted but not currently applied as a filter.","value":"","disabled":true}]},"description":"Returns notes for your organization, usually scoped to one or more records with `reference_ids`.\n\n**Privilege:** `notes/r` · **Organization:** `organization_id` query parameter.\n\nDeleted notes are never returned. Without `reference_ids`, only notes written by your own organization are returned.\n\n### Paging\nResults are ordered by `entered_at` (oldest first; `reverse=true` for newest first). To page, send `limit`, then pass the last item's `index` back as `skip`.\n\n### Response\n`200` with an array of notes in `data`.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"type\": \"json\",\n \"data\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60005\",\n \"organization\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60001\",\n \"name\": \"Example Facilities Co.\"\n },\n \"entered_at\": \"2026-09-29T14:03:11.482Z\",\n \"message\": \"Replaced the filter — @members/64b7f0c2a1b2c3d4e5f60004 please confirm on your next visit.\",\n \"skip_reason\": false,\n \"references\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60002\",\n \"name\": \"Rooftop unit 3 not cooling\",\n \"resource_type\": \"ticket\"\n }\n ],\n \"attachments\": [],\n \"mentions\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60004\",\n \"name\": \"Sam Lee\",\n \"image\": null,\n \"resource_type\": \"members\"\n }\n ],\n \"tagged_entities\": [],\n \"request_uuid\": \"5b1f7a52-6c0e-4b8e-9d7e-2f4a1c9e0b33\",\n \"created_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"created_at\": \"2026-09-29T14:03:11.482Z\",\n \"modified_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"modified_at\": \"2026-09-29T14:03:11.482Z\",\n \"state\": \"ACTIVE\",\n \"index\": \"2026-09-29T14:03:11.482Z64b7f0c2a1b2c3d4e5f60005\"\n }\n ],\n \"details\": \"Successfully retrieved the notes\",\n \"message\": \"OK\",\n \"requested_at\": \"2026-09-29 14:03:11.301\",\n \"responded_at\": \"2026-09-29 14:03:11.517\"\n}"}],"_postman_id":"4e4c5f7c-ef9a-aea0-4472-c441e96fc621"},{"name":"Update Note","id":"2aae52e9-83fe-ccf8-62c6-54d1b84f4d3e","request":{"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"message\": \"Replaced the filter and reset the thermostat.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chekhub.com/chat/v1/notes/:note_id","description":"

Edits a note's text or tags. Only the note's author can edit it.

\n

Privilege: notes/u · Organization: organization_id in the body.

\n

Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredNotes
organization_idObjectIdyesYour organization.
messagestringnoNew text (max 5000 characters). Omit to keep the current text. Mentions (@members/<id>, @teams/<id>) are recalculated from the new text.
tagged_entitiesarraynoReplaces the tagged members/teams. Omit to keep the current tags.
\n

Response

\n

200 with the updated note in data. 403 if you are not the author, 404 if the note doesn't exist or was deleted.

\n

Authentication: your organization API key in the apikey header (see Accounts › Create API Key), or Authorization: Bearer <token>. Successful responses are { status, type, data, details, message, requested_at, responded_at }; errors are { status, code, message, details }. Notes share the comment error codes (comment/not-found, comment/forbidden, …).

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","notes",":note_id"],"host":["api","chekhub","com"],"query":[],"variable":[{"type":"any","key":"note_id"}]}},"response":[{"id":"a99d5d7f-e742-0cdc-54b1-12da1077952b","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"message\": \"Replaced the filter and reset the thermostat.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.chekhub.com/chat/v1/notes/:note_id","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","notes",":note_id"],"variable":[{"key":"note_id"}]},"description":"Edits a note's text or tags. Only the note's author can edit it.\n\n**Privilege:** `notes/u` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | Your organization. |\n| `message` | string | no | New text (max 5000 characters). Omit to keep the current text. Mentions (`@members/`, `@teams/`) are recalculated from the new text. |\n| `tagged_entities` | array | no | Replaces the tagged members/teams. Omit to keep the current tags. |\n\n### Response\n`200` with the updated note in `data`. `403` if you are not the author, `404` if the note doesn't exist or was deleted.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"type\": \"json\",\n \"data\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60005\",\n \"organization\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60001\",\n \"name\": \"Example Facilities Co.\"\n },\n \"entered_at\": \"2026-09-29T14:03:11.482Z\",\n \"message\": \"Replaced the filter and reset the thermostat.\",\n \"skip_reason\": false,\n \"references\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60002\",\n \"name\": \"Rooftop unit 3 not cooling\",\n \"resource_type\": \"ticket\"\n }\n ],\n \"attachments\": [],\n \"mentions\": [],\n \"tagged_entities\": [],\n \"request_uuid\": \"5b1f7a52-6c0e-4b8e-9d7e-2f4a1c9e0b33\",\n \"created_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"created_at\": \"2026-09-29T14:03:11.482Z\",\n \"modified_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"modified_at\": \"2026-09-29T15:20:44.019Z\",\n \"state\": \"ACTIVE\"\n },\n \"details\": \"Successfully updated the note\",\n \"message\": \"OK\",\n \"requested_at\": \"2026-09-29 15:20:43.870\",\n \"responded_at\": \"2026-09-29 15:20:44.052\"\n}"},{"id":"8aabb559-a16b-fc3d-8f49-8e83ea1fbb7e","name":"403 Not the author","originalRequest":{"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"message\": \"Replaced the filter and reset the thermostat.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.chekhub.com/chat/v1/notes/:note_id","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","notes",":note_id"],"variable":[{"key":"note_id"}]},"description":"Edits a note's text or tags. Only the note's author can edit it.\n\n**Privilege:** `notes/u` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | Your organization. |\n| `message` | string | no | New text (max 5000 characters). Omit to keep the current text. Mentions (`@members/`, `@teams/`) are recalculated from the new text. |\n| `tagged_entities` | array | no | Replaces the tagged members/teams. Omit to keep the current tags. |\n\n### Response\n`200` with the updated note in `data`. `403` if you are not the author, `404` if the note doesn't exist or was deleted.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"comment/forbidden\",\n \"message\": \"Forbidden\",\n \"details\": \"You are not the author, you cannot update/delete comment\"\n}"},{"id":"b004e740-15d7-3e8b-c18f-ef2836e7627f","name":"404 Not found","originalRequest":{"method":"PATCH","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"organization_id\": \"{{organization_id}}\",\n \"message\": \"Replaced the filter and reset the thermostat.\",\n \"tagged_entities\": [\n {\n \"_id\": \"{{member_id}}\",\n \"resource_type\": \"member\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.chekhub.com/chat/v1/notes/:note_id","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","notes",":note_id"],"variable":[{"key":"note_id"}]},"description":"Edits a note's text or tags. Only the note's author can edit it.\n\n**Privilege:** `notes/u` · **Organization:** `organization_id` in the body.\n\n### Body\n\n| Field | Type | Required | Notes |\n|---|---|---|---|\n| `organization_id` | ObjectId | yes | Your organization. |\n| `message` | string | no | New text (max 5000 characters). Omit to keep the current text. Mentions (`@members/`, `@teams/`) are recalculated from the new text. |\n| `tagged_entities` | array | no | Replaces the tagged members/teams. Omit to keep the current tags. |\n\n### Response\n`200` with the updated note in `data`. `403` if you are not the author, `404` if the note doesn't exist or was deleted.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"comment/not-found\",\n \"message\": \"Not Found\",\n \"details\": \"The specified resource could not be found\"\n}"}],"_postman_id":"2aae52e9-83fe-ccf8-62c6-54d1b84f4d3e"},{"name":"Delete Note","id":"9409538d-5c41-1217-07c4-9f680696463e","request":{"method":"DELETE","header":[],"url":"https://api.chekhub.com/chat/v1/notes/:note_id?organization_id={{organization_id}}&resource_type=ticket","description":"

Deletes a note. Only the note's author can delete it. The note is soft-deleted (state: DELETED) and no longer appears in lists.

\n

Privilege: notes/d · Organization: organization_id query parameter.

\n

Response

\n

200 with no data body. 403 if you are not the author, 404 if it doesn't exist or is already deleted.

\n

Authentication: your organization API key in the apikey header (see Accounts › Create API Key), or Authorization: Bearer <token>. Successful responses are { status, type, data, details, message, requested_at, responded_at }; errors are { status, code, message, details }. Notes share the comment error codes (comment/not-found, comment/forbidden, …).

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","notes",":note_id"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required. Your organization.

\n","type":"text/plain"},"key":"organization_id","value":"{{organization_id}}"},{"description":{"content":"

Recommended. The type of the record the note is on (same value used on create). Used to decrement that record's note count; if omitted the note is still deleted but the count is not updated.

\n","type":"text/plain"},"key":"resource_type","value":"ticket"}],"variable":[{"type":"any","key":"note_id"}]}},"response":[{"id":"594ab855-b1af-ab76-8835-5154b6316bf2","name":"200 OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chekhub.com/chat/v1/notes/:note_id?organization_id={{organization_id}}&resource_type=ticket","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","notes",":note_id"],"query":[{"key":"organization_id","description":"Required. Your organization.","value":"{{organization_id}}"},{"key":"resource_type","description":"Recommended. The type of the record the note is on (same value used on create). Used to decrement that record's note count; if omitted the note is still deleted but the count is not updated.","value":"ticket"}],"variable":[{"key":"note_id"}]},"description":"Deletes a note. Only the note's author can delete it. The note is soft-deleted (`state: DELETED`) and no longer appears in lists.\n\n**Privilege:** `notes/d` · **Organization:** `organization_id` query parameter.\n\n### Response\n`200` with no `data` body. `403` if you are not the author, `404` if it doesn't exist or is already deleted.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"type\": \"json\",\n \"details\": \"Successfully deleted the note\",\n \"message\": \"OK\",\n \"requested_at\": \"2026-09-29 14:03:11.301\",\n \"responded_at\": \"2026-09-29 14:03:11.517\"\n}"},{"id":"7c92ce37-7616-73e6-ae29-454aaae778a7","name":"403 Not the author","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chekhub.com/chat/v1/notes/:note_id?organization_id={{organization_id}}&resource_type=ticket","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","notes",":note_id"],"query":[{"key":"organization_id","description":"Required. Your organization.","value":"{{organization_id}}"},{"key":"resource_type","description":"Recommended. The type of the record the note is on (same value used on create). Used to decrement that record's note count; if omitted the note is still deleted but the count is not updated.","value":"ticket"}],"variable":[{"key":"note_id"}]},"description":"Deletes a note. Only the note's author can delete it. The note is soft-deleted (`state: DELETED`) and no longer appears in lists.\n\n**Privilege:** `notes/d` · **Organization:** `organization_id` query parameter.\n\n### Response\n`200` with no `data` body. `403` if you are not the author, `404` if it doesn't exist or is already deleted.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"code\": \"comment/forbidden\",\n \"message\": \"Forbidden\",\n \"details\": \"You are not the author, you cannot update/delete comment\"\n}"}],"_postman_id":"9409538d-5c41-1217-07c4-9f680696463e"},{"name":"Add Note Attachment","id":"ed119ff6-3c4a-1d31-8f84-18a894d93420","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"type":"file","value":"","description":"

Required. The file to attach (multipart field name file).

\n","key":"file"},{"type":"text","value":"true","description":"

Optional boolean. Send true when attaching files as part of creating the note, so the note's modified-by/modified-at are left as the original create.

\n","key":"initial_note"}]},"url":"https://api.chekhub.com/chat/v1/notes/:note_id/attachments?organization_id={{organization_id}}","description":"

Uploads a file and attaches it to a note. Only the note's author can add attachments.

\n

Privilege: notes/c · Organization: organization_id query parameter. Send as multipart/form-data.

\n

Typical flow: Create Note first, then call this once per file with initial_note=true.

\n

The uploaded file is also stored in the organization's media library, referenced to the note and its record.

\n

Response

\n

201 with the updated note in data; the new file is in attachments (its _id is the attachment_id for Delete Note Attachment). 406 if no file is sent.

\n

Authentication: your organization API key in the apikey header (see Accounts › Create API Key), or Authorization: Bearer <token>. Successful responses are { status, type, data, details, message, requested_at, responded_at }; errors are { status, code, message, details }. Notes share the comment error codes (comment/not-found, comment/forbidden, …).

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","notes",":note_id","attachments"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required. Your organization.

\n","type":"text/plain"},"key":"organization_id","value":"{{organization_id}}"}],"variable":[{"type":"any","key":"note_id"}]}},"response":[{"id":"0a3050a1-6de8-9290-693c-e7855f27d312","name":"201 Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"type":"file","value":"","description":"Required. The file to attach (multipart field name `file`).","key":"file"},{"type":"text","value":"true","description":"Optional boolean. Send `true` when attaching files as part of creating the note, so the note's modified-by/modified-at are left as the original create.","key":"initial_note"}]},"url":{"raw":"https://api.chekhub.com/chat/v1/notes/:note_id/attachments?organization_id={{organization_id}}","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","notes",":note_id","attachments"],"query":[{"value":"{{organization_id}}","description":"Required. Your organization.","key":"organization_id"}],"variable":[{"key":"note_id"}]},"description":"Uploads a file and attaches it to a note. Only the note's author can add attachments.\n\n**Privilege:** `notes/c` · **Organization:** `organization_id` query parameter. Send as `multipart/form-data`.\n\nTypical flow: **Create Note** first, then call this once per file with `initial_note=true`.\n\nThe uploaded file is also stored in the organization's media library, referenced to the note and its record.\n\n### Response\n`201` with the updated note in `data`; the new file is in `attachments` (its `_id` is the `attachment_id` for **Delete Note Attachment**). `406` if no file is sent.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"type\": \"json\",\n \"data\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60005\",\n \"organization\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60001\",\n \"name\": \"Example Facilities Co.\"\n },\n \"entered_at\": \"2026-09-29T14:03:11.482Z\",\n \"message\": \"Replaced the filter — @members/64b7f0c2a1b2c3d4e5f60004 please confirm on your next visit.\",\n \"skip_reason\": false,\n \"references\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60002\",\n \"name\": \"Rooftop unit 3 not cooling\",\n \"resource_type\": \"ticket\"\n }\n ],\n \"attachments\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60006\",\n \"name\": \"filter-photo.jpg\",\n \"extension\": \"jpg\",\n \"modified_at\": \"2026-09-29T14:03:11.482Z\",\n \"created_at\": \"2026-09-29T14:03:11.482Z\",\n \"created_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"modified_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n }\n }\n ],\n \"mentions\": [\n {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60004\",\n \"name\": \"Sam Lee\",\n \"image\": null,\n \"resource_type\": \"members\"\n }\n ],\n \"tagged_entities\": [],\n \"request_uuid\": \"5b1f7a52-6c0e-4b8e-9d7e-2f4a1c9e0b33\",\n \"created_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"created_at\": \"2026-09-29T14:03:11.482Z\",\n \"modified_by\": {\n \"_id\": \"64b7f0c2a1b2c3d4e5f60003\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"image\": null\n },\n \"modified_at\": \"2026-09-29T14:03:11.482Z\",\n \"state\": \"ACTIVE\"\n },\n \"details\": \"Successfully added the note\",\n \"message\": \"OK\",\n \"requested_at\": \"2026-09-29 14:03:11.301\",\n \"responded_at\": \"2026-09-29 14:03:11.517\"\n}"},{"id":"f312638d-89be-3307-3b4e-af23d515f0c4","name":"406 No file","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"type":"file","value":"","description":"Required. The file to attach (multipart field name `file`).","key":"file"},{"type":"text","value":"true","description":"Optional boolean. Send `true` when attaching files as part of creating the note, so the note's modified-by/modified-at are left as the original create.","key":"initial_note"}]},"url":{"raw":"https://api.chekhub.com/chat/v1/notes/:note_id/attachments?organization_id={{organization_id}}","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","notes",":note_id","attachments"],"query":[{"value":"{{organization_id}}","description":"Required. Your organization.","key":"organization_id"}],"variable":[{"key":"note_id"}]},"description":"Uploads a file and attaches it to a note. Only the note's author can add attachments.\n\n**Privilege:** `notes/c` · **Organization:** `organization_id` query parameter. Send as `multipart/form-data`.\n\nTypical flow: **Create Note** first, then call this once per file with `initial_note=true`.\n\nThe uploaded file is also stored in the organization's media library, referenced to the note and its record.\n\n### Response\n`201` with the updated note in `data`; the new file is in `attachments` (its `_id` is the `attachment_id` for **Delete Note Attachment**). `406` if no file is sent.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"Not Acceptable","code":406,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 406,\n \"code\": \"teams/comments/attachments/bad-request\",\n \"message\": \"Missing required request parameters\",\n \"details\": \"Missing required parameters to process the request\"\n}"}],"_postman_id":"ed119ff6-3c4a-1d31-8f84-18a894d93420"},{"name":"Delete Note Attachment","id":"d2b395f1-635e-5889-b65c-05bcba294071","request":{"method":"DELETE","header":[],"url":"https://api.chekhub.com/chat/v1/notes/:note_id/attachments/:attachment_id?organization_id={{organization_id}}","description":"

Removes a file from a note. Only the note's author can remove attachments.

\n

Privilege: notes/d · Organization: organization_id query parameter.

\n

Response

\n

200 with no data body. 404 if the note or the attachment doesn't exist.

\n

Authentication: your organization API key in the apikey header (see Accounts › Create API Key), or Authorization: Bearer <token>. Successful responses are { status, type, data, details, message, requested_at, responded_at }; errors are { status, code, message, details }. Notes share the comment error codes (comment/not-found, comment/forbidden, …).

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["chat","v1","notes",":note_id","attachments",":attachment_id"],"host":["api","chekhub","com"],"query":[{"description":{"content":"

Required. Your organization.

\n","type":"text/plain"},"key":"organization_id","value":"{{organization_id}}"}],"variable":[{"type":"any","key":"note_id"},{"type":"any","key":"attachment_id"}]}},"response":[{"id":"ccbea936-1d72-2a9d-50c7-ee36e42d5f16","name":"200 OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chekhub.com/chat/v1/notes/:note_id/attachments/:attachment_id?organization_id={{organization_id}}","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","notes",":note_id","attachments",":attachment_id"],"query":[{"description":"Required. Your organization.","value":"{{organization_id}}","key":"organization_id"}],"variable":[{"key":"note_id"},{"key":"attachment_id"}]},"description":"Removes a file from a note. Only the note's author can remove attachments.\n\n**Privilege:** `notes/d` · **Organization:** `organization_id` query parameter.\n\n### Response\n`200` with no `data` body. `404` if the note or the attachment doesn't exist.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"type\": \"json\",\n \"details\": \"Successfully deleted the note\",\n \"message\": \"OK\",\n \"requested_at\": \"2026-09-29 14:03:11.301\",\n \"responded_at\": \"2026-09-29 14:03:11.517\"\n}"},{"id":"0e15a110-2423-72ab-020e-93ca4a90ccf5","name":"404 Attachment not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.chekhub.com/chat/v1/notes/:note_id/attachments/:attachment_id?organization_id={{organization_id}}","protocol":"https","host":["api","chekhub","com"],"path":["chat","v1","notes",":note_id","attachments",":attachment_id"],"query":[{"description":"Required. Your organization.","value":"{{organization_id}}","key":"organization_id"}],"variable":[{"key":"note_id"},{"key":"attachment_id"}]},"description":"Removes a file from a note. Only the note's author can remove attachments.\n\n**Privilege:** `notes/d` · **Organization:** `organization_id` query parameter.\n\n### Response\n`200` with no `data` body. `404` if the note or the attachment doesn't exist.\n\n**Authentication:** your organization API key in the `apikey` header (see **Accounts › Create API Key**), or `Authorization: Bearer `. Successful responses are `{ status, type, data, details, message, requested_at, responded_at }`; errors are `{ status, code, message, details }`. Notes share the comment error codes (`comment/not-found`, `comment/forbidden`, …).\n"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"value":"application/json; charset=utf-8","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"code\": \"comment/attachment-not-found\",\n \"message\": \"Not Found\",\n \"details\": \"The specified comment attachment could not be found\"\n}"}],"_postman_id":"d2b395f1-635e-5889-b65c-05bcba294071"}],"id":"2ba6be85-89a3-4746-82c5-bc9264e7235c","_postman_id":"2ba6be85-89a3-4746-82c5-bc9264e7235c","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]},"isInherited":true,"source":{"_postman_id":"eb48b80e-2608-4bf5-9779-12c421c47e79","id":"eb48b80e-2608-4bf5-9779-12c421c47e79","name":"API Documentation","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"}]}},"event":[{"listen":"prerequest","script":{"id":"b2616478-a048-48df-af97-b64d401f67c3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3a9ea9c5-b052-41a7-9780-f8c472c4e131","type":"text/javascript","exec":[""]}}]}