{"items":[{"type":"link","label":"Hook REST API","link":"/v1/openapi","routeSlug":"/v1/openapi","content":{"contentType":"overview","meta":{"name":"Hook REST API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/v1/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/v1/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Hook REST API (1.0.33)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The Hook REST API enables you to programmatically access and manage your Hook workspace."}],"sectionId":"/v1/openapi"}],"sectionId":"/v1/openapi"}]}]}},{"type":"group","label":"Members","link":"/v1/openapi/members","routeSlug":"/v1/openapi/members","items":[{"label":"Get the current member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/members/getcurrentmember","routeSlug":"/v1/openapi/members/getcurrentmember","metadata":{"seo":{"title":"Get the current member","description":"Returns the member associated with the authorisation token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrentMember","name":"Get the current member","isWebhook":false,"pointer":"/paths/~1members~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the current member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the member associated with the authorisation token"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/members/me","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/members/me","href":"members/getcurrentmember","openApiOperationId":"getCurrentMember","summary":"Get the current member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Member"}},"schemaId":"components/schemas/Member"}],"pointer":"/paths/~1members~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Member","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Member"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/getcurrentmember"}],"panels":[]}]},"httpPath":"/members/me"},{"label":"List all members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/members/listmembers","routeSlug":"/v1/openapi/members/listmembers","metadata":{"seo":{"title":"List all members","description":"Returns a list of members"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMembers","name":"List all members","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of members"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/members","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/members","href":"members/listmembers","openApiOperationId":"listMembers","summary":"List all members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MemberList"}},"schemaId":"components/schemas/MemberList"}],"pointer":"/paths/~1organizations~1{organizationId}~1members/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MemberList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MemberList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/listmembers"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/members"},{"label":"Get a member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/members/getmember","routeSlug":"/v1/openapi/members/getmember","metadata":{"seo":{"title":"Get a member","description":"Returns a member by their ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMember","name":"Get a member","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1members~1{memberId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a member by their ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true},{"name":"memberId","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1members~1{memberId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/members/{memberId}","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"},{"name":"memberId","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/members/{memberId}","href":"members/getmember","openApiOperationId":"getMember","summary":"Get a member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Member"}},"schemaId":"components/schemas/Member"}],"pointer":"/paths/~1organizations~1{organizationId}~1members~1{memberId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Member","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Member"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/getmember"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/members/{memberId}"}],"content":{"contentType":"group","meta":{"name":"Members"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Members","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/members/me","summary":"Get the current member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/getcurrentmember","deprecated":false},{"title":"/organizations/{organizationId}/members","summary":"List all members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/listmembers","deprecated":false},{"title":"/organizations/{organizationId}/members/{memberId}","summary":"Get a member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/getmember","deprecated":false}]}]}]}]}},{"type":"group","label":"Automations","link":"/v1/openapi/automations","routeSlug":"/v1/openapi/automations","items":[{"label":"List all automations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/automations/listautomations","routeSlug":"/v1/openapi/automations/listautomations","metadata":{"seo":{"title":"List all automations","description":"List all automations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAutomations","name":"List all automations","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1automations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all automations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1automations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/automations","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/automations","href":"automations/listautomations","openApiOperationId":"listAutomations","summary":"List all automations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutomationSummaryList"}},"schemaId":"components/schemas/AutomationSummaryList"}],"pointer":"/paths/~1organizations~1{organizationId}~1automations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AutomationSummaryList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutomationSummaryList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/automations/listautomations"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/automations"},{"label":"Get a single automation by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/automations/getautomation","routeSlug":"/v1/openapi/automations/getautomation","metadata":{"seo":{"title":"Get a single automation by ID","description":"Get a single automation by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAutomation","name":"Get a single automation by ID","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1automations~1{automationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single automation by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true},{"name":"automationId","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1automations~1{automationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/automations/{automationId}","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"},{"name":"automationId","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/automations/{automationId}","href":"automations/getautomation","openApiOperationId":"getAutomation","summary":"Get a single automation by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Automation"}},"schemaId":"components/schemas/Automation"}],"pointer":"/paths/~1organizations~1{organizationId}~1automations~1{automationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Automation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Automation"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/automations/getautomation"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/automations/{automationId}"},{"label":"List logs for an automation action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/automations/listautomationactionlogs","routeSlug":"/v1/openapi/automations/listautomationactionlogs","metadata":{"seo":{"title":"List logs for an automation action","description":"List logs for an automation action"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAutomationActionLogs","name":"List logs for an automation action","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1automations~1{automationId}~1actions~1{actionId}~1logs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List logs for an automation action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true},{"name":"automationId","in":"path","schemaId":"schema_13","required":true},{"name":"actionId","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1automations~1{automationId}~1actions~1{actionId}~1logs/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_14"},{"name":"limit","in":"query","schemaId":"schema_15"}],"pointer":"/paths/~1organizations~1{organizationId}~1automations~1{automationId}~1actions~1{actionId}~1logs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/automations/{automationId}/actions/{actionId}/logs","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"},{"name":"automationId","in":"path","required":true,"schemaId":"schema_13"},{"name":"actionId","in":"path","required":true,"schemaId":"schema_13"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_14"},{"name":"limit","in":"query","required":false,"schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/automations/{automationId}/actions/{actionId}/logs","href":"automations/listautomationactionlogs","openApiOperationId":"listAutomationActionLogs","summary":"List logs for an automation action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutomationActionLogList"}},"schemaId":"components/schemas/AutomationActionLogList"}],"pointer":"/paths/~1organizations~1{organizationId}~1automations~1{automationId}~1actions~1{actionId}~1logs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AutomationActionLogList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutomationActionLogList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/automations/listautomationactionlogs"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/automations/{automationId}/actions/{actionId}/logs"},{"label":"List logs for an automation trigger","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/automations/listautomationtriggerlogs","routeSlug":"/v1/openapi/automations/listautomationtriggerlogs","metadata":{"seo":{"title":"List logs for an automation trigger","description":"List logs for an automation trigger"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAutomationTriggerLogs","name":"List logs for an automation trigger","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1automations~1{automationId}~1triggers~1{triggerId}~1logs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List logs for an automation trigger","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true},{"name":"automationId","in":"path","schemaId":"schema_13","required":true},{"name":"triggerId","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1automations~1{automationId}~1triggers~1{triggerId}~1logs/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_14"},{"name":"limit","in":"query","schemaId":"schema_15"}],"pointer":"/paths/~1organizations~1{organizationId}~1automations~1{automationId}~1triggers~1{triggerId}~1logs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/automations/{automationId}/triggers/{triggerId}/logs","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"},{"name":"automationId","in":"path","required":true,"schemaId":"schema_13"},{"name":"triggerId","in":"path","required":true,"schemaId":"schema_13"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_14"},{"name":"limit","in":"query","required":false,"schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/automations/{automationId}/triggers/{triggerId}/logs","href":"automations/listautomationtriggerlogs","openApiOperationId":"listAutomationTriggerLogs","summary":"List logs for an automation trigger"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutomationTriggerLogList"}},"schemaId":"components/schemas/AutomationTriggerLogList"}],"pointer":"/paths/~1organizations~1{organizationId}~1automations~1{automationId}~1triggers~1{triggerId}~1logs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AutomationTriggerLogList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutomationTriggerLogList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/automations/listautomationtriggerlogs"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/automations/{automationId}/triggers/{triggerId}/logs"}],"content":{"contentType":"group","meta":{"name":"Automations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Automations","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizations/{organizationId}/automations","summary":"List all automations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/automations/listautomations","deprecated":false},{"title":"/organizations/{organizationId}/automations/{automationId}","summary":"Get a single automation by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/automations/getautomation","deprecated":false},{"title":"/organizations/{organizationId}/automations/{automationId}/actions/{actionId}/logs","summary":"List logs for an automation action","prefix":{"name":"get","color":"get"},"badges":[],"link":"/automations/listautomationactionlogs","deprecated":false},{"title":"/organizations/{organizationId}/automations/{automationId}/triggers/{triggerId}/logs","summary":"List logs for an automation trigger","prefix":{"name":"get","color":"get"},"badges":[],"link":"/automations/listautomationtriggerlogs","deprecated":false}]}]}]}]}},{"type":"group","label":"Briefs","link":"/v1/openapi/briefs","routeSlug":"/v1/openapi/briefs","items":[{"label":"List all briefs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/briefs/listbriefs","routeSlug":"/v1/openapi/briefs/listbriefs","metadata":{"seo":{"title":"List all briefs","description":"Returns the active brief definitions configured for the organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBriefs","name":"List all briefs","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1briefs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all briefs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the active brief definitions configured for the organization"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1briefs/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_14"},{"name":"limit","in":"query","schemaId":"schema_15"}],"pointer":"/paths/~1organizations~1{organizationId}~1briefs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/briefs","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_14"},{"name":"limit","in":"query","required":false,"schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/briefs","href":"briefs/listbriefs","openApiOperationId":"listBriefs","summary":"List all briefs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BriefList"}},"schemaId":"components/schemas/BriefList"}],"pointer":"/paths/~1organizations~1{organizationId}~1briefs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BriefList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BriefList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/briefs/listbriefs"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/briefs"},{"label":"List the contents generated for a brief for a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/briefs/listcustomerbriefcontents","routeSlug":"/v1/openapi/briefs/listcustomerbriefcontents","metadata":{"seo":{"title":"List the contents generated for a brief for a customer","description":"Returns the generated contents for a single brief on a customer, most recent first"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomerBriefContents","name":"List the contents generated for a brief for a customer","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1briefs~1{briefId}~1contents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the contents generated for a brief for a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the generated contents for a single brief on a customer, most recent first"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true},{"name":"customerId","in":"path","schemaId":"schema_13","required":true},{"name":"briefId","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1briefs~1{briefId}~1contents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_14"},{"name":"limit","in":"query","schemaId":"schema_15"}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1briefs~1{briefId}~1contents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/customers/{customerId}/briefs/{briefId}/contents","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"},{"name":"customerId","in":"path","required":true,"schemaId":"schema_13"},{"name":"briefId","in":"path","required":true,"schemaId":"schema_13"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_14"},{"name":"limit","in":"query","required":false,"schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/customers/{customerId}/briefs/{briefId}/contents","href":"briefs/listcustomerbriefcontents","openApiOperationId":"listCustomerBriefContents","summary":"List the contents generated for a brief for a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BriefContentList"}},"schemaId":"components/schemas/BriefContentList"}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1briefs~1{briefId}~1contents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BriefContentList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BriefContentList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/briefs/listcustomerbriefcontents"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/customers/{customerId}/briefs/{briefId}/contents"}],"content":{"contentType":"group","meta":{"name":"Briefs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Briefs","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizations/{organizationId}/briefs","summary":"List all briefs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/briefs/listbriefs","deprecated":false},{"title":"/organizations/{organizationId}/customers/{customerId}/briefs/{briefId}/contents","summary":"List the contents generated for a brief for a customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/briefs/listcustomerbriefcontents","deprecated":false}]}]}]}]}},{"type":"group","label":"CustomFields","link":"/v1/openapi/customfields","routeSlug":"/v1/openapi/customfields","items":[{"label":"List custom fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/customfields/listcustomfields","routeSlug":"/v1/openapi/customfields/listcustomfields","metadata":{"seo":{"title":"List custom fields","description":"Returns the custom field definitions for the organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomFields","name":"List custom fields","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1custom-fields/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List custom fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the custom field definitions for the organization"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1custom-fields/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/custom-fields","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/custom-fields","href":"customfields/listcustomfields","openApiOperationId":"listCustomFields","summary":"List custom fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldList"}},"schemaId":"components/schemas/CustomFieldList"}],"pointer":"/paths/~1organizations~1{organizationId}~1custom-fields/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomFieldList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customfields/listcustomfields"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/custom-fields"}],"content":{"contentType":"group","meta":{"name":"CustomFields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CustomFields","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizations/{organizationId}/custom-fields","summary":"List custom fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customfields/listcustomfields","deprecated":false}]}]}]}]}},{"type":"group","label":"MemberRoles","link":"/v1/openapi/memberroles","routeSlug":"/v1/openapi/memberroles","items":[{"label":"List member roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/memberroles/listmemberroles","routeSlug":"/v1/openapi/memberroles/listmemberroles","metadata":{"seo":{"title":"List member roles","description":"Returns the member-customer role definitions for the organization. These are the roles that associate a member with a customer, such as CSM or Account Manager"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMemberRoles","name":"List member roles","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1member-roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List member roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the member-customer role definitions for the organization. These are the roles that associate a member with a customer, such as CSM or Account Manager"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1member-roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/member-roles","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/member-roles","href":"memberroles/listmemberroles","openApiOperationId":"listMemberRoles","summary":"List member roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MemberRoleList"}},"schemaId":"components/schemas/MemberRoleList"}],"pointer":"/paths/~1organizations~1{organizationId}~1member-roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MemberRoleList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MemberRoleList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberroles/listmemberroles"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/member-roles"}],"content":{"contentType":"group","meta":{"name":"MemberRoles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"MemberRoles","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizations/{organizationId}/member-roles","summary":"List member roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberroles/listmemberroles","deprecated":false}]}]}]}]}},{"type":"group","label":"Notes","link":"/v1/openapi/notes","routeSlug":"/v1/openapi/notes","items":[{"label":"List note categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/notes/listnotecategories","routeSlug":"/v1/openapi/notes/listnotecategories","metadata":{"seo":{"title":"List note categories","description":"Returns the active note categories for the organization, for use when creating a note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNoteCategories","name":"List note categories","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1note-categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List note categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the active note categories for the organization, for use when creating a note"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1note-categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/note-categories","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/note-categories","href":"notes/listnotecategories","openApiOperationId":"listNoteCategories","summary":"List note categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoteCategoryList"}},"schemaId":"components/schemas/NoteCategoryList"}],"pointer":"/paths/~1organizations~1{organizationId}~1note-categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NoteCategoryList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoteCategoryList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/listnotecategories"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/note-categories"},{"label":"List all notes for a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/notes/listcustomernotes","routeSlug":"/v1/openapi/notes/listcustomernotes","metadata":{"seo":{"title":"List all notes for a customer","description":"List all notes for a customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomerNotes","name":"List all notes for a customer","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all notes for a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true},{"name":"customerId","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1notes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_14"},{"name":"limit","in":"query","schemaId":"schema_15"}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/customers/{customerId}/notes","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"},{"name":"customerId","in":"path","required":true,"schemaId":"schema_13"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_14"},{"name":"limit","in":"query","required":false,"schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/customers/{customerId}/notes","href":"notes/listcustomernotes","openApiOperationId":"listCustomerNotes","summary":"List all notes for a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoteList"}},"schemaId":"components/schemas/NoteList"}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NoteList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoteList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/listcustomernotes"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/customers/{customerId}/notes"},{"label":"Create a note for a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/notes/createcustomernote","routeSlug":"/v1/openapi/notes/createcustomernote","metadata":{"seo":{"title":"Create a note for a customer","description":"Create a note for a customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomerNote","name":"Create a note for a customer","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a note for a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true},{"name":"customerId","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16","pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizations/{organizationId}/customers/{customerId}/notes","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"},{"name":"customerId","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_16"}},"responseCodes":["201"],"pointer":"/organizations/{organizationId}/customers/{customerId}/notes","href":"notes/createcustomernote","openApiOperationId":"createCustomerNote","summary":"Create a note for a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Note"}},"schemaId":"components/schemas/Note"}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Note","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Note"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/createcustomernote"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/customers/{customerId}/notes"}],"content":{"contentType":"group","meta":{"name":"Notes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notes","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizations/{organizationId}/note-categories","summary":"List note categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/listnotecategories","deprecated":false},{"title":"/organizations/{organizationId}/customers/{customerId}/notes","summary":"List all notes for a customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/listcustomernotes","deprecated":false},{"title":"/organizations/{organizationId}/customers/{customerId}/notes","summary":"Create a note for a customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notes/createcustomernote","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/v1/openapi/products","routeSlug":"/v1/openapi/products","items":[{"label":"List products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/products/listproducts","routeSlug":"/v1/openapi/products/listproducts","metadata":{"seo":{"title":"List products","description":"List products"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProducts","name":"List products","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_17","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/products","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"schemaId":"schema_17"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/products","href":"products/listproducts","openApiOperationId":"listProducts","summary":"List products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductList"}},"schemaId":"components/schemas/ProductList"}],"pointer":"/paths/~1organizations~1{organizationId}~1products/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/listproducts"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/products"},{"label":"List product metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/products/listproductmetrics","routeSlug":"/v1/openapi/products/listproductmetrics","metadata":{"seo":{"title":"List product metrics","description":"Returns the metrics for a given product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProductMetrics","name":"List product metrics","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1products~1{productId}~1metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List product metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the metrics for a given product"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true},{"name":"productId","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1products~1{productId}~1metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/products/{productId}/metrics","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"},{"name":"productId","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/products/{productId}/metrics","href":"products/listproductmetrics","openApiOperationId":"listProductMetrics","summary":"List product metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductMetricList"}},"schemaId":"components/schemas/ProductMetricList"}],"pointer":"/paths/~1organizations~1{organizationId}~1products~1{productId}~1metrics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductMetricList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductMetricList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/listproductmetrics"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/products/{productId}/metrics"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizations/{organizationId}/products","summary":"List products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/listproducts","deprecated":false},{"title":"/organizations/{organizationId}/products/{productId}/metrics","summary":"List product metrics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/listproductmetrics","deprecated":false}]}]}]}]}},{"type":"group","label":"Signals","link":"/v1/openapi/signals","routeSlug":"/v1/openapi/signals","items":[{"label":"List all signals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/signals/listsignals","routeSlug":"/v1/openapi/signals/listsignals","metadata":{"seo":{"title":"List all signals","description":"List all signals"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSignals","name":"List all signals","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1signals/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all signals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1signals/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_14"},{"name":"limit","in":"query","schemaId":"schema_15"},{"name":"scope","in":"query","schemaId":"schema_18","description":"All will return all visible customers. Team will restrict this to those where your team members (members under a shared manager) are assigned a role on the customer. Mine will only return customers you are assigned a role to on the customer."},{"name":"status","in":"query","schemaId":"schema_19"}],"pointer":"/paths/~1organizations~1{organizationId}~1signals/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/signals","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_14"},{"name":"limit","in":"query","required":false,"schemaId":"schema_15"},{"name":"scope","in":"query","required":false,"schemaId":"schema_18"},{"name":"status","in":"query","required":false,"schemaId":"schema_19"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/signals","href":"signals/listsignals","openApiOperationId":"listSignals","summary":"List all signals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignalList"}},"schemaId":"components/schemas/SignalList"}],"pointer":"/paths/~1organizations~1{organizationId}~1signals/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SignalList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignalList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/signals/listsignals"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/signals"},{"label":"Get a single signal by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/signals/getsignal","routeSlug":"/v1/openapi/signals/getsignal","metadata":{"seo":{"title":"Get a single signal by ID","description":"Get a single signal by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSignal","name":"Get a single signal by ID","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1signals~1{signalId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single signal by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true},{"name":"signalId","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1signals~1{signalId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/signals/{signalId}","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"},{"name":"signalId","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/signals/{signalId}","href":"signals/getsignal","openApiOperationId":"getSignal","summary":"Get a single signal by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Signal"}},"schemaId":"components/schemas/Signal"}],"pointer":"/paths/~1organizations~1{organizationId}~1signals~1{signalId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Signal","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Signal"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/signals/getsignal"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/signals/{signalId}"}],"content":{"contentType":"group","meta":{"name":"Signals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Signals","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizations/{organizationId}/signals","summary":"List all signals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/signals/listsignals","deprecated":false},{"title":"/organizations/{organizationId}/signals/{signalId}","summary":"Get a single signal by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/signals/getsignal","deprecated":false}]}]}]}]}},{"type":"group","label":"Customers","link":"/v1/openapi/customers","routeSlug":"/v1/openapi/customers","items":[{"label":"List all customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/customers/listcustomers","routeSlug":"/v1/openapi/customers/listcustomers","metadata":{"seo":{"title":"List all customers","description":"List all customers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomers","name":"List all customers","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1customers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1customers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_14"},{"name":"limit","in":"query","schemaId":"schema_15"},{"name":"scope","in":"query","schemaId":"schema_18","description":"All will return all visible customers. Team will restrict this to those where your team members (members under a shared manager) are assigned a role on the customer. Mine will only return customers you are assigned a role to on the customer."},{"name":"status","in":"query","schemaId":"schema_20"},{"name":"updatedSince","in":"query","schemaId":"schema_21","description":"Only return customers updated at or after this time, up to now."},{"name":"memberId","in":"query","schemaId":"schema_13","description":"Only return customers this member is assigned to (in any role)."},{"name":"memberRoleId","in":"query","schemaId":"schema_13","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Narrow the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memberId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter to a single role, e.g. CSM. The role id is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by ListMemberRoles. Must be supplied together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memberId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sourceKey","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source to match "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceExternalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" against, e.g. salesforce. This is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in a customer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry. Must be supplied together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceExternalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sourceExternalId","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter customers by their ID in an external source, such as a CRM. Must be supplied together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"segment","in":"query","schemaId":"schema_23","description":"Filter customers by segment name"},{"name":"domain","in":"query","schemaId":"schema_23","description":"Filter customers by domain, e.g. example.com"},{"name":"country","in":"query","schemaId":"schema_23","description":"Filter customers by country"},{"name":"region","in":"query","schemaId":"schema_23","description":"Filter customers by region"},{"name":"city","in":"query","schemaId":"schema_23","description":"Filter customers by city"}],"pointer":"/paths/~1organizations~1{organizationId}~1customers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/customers","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_14"},{"name":"limit","in":"query","required":false,"schemaId":"schema_15"},{"name":"scope","in":"query","required":false,"schemaId":"schema_18"},{"name":"status","in":"query","required":false,"schemaId":"schema_20"},{"name":"updatedSince","in":"query","required":false,"schemaId":"schema_21"},{"name":"memberId","in":"query","required":false,"schemaId":"schema_13"},{"name":"memberRoleId","in":"query","required":false,"schemaId":"schema_13"},{"name":"sourceKey","in":"query","required":false,"schemaId":"schema_22"},{"name":"sourceExternalId","in":"query","required":false,"schemaId":"schema_23"},{"name":"segment","in":"query","required":false,"schemaId":"schema_23"},{"name":"domain","in":"query","required":false,"schemaId":"schema_23"},{"name":"country","in":"query","required":false,"schemaId":"schema_23"},{"name":"region","in":"query","required":false,"schemaId":"schema_23"},{"name":"city","in":"query","required":false,"schemaId":"schema_23"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/customers","href":"customers/listcustomers","openApiOperationId":"listCustomers","summary":"List all customers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerList"}},"schemaId":"components/schemas/CustomerList"}],"pointer":"/paths/~1organizations~1{organizationId}~1customers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/listcustomers"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/customers"},{"label":"Get a single customer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/customers/getcustomer","routeSlug":"/v1/openapi/customers/getcustomer","metadata":{"seo":{"title":"Get a single customer by ID","description":"Get a single customer by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomer","name":"Get a single customer by ID","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single customer by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true},{"name":"customerId","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/customers/{customerId}","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"},{"name":"customerId","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/customers/{customerId}","href":"customers/getcustomer","openApiOperationId":"getCustomer","summary":"Get a single customer by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}},"schemaId":"components/schemas/Customer"}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Customer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getcustomer"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/customers/{customerId}"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizations/{organizationId}/customers","summary":"List all customers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/listcustomers","deprecated":false},{"title":"/organizations/{organizationId}/customers/{customerId}","summary":"Get a single customer by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getcustomer","deprecated":false}]}]}]}]}},{"type":"group","label":"Meetings","link":"/v1/openapi/meetings","routeSlug":"/v1/openapi/meetings","items":[{"label":"List all meetings for a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/meetings/listcustomermeetings","routeSlug":"/v1/openapi/meetings/listcustomermeetings","metadata":{"seo":{"title":"List all meetings for a customer","description":"List all meetings for a customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomerMeetings","name":"List all meetings for a customer","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1meetings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all meetings for a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true},{"name":"customerId","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1meetings/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_14"},{"name":"limit","in":"query","schemaId":"schema_15"},{"name":"minStartDate","in":"query","schemaId":"schema_21","description":"Only return meetings starting on or after this date"}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1meetings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/customers/{customerId}/meetings","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"},{"name":"customerId","in":"path","required":true,"schemaId":"schema_13"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_14"},{"name":"limit","in":"query","required":false,"schemaId":"schema_15"},{"name":"minStartDate","in":"query","required":false,"schemaId":"schema_21"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/customers/{customerId}/meetings","href":"meetings/listcustomermeetings","openApiOperationId":"listCustomerMeetings","summary":"List all meetings for a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MeetingList"}},"schemaId":"components/schemas/MeetingList"}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1meetings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MeetingList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MeetingList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meetings/listcustomermeetings"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/customers/{customerId}/meetings"},{"label":"Get a single meeting for a customer by ID, including its transcript","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/meetings/getcustomermeeting","routeSlug":"/v1/openapi/meetings/getcustomermeeting","metadata":{"seo":{"title":"Get a single meeting for a customer by ID, including its transcript","description":"Get a single meeting for a customer by ID, including its transcript"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomerMeeting","name":"Get a single meeting for a customer by ID, including its transcript","isWebhook":false,"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1meetings~1{meetingId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single meeting for a customer by ID, including its transcript","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_12","description":"Organization ID of the member accessing the resource","required":true},{"name":"customerId","in":"path","schemaId":"schema_13","required":true},{"name":"meetingId","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1meetings~1{meetingId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{organizationId}/customers/{customerId}/meetings/{meetingId}","servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"my-organization-id","schemaId":"schema_12"},{"name":"customerId","in":"path","required":true,"schemaId":"schema_13"},{"name":"meetingId","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/organizations/{organizationId}/customers/{customerId}/meetings/{meetingId}","href":"meetings/getcustomermeeting","openApiOperationId":"getCustomerMeeting","summary":"Get a single meeting for a customer by ID, including its transcript"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.hook.co/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Default Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MeetingWithTranscript"}},"schemaId":"components/schemas/MeetingWithTranscript"}],"pointer":"/paths/~1organizations~1{organizationId}~1customers~1{customerId}~1meetings~1{meetingId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MeetingWithTranscript","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MeetingWithTranscript"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meetings/getcustomermeeting"}],"panels":[]}]},"httpPath":"/organizations/{organizationId}/customers/{customerId}/meetings/{meetingId}"}],"content":{"contentType":"group","meta":{"name":"Meetings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Meetings","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizations/{organizationId}/customers/{customerId}/meetings","summary":"List all meetings for a customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/meetings/listcustomermeetings","deprecated":false},{"title":"/organizations/{organizationId}/customers/{customerId}/meetings/{meetingId}","summary":"Get a single meeting for a customer by ID, including its transcript","prefix":{"name":"get","color":"get"},"badges":[],"link":"/meetings/getcustomermeeting","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ScopeInput":{"id":"components/schemas/ScopeInput","kind":"json-schema","title":"ScopeInput","data":{"type":"string","enum":["mine","team","all"]}},"components/schemas/SignalStatusInput":{"id":"components/schemas/SignalStatusInput","kind":"json-schema","title":"SignalStatusInput","data":{"type":"string","enum":["Active","Cleared","Detected","Dismissed"]}},"components/schemas/CustomerStatusInput":{"id":"components/schemas/CustomerStatusInput","kind":"json-schema","title":"CustomerStatusInput","data":{"type":"string","enum":["Active","Churned","Upcoming","Unassigned"]}},"components/schemas/Member":{"id":"components/schemas/Member","kind":"json-schema","title":"Member","data":{"type":"object","properties":{"id":{"type":"integer","example":1234,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"firstName":{"type":"string","example":"Phoebe","nullable":true},"lastName":{"type":"string","example":"Frere","nullable":true},"email":{"type":"string","example":"phoebe@example.com"},"organizationId":{"type":"string","example":"my-organization-id"},"managerId":{"description":"The Member ID of this member's manager","type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0,"nullable":true}},"additionalProperties":false,"required":["id","firstName","lastName","email","organizationId","managerId"]}},"components/schemas/MemberList":{"id":"components/schemas/MemberList","kind":"json-schema","title":"MemberList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Member"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/AutomationActionLogStatus":{"id":"components/schemas/AutomationActionLogStatus","kind":"json-schema","title":"AutomationActionLogStatus","data":{"type":"string","enum":["success","error","skipped","info","close"]}},"components/schemas/AutomationTriggerLogStatus":{"id":"components/schemas/AutomationTriggerLogStatus","kind":"json-schema","title":"AutomationTriggerLogStatus","data":{"type":"string","enum":["info","failed"]}},"components/schemas/AutomationSummary":{"id":"components/schemas/AutomationSummary","kind":"json-schema","title":"AutomationSummary","data":{"type":"object","properties":{"id":{"type":"integer","example":1234,"maximum":9007199254740991,"minimum":-9007199254740991},"name":{"type":"string","example":"High value account at risk"},"deactivatedDate":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false,"required":["id","name","deactivatedDate"]}},"components/schemas/AutomationTrigger":{"id":"components/schemas/AutomationTrigger","kind":"json-schema","title":"AutomationTrigger","data":{"type":"object","properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991}},"additionalProperties":false,"required":["id"]}},"components/schemas/AutomationAction":{"id":"components/schemas/AutomationAction","kind":"json-schema","title":"AutomationAction","data":{"type":"object","properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991}},"additionalProperties":false,"required":["id"]}},"components/schemas/Automation":{"id":"components/schemas/Automation","kind":"json-schema","title":"Automation","data":{"type":"object","properties":{"id":{"type":"integer","example":1234,"maximum":9007199254740991,"minimum":-9007199254740991},"name":{"type":"string","example":"High value account at risk"},"deactivatedDate":{"type":"string","format":"date-time","nullable":true},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/AutomationTrigger"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/AutomationAction"}},"children":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Automation"}]}}},"additionalProperties":false,"required":["id","name","deactivatedDate","triggers","actions","children"]}},"components/schemas/AutomationActionLog":{"id":"components/schemas/AutomationActionLog","kind":"json-schema","title":"AutomationActionLog","data":{"type":"object","properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"customer":{"type":"object","additionalProperties":false,"nullable":true,"properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"name":{"type":"string"}},"required":["id","name"]},"user":{"type":"object","additionalProperties":false,"nullable":true,"properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"customerId":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true}},"required":["id","customerId","firstName","lastName"]},"contact":{"type":"object","additionalProperties":false,"nullable":true,"properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"customerId":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true}},"required":["id","customerId","firstName","lastName"]},"status":{"allOf":[{"$ref":"#/components/schemas/AutomationActionLogStatus"}],"nullable":true},"message":{"type":"string","nullable":true},"createdDate":{"type":"string","format":"date-time"}},"additionalProperties":false,"required":["id","customer","user","contact","status","message","createdDate"]}},"components/schemas/AutomationTriggerLog":{"id":"components/schemas/AutomationTriggerLog","kind":"json-schema","title":"AutomationTriggerLog","data":{"type":"object","properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"status":{"$ref":"#/components/schemas/AutomationTriggerLogStatus"},"message":{"type":"string","nullable":true},"createdDate":{"type":"string","format":"date-time"}},"additionalProperties":false,"required":["id","status","message","createdDate"]}},"components/schemas/AutomationSummaryList":{"id":"components/schemas/AutomationSummaryList","kind":"json-schema","title":"AutomationSummaryList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AutomationSummary"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/AutomationActionLogList":{"id":"components/schemas/AutomationActionLogList","kind":"json-schema","title":"AutomationActionLogList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AutomationActionLog"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/AutomationTriggerLogList":{"id":"components/schemas/AutomationTriggerLogList","kind":"json-schema","title":"AutomationTriggerLogList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AutomationTriggerLog"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/Brief":{"id":"components/schemas/Brief","kind":"json-schema","title":"Brief","data":{"type":"object","properties":{"id":{"type":"integer","example":42,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"name":{"type":"string","example":"Executive summary"},"description":{"type":"string","example":"A high level summary of the customer relationship.","nullable":true}},"additionalProperties":false,"required":["id","name","description"]}},"components/schemas/BriefList":{"id":"components/schemas/BriefList","kind":"json-schema","title":"BriefList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Brief"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/BriefContent":{"id":"components/schemas/BriefContent","kind":"json-schema","title":"BriefContent","data":{"type":"object","properties":{"id":{"type":"integer","example":981,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"briefId":{"type":"integer","example":42,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"customerId":{"type":"integer","example":12,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"content":{"example":"Renewal is on track; the champion is engaged.","type":"string"},"createdDate":{"type":"string","format":"date-time"},"updatedDate":{"type":"string","format":"date-time"}},"additionalProperties":false,"required":["id","briefId","customerId","content","createdDate","updatedDate"]}},"components/schemas/BriefContentList":{"id":"components/schemas/BriefContentList","kind":"json-schema","title":"BriefContentList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BriefContent"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/CustomField":{"id":"components/schemas/CustomField","kind":"json-schema","title":"CustomField","data":{"type":"object","properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"key":{"type":"string","example":"tier"},"name":{"type":"string","example":"Tier"},"type":{"type":"string","example":"account"},"dataType":{"type":"string","example":"string"},"productId":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"nullable":true}},"additionalProperties":false,"required":["id","key","name","type","dataType","productId"]}},"components/schemas/CustomFieldList":{"id":"components/schemas/CustomFieldList","kind":"json-schema","title":"CustomFieldList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/MemberRole":{"id":"components/schemas/MemberRole","kind":"json-schema","title":"MemberRole","data":{"type":"object","properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"key":{"type":"string","example":"csm"},"name":{"type":"string","example":"CSM"}},"additionalProperties":false,"required":["id","key","name"]}},"components/schemas/MemberRoleList":{"id":"components/schemas/MemberRoleList","kind":"json-schema","title":"MemberRoleList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MemberRole"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/NoteCategory":{"id":"components/schemas/NoteCategory","kind":"json-schema","title":"NoteCategory","data":{"type":"object","properties":{"id":{"type":"integer","example":3,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"name":{"type":"string","example":"Meeting"}},"additionalProperties":false,"required":["id","name"]}},"components/schemas/NoteCategoryList":{"id":"components/schemas/NoteCategoryList","kind":"json-schema","title":"NoteCategoryList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/NoteCategory"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/NotePerson":{"id":"components/schemas/NotePerson","kind":"json-schema","title":"NotePerson","data":{"type":"object","properties":{"id":{"type":"integer","example":7,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"email":{"type":"string","example":"jane@example.com","nullable":true},"firstName":{"type":"string","example":"Jane","nullable":true},"lastName":{"type":"string","example":"Doe","nullable":true}},"additionalProperties":false,"required":["id","email","firstName","lastName"]}},"components/schemas/Note":{"id":"components/schemas/Note","kind":"json-schema","title":"Note","data":{"type":"object","properties":{"id":{"type":"integer","example":64,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"customerId":{"type":"integer","example":12,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"title":{"type":"string","example":"Kick off call","nullable":true},"body":{"type":"string","example":"Discussed onboarding plan.","nullable":true},"category":{"$ref":"#/components/schemas/NoteCategory"},"users":{"type":"array","items":{"$ref":"#/components/schemas/NotePerson"}},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/NotePerson"}},"createdDate":{"type":"string","format":"date-time"},"updatedDate":{"type":"string","format":"date-time"}},"additionalProperties":false,"required":["id","customerId","title","body","category","users","contacts","createdDate","updatedDate"]}},"components/schemas/NoteList":{"id":"components/schemas/NoteList","kind":"json-schema","title":"NoteList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Note"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"type":"object","properties":{"id":{"type":"integer","example":8732,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"name":{"type":"string","example":"Platform product"},"key":{"type":"string","example":"platform"}},"additionalProperties":false,"required":["id","name","key"]}},"components/schemas/ProductList":{"id":"components/schemas/ProductList","kind":"json-schema","title":"ProductList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/ProductMetric":{"id":"components/schemas/ProductMetric","kind":"json-schema","title":"ProductMetric","data":{"type":"object","properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"key":{"type":"string","example":"health_score"},"name":{"type":"string","example":"Health Score"},"dataType":{"type":"string","example":"percentage"}},"additionalProperties":false,"required":["id","key","name","dataType"]}},"components/schemas/ProductMetricList":{"id":"components/schemas/ProductMetricList","kind":"json-schema","title":"ProductMetricList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductMetric"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/SignalCategory":{"id":"components/schemas/SignalCategory","kind":"json-schema","title":"SignalCategory","data":{"type":"object","properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"name":{"type":"string"}},"additionalProperties":false,"required":["id","name"]}},"components/schemas/SignalDismissalReason":{"id":"components/schemas/SignalDismissalReason","kind":"json-schema","title":"SignalDismissalReason","data":{"type":"object","properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"name":{"type":"string"}},"additionalProperties":false,"required":["id","name"]}},"components/schemas/SignalOutcome":{"id":"components/schemas/SignalOutcome","kind":"json-schema","title":"SignalOutcome","data":{"type":"object","properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"name":{"type":"string"}},"additionalProperties":false,"required":["id","name"]}},"components/schemas/SignalCompetitor":{"id":"components/schemas/SignalCompetitor","kind":"json-schema","title":"SignalCompetitor","data":{"type":"object","properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"name":{"type":"string"}},"additionalProperties":false,"required":["id","name"]}},"components/schemas/SignalType":{"id":"components/schemas/SignalType","kind":"json-schema","title":"SignalType","data":{"type":"object","properties":{"id":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991},"name":{"type":"string"},"color":{"type":"string"}},"additionalProperties":false,"required":["id","name","color"]}},"components/schemas/Signal":{"id":"components/schemas/Signal","kind":"json-schema","title":"Signal","data":{"type":"object","properties":{"id":{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"customerId":{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"productId":{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"productKey":{"type":"string"},"status":{"type":"string"},"source":{"type":"string"},"summary":{"type":"string","nullable":true},"notes":{"type":"string","enum":[null],"deprecated":true,"nullable":true},"severity":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"nullable":true},"severityExplanation":{"type":"string","nullable":true},"createdById":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"nullable":true},"updatedById":{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"nullable":true},"ownerId":{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0,"nullable":true},"latestNote":{"type":"string","nullable":true},"isDraft":{"type":"boolean"},"isPrimary":{"type":"boolean","nullable":true},"createdDate":{"type":"string","format":"date-time"},"raisedDate":{"type":"string","format":"date-time"},"closedDate":{"type":"string","format":"date-time","nullable":true},"updatedDate":{"type":"string","format":"date-time"},"opportunity":{"type":"string","nullable":true},"category":{"allOf":[{"$ref":"#/components/schemas/SignalCategory"}],"nullable":true},"dismissalReason":{"allOf":[{"$ref":"#/components/schemas/SignalDismissalReason"}],"nullable":true},"subCategory":{"allOf":[{"$ref":"#/components/schemas/SignalCategory"}],"nullable":true},"outcome":{"allOf":[{"$ref":"#/components/schemas/SignalOutcome"}],"nullable":true},"outcomeNotes":{"type":"string","nullable":true},"competitor":{"allOf":[{"$ref":"#/components/schemas/SignalCompetitor"}],"nullable":true},"type":{"$ref":"#/components/schemas/SignalType"}},"additionalProperties":false,"required":["id","customerId","productId","productKey","status","source","summary","notes","severity","severityExplanation","createdById","updatedById","ownerId","latestNote","isDraft","isPrimary","createdDate","raisedDate","closedDate","updatedDate","opportunity","category","dismissalReason","subCategory","outcome","outcomeNotes","competitor","type"]}},"components/schemas/SignalList":{"id":"components/schemas/SignalList","kind":"json-schema","title":"SignalList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Signal"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/CustomerMemberRole":{"id":"components/schemas/CustomerMemberRole","kind":"json-schema","title":"CustomerMemberRole","data":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/Member"}},"key":{"type":"string","example":"csm"},"name":{"type":"string","example":"CSM"}},"additionalProperties":false,"required":["members","key","name"]}},"components/schemas/CustomerCustomField":{"id":"components/schemas/CustomerCustomField","kind":"json-schema","title":"CustomerCustomField","data":{"type":"object","properties":{"key":{"type":"string","example":"health_score"},"value":{"example":85}},"additionalProperties":false,"required":["key","value"]}},"components/schemas/CustomerProductMetric":{"id":"components/schemas/CustomerProductMetric","kind":"json-schema","title":"CustomerProductMetric","data":{"type":"object","properties":{"key":{"type":"string","example":"active_integrations"},"value":{"example":85}},"additionalProperties":false,"required":["key","value"]}},"components/schemas/CustomerProduct":{"id":"components/schemas/CustomerProduct","kind":"json-schema","title":"CustomerProduct","data":{"type":"object","properties":{"key":{"type":"string","example":"platform"},"status":{"type":"string","example":"active"},"arr":{"type":"number","example":12000,"nullable":true},"renewalDate":{"type":"string","example":"2026-01-01","nullable":true},"engagement":{"type":"object","additionalProperties":false,"nullable":true,"properties":{"level":{"type":"string","example":"high","nullable":true}},"required":["level"]},"upsell":{"type":"object","additionalProperties":false,"nullable":true,"properties":{"level":{"type":"string","example":"upsell"}},"required":["level"]},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/CustomerProductMetric"}}},"additionalProperties":false,"required":["key","status","arr","renewalDate","engagement","upsell","metrics"]}},"components/schemas/CustomerSource":{"id":"components/schemas/CustomerSource","kind":"json-schema","title":"CustomerSource","data":{"type":"object","properties":{"key":{"type":"string","example":"salesforce"},"externalId":{"type":"string","example":"0010x000000aAAA"}},"additionalProperties":false,"required":["key","externalId"]}},"components/schemas/Customer":{"id":"components/schemas/Customer","kind":"json-schema","title":"Customer","data":{"type":"object","properties":{"id":{"type":"integer","example":1234,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"name":{"type":"string","example":"Acme Corp"},"city":{"type":"string","example":"San Francisco","nullable":true},"country":{"type":"string","example":"US","nullable":true},"region":{"type":"string","example":"US","nullable":true},"timezone":{"type":"string","example":"America/Los_Angeles","nullable":true},"domain":{"type":"string","example":"acme.com","nullable":true},"employeeCount":{"type":"integer","example":500,"maximum":9007199254740991,"minimum":-9007199254740991,"nullable":true},"segment":{"type":"string","example":"Enterprise","nullable":true},"memberRoles":{"type":"array","items":{"$ref":"#/components/schemas/CustomerMemberRole"}},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomerCustomField"}},"products":{"type":"array","items":{"$ref":"#/components/schemas/CustomerProduct"}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSource"}},"updatedDate":{"type":"string","format":"date-time"}},"additionalProperties":false,"required":["id","name","city","country","region","timezone","domain","employeeCount","segment","memberRoles","customFields","products","sources","updatedDate"]}},"components/schemas/CustomerList":{"id":"components/schemas/CustomerList","kind":"json-schema","title":"CustomerList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/MeetingPerson":{"id":"components/schemas/MeetingPerson","kind":"json-schema","title":"MeetingPerson","data":{"type":"object","properties":{"id":{"type":"integer","example":7,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"email":{"type":"string","example":"jane@example.com","nullable":true},"firstName":{"type":"string","example":"Jane","nullable":true},"lastName":{"type":"string","example":"Doe","nullable":true}},"additionalProperties":false,"required":["id","email","firstName","lastName"]}},"components/schemas/Meeting":{"id":"components/schemas/Meeting","kind":"json-schema","title":"Meeting","data":{"type":"object","properties":{"id":{"type":"integer","example":88,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"customerId":{"type":"integer","example":12,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"topic":{"type":"string","example":"Quarterly business review"},"summary":{"type":"string","example":"Reviewed adoption and agreed next steps.","nullable":true},"url":{"type":"string","example":"https://meet.example.com/abc-defg-hij","nullable":true},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"members":{"type":"array","items":{"$ref":"#/components/schemas/Member"}},"users":{"type":"array","items":{"$ref":"#/components/schemas/MeetingPerson"}},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/MeetingPerson"}},"unmatchedParticipants":{"description":"Participants that could not be matched to a member, user or contact","type":"array","items":{"type":"string"},"example":["guest@example.com"]},"nextSteps":{"type":"array","items":{"type":"string"},"example":["Share the updated pricing proposal"]},"hasTranscript":{"type":"boolean"},"createdDate":{"type":"string","format":"date-time"},"updatedDate":{"type":"string","format":"date-time"}},"additionalProperties":false,"required":["id","customerId","topic","summary","url","startDate","endDate","members","users","contacts","unmatchedParticipants","nextSteps","hasTranscript","createdDate","updatedDate"]}},"components/schemas/MeetingList":{"id":"components/schemas/MeetingList","kind":"json-schema","title":"MeetingList","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Meeting"}},"totalCount":{"type":"number"}},"additionalProperties":false,"required":["items","totalCount"]}},"components/schemas/MeetingTranscriptLine":{"id":"components/schemas/MeetingTranscriptLine","kind":"json-schema","title":"MeetingTranscriptLine","data":{"type":"object","properties":{"speakerName":{"type":"string","example":"Jane Doe"},"orderNumber":{"type":"integer","example":1,"maximum":9007199254740991,"minimum":-9007199254740991},"text":{"type":"string","example":"Thanks everyone for joining."},"start":{"description":"Milliseconds from the start of the meeting","type":"number","example":500,"nullable":true},"end":{"description":"Milliseconds from the start of the meeting","type":"number","example":3200,"nullable":true}},"additionalProperties":false,"required":["speakerName","orderNumber","text","start","end"]}},"components/schemas/MeetingWithTranscript":{"id":"components/schemas/MeetingWithTranscript","kind":"json-schema","title":"MeetingWithTranscript","data":{"type":"object","properties":{"id":{"type":"integer","example":88,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"customerId":{"type":"integer","example":12,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"topic":{"type":"string","example":"Quarterly business review"},"summary":{"type":"string","example":"Reviewed adoption and agreed next steps.","nullable":true},"url":{"type":"string","example":"https://meet.example.com/abc-defg-hij","nullable":true},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"members":{"type":"array","items":{"$ref":"#/components/schemas/Member"}},"users":{"type":"array","items":{"$ref":"#/components/schemas/MeetingPerson"}},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/MeetingPerson"}},"unmatchedParticipants":{"description":"Participants that could not be matched to a member, user or contact","type":"array","items":{"type":"string"},"example":["guest@example.com"]},"nextSteps":{"type":"array","items":{"type":"string"},"example":["Share the updated pricing proposal"]},"hasTranscript":{"type":"boolean"},"createdDate":{"type":"string","format":"date-time"},"updatedDate":{"type":"string","format":"date-time"},"transcript":{"description":"The lines of the transcript, in order. Null when the meeting was not transcribed","type":"array","items":{"$ref":"#/components/schemas/MeetingTranscriptLine"},"nullable":true}},"additionalProperties":false,"required":["id","customerId","topic","summary","url","startDate","endDate","members","users","contacts","unmatchedParticipants","nextSteps","hasTranscript","createdDate","updatedDate","transcript"]}},"schema_12":{"kind":"json-schema","data":{"type":"string","example":"my-organization-id"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"integer","default":0,"maximum":9007199254740991,"minimum":0},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"integer","default":100,"exclusiveMinimum":true,"maximum":250,"minimum":0},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","properties":{"categoryId":{"type":"integer","example":3,"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"title":{"type":"string","example":"Kick off call","minLength":1},"body":{"type":"string","example":"Discussed onboarding plan.","minLength":1},"userIds":{"type":"array","items":{"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":9007199254740991},"example":[7,11]},"contactIds":{"type":"array","items":{"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":9007199254740991},"example":[21,34]}},"required":["categoryId","body"]},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"default":"all","allOf":[{"$ref":"#/components/schemas/ScopeInput"}]},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SignalStatusInput"}]},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CustomerStatusInput"}]},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"string","minLength":1},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"id":"schema_23"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"/_mock/v1/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://api.hook.co/v1"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/v1/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/v1/openapi.json?download"},{"url":"/_bundle/v1/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Hook REST API","description":"The Hook REST API enables you to programmatically access and manage your Hook workspace."}},"baseSlug":"/v1/openapi","routesMapping":{}}