Returns every field the ticket list returns, with the same values, plus the ones the list
leaves out because each costs a further read: the ticket’s Description, the assets and
uptime checks linked to it, its logged Time and Products totals, any ticket-level
BillingOverride, its Shipments, and its Banner.
GET
/
v1
/
tickets
/
{ticketId}
Gets a single ticket.
curl --request GET \ --url https://api.usw.gorelo.io/v1/tickets/{ticketId} \ --header 'X-API-Key: <api-key>'
Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.
A ticket's full detail, as returned by the single-ticket endpoint. Every field the ticket list
serves is present and carries the same value; the fields below are the ones the list leaves out
because they each cost an extra read and are rarely wanted for every row of a page.
All timestamps are UTC.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Gorelo Documentation","colors":{"primary":"#1DAF94","light":"#8AEFDD","dark":"#1DAF94"},"logo":{"light":"https://mintcdn.com/gorelo/J8h_fLstMj_tYUTJ/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=J8h_fLstMj_tYUTJ\u0026q=85\u0026s=3c12ffa7afbcef131d2c6fb36f00e159","dark":"https://mintcdn.com/gorelo/J8h_fLstMj_tYUTJ/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=J8h_fLstMj_tYUTJ\u0026q=85\u0026s=2dc592c604dd68bb156e97c047088df2"},"favicon":"https://mintcdn.com/gorelo/eK-NlDv-DeG3Jk2m/favicon.svg?fit=max\u0026auto=format\u0026n=eK-NlDv-DeG3Jk2m\u0026q=85\u0026s=99510712391acd38a7057cf358869244","api":{"url":"full"},"appearance":{"default":"dark"},"background":{"color":{"light":"#FBFBFB","dark":"#1F2023"}},"navbar":{"links":[{"href":"https://feedback.gorelo.io/changelog","label":"Changelog"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.mintlify.com"}},"footer":{"socials":{"x":"https://twitter.com/Goreloio","facebook":"https://www.facebook.com/gorelo.io","linkedin":"https://www.linkedin.com/company/gorelo","youtube":"https://www.youtube.com/@gorelotech","discord":"https://discord.com/invite/BpmP8BSrj6","website":"https://www.gorelo.io/"}},"seo":{"indexing":"navigable"},"fonts":{"family":"Inter","weight":400},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"what-is-gorelo"},{"language":"ar","href":"ar/what-is-gorelo"},{"language":"pt-BR","href":"pt-BR/what-is-gorelo"},{"language":"fr-CA","href":"fr-CA/what-is-gorelo"},{"language":"ca","href":"ca/what-is-gorelo"},{"language":"cn","href":"cn/what-is-gorelo"},{"language":"zh","href":"zh/what-is-gorelo"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gorelo","hasAudioNarration":false,"actualSubdomain":"gorelo","customDomains":["help.gorelo.io"],"gitSource":{"type":"github","owner":"gorelo","repo":"gorelo_public_docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae0e7e8f954e5368715cbc6","collectionId":"9e2c5cbd-ad8e-42d1-aeb6-bcda615db32d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0e7e8f954e5368715cbc6"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae0e8186786d105b8a06985","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"en","tag":"API","count":128},{"language":"ar","tag":"API","count":128},{"language":"ca","tag":"API","count":128},{"language":"cn","tag":"API","count":128},{"language":"fr-CA","tag":"API","count":128},{"language":"pt-BR","tag":"API","count":128},{"language":"zh","tag":"API","count":128},{"language":"en","tag":"API reference","count":125},{"language":"ar","tag":"مرجع API","count":125},{"language":"ca","tag":"Referència de l'API","count":125},{"language":"cn","tag":"API 参考","count":125},{"language":"fr-CA","tag":"Référence de l'API","count":125},{"language":"pt-BR","tag":"Referência da API","count":125},{"language":"zh","tag":"API 參考","count":125},{"language":"en","tag":"Service Delivery","count":40},{"language":"ar","tag":"تقديم الخدمة","count":40},{"language":"ca","tag":"Prestació de servei","count":40},{"language":"cn","tag":"服务交付","count":40},{"language":"fr-CA","tag":"Prestation de services","count":40},{"language":"pt-BR","tag":"Entrega de serviços","count":40},{"language":"zh","tag":"服務交付","count":40},{"language":"en","tag":"Remote Management","count":35},{"language":"ar","tag":"الإدارة عن بُعد","count":35},{"language":"ca","tag":"Gestió remota","count":35},{"language":"cn","tag":"远程管理","count":35},{"language":"fr-CA","tag":"Gestion à distance","count":35},{"language":"pt-BR","tag":"Gerenciamento remoto","count":35},{"language":"zh","tag":"遠端管理","count":35},{"language":"en","tag":"Billing","count":34},{"language":"en","tag":"Projects","count":31},{"language":"ar","tag":"Projects","count":28},{"language":"ca","tag":"Projects","count":28},{"language":"cn","tag":"Projects","count":28},{"language":"fr-CA","tag":"Projects","count":28},{"language":"pt-BR","tag":"Projects","count":28},{"language":"zh","tag":"Projects","count":28},{"language":"en","tag":"Assets","count":26},{"language":"ar","tag":"Billing","count":24},{"language":"ca","tag":"Billing","count":24},{"language":"cn","tag":"Billing","count":24},{"language":"fr-CA","tag":"Billing","count":24},{"language":"pt-BR","tag":"Billing","count":24},{"language":"zh","tag":"Billing","count":24},{"language":"en","tag":"Tickets","count":22},{"language":"ar","tag":"Assets","count":22},{"language":"ca","tag":"Assets","count":22},{"language":"cn","tag":"Assets","count":22},{"language":"fr-CA","tag":"Assets","count":22},{"language":"pt-BR","tag":"Tickets","count":22},{"language":"pt-BR","tag":"Assets","count":22},{"language":"zh","tag":"Assets","count":22},{"language":"en","tag":"How-to guides","count":19},{"language":"ar","tag":"أدلة الكيفية","count":19},{"language":"ca","tag":"Guies pràctiques","count":19},{"language":"cn","tag":"操作指南","count":19},{"language":"fr-CA","tag":"Guides pratiques","count":19},{"language":"pt-BR","tag":"Guias práticos","count":19},{"language":"zh","tag":"操作指南","count":19},{"language":"ar","tag":"Tickets","count":16},{"language":"ca","tag":"Tickets","count":16},{"language":"cn","tag":"Tickets","count":16},{"language":"fr-CA","tag":"Tickets","count":16},{"language":"zh","tag":"Tickets","count":16},{"language":"en","tag":"Documents","count":15},{"language":"ca","tag":"Documents","count":15},{"language":"fr-CA","tag":"Documents","count":15},{"language":"ar","tag":"العمليات","count":13},{"language":"cn","tag":"运营","count":13},{"language":"pt-BR","tag":"Operações","count":13},{"language":"zh","tag":"營運","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"help@gorelo.io","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"pt-br/api-reference/tickets/gets-a-single-ticket","slug":"/pt-br/api-reference/tickets/gets-a-single-ticket","pageMetadata":{"title":"Gets a single ticket.","description":"Returns every field the ticket list returns, with the same values, plus the ones the list\r\nleaves out because each costs a further read: the ticket's `Description`, the assets and\r\nuptime checks linked to it, its logged `Time` and `Products` totals, any ticket-level\r\n`BillingOverride`, its `Shipments`, and its `Banner`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}","href":"/pt-br/api-reference/tickets/gets-a-single-ticket","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns every field the ticket list returns, with the same values, plus the ones the list\\r\\nleaves out because each costs a further read: the ticket’s \", _jsx(_components.code, {\n children: \"Description\"\n }), \", the assets and\\r\\nuptime checks linked to it, its logged \", _jsx(_components.code, {\n children: \"Time\"\n }), \" and \", _jsx(_components.code, {\n children: \"Products\"\n }), \" totals, any ticket-level\\r\\n\", _jsx(_components.code, {\n children: \"BillingOverride\"\n }), \", its \", _jsx(_components.code, {\n children: \"Shipments\"\n }), \", and its \", _jsx(_components.code, {\n children: \"Banner\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Gets a single ticket.","description":"Returns every field the ticket list returns, with the same values, plus the ones the list\r\nleaves out because each costs a further read: the ticket's `Description`, the assets and\r\nuptime checks linked to it, its logged `Time` and `Products` totals, any ticket-level\r\n`BillingOverride`, its `Shipments`, and its `Banner`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}","href":"/pt-br/api-reference/tickets/gets-a-single-ticket","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Tickets"],"summary":"Gets a single ticket.","description":"Returns every field the ticket list returns, with the same values, plus the ones the list\r\nleaves out because each costs a further read: the ticket's `Description`, the assets and\r\nuptime checks linked to it, its logged `Time` and `Products` totals, any ticket-level\r\n`BillingOverride`, its `Shipments`, and its `Banner`.","operationId":"get_v1_tickets_ticketId","parameters":["9fdf964d-463c-45f4-8597-b82d7bfc473c"],"responses":{"200":"aa00d000-1f16-4176-8ca8-d3b1e95c1734","400":"20ccc825-a603-42a0-83af-ac2978e43cda","401":"e9cc3d83-090f-4485-92be-53adab1abd93","404":"86e7ec26-148b-4bfa-a79a-964107bf8627","500":"2b918261-6a48-4fc4-8e4d-0118339237ca"},"method":"get","type":"path","servers":["c45f3e55-70a5-4683-bd92-9d0a077a9a8f","2a42ac77-a3aa-4890-87be-e126aeef1e79"],"security":["f01c3aed-69e3-4627-b3db-e003e1c21463"],"path":"/v1/tickets/{ticketId}","baseUrlOptions":["https://api.usw.gorelo.io","https://api.aue.gorelo.io"],"title":"Gets a single ticket.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","urlDisplay":"full"},"dependencies":{"parameters":{"9fdf964d-463c-45f4-8597-b82d7bfc473c":{"name":"ticketId","in":"path","description":"Ticket identifier.","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Ticket identifier.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"aa00d000-1f16-4176-8ca8-d3b1e95c1734":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"type":"object","properties":{"Id":{"type":"string","description":"Ticket identifier.","format":"uuid","uniqueKey":"Data.Id","typeLabel":"string\u003cuuid>"},"Title":{"type":"string","description":"Ticket title/subject.","uniqueKey":"Data.Title","typeLabel":"string"},"Number":{"oneOf":[{"type":"integer","description":"Sequential ticket number.","format":"int64","uniqueKey":"Data.Number.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Sequential ticket number.","format":"int64","uniqueKey":"Data.Number.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Number","typeLabel":"integer\u003cint64> | null"},"DisplayNumber":{"type":"string","description":"Human-readable ticket number, including any service-provider prefix.","uniqueKey":"Data.DisplayNumber","typeLabel":"string"},"ClientId":{"oneOf":[{"type":"integer","description":"Identifier of the client the ticket belongs to.","format":"int64","uniqueKey":"Data.ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the client the ticket belongs to.","format":"int64","uniqueKey":"Data.ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ClientId","typeLabel":"integer\u003cint64> | null"},"LocationId":{"oneOf":[{"type":"integer","description":"Identifier of the client location the ticket belongs to.","format":"int64","uniqueKey":"Data.LocationId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the client location the ticket belongs to.","format":"int64","uniqueKey":"Data.LocationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.LocationId","typeLabel":"integer\u003cint64> | null"},"ContactId":{"oneOf":[{"type":"integer","description":"Identifier of the primary contact.","format":"int64","uniqueKey":"Data.ContactId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the primary contact.","format":"int64","uniqueKey":"Data.ContactId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ContactId","typeLabel":"integer\u003cint64> | null"},"CcContactIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.CcContactIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of additional (CC) contacts.","uniqueKey":"Data.CcContactIds","typeLabel":"integer\u003cint64>[]"},"LeadAssigneeId":{"oneOf":[{"type":"integer","description":"Identifier of the lead assignee (technician).","format":"int64","uniqueKey":"Data.LeadAssigneeId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the lead assignee (technician).","format":"int64","uniqueKey":"Data.LeadAssigneeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.LeadAssigneeId","typeLabel":"integer\u003cint64> | null"},"AssistingAssigneeIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.AssistingAssigneeIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of assisting assignees (technicians).","uniqueKey":"Data.AssistingAssigneeIds","typeLabel":"integer\u003cint64>[]"},"WatcherIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.WatcherIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of technicians watching the ticket.","uniqueKey":"Data.WatcherIds","typeLabel":"integer\u003cint64>[]"},"GroupIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.GroupIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of all technician groups the ticket is assigned to.","uniqueKey":"Data.GroupIds","typeLabel":"integer\u003cint64>[]"},"PrimaryGroupId":{"oneOf":[{"type":"integer","description":"Identifier of the primary technician group.","format":"int64","uniqueKey":"Data.PrimaryGroupId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the primary technician group.","format":"int64","uniqueKey":"Data.PrimaryGroupId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.PrimaryGroupId","typeLabel":"integer\u003cint64> | null"},"Status":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Status.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Status.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Status","typeLabel":"object"},"StatusUpdatedOn":{"oneOf":[{"type":"string","description":"Timestamp of the last status change (UTC).","format":"date-time","uniqueKey":"Data.StatusUpdatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Timestamp of the last status change (UTC).","format":"date-time","uniqueKey":"Data.StatusUpdatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.StatusUpdatedOn","typeLabel":"string\u003cdate-time> | null"},"StatusReason":{"type":"string","description":"Reason recorded for the current status, when applicable.","uniqueKey":"Data.StatusReason","typeLabel":"string"},"Priority":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Priority.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Priority.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Priority","typeLabel":"object"},"Source":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Source.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Source.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Source","typeLabel":"object"},"Type":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Type.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Type.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Type","typeLabel":"object"},"TagIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.TagIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of tags applied to the ticket.","uniqueKey":"Data.TagIds","typeLabel":"integer\u003cint64>[]"},"ChecklistSummary":{"type":"object","properties":{"Completed":{"type":"integer","description":"How many checklist items are completed.","format":"int32","uniqueKey":"Data.ChecklistSummary.Completed","typeLabel":"integer\u003cint32>"},"Total":{"type":"integer","description":"How many checklist items exist in total.","format":"int32","uniqueKey":"Data.ChecklistSummary.Total","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"description":"Checklist completion across every checklist on a ticket.","uniqueKey":"Data.ChecklistSummary","typeLabel":"object"},"IsUnread":{"type":"boolean","description":"Whether the ticket is currently unread.","uniqueKey":"Data.IsUnread","typeLabel":"boolean"},"IsWaitingOnThem":{"type":"boolean","description":"Whether the ticket is waiting on the client rather than on the service provider.","uniqueKey":"Data.IsWaitingOnThem","typeLabel":"boolean"},"IsMerged":{"type":"boolean","description":"Whether the ticket has been merged into another ticket.","uniqueKey":"Data.IsMerged","typeLabel":"boolean"},"MergedIntoTicketId":{"oneOf":[{"type":"integer","description":"Identifier of the ticket this one was merged into, if any.","format":"int64","uniqueKey":"Data.MergedIntoTicketId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the ticket this one was merged into, if any.","format":"int64","uniqueKey":"Data.MergedIntoTicketId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.MergedIntoTicketId","typeLabel":"integer\u003cint64> | null"},"MergedTicketIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"Data.MergedTicketIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Identifiers of tickets merged into this one.","uniqueKey":"Data.MergedTicketIds","typeLabel":"string\u003cuuid>[]"},"Sla":{"type":"object","properties":{"FirstResponse":{"type":"object","properties":{"ElapsedBusinessMinutes":{"oneOf":[{"type":"number","description":"Time from the ticket being created to its first response, in minutes.\r\n Null until the ticket has had a first response.","format":"double","uniqueKey":"Data.Sla.FirstResponse.ElapsedBusinessMinutes.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Time from the ticket being created to its first response, in minutes.\r\n Null until the ticket has had a first response.","format":"double","uniqueKey":"Data.Sla.FirstResponse.ElapsedBusinessMinutes.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Sla.FirstResponse.ElapsedBusinessMinutes","typeLabel":"number\u003cdouble> | null"}},"additionalProperties":false,"description":"First-response SLA details.","uniqueKey":"Data.Sla.FirstResponse","typeLabel":"object"}},"additionalProperties":false,"description":"SLA information for a ticket.","uniqueKey":"Data.Sla","typeLabel":"object"},"LastUpdate":{"type":"object","properties":{"UpdateType":{"type":"string","description":"Type of the last update: New, CommentCreated, StatusUpdated, TechnicianMentioned,\r\nExternalCommentCreated, TechnicianUpdated, Read, Unread. Empty for any other update.","uniqueKey":"Data.LastUpdate.UpdateType","typeLabel":"string"},"Summary":{"type":"string","description":"Short summary of the last update.","uniqueKey":"Data.LastUpdate.Summary","typeLabel":"string"},"On":{"oneOf":[{"type":"string","description":"Timestamp of the last update (UTC).","format":"date-time","uniqueKey":"Data.LastUpdate.On.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Timestamp of the last update (UTC).","format":"date-time","uniqueKey":"Data.LastUpdate.On.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.LastUpdate.On","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"Summary of the most recent update to a ticket.","uniqueKey":"Data.LastUpdate","typeLabel":"object"},"CreatedOn":{"oneOf":[{"type":"string","description":"Ticket creation timestamp (UTC).","format":"date-time","uniqueKey":"Data.CreatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Ticket creation timestamp (UTC).","format":"date-time","uniqueKey":"Data.CreatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.CreatedOn","typeLabel":"string\u003cdate-time> | null"},"UpdatedOn":{"oneOf":[{"type":"string","description":"Ticket last-updated timestamp (UTC). Default sort key for the list endpoint.","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Ticket last-updated timestamp (UTC). Default sort key for the list endpoint.","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UpdatedOn","typeLabel":"string\u003cdate-time> | null"},"ClosedOn":{"oneOf":[{"type":"string","description":"Ticket closed timestamp (UTC), if closed.","format":"date-time","uniqueKey":"Data.ClosedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Ticket closed timestamp (UTC), if closed.","format":"date-time","uniqueKey":"Data.ClosedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ClosedOn","typeLabel":"string\u003cdate-time> | null"},"Description":{"oneOf":[{"type":"string","description":"The ticket's description — the body of its first (primary) comment, as plain text.\r\nNull when the ticket has no primary comment recorded.","uniqueKey":"Data.Description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ticket's description — the body of its first (primary) comment, as plain text.\r\nNull when the ticket has no primary comment recorded.","uniqueKey":"Data.Description.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Description","typeLabel":"string | null"},"AgentAssetIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"Data.AgentAssetIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Identifiers of the managed devices (agent assets) currently linked to the ticket.","uniqueKey":"Data.AgentAssetIds","typeLabel":"string\u003cuuid>[]"},"CustomAssetIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"Data.CustomAssetIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Identifiers of the custom assets currently linked to the ticket.","uniqueKey":"Data.CustomAssetIds","typeLabel":"string\u003cuuid>[]"},"UptimeIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"Data.UptimeIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Identifiers of the uptime checks currently linked to the ticket.","uniqueKey":"Data.UptimeIds","typeLabel":"string\u003cuuid>[]"},"Time":{"type":"object","properties":{"ActualHours":{"type":"number","description":"All time recorded against the ticket as timed, whatever its billable state.","format":"double","uniqueKey":"Data.Time.ActualHours","typeLabel":"number\u003cdouble>"},"AdjustedHours":{"type":"number","description":"The same total after manual corrections to individual entries.","format":"double","uniqueKey":"Data.Time.AdjustedHours","typeLabel":"number\u003cdouble>"},"Breakdown":{"type":"object","properties":{"Billable":{"type":"object","properties":{"ActualHours":{"type":"number","description":"Hours as the timer recorded them.","format":"double","uniqueKey":"Data.Time.Breakdown.Billable.ActualHours","typeLabel":"number\u003cdouble>"},"AdjustedHours":{"type":"number","description":"Hours after any manual correction to the entry.","format":"double","uniqueKey":"Data.Time.Breakdown.Billable.AdjustedHours","typeLabel":"number\u003cdouble>"}},"additionalProperties":false,"description":"One bucket of a ticket's time, in decimal hours.","uniqueKey":"Data.Time.Breakdown.Billable","typeLabel":"object"},"NotBillable":{"type":"object","properties":{"ActualHours":{"type":"number","description":"Hours as the timer recorded them.","format":"double","uniqueKey":"Data.Time.Breakdown.NotBillable.ActualHours","typeLabel":"number\u003cdouble>"},"AdjustedHours":{"type":"number","description":"Hours after any manual correction to the entry.","format":"double","uniqueKey":"Data.Time.Breakdown.NotBillable.AdjustedHours","typeLabel":"number\u003cdouble>"}},"additionalProperties":false,"description":"One bucket of a ticket's time, in decimal hours.","uniqueKey":"Data.Time.Breakdown.NotBillable","typeLabel":"object"},"NotBillableHidden":{"type":"object","properties":{"ActualHours":{"type":"number","description":"Hours as the timer recorded them.","format":"double","uniqueKey":"Data.Time.Breakdown.NotBillableHidden.ActualHours","typeLabel":"number\u003cdouble>"},"AdjustedHours":{"type":"number","description":"Hours after any manual correction to the entry.","format":"double","uniqueKey":"Data.Time.Breakdown.NotBillableHidden.AdjustedHours","typeLabel":"number\u003cdouble>"}},"additionalProperties":false,"description":"One bucket of a ticket's time, in decimal hours.","uniqueKey":"Data.Time.Breakdown.NotBillableHidden","typeLabel":"object"}},"additionalProperties":false,"description":"A ticket's time split by billable state. An entry stays in its billable-state bucket\r\nwhatever its position in the billing pipeline — approved or invoiced time is not moved\r\nelsewhere — so the buckets do not overlap.","uniqueKey":"Data.Time.Breakdown","typeLabel":"object"}},"additionalProperties":false,"description":"Time logged against a ticket, in decimal hours, summed from the ticket's time entries.\r\n \r\nEvery figure comes in two forms: the time as the timer actually recorded it, and the time as it\r\nstands after a technician corrected an entry by hand. An entry with no correction reports the\r\nsame value for both, so the two totals differ only on tickets where someone adjusted an entry.\r\n \r\nAn entry still being timed, or one whose recorded end precedes its start, has no usable duration\r\nand contributes nothing. Each figure is rounded to four decimal places.","uniqueKey":"Data.Time","typeLabel":"object"},"Products":{"type":"object","properties":{"Count":{"type":"integer","description":"How many products are on the ticket, whatever their billable state.","format":"int32","uniqueKey":"Data.Products.Count","typeLabel":"integer\u003cint32>"},"TotalAmount":{"type":"number","description":"What those products are worth to the client, in the service provider's currency: each\r\nbillable product's price × quantity, rounded to two decimals, summed. Products marked not\r\nbillable, hidden or void are counted by `Count` but contribute nothing here,\r\nbecause invoicing bills them as zero. Excludes tax.","format":"double","uniqueKey":"Data.Products.TotalAmount","typeLabel":"number\u003cdouble>"}},"additionalProperties":false,"description":"The products added to a ticket.","uniqueKey":"Data.Products","typeLabel":"object"},"BillingOverride":{"type":"object","properties":{"ServiceLine":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.BillingOverride.ServiceLine.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.BillingOverride.ServiceLine.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.BillingOverride.ServiceLine","typeLabel":"object"},"BillingRole":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.BillingOverride.BillingRole.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.BillingOverride.BillingRole.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.BillingOverride.BillingRole","typeLabel":"object"},"WorkType":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.BillingOverride.WorkType.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.BillingOverride.WorkType.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.BillingOverride.WorkType","typeLabel":"object"},"BillableStatus":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.BillingOverride.BillableStatus.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.BillingOverride.BillableStatus.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.BillingOverride.BillableStatus","typeLabel":"object"}},"additionalProperties":false,"description":"Billing settings overridden at the ticket level.","uniqueKey":"Data.BillingOverride","typeLabel":"object"},"Shipments":{"type":"array","items":{"type":"object","properties":{"TrackingNumber":{"type":"string","description":"The carrier's tracking number.","uniqueKey":"Data.Shipments.items.[INDEX].TrackingNumber","typeLabel":"string"},"Carrier":{"type":"string","description":"The carrier, as its tracking slug (e.g. \"star-track\").","uniqueKey":"Data.Shipments.items.[INDEX].Carrier","typeLabel":"string"},"Status":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Shipments.items.[INDEX].Status.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Shipments.items.[INDEX].Status.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Shipments.items.[INDEX].Status","typeLabel":"object"},"Name":{"oneOf":[{"type":"string","description":"Label given to the shipment on the ticket.","uniqueKey":"Data.Shipments.items.[INDEX].Name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Label given to the shipment on the ticket.","uniqueKey":"Data.Shipments.items.[INDEX].Name.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Shipments.items.[INDEX].Name","typeLabel":"string | null"}},"additionalProperties":false,"description":"One shipment tracked on a ticket.","uniqueKey":"Data.Shipments.items.[INDEX]","typeLabel":"object"},"description":"Shipment tracking attached to the ticket, one entry per tracking number.","uniqueKey":"Data.Shipments","typeLabel":"object[]"},"Banner":{"oneOf":[{"type":"string","description":"Banner text shown on the ticket. May contain HTML.","uniqueKey":"Data.Banner.oneOf.0","typeLabel":"string"},{"type":"null","description":"Banner text shown on the ticket. May contain HTML.","uniqueKey":"Data.Banner.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Banner","typeLabel":"string | null"}},"additionalProperties":false,"description":"A ticket's full detail, as returned by the single-ticket endpoint. Every field the ticket list\r\nserves is present and carries the same value; the fields below are the ones the list leaves out\r\nbecause they each cost an extra read and are rarely wanted for every row of a page.\r\nAll timestamps are UTC.","uniqueKey":"Data","typeLabel":"object"},"DataContext":{"oneOf":[{"type":"object","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext","typeLabel":"object | null"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Title":"\u003cstring>","Number":123,"DisplayNumber":"\u003cstring>","ClientId":123,"LocationId":123,"ContactId":123,"CcContactIds":[123],"LeadAssigneeId":123,"AssistingAssigneeIds":[123],"WatcherIds":[123],"GroupIds":[123],"PrimaryGroupId":123,"Status":{"Id":1,"Name":"\u003cstring>"},"StatusUpdatedOn":"2023-11-07T05:31:56Z","StatusReason":"\u003cstring>","Priority":{"Id":1,"Name":"\u003cstring>"},"Source":{"Id":1,"Name":"\u003cstring>"},"Type":{"Id":1,"Name":"\u003cstring>"},"TagIds":[123],"ChecklistSummary":{"Completed":123,"Total":123},"IsUnread":true,"IsWaitingOnThem":true,"IsMerged":true,"MergedIntoTicketId":123,"MergedTicketIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"Sla":{"FirstResponse":{"ElapsedBusinessMinutes":123}},"LastUpdate":{"UpdateType":"\u003cstring>","Summary":"\u003cstring>","On":"2023-11-07T05:31:56Z"},"CreatedOn":"2023-11-07T05:31:56Z","UpdatedOn":"2023-11-07T05:31:56Z","ClosedOn":"2023-11-07T05:31:56Z","Description":"\u003cstring>","AgentAssetIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"CustomAssetIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"UptimeIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"Time":{"ActualHours":123,"AdjustedHours":123,"Breakdown":{"Billable":{"ActualHours":123,"AdjustedHours":123},"NotBillable":{"ActualHours":123,"AdjustedHours":123},"NotBillableHidden":{"ActualHours":123,"AdjustedHours":123}}},"Products":{"Count":123,"TotalAmount":123},"BillingOverride":{"ServiceLine":{"Id":1,"Name":"\u003cstring>"},"BillingRole":{"Id":1,"Name":"\u003cstring>"},"WorkType":{"Id":1,"Name":"\u003cstring>"},"BillableStatus":{"Id":1,"Name":"\u003cstring>"}},"Shipments":[{"TrackingNumber":"\u003cstring>","Carrier":"\u003cstring>","Status":{"Id":1,"Name":"\u003cstring>"},"Name":"\u003cstring>"}],"Banner":"\u003cstring>"},"DataContext":null,"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"type":"object","properties":{"Id":{"type":"string","description":"Ticket identifier.","format":"uuid","uniqueKey":"Data.Id","typeLabel":"string\u003cuuid>"},"Title":{"type":"string","description":"Ticket title/subject.","uniqueKey":"Data.Title","typeLabel":"string"},"Number":{"oneOf":[{"type":"integer","description":"Sequential ticket number.","format":"int64","uniqueKey":"Data.Number.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Sequential ticket number.","format":"int64","uniqueKey":"Data.Number.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Number","typeLabel":"integer\u003cint64> | null"},"DisplayNumber":{"type":"string","description":"Human-readable ticket number, including any service-provider prefix.","uniqueKey":"Data.DisplayNumber","typeLabel":"string"},"ClientId":{"oneOf":[{"type":"integer","description":"Identifier of the client the ticket belongs to.","format":"int64","uniqueKey":"Data.ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the client the ticket belongs to.","format":"int64","uniqueKey":"Data.ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ClientId","typeLabel":"integer\u003cint64> | null"},"LocationId":{"oneOf":[{"type":"integer","description":"Identifier of the client location the ticket belongs to.","format":"int64","uniqueKey":"Data.LocationId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the client location the ticket belongs to.","format":"int64","uniqueKey":"Data.LocationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.LocationId","typeLabel":"integer\u003cint64> | null"},"ContactId":{"oneOf":[{"type":"integer","description":"Identifier of the primary contact.","format":"int64","uniqueKey":"Data.ContactId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the primary contact.","format":"int64","uniqueKey":"Data.ContactId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ContactId","typeLabel":"integer\u003cint64> | null"},"CcContactIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.CcContactIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of additional (CC) contacts.","uniqueKey":"Data.CcContactIds","typeLabel":"integer\u003cint64>[]"},"LeadAssigneeId":{"oneOf":[{"type":"integer","description":"Identifier of the lead assignee (technician).","format":"int64","uniqueKey":"Data.LeadAssigneeId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the lead assignee (technician).","format":"int64","uniqueKey":"Data.LeadAssigneeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.LeadAssigneeId","typeLabel":"integer\u003cint64> | null"},"AssistingAssigneeIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.AssistingAssigneeIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of assisting assignees (technicians).","uniqueKey":"Data.AssistingAssigneeIds","typeLabel":"integer\u003cint64>[]"},"WatcherIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.WatcherIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of technicians watching the ticket.","uniqueKey":"Data.WatcherIds","typeLabel":"integer\u003cint64>[]"},"GroupIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.GroupIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of all technician groups the ticket is assigned to.","uniqueKey":"Data.GroupIds","typeLabel":"integer\u003cint64>[]"},"PrimaryGroupId":{"oneOf":[{"type":"integer","description":"Identifier of the primary technician group.","format":"int64","uniqueKey":"Data.PrimaryGroupId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the primary technician group.","format":"int64","uniqueKey":"Data.PrimaryGroupId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.PrimaryGroupId","typeLabel":"integer\u003cint64> | null"},"Status":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Status.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Status.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Status","typeLabel":"object"},"StatusUpdatedOn":{"oneOf":[{"type":"string","description":"Timestamp of the last status change (UTC).","format":"date-time","uniqueKey":"Data.StatusUpdatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Timestamp of the last status change (UTC).","format":"date-time","uniqueKey":"Data.StatusUpdatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.StatusUpdatedOn","typeLabel":"string\u003cdate-time> | null"},"StatusReason":{"type":"string","description":"Reason recorded for the current status, when applicable.","uniqueKey":"Data.StatusReason","typeLabel":"string"},"Priority":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Priority.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Priority.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Priority","typeLabel":"object"},"Source":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Source.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Source.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Source","typeLabel":"object"},"Type":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Type.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Type.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Type","typeLabel":"object"},"TagIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.TagIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of tags applied to the ticket.","uniqueKey":"Data.TagIds","typeLabel":"integer\u003cint64>[]"},"ChecklistSummary":{"type":"object","properties":{"Completed":{"type":"integer","description":"How many checklist items are completed.","format":"int32","uniqueKey":"Data.ChecklistSummary.Completed","typeLabel":"integer\u003cint32>"},"Total":{"type":"integer","description":"How many checklist items exist in total.","format":"int32","uniqueKey":"Data.ChecklistSummary.Total","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"description":"Checklist completion across every checklist on a ticket.","uniqueKey":"Data.ChecklistSummary","typeLabel":"object"},"IsUnread":{"type":"boolean","description":"Whether the ticket is currently unread.","uniqueKey":"Data.IsUnread","typeLabel":"boolean"},"IsWaitingOnThem":{"type":"boolean","description":"Whether the ticket is waiting on the client rather than on the service provider.","uniqueKey":"Data.IsWaitingOnThem","typeLabel":"boolean"},"IsMerged":{"type":"boolean","description":"Whether the ticket has been merged into another ticket.","uniqueKey":"Data.IsMerged","typeLabel":"boolean"},"MergedIntoTicketId":{"oneOf":[{"type":"integer","description":"Identifier of the ticket this one was merged into, if any.","format":"int64","uniqueKey":"Data.MergedIntoTicketId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the ticket this one was merged into, if any.","format":"int64","uniqueKey":"Data.MergedIntoTicketId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.MergedIntoTicketId","typeLabel":"integer\u003cint64> | null"},"MergedTicketIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"Data.MergedTicketIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Identifiers of tickets merged into this one.","uniqueKey":"Data.MergedTicketIds","typeLabel":"string\u003cuuid>[]"},"Sla":{"type":"object","properties":{"FirstResponse":{"type":"object","properties":{"ElapsedBusinessMinutes":{"oneOf":[{"type":"number","description":"Time from the ticket being created to its first response, in minutes.\r\n Null until the ticket has had a first response.","format":"double","uniqueKey":"Data.Sla.FirstResponse.ElapsedBusinessMinutes.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Time from the ticket being created to its first response, in minutes.\r\n Null until the ticket has had a first response.","format":"double","uniqueKey":"Data.Sla.FirstResponse.ElapsedBusinessMinutes.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Sla.FirstResponse.ElapsedBusinessMinutes","typeLabel":"number\u003cdouble> | null"}},"additionalProperties":false,"description":"First-response SLA details.","uniqueKey":"Data.Sla.FirstResponse","typeLabel":"object"}},"additionalProperties":false,"description":"SLA information for a ticket.","uniqueKey":"Data.Sla","typeLabel":"object"},"LastUpdate":{"type":"object","properties":{"UpdateType":{"type":"string","description":"Type of the last update: New, CommentCreated, StatusUpdated, TechnicianMentioned,\r\nExternalCommentCreated, TechnicianUpdated, Read, Unread. Empty for any other update.","uniqueKey":"Data.LastUpdate.UpdateType","typeLabel":"string"},"Summary":{"type":"string","description":"Short summary of the last update.","uniqueKey":"Data.LastUpdate.Summary","typeLabel":"string"},"On":{"oneOf":[{"type":"string","description":"Timestamp of the last update (UTC).","format":"date-time","uniqueKey":"Data.LastUpdate.On.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Timestamp of the last update (UTC).","format":"date-time","uniqueKey":"Data.LastUpdate.On.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.LastUpdate.On","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"Summary of the most recent update to a ticket.","uniqueKey":"Data.LastUpdate","typeLabel":"object"},"CreatedOn":{"oneOf":[{"type":"string","description":"Ticket creation timestamp (UTC).","format":"date-time","uniqueKey":"Data.CreatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Ticket creation timestamp (UTC).","format":"date-time","uniqueKey":"Data.CreatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.CreatedOn","typeLabel":"string\u003cdate-time> | null"},"UpdatedOn":{"oneOf":[{"type":"string","description":"Ticket last-updated timestamp (UTC). Default sort key for the list endpoint.","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Ticket last-updated timestamp (UTC). Default sort key for the list endpoint.","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UpdatedOn","typeLabel":"string\u003cdate-time> | null"},"ClosedOn":{"oneOf":[{"type":"string","description":"Ticket closed timestamp (UTC), if closed.","format":"date-time","uniqueKey":"Data.ClosedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Ticket closed timestamp (UTC), if closed.","format":"date-time","uniqueKey":"Data.ClosedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ClosedOn","typeLabel":"string\u003cdate-time> | null"},"Description":{"oneOf":[{"type":"string","description":"The ticket's description — the body of its first (primary) comment, as plain text.\r\nNull when the ticket has no primary comment recorded.","uniqueKey":"Data.Description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ticket's description — the body of its first (primary) comment, as plain text.\r\nNull when the ticket has no primary comment recorded.","uniqueKey":"Data.Description.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Description","typeLabel":"string | null"},"AgentAssetIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"Data.AgentAssetIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Identifiers of the managed devices (agent assets) currently linked to the ticket.","uniqueKey":"Data.AgentAssetIds","typeLabel":"string\u003cuuid>[]"},"CustomAssetIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"Data.CustomAssetIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Identifiers of the custom assets currently linked to the ticket.","uniqueKey":"Data.CustomAssetIds","typeLabel":"string\u003cuuid>[]"},"UptimeIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"Data.UptimeIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Identifiers of the uptime checks currently linked to the ticket.","uniqueKey":"Data.UptimeIds","typeLabel":"string\u003cuuid>[]"},"Time":{"type":"object","properties":{"ActualHours":{"type":"number","description":"All time recorded against the ticket as timed, whatever its billable state.","format":"double","uniqueKey":"Data.Time.ActualHours","typeLabel":"number\u003cdouble>"},"AdjustedHours":{"type":"number","description":"The same total after manual corrections to individual entries.","format":"double","uniqueKey":"Data.Time.AdjustedHours","typeLabel":"number\u003cdouble>"},"Breakdown":{"type":"object","properties":{"Billable":{"type":"object","properties":{"ActualHours":{"type":"number","description":"Hours as the timer recorded them.","format":"double","uniqueKey":"Data.Time.Breakdown.Billable.ActualHours","typeLabel":"number\u003cdouble>"},"AdjustedHours":{"type":"number","description":"Hours after any manual correction to the entry.","format":"double","uniqueKey":"Data.Time.Breakdown.Billable.AdjustedHours","typeLabel":"number\u003cdouble>"}},"additionalProperties":false,"description":"One bucket of a ticket's time, in decimal hours.","uniqueKey":"Data.Time.Breakdown.Billable","typeLabel":"object"},"NotBillable":{"type":"object","properties":{"ActualHours":{"type":"number","description":"Hours as the timer recorded them.","format":"double","uniqueKey":"Data.Time.Breakdown.NotBillable.ActualHours","typeLabel":"number\u003cdouble>"},"AdjustedHours":{"type":"number","description":"Hours after any manual correction to the entry.","format":"double","uniqueKey":"Data.Time.Breakdown.NotBillable.AdjustedHours","typeLabel":"number\u003cdouble>"}},"additionalProperties":false,"description":"One bucket of a ticket's time, in decimal hours.","uniqueKey":"Data.Time.Breakdown.NotBillable","typeLabel":"object"},"NotBillableHidden":{"type":"object","properties":{"ActualHours":{"type":"number","description":"Hours as the timer recorded them.","format":"double","uniqueKey":"Data.Time.Breakdown.NotBillableHidden.ActualHours","typeLabel":"number\u003cdouble>"},"AdjustedHours":{"type":"number","description":"Hours after any manual correction to the entry.","format":"double","uniqueKey":"Data.Time.Breakdown.NotBillableHidden.AdjustedHours","typeLabel":"number\u003cdouble>"}},"additionalProperties":false,"description":"One bucket of a ticket's time, in decimal hours.","uniqueKey":"Data.Time.Breakdown.NotBillableHidden","typeLabel":"object"}},"additionalProperties":false,"description":"A ticket's time split by billable state. An entry stays in its billable-state bucket\r\nwhatever its position in the billing pipeline — approved or invoiced time is not moved\r\nelsewhere — so the buckets do not overlap.","uniqueKey":"Data.Time.Breakdown","typeLabel":"object"}},"additionalProperties":false,"description":"Time logged against a ticket, in decimal hours, summed from the ticket's time entries.\r\n \r\nEvery figure comes in two forms: the time as the timer actually recorded it, and the time as it\r\nstands after a technician corrected an entry by hand. An entry with no correction reports the\r\nsame value for both, so the two totals differ only on tickets where someone adjusted an entry.\r\n \r\nAn entry still being timed, or one whose recorded end precedes its start, has no usable duration\r\nand contributes nothing. Each figure is rounded to four decimal places.","uniqueKey":"Data.Time","typeLabel":"object"},"Products":{"type":"object","properties":{"Count":{"type":"integer","description":"How many products are on the ticket, whatever their billable state.","format":"int32","uniqueKey":"Data.Products.Count","typeLabel":"integer\u003cint32>"},"TotalAmount":{"type":"number","description":"What those products are worth to the client, in the service provider's currency: each\r\nbillable product's price × quantity, rounded to two decimals, summed. Products marked not\r\nbillable, hidden or void are counted by `Count` but contribute nothing here,\r\nbecause invoicing bills them as zero. Excludes tax.","format":"double","uniqueKey":"Data.Products.TotalAmount","typeLabel":"number\u003cdouble>"}},"additionalProperties":false,"description":"The products added to a ticket.","uniqueKey":"Data.Products","typeLabel":"object"},"BillingOverride":{"type":"object","properties":{"ServiceLine":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.BillingOverride.ServiceLine.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.BillingOverride.ServiceLine.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.BillingOverride.ServiceLine","typeLabel":"object"},"BillingRole":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.BillingOverride.BillingRole.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.BillingOverride.BillingRole.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.BillingOverride.BillingRole","typeLabel":"object"},"WorkType":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.BillingOverride.WorkType.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.BillingOverride.WorkType.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.BillingOverride.WorkType","typeLabel":"object"},"BillableStatus":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.BillingOverride.BillableStatus.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.BillingOverride.BillableStatus.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.BillingOverride.BillableStatus","typeLabel":"object"}},"additionalProperties":false,"description":"Billing settings overridden at the ticket level.","uniqueKey":"Data.BillingOverride","typeLabel":"object"},"Shipments":{"type":"array","items":{"type":"object","properties":{"TrackingNumber":{"type":"string","description":"The carrier's tracking number.","uniqueKey":"Data.Shipments.items.[INDEX].TrackingNumber","typeLabel":"string"},"Carrier":{"type":"string","description":"The carrier, as its tracking slug (e.g. \"star-track\").","uniqueKey":"Data.Shipments.items.[INDEX].Carrier","typeLabel":"string"},"Status":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Shipments.items.[INDEX].Status.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Shipments.items.[INDEX].Status.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Shipments.items.[INDEX].Status","typeLabel":"object"},"Name":{"oneOf":[{"type":"string","description":"Label given to the shipment on the ticket.","uniqueKey":"Data.Shipments.items.[INDEX].Name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Label given to the shipment on the ticket.","uniqueKey":"Data.Shipments.items.[INDEX].Name.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Shipments.items.[INDEX].Name","typeLabel":"string | null"}},"additionalProperties":false,"description":"One shipment tracked on a ticket.","uniqueKey":"Data.Shipments.items.[INDEX]","typeLabel":"object"},"description":"Shipment tracking attached to the ticket, one entry per tracking number.","uniqueKey":"Data.Shipments","typeLabel":"object[]"},"Banner":{"oneOf":[{"type":"string","description":"Banner text shown on the ticket. May contain HTML.","uniqueKey":"Data.Banner.oneOf.0","typeLabel":"string"},{"type":"null","description":"Banner text shown on the ticket. May contain HTML.","uniqueKey":"Data.Banner.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Banner","typeLabel":"string | null"}},"additionalProperties":false,"description":"A ticket's full detail, as returned by the single-ticket endpoint. Every field the ticket list\r\nserves is present and carries the same value; the fields below are the ones the list leaves out\r\nbecause they each cost an extra read and are rarely wanted for every row of a page.\r\nAll timestamps are UTC.","uniqueKey":"Data","typeLabel":"object"},"DataContext":{"oneOf":[{"type":"object","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext","typeLabel":"object | null"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Title":"\u003cstring>","Number":123,"DisplayNumber":"\u003cstring>","ClientId":123,"LocationId":123,"ContactId":123,"CcContactIds":[123],"LeadAssigneeId":123,"AssistingAssigneeIds":[123],"WatcherIds":[123],"GroupIds":[123],"PrimaryGroupId":123,"Status":{"Id":1,"Name":"\u003cstring>"},"StatusUpdatedOn":"2023-11-07T05:31:56Z","StatusReason":"\u003cstring>","Priority":{"Id":1,"Name":"\u003cstring>"},"Source":{"Id":1,"Name":"\u003cstring>"},"Type":{"Id":1,"Name":"\u003cstring>"},"TagIds":[123],"ChecklistSummary":{"Completed":123,"Total":123},"IsUnread":true,"IsWaitingOnThem":true,"IsMerged":true,"MergedIntoTicketId":123,"MergedTicketIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"Sla":{"FirstResponse":{"ElapsedBusinessMinutes":123}},"LastUpdate":{"UpdateType":"\u003cstring>","Summary":"\u003cstring>","On":"2023-11-07T05:31:56Z"},"CreatedOn":"2023-11-07T05:31:56Z","UpdatedOn":"2023-11-07T05:31:56Z","ClosedOn":"2023-11-07T05:31:56Z","Description":"\u003cstring>","AgentAssetIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"CustomAssetIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"UptimeIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"Time":{"ActualHours":123,"AdjustedHours":123,"Breakdown":{"Billable":{"ActualHours":123,"AdjustedHours":123},"NotBillable":{"ActualHours":123,"AdjustedHours":123},"NotBillableHidden":{"ActualHours":123,"AdjustedHours":123}}},"Products":{"Count":123,"TotalAmount":123},"BillingOverride":{"ServiceLine":{"Id":1,"Name":"\u003cstring>"},"BillingRole":{"Id":1,"Name":"\u003cstring>"},"WorkType":{"Id":1,"Name":"\u003cstring>"},"BillableStatus":{"Id":1,"Name":"\u003cstring>"}},"Shipments":[{"TrackingNumber":"\u003cstring>","Carrier":"\u003cstring>","Status":{"Id":1,"Name":"\u003cstring>"},"Name":"\u003cstring>"}],"Banner":"\u003cstring>"},"DataContext":null,"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"type":"object","properties":{"Id":{"type":"string","description":"Ticket identifier.","format":"uuid","uniqueKey":"Data.Id","typeLabel":"string\u003cuuid>"},"Title":{"type":"string","description":"Ticket title/subject.","uniqueKey":"Data.Title","typeLabel":"string"},"Number":{"oneOf":[{"type":"integer","description":"Sequential ticket number.","format":"int64","uniqueKey":"Data.Number.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Sequential ticket number.","format":"int64","uniqueKey":"Data.Number.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Number","typeLabel":"integer\u003cint64> | null"},"DisplayNumber":{"type":"string","description":"Human-readable ticket number, including any service-provider prefix.","uniqueKey":"Data.DisplayNumber","typeLabel":"string"},"ClientId":{"oneOf":[{"type":"integer","description":"Identifier of the client the ticket belongs to.","format":"int64","uniqueKey":"Data.ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the client the ticket belongs to.","format":"int64","uniqueKey":"Data.ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ClientId","typeLabel":"integer\u003cint64> | null"},"LocationId":{"oneOf":[{"type":"integer","description":"Identifier of the client location the ticket belongs to.","format":"int64","uniqueKey":"Data.LocationId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the client location the ticket belongs to.","format":"int64","uniqueKey":"Data.LocationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.LocationId","typeLabel":"integer\u003cint64> | null"},"ContactId":{"oneOf":[{"type":"integer","description":"Identifier of the primary contact.","format":"int64","uniqueKey":"Data.ContactId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the primary contact.","format":"int64","uniqueKey":"Data.ContactId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ContactId","typeLabel":"integer\u003cint64> | null"},"CcContactIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.CcContactIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of additional (CC) contacts.","uniqueKey":"Data.CcContactIds","typeLabel":"integer\u003cint64>[]"},"LeadAssigneeId":{"oneOf":[{"type":"integer","description":"Identifier of the lead assignee (technician).","format":"int64","uniqueKey":"Data.LeadAssigneeId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the lead assignee (technician).","format":"int64","uniqueKey":"Data.LeadAssigneeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.LeadAssigneeId","typeLabel":"integer\u003cint64> | null"},"AssistingAssigneeIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.AssistingAssigneeIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of assisting assignees (technicians).","uniqueKey":"Data.AssistingAssigneeIds","typeLabel":"integer\u003cint64>[]"},"WatcherIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.WatcherIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of technicians watching the ticket.","uniqueKey":"Data.WatcherIds","typeLabel":"integer\u003cint64>[]"},"GroupIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.GroupIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of all technician groups the ticket is assigned to.","uniqueKey":"Data.GroupIds","typeLabel":"integer\u003cint64>[]"},"PrimaryGroupId":{"oneOf":[{"type":"integer","description":"Identifier of the primary technician group.","format":"int64","uniqueKey":"Data.PrimaryGroupId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the primary technician group.","format":"int64","uniqueKey":"Data.PrimaryGroupId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.PrimaryGroupId","typeLabel":"integer\u003cint64> | null"},"Status":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Status.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Status.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Status","typeLabel":"object"},"StatusUpdatedOn":{"oneOf":[{"type":"string","description":"Timestamp of the last status change (UTC).","format":"date-time","uniqueKey":"Data.StatusUpdatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Timestamp of the last status change (UTC).","format":"date-time","uniqueKey":"Data.StatusUpdatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.StatusUpdatedOn","typeLabel":"string\u003cdate-time> | null"},"StatusReason":{"type":"string","description":"Reason recorded for the current status, when applicable.","uniqueKey":"Data.StatusReason","typeLabel":"string"},"Priority":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Priority.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Priority.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Priority","typeLabel":"object"},"Source":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Source.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Source.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Source","typeLabel":"object"},"Type":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Type.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Type.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Type","typeLabel":"object"},"TagIds":{"type":"array","items":{"type":"integer","format":"int64","uniqueKey":"Data.TagIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"description":"Identifiers of tags applied to the ticket.","uniqueKey":"Data.TagIds","typeLabel":"integer\u003cint64>[]"},"ChecklistSummary":{"type":"object","properties":{"Completed":{"type":"integer","description":"How many checklist items are completed.","format":"int32","uniqueKey":"Data.ChecklistSummary.Completed","typeLabel":"integer\u003cint32>"},"Total":{"type":"integer","description":"How many checklist items exist in total.","format":"int32","uniqueKey":"Data.ChecklistSummary.Total","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"description":"Checklist completion across every checklist on a ticket.","uniqueKey":"Data.ChecklistSummary","typeLabel":"object"},"IsUnread":{"type":"boolean","description":"Whether the ticket is currently unread.","uniqueKey":"Data.IsUnread","typeLabel":"boolean"},"IsWaitingOnThem":{"type":"boolean","description":"Whether the ticket is waiting on the client rather than on the service provider.","uniqueKey":"Data.IsWaitingOnThem","typeLabel":"boolean"},"IsMerged":{"type":"boolean","description":"Whether the ticket has been merged into another ticket.","uniqueKey":"Data.IsMerged","typeLabel":"boolean"},"MergedIntoTicketId":{"oneOf":[{"type":"integer","description":"Identifier of the ticket this one was merged into, if any.","format":"int64","uniqueKey":"Data.MergedIntoTicketId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the ticket this one was merged into, if any.","format":"int64","uniqueKey":"Data.MergedIntoTicketId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.MergedIntoTicketId","typeLabel":"integer\u003cint64> | null"},"MergedTicketIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"Data.MergedTicketIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Identifiers of tickets merged into this one.","uniqueKey":"Data.MergedTicketIds","typeLabel":"string\u003cuuid>[]"},"Sla":{"type":"object","properties":{"FirstResponse":{"type":"object","properties":{"ElapsedBusinessMinutes":{"oneOf":[{"type":"number","description":"Time from the ticket being created to its first response, in minutes.\r\n Null until the ticket has had a first response.","format":"double","uniqueKey":"Data.Sla.FirstResponse.ElapsedBusinessMinutes.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Time from the ticket being created to its first response, in minutes.\r\n Null until the ticket has had a first response.","format":"double","uniqueKey":"Data.Sla.FirstResponse.ElapsedBusinessMinutes.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Sla.FirstResponse.ElapsedBusinessMinutes","typeLabel":"number\u003cdouble> | null"}},"additionalProperties":false,"description":"First-response SLA details.","uniqueKey":"Data.Sla.FirstResponse","typeLabel":"object"}},"additionalProperties":false,"description":"SLA information for a ticket.","uniqueKey":"Data.Sla","typeLabel":"object"},"LastUpdate":{"type":"object","properties":{"UpdateType":{"type":"string","description":"Type of the last update: New, CommentCreated, StatusUpdated, TechnicianMentioned,\r\nExternalCommentCreated, TechnicianUpdated, Read, Unread. Empty for any other update.","uniqueKey":"Data.LastUpdate.UpdateType","typeLabel":"string"},"Summary":{"type":"string","description":"Short summary of the last update.","uniqueKey":"Data.LastUpdate.Summary","typeLabel":"string"},"On":{"oneOf":[{"type":"string","description":"Timestamp of the last update (UTC).","format":"date-time","uniqueKey":"Data.LastUpdate.On.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Timestamp of the last update (UTC).","format":"date-time","uniqueKey":"Data.LastUpdate.On.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.LastUpdate.On","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"Summary of the most recent update to a ticket.","uniqueKey":"Data.LastUpdate","typeLabel":"object"},"CreatedOn":{"oneOf":[{"type":"string","description":"Ticket creation timestamp (UTC).","format":"date-time","uniqueKey":"Data.CreatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Ticket creation timestamp (UTC).","format":"date-time","uniqueKey":"Data.CreatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.CreatedOn","typeLabel":"string\u003cdate-time> | null"},"UpdatedOn":{"oneOf":[{"type":"string","description":"Ticket last-updated timestamp (UTC). Default sort key for the list endpoint.","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Ticket last-updated timestamp (UTC). Default sort key for the list endpoint.","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UpdatedOn","typeLabel":"string\u003cdate-time> | null"},"ClosedOn":{"oneOf":[{"type":"string","description":"Ticket closed timestamp (UTC), if closed.","format":"date-time","uniqueKey":"Data.ClosedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Ticket closed timestamp (UTC), if closed.","format":"date-time","uniqueKey":"Data.ClosedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ClosedOn","typeLabel":"string\u003cdate-time> | null"},"Description":{"oneOf":[{"type":"string","description":"The ticket's description — the body of its first (primary) comment, as plain text.\r\nNull when the ticket has no primary comment recorded.","uniqueKey":"Data.Description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ticket's description — the body of its first (primary) comment, as plain text.\r\nNull when the ticket has no primary comment recorded.","uniqueKey":"Data.Description.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Description","typeLabel":"string | null"},"AgentAssetIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"Data.AgentAssetIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Identifiers of the managed devices (agent assets) currently linked to the ticket.","uniqueKey":"Data.AgentAssetIds","typeLabel":"string\u003cuuid>[]"},"CustomAssetIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"Data.CustomAssetIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Identifiers of the custom assets currently linked to the ticket.","uniqueKey":"Data.CustomAssetIds","typeLabel":"string\u003cuuid>[]"},"UptimeIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"Data.UptimeIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Identifiers of the uptime checks currently linked to the ticket.","uniqueKey":"Data.UptimeIds","typeLabel":"string\u003cuuid>[]"},"Time":{"type":"object","properties":{"ActualHours":{"type":"number","description":"All time recorded against the ticket as timed, whatever its billable state.","format":"double","uniqueKey":"Data.Time.ActualHours","typeLabel":"number\u003cdouble>"},"AdjustedHours":{"type":"number","description":"The same total after manual corrections to individual entries.","format":"double","uniqueKey":"Data.Time.AdjustedHours","typeLabel":"number\u003cdouble>"},"Breakdown":{"type":"object","properties":{"Billable":{"type":"object","properties":{"ActualHours":{"type":"number","description":"Hours as the timer recorded them.","format":"double","uniqueKey":"Data.Time.Breakdown.Billable.ActualHours","typeLabel":"number\u003cdouble>"},"AdjustedHours":{"type":"number","description":"Hours after any manual correction to the entry.","format":"double","uniqueKey":"Data.Time.Breakdown.Billable.AdjustedHours","typeLabel":"number\u003cdouble>"}},"additionalProperties":false,"description":"One bucket of a ticket's time, in decimal hours.","uniqueKey":"Data.Time.Breakdown.Billable","typeLabel":"object"},"NotBillable":{"type":"object","properties":{"ActualHours":{"type":"number","description":"Hours as the timer recorded them.","format":"double","uniqueKey":"Data.Time.Breakdown.NotBillable.ActualHours","typeLabel":"number\u003cdouble>"},"AdjustedHours":{"type":"number","description":"Hours after any manual correction to the entry.","format":"double","uniqueKey":"Data.Time.Breakdown.NotBillable.AdjustedHours","typeLabel":"number\u003cdouble>"}},"additionalProperties":false,"description":"One bucket of a ticket's time, in decimal hours.","uniqueKey":"Data.Time.Breakdown.NotBillable","typeLabel":"object"},"NotBillableHidden":{"type":"object","properties":{"ActualHours":{"type":"number","description":"Hours as the timer recorded them.","format":"double","uniqueKey":"Data.Time.Breakdown.NotBillableHidden.ActualHours","typeLabel":"number\u003cdouble>"},"AdjustedHours":{"type":"number","description":"Hours after any manual correction to the entry.","format":"double","uniqueKey":"Data.Time.Breakdown.NotBillableHidden.AdjustedHours","typeLabel":"number\u003cdouble>"}},"additionalProperties":false,"description":"One bucket of a ticket's time, in decimal hours.","uniqueKey":"Data.Time.Breakdown.NotBillableHidden","typeLabel":"object"}},"additionalProperties":false,"description":"A ticket's time split by billable state. An entry stays in its billable-state bucket\r\nwhatever its position in the billing pipeline — approved or invoiced time is not moved\r\nelsewhere — so the buckets do not overlap.","uniqueKey":"Data.Time.Breakdown","typeLabel":"object"}},"additionalProperties":false,"description":"Time logged against a ticket, in decimal hours, summed from the ticket's time entries.\r\n \r\nEvery figure comes in two forms: the time as the timer actually recorded it, and the time as it\r\nstands after a technician corrected an entry by hand. An entry with no correction reports the\r\nsame value for both, so the two totals differ only on tickets where someone adjusted an entry.\r\n \r\nAn entry still being timed, or one whose recorded end precedes its start, has no usable duration\r\nand contributes nothing. Each figure is rounded to four decimal places.","uniqueKey":"Data.Time","typeLabel":"object"},"Products":{"type":"object","properties":{"Count":{"type":"integer","description":"How many products are on the ticket, whatever their billable state.","format":"int32","uniqueKey":"Data.Products.Count","typeLabel":"integer\u003cint32>"},"TotalAmount":{"type":"number","description":"What those products are worth to the client, in the service provider's currency: each\r\nbillable product's price × quantity, rounded to two decimals, summed. Products marked not\r\nbillable, hidden or void are counted by `Count` but contribute nothing here,\r\nbecause invoicing bills them as zero. Excludes tax.","format":"double","uniqueKey":"Data.Products.TotalAmount","typeLabel":"number\u003cdouble>"}},"additionalProperties":false,"description":"The products added to a ticket.","uniqueKey":"Data.Products","typeLabel":"object"},"BillingOverride":{"type":"object","properties":{"ServiceLine":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.BillingOverride.ServiceLine.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.BillingOverride.ServiceLine.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.BillingOverride.ServiceLine","typeLabel":"object"},"BillingRole":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.BillingOverride.BillingRole.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.BillingOverride.BillingRole.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.BillingOverride.BillingRole","typeLabel":"object"},"WorkType":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.BillingOverride.WorkType.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.BillingOverride.WorkType.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.BillingOverride.WorkType","typeLabel":"object"},"BillableStatus":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.BillingOverride.BillableStatus.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.BillingOverride.BillableStatus.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.BillingOverride.BillableStatus","typeLabel":"object"}},"additionalProperties":false,"description":"Billing settings overridden at the ticket level.","uniqueKey":"Data.BillingOverride","typeLabel":"object"},"Shipments":{"type":"array","items":{"type":"object","properties":{"TrackingNumber":{"type":"string","description":"The carrier's tracking number.","uniqueKey":"Data.Shipments.items.[INDEX].TrackingNumber","typeLabel":"string"},"Carrier":{"type":"string","description":"The carrier, as its tracking slug (e.g. \"star-track\").","uniqueKey":"Data.Shipments.items.[INDEX].Carrier","typeLabel":"string"},"Status":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Shipments.items.[INDEX].Status.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Shipments.items.[INDEX].Status.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Shipments.items.[INDEX].Status","typeLabel":"object"},"Name":{"oneOf":[{"type":"string","description":"Label given to the shipment on the ticket.","uniqueKey":"Data.Shipments.items.[INDEX].Name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Label given to the shipment on the ticket.","uniqueKey":"Data.Shipments.items.[INDEX].Name.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Shipments.items.[INDEX].Name","typeLabel":"string | null"}},"additionalProperties":false,"description":"One shipment tracked on a ticket.","uniqueKey":"Data.Shipments.items.[INDEX]","typeLabel":"object"},"description":"Shipment tracking attached to the ticket, one entry per tracking number.","uniqueKey":"Data.Shipments","typeLabel":"object[]"},"Banner":{"oneOf":[{"type":"string","description":"Banner text shown on the ticket. May contain HTML.","uniqueKey":"Data.Banner.oneOf.0","typeLabel":"string"},{"type":"null","description":"Banner text shown on the ticket. May contain HTML.","uniqueKey":"Data.Banner.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.Banner","typeLabel":"string | null"}},"additionalProperties":false,"description":"A ticket's full detail, as returned by the single-ticket endpoint. Every field the ticket list\r\nserves is present and carries the same value; the fields below are the ones the list leaves out\r\nbecause they each cost an extra read and are rarely wanted for every row of a page.\r\nAll timestamps are UTC.","uniqueKey":"Data","typeLabel":"object"},"DataContext":{"oneOf":[{"type":"object","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext","typeLabel":"object | null"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Title":"\u003cstring>","Number":123,"DisplayNumber":"\u003cstring>","ClientId":123,"LocationId":123,"ContactId":123,"CcContactIds":[123],"LeadAssigneeId":123,"AssistingAssigneeIds":[123],"WatcherIds":[123],"GroupIds":[123],"PrimaryGroupId":123,"Status":{"Id":1,"Name":"\u003cstring>"},"StatusUpdatedOn":"2023-11-07T05:31:56Z","StatusReason":"\u003cstring>","Priority":{"Id":1,"Name":"\u003cstring>"},"Source":{"Id":1,"Name":"\u003cstring>"},"Type":{"Id":1,"Name":"\u003cstring>"},"TagIds":[123],"ChecklistSummary":{"Completed":123,"Total":123},"IsUnread":true,"IsWaitingOnThem":true,"IsMerged":true,"MergedIntoTicketId":123,"MergedTicketIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"Sla":{"FirstResponse":{"ElapsedBusinessMinutes":123}},"LastUpdate":{"UpdateType":"\u003cstring>","Summary":"\u003cstring>","On":"2023-11-07T05:31:56Z"},"CreatedOn":"2023-11-07T05:31:56Z","UpdatedOn":"2023-11-07T05:31:56Z","ClosedOn":"2023-11-07T05:31:56Z","Description":"\u003cstring>","AgentAssetIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"CustomAssetIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"UptimeIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"Time":{"ActualHours":123,"AdjustedHours":123,"Breakdown":{"Billable":{"ActualHours":123,"AdjustedHours":123},"NotBillable":{"ActualHours":123,"AdjustedHours":123},"NotBillableHidden":{"ActualHours":123,"AdjustedHours":123}}},"Products":{"Count":123,"TotalAmount":123},"BillingOverride":{"ServiceLine":{"Id":1,"Name":"\u003cstring>"},"BillingRole":{"Id":1,"Name":"\u003cstring>"},"WorkType":{"Id":1,"Name":"\u003cstring>"},"BillableStatus":{"Id":1,"Name":"\u003cstring>"}},"Shipments":[{"TrackingNumber":"\u003cstring>","Carrier":"\u003cstring>","Status":{"Id":1,"Name":"\u003cstring>"},"Name":"\u003cstring>"}],"Banner":"\u003cstring>"},"DataContext":null,"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"20ccc825-a603-42a0-83af-ac2978e43cda":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"e9cc3d83-090f-4485-92be-53adab1abd93":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"86e7ec26-148b-4bfa-a79a-964107bf8627":{"description":"Not Found","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"2b918261-6a48-4fc4-8e4d-0118339237ca":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f01c3aed-69e3-4627-b3db-e003e1c21463":{"ApiKeyAuth":{"type":"apiKey","description":"Your Gorelo API key. See [Generate API key](/generate-api-key). If your data is hosted in Australia, click the base URL at the top of this page and select `https://api.aue.gorelo.io`.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"c45f3e55-70a5-4683-bd92-9d0a077a9a8f":{"url":"https://api.usw.gorelo.io","description":"US"},"2a42ac77-a3aa-4890-87be-e126aeef1e79":{"url":"https://api.aue.gorelo.io","description":"Australia"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Your Gorelo API key. See [Generate API key](/generate-api-key). If your data is hosted in Australia, click the base URL at the top of this page and select `https://api.aue.gorelo.io`.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"Your Gorelo API key. See [Generate API key](/generate-api-key). If your data is hosted in Australia, click the base URL at the top of this page and select `https://api.aue.gorelo.io`.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"gorelo","siteName":"Gorelo Documentation","title":"Gets a single ticket. - Gorelo Documentation","contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/tickets/gets-a-single-ticket","matchLevel":1},"ar":{"href":"/ar/api-reference/tickets/gets-a-single-ticket","matchLevel":1},"pt-BR":{"href":"/pt-br/api-reference/tickets/gets-a-single-ticket","matchLevel":0},"fr-CA":{"href":"/fr-ca/api-reference/tickets/gets-a-single-ticket","matchLevel":1},"ca":{"href":"/ca/api-reference/tickets/gets-a-single-ticket","matchLevel":1},"cn":{"href":"/cn/api-reference/tickets/gets-a-single-ticket","matchLevel":1},"zh":{"href":"/zh/api-reference/tickets/gets-a-single-ticket","matchLevel":1}}},"lastModified":"2026-10-27T17:47:14.062Z","originalFileLocation":"pt-br/api-reference/tickets/gets-a-single-ticket.mdx","locale":"pt-BR"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns every field the ticket list returns, with the same values, plus the ones the list leaves out because each costs a further read: the ticket\u0026#x27;s Description, the assets and uptime checks linked to it, its logged Time and Products totals, any ticket-level BillingOverride, its Shipments, and its Banner.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gorelo Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Gets a single ticket. - Gorelo Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns every field the ticket list returns, with the same values, plus the ones the list leaves out because each costs a further read: the ticket\u0026#x27;s Description, the assets and uptime checks linked to it, its logged Time and Products totals, any ticket-level BillingOverride, its Shipments, and its Banner.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gorelo Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.gorelo.io/pt-br/api-reference/tickets/gets-a-single-ticket\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gorelo.mintlify.app/_mintlify/api/og/v2?division=Tickets\u0026amp;title=Gets+a+single+ticket.\u0026amp;description=Returns+every+field+the+ticket+list+returns%2C+with+the+same+values%2C+plus+the+ones+the+list%0D%0Aleaves+out+because+each+costs+a+further+read%3A+the+ticket%27s+%60Descripti\u0026amp;theme=13a01696fc0cf71f5fdb322b\u0026amp;signature=abdaf41599e599c4f8e813f99b6d0da43a0a8500a3e3ba5b68fdaa83edfd1058\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Gets a single ticket. - Gorelo Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns every field the ticket list returns, with the same values, plus the ones the list leaves out because each costs a further read: the ticket\u0026#x27;s Description, the assets and uptime checks linked to it, its logged Time and Products totals, any ticket-level BillingOverride, its Shipments, and its Banner.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gorelo.mintlify.app/_mintlify/api/og/v2?division=Tickets\u0026amp;title=Gets+a+single+ticket.\u0026amp;description=Returns+every+field+the+ticket+list+returns%2C+with+the+same+values%2C+plus+the+ones+the+list%0D%0Aleaves+out+because+each+costs+a+further+read%3A+the+ticket%27s+%60Descripti\u0026amp;theme=13a01696fc0cf71f5fdb322b\u0026amp;signature=abdaf41599e599c4f8e813f99b6d0da43a0a8500a3e3ba5b68fdaa83edfd1058\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gorelo Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1DAF94\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.gorelo.io/pt-br/api-reference/tickets/gets-a-single-ticket\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pt-br/api-reference/tickets/gets-a-single-ticket.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://help.gorelo.io/pt-br/api-reference/tickets/gets-a-single-ticket\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://help.gorelo.io/api-reference/tickets/gets-a-single-ticket\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ar\" href=\"https://help.gorelo.io/ar/api-reference/tickets/gets-a-single-ticket\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr-CA\" href=\"https://help.gorelo.io/fr-ca/api-reference/tickets/gets-a-single-ticket\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ca\" href=\"https://help.gorelo.io/ca/api-reference/tickets/gets-a-single-ticket\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://help.gorelo.io/cn/api-reference/tickets/gets-a-single-ticket\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://help.gorelo.io/api-reference/tickets/gets-a-single-ticket\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.gorelo.io/#organization\",\"name\":\"Gorelo Documentation\",\"url\":\"https://help.gorelo.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gorelo/J8h_fLstMj_tYUTJ/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=J8h_fLstMj_tYUTJ\u0026q=85\u0026s=3c12ffa7afbcef131d2c6fb36f00e159\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.gorelo.io#website\",\"name\":\"Gorelo Documentation\",\"url\":\"https://help.gorelo.io\",\"publisher\":{\"@id\":\"https://help.gorelo.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.gorelo.io/pt-br/api-reference/tickets/gets-a-single-ticket#webpage\",\"url\":\"https://help.gorelo.io/pt-br/api-reference/tickets/gets-a-single-ticket\",\"name\":\"Gets a single ticket.\",\"description\":\"Returns every field the ticket list returns, with the same values, plus the ones the list leaves out because each costs a further read: the ticket's Description, the assets and uptime checks linked to it, its logged Time and Products totals, any ticket-level BillingOverride, its Shipments, and its Banner.\",\"dateModified\":\"2026-10-27T17:47:14.062Z\",\"isPartOf\":{\"@id\":\"https://help.gorelo.io#website\"},\"breadcrumb\":{\"@id\":\"https://help.gorelo.io/pt-br/api-reference/tickets/gets-a-single-ticket#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.gorelo.io/pt-br/api-reference/tickets/gets-a-single-ticket#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Referência da API\",\"item\":\"https://help.gorelo.io/pt-br/api-reference/alerts/lists-alerts-for-the-authenticated-service-provider\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tickets\",\"item\":\"https://help.gorelo.io/pt-br/api-reference/tickets/lists-tickets\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Gets a single ticket.\",\"item\":\"https://help.gorelo.io/pt-br/api-reference/tickets/gets-a-single-ticket\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.gorelo.io/pt-br/api-reference/tickets/gets-a-single-ticket#apireference\",\"headline\":\"Gets a single ticket.\",\"name\":\"Gets a single ticket.\",\"description\":\"Returns every field the ticket list returns, with the same values, plus the ones the list leaves out because each costs a further read: the ticket's Description, the assets and uptime checks linked to it, its logged Time and Products totals, any ticket-level BillingOverride, its Shipments, and its Banner.\",\"url\":\"https://help.gorelo.io/pt-br/api-reference/tickets/gets-a-single-ticket\",\"mainEntityOfPage\":{\"@id\":\"https://help.gorelo.io/pt-br/api-reference/tickets/gets-a-single-ticket#webpage\"},\"dateModified\":\"2026-10-27T17:47:14.062Z\",\"publisher\":{\"@id\":\"https://help.gorelo.io/#organization\"},\"isPartOf\":{\"@id\":\"https://help.gorelo.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gorelo Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gorelo Documentation","nav":{"global":null,"languages":[{"language":"en","default":true,"pages":[{"title":"en","href":"/api-reference/tickets/gets-a-single-ticket"}]},{"language":"ar","pages":[{"title":"ar","href":"/ar/api-reference/tickets/gets-a-single-ticket"}]},{"language":"pt-BR","tabs":[{"tab":"Comece aqui","icon":"rocket-launch","pages":[{"title":"Comece aqui","href":"/pt-BR/what-is-gorelo"}]},{"tab":"Entrega de serviços","icon":"bell","pages":[{"title":"Entrega de serviços","href":"/pt-BR/sd-overview"}]},{"tab":"Gerenciamento remoto","icon":"desktop","pages":[{"title":"Gerenciamento remoto","href":"/pt-BR/remote-management-overview"}]},{"tab":"Faturamento","icon":"sack-dollar","pages":[{"title":"Faturamento","href":"/pt-BR/how-billing-works"}]},{"tab":"Integrações","icon":"plug","pages":[{"title":"Integrações","href":"/pt-BR/integrations-overview"}]},{"tab":"API","icon":"satellite-dish","pages":[{"title":"Visão geral da API do Gorelo","href":"/pt-BR/api-overview"},{"title":"Gerar chave de API","href":"/pt-BR/generate-api-key"},{"title":"Revogar chave de API","href":"/pt-BR/revoke-api-key"},{"group":"Referência da API","pages":[{"group":"Alerts","pages":[{"title":"Lists alerts for the authenticated service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/alerts","href":"/pt-br/api-reference/alerts/lists-alerts-for-the-authenticated-service-provider"},{"title":"Posts an external alert against a client for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/alerts","href":"/pt-br/api-reference/alerts/posts-an-external-alert-against-a-client-for-the-service-provider"}]},{"group":"Assets","pages":[{"title":"Lists agent assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents","href":"/pt-br/api-reference/assets/lists-agent-assets"},{"title":"Lists custom assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/custom","href":"/pt-br/api-reference/assets/lists-custom-assets"},{"title":"Creates a custom asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/assets/custom","href":"/pt-br/api-reference/assets/creates-a-custom-asset"},{"title":"Gets a single custom asset by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/custom/{customAssetId}","href":"/pt-br/api-reference/assets/gets-a-single-custom-asset-by-id"},{"title":"Deletes a custom asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/assets/custom/{customAssetId}","href":"/pt-br/api-reference/assets/deletes-a-custom-asset"},{"title":"Updates a custom asset. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/assets/custom/{customAssetId}","href":"/pt-br/api-reference/assets/updates-a-custom-asset-send-only-the-fields-you-want-to-change"},{"title":"Gets a single agent (managed device) asset by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}","href":"/pt-br/api-reference/assets/gets-a-single-agent-managed-device-asset-by-id"},{"title":"Deletes an agent (managed device) asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/assets/agents/{agentAssetId}","href":"/pt-br/api-reference/assets/deletes-an-agent-managed-device-asset"},{"title":"Lists the patches installed on an agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/patches","href":"/pt-br/api-reference/assets/lists-the-patches-installed-on-an-agent"},{"title":"Lists the Windows updates pending on an agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/patches/available","href":"/pt-br/api-reference/assets/lists-the-windows-updates-pending-on-an-agent"},{"title":"Lists the applications installed on an agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/apps","href":"/pt-br/api-reference/assets/lists-the-applications-installed-on-an-agent"},{"title":"Gets an agent's processors, memory and disks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/hardware","href":"/pt-br/api-reference/assets/gets-an-agents-processors-memory-and-disks"},{"title":"Lists the tags on an agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/tags","href":"/pt-br/api-reference/assets/lists-the-tags-on-an-agent"},{"title":"Lists the service provider's scripts using cursor pagination.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/scripts","href":"/pt-br/api-reference/assets/lists-the-service-providers-scripts-using-cursor-pagination"},{"title":"Gets a script, with its content.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/scripts/{scriptId}","href":"/pt-br/api-reference/assets/gets-a-script-with-its-content"},{"title":"Lists the asset types.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/types","href":"/pt-br/api-reference/assets/lists-the-asset-types"},{"title":"Lists the hardware types a custom asset can be given. \u003cb>Deprecated:\u003c/b> use `GET /v1/assets/types`.","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/custom/hardware-types","href":"/pt-br/api-reference/assets/lists-the-hardware-types-a-custom-asset-can-be-given-\u003cb>deprecated:\u003cb>-use-`get-v1assetstypes`"},{"title":"Lists uptime checks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/uptime","href":"/pt-br/api-reference/assets/lists-uptime-checks"},{"title":"Creates an uptime check.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/uptime","href":"/pt-br/api-reference/assets/creates-an-uptime-check"},{"title":"Gets a single uptime check by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/uptime/{uptimeId}","href":"/pt-br/api-reference/assets/gets-a-single-uptime-check-by-id"},{"title":"Deletes an uptime check.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/uptime/{uptimeId}","href":"/pt-br/api-reference/assets/deletes-an-uptime-check"},{"title":"Updates an uptime check. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/uptime/{uptimeId}","href":"/pt-br/api-reference/assets/updates-an-uptime-check-send-only-the-fields-you-want-to-change"}]},{"group":"Attachments","pages":[{"title":"Uploads a file and returns a link to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/attachments","href":"/pt-br/api-reference/attachments/uploads-a-file-and-returns-a-link-to-it"}]},{"group":"Billing","pages":[{"title":"Downloads the rendered PDF for an invoice.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/invoices/{invoiceId}/pdf","href":"/pt-br/api-reference/billing/downloads-the-rendered-pdf-for-an-invoice"},{"title":"Lists billing roles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing-roles","href":"/pt-br/api-reference/billing/lists-billing-roles"},{"title":"Lists work types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/work-types","href":"/pt-br/api-reference/billing/lists-work-types"},{"title":"Lists the tax rates configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/taxes","href":"/pt-br/api-reference/billing/lists-the-tax-rates-configured-for-the-service-provider"},{"title":"Lists logged time across every ticket and task, narrowed by any of the filters.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/time-entries","href":"/pt-br/api-reference/billing/lists-logged-time-across-every-ticket-and-task-narrowed-by-any-of-the-filters"},{"title":"Logs time against a ticket.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/time-entries","href":"/pt-br/api-reference/billing/logs-time-against-a-ticket"},{"title":"Gets a single time entry by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/time-entries/{timeEntryId}","href":"/pt-br/api-reference/billing/gets-a-single-time-entry-by-id"},{"title":"Deletes a time entry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/time-entries/{timeEntryId}","href":"/pt-br/api-reference/billing/deletes-a-time-entry"},{"title":"Partially updates a time entry. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/time-entries/{timeEntryId}","href":"/pt-br/api-reference/billing/partially-updates-a-time-entry-send-only-the-fields-you-want-to-change"},{"title":"Lists billing contracts, each with the service lines it is made of.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contracts","href":"/pt-br/api-reference/billing/lists-billing-contracts-each-with-the-service-lines-it-is-made-of"},{"title":"Everything about one contract, including each service line's actual products/labor.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contracts/{contractId}","href":"/pt-br/api-reference/billing/everything-about-one-contract-including-each-service-lines-actual-productslabor"},{"title":"Deletes a contract.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contracts/{contractId}","href":"/pt-br/api-reference/billing/deletes-a-contract"},{"title":"Lists the service provider's invoices, filtered and sorted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/invoices","href":"/pt-br/api-reference/billing/lists-the-service-providers-invoices-filtered-and-sorted"},{"title":"Raises a manual invoice against a client, with line items.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/invoices","href":"/pt-br/api-reference/billing/raises-a-manual-invoice-against-a-client-with-line-items"},{"title":"Gets one invoice, with its attachments and line items.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/invoices/{invoiceId}","href":"/pt-br/api-reference/billing/gets-one-invoice-with-its-attachments-and-line-items"},{"title":"Deletes or voids an invoice, depending on its current status.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/invoices/{invoiceId}","href":"/pt-br/api-reference/billing/deletes-or-voids-an-invoice-depending-on-its-current-status"},{"title":"Records a payment received outside Gorelo against an approved invoice.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/payments","href":"/pt-br/api-reference/billing/records-a-payment-received-outside-gorelo-against-an-approved-invoice"},{"title":"Deletes a payment that was recorded through the API.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/payments/{paymentId}","href":"/pt-br/api-reference/billing/deletes-a-payment-that-was-recorded-through-the-api"},{"title":"Lists the categories products are organised under, each with its subcategories.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/items/categories","href":"/pt-br/api-reference/billing/lists-the-categories-products-are-organised-under-each-with-its-subcategories"},{"title":"Lists the service provider's item catalog: products and bundles.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/items","href":"/pt-br/api-reference/billing/lists-the-service-providers-item-catalog:-products-and-bundles"},{"title":"Creates a product or a bundle in the item catalog.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/items","href":"/pt-br/api-reference/billing/creates-a-product-or-a-bundle-in-the-item-catalog"},{"title":"A single catalog item — a product or a bundle.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/items/{itemId}","href":"/pt-br/api-reference/billing/a-single-catalog-item-—-a-product-or-a-bundle"},{"title":"Deletes an item.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/items/{itemId}","href":"/pt-br/api-reference/billing/deletes-an-item"},{"title":"Partially updates an item. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/items/{itemId}","href":"/pt-br/api-reference/billing/partially-updates-an-item-send-only-the-fields-you-want-to-change"}]},{"group":"Clients","pages":[{"title":"Lists clients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/clients","href":"/pt-br/api-reference/clients/lists-clients"},{"title":"Creates a client (and its default location) for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/clients","href":"/pt-br/api-reference/clients/creates-a-client-and-its-default-location-for-the-service-provider"},{"title":"Gets a single client by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/clients/{clientId}","href":"/pt-br/api-reference/clients/gets-a-single-client-by-id"},{"title":"Deletes a client.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/clients/{clientId}","href":"/pt-br/api-reference/clients/deletes-a-client"},{"title":"Updates an existing client. Only supplied (non-null) fields are changed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/clients/{clientId}","href":"/pt-br/api-reference/clients/updates-an-existing-client-only-supplied-non-null-fields-are-changed"},{"title":"Lists the locations for a given client.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/clients/{clientId}/locations","href":"/pt-br/api-reference/clients/lists-the-locations-for-a-given-client"}]},{"group":"Contacts","pages":[{"title":"Gets a single contact by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{contactId}","href":"/pt-br/api-reference/contacts/gets-a-single-contact-by-id"},{"title":"Deletes a contact.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{contactId}","href":"/pt-br/api-reference/contacts/deletes-a-contact"},{"title":"Updates an existing contact.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{contactId}","href":"/pt-br/api-reference/contacts/updates-an-existing-contact"},{"title":"Lists contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/pt-br/api-reference/contacts/lists-contacts"},{"title":"Creates a contact under a client, or a temporary contact when no client is given.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/pt-br/api-reference/contacts/creates-a-contact-under-a-client-or-a-temporary-contact-when-no-client-is-given"}]},{"group":"Deletions","pages":[{"title":"Lists deleted records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/deletions","href":"/pt-br/api-reference/deletions/lists-deleted-records"}]},{"group":"Documents","pages":[{"title":"Lists the service provider's documents.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents","href":"/pt-br/api-reference/documents/lists-the-service-providers-documents"},{"title":"Creates a document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents","href":"/pt-br/api-reference/documents/creates-a-document"},{"title":"Gets a single document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}","href":"/pt-br/api-reference/documents/gets-a-single-document"},{"title":"Updates a document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/documents/{documentId}","href":"/pt-br/api-reference/documents/updates-a-document"},{"title":"Duplicates a document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents/{documentId}/duplicate","href":"/pt-br/api-reference/documents/duplicates-a-document"},{"title":"Downloads a document as a PDF.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}/pdf","href":"/pt-br/api-reference/documents/downloads-a-document-as-a-pdf"},{"title":"Lists a document's versions, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}/versions","href":"/pt-br/api-reference/documents/lists-a-documents-versions-newest-first"},{"title":"Gets one version of a document, with its body and attachments.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}/versions/{versionId}","href":"/pt-br/api-reference/documents/gets-one-version-of-a-document-with-its-body-and-attachments"},{"title":"Makes an earlier version the current one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents/{documentId}/versions/{versionId}/restore","href":"/pt-br/api-reference/documents/makes-an-earlier-version-the-current-one"},{"title":"Lists the records a document is related to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}/related-items","href":"/pt-br/api-reference/documents/lists-the-records-a-document-is-related-to"},{"title":"Relates a document to other records.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents/{documentId}/related-items","href":"/pt-br/api-reference/documents/relates-a-document-to-other-records"},{"title":"Removes one related item from a document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/documents/{documentId}/related-items/{relatedItemId}","href":"/pt-br/api-reference/documents/removes-one-related-item-from-a-document"}]},{"group":"Forms","pages":[{"title":"Lists the service provider's forms, most recently updated first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/forms","href":"/pt-br/api-reference/forms/lists-the-service-providers-forms-most-recently-updated-first"},{"title":"Lists a form's submitted responses, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/forms/{formId}/responses","href":"/pt-br/api-reference/forms/lists-a-forms-submitted-responses-newest-first"},{"title":"Issues a link through which the form can be submitted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/forms/{formId}/submission-links","href":"/pt-br/api-reference/forms/issues-a-link-through-which-the-form-can-be-submitted"}]},{"group":"Organization","pages":[{"title":"Lists users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organization/users","href":"/pt-br/api-reference/organization/lists-users"},{"title":"Lists the service provider's API keys using cursor pagination, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/api-keys","href":"/pt-br/api-reference/organization/lists-the-service-providers-api-keys-using-cursor-pagination-newest-first"},{"title":"Creates an API key for the authenticated service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/api-keys","href":"/pt-br/api-reference/organization/creates-an-api-key-for-the-authenticated-service-provider"},{"title":"Revokes an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/api-keys/{apiKeyId}","href":"/pt-br/api-reference/organization/revokes-an-api-key"},{"title":"Lists the technician groups configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organization/groups","href":"/pt-br/api-reference/organization/lists-the-technician-groups-configured-for-the-service-provider"}]},{"group":"Projects","pages":[{"title":"Lists the projects visible to the authenticated service provider, newest activity first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects","href":"/pt-br/api-reference/projects/lists-the-projects-visible-to-the-authenticated-service-provider-newest-activity-first"},{"title":"Creates a project for the authenticated service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects","href":"/pt-br/api-reference/projects/creates-a-project-for-the-authenticated-service-provider"},{"title":"Gets a single project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}","href":"/pt-br/api-reference/projects/gets-a-single-project"},{"title":"Deletes a project and every task in it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}","href":"/pt-br/api-reference/projects/deletes-a-project-and-every-task-in-it"},{"title":"Updates a project. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/projects/{projectId}","href":"/pt-br/api-reference/projects/updates-a-project-send-only-the-fields-you-want-to-change"},{"title":"Lists the project tags configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/tags","href":"/pt-br/api-reference/projects/lists-the-project-tags-configured-for-the-service-provider"},{"title":"Lists the project types configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/types","href":"/pt-br/api-reference/projects/lists-the-project-types-configured-for-the-service-provider"},{"title":"Lists a project's sections.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/sections","href":"/pt-br/api-reference/projects/lists-a-projects-sections"},{"title":"Adds a section to a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/sections","href":"/pt-br/api-reference/projects/adds-a-section-to-a-project"},{"title":"Deletes a section and every task in it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/sections/{sectionId}","href":"/pt-br/api-reference/projects/deletes-a-section-and-every-task-in-it"},{"title":"Updates a section's title or colour. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/projects/{projectId}/sections/{sectionId}","href":"/pt-br/api-reference/projects/updates-a-sections-title-or-colour-send-only-the-fields-you-want-to-change"},{"title":"Lists a project's tasks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks","href":"/pt-br/api-reference/projects/lists-a-projects-tasks"},{"title":"Creates a task on a project's board.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/tasks","href":"/pt-br/api-reference/projects/creates-a-task-on-a-projects-board"},{"title":"Returns a project's comments, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/comments","href":"/pt-br/api-reference/projects/returns-a-projects-comments-newest-first"},{"title":"Posts a comment on a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/comments","href":"/pt-br/api-reference/projects/posts-a-comment-on-a-project"},{"title":"Returns one comment on a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/comments/{commentId}","href":"/pt-br/api-reference/projects/returns-one-comment-on-a-project"},{"title":"Deletes one comment on a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/comments/{commentId}","href":"/pt-br/api-reference/projects/deletes-one-comment-on-a-project"},{"title":"Returns one task in full.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}","href":"/pt-br/api-reference/projects/returns-one-task-in-full"},{"title":"Deletes a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/tasks/{taskId}","href":"/pt-br/api-reference/projects/deletes-a-task"},{"title":"Updates a task. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/projects/{projectId}/tasks/{taskId}","href":"/pt-br/api-reference/projects/updates-a-task-send-only-the-fields-you-want-to-change"},{"title":"Returns a task's comments, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}/comments","href":"/pt-br/api-reference/projects/returns-a-tasks-comments-newest-first"},{"title":"Posts a comment on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/tasks/{taskId}/comments","href":"/pt-br/api-reference/projects/posts-a-comment-on-a-task"},{"title":"Starts a side conversation on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/tasks/{taskId}/conversations/side-conversation","href":"/pt-br/api-reference/projects/starts-a-side-conversation-on-a-task"},{"title":"Asks contacts to approve something on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/tasks/{taskId}/conversations/approval","href":"/pt-br/api-reference/projects/asks-contacts-to-approve-something-on-a-task"},{"title":"Returns one comment on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}/comments/{commentId}","href":"/pt-br/api-reference/projects/returns-one-comment-on-a-task"},{"title":"Deletes one comment on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/tasks/{taskId}/comments/{commentId}","href":"/pt-br/api-reference/projects/deletes-one-comment-on-a-task"},{"title":"Lists the conversations on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}/conversations","href":"/pt-br/api-reference/projects/lists-the-conversations-on-a-task"},{"title":"Gets one approval on a task, with its approvers.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}/approvals/{approvalId}","href":"/pt-br/api-reference/projects/gets-one-approval-on-a-task-with-its-approvers"}]},{"group":"Tickets","pages":[{"title":"Lists tickets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets","href":"/pt-br/api-reference/tickets/lists-tickets"},{"title":"Creates a ticket for the authenticated service provider.","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tickets","href":"/pt-br/api-reference/tickets/creates-a-ticket-for-the-authenticated-service-provider"},{"title":"Gets a single ticket.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}","href":"/pt-br/api-reference/tickets/gets-a-single-ticket"},{"title":"Deletes a ticket and its time entries.","description":"This is the same soft-delete the app performs: the ticket is deactivated and recoverable from\r\nthe Recycle Bin, never removed. Its delayed actions are cleared, scheduled automation is\r\ncancelled and it leaves the search index, exactly as when it is deleted in the app.\r\nThe ticket's time entries are deleted with it, and any contract hours they consumed are\r\nreturned to the contract. If any of those time entries has already been approved, completed, voided\r\nor invoiced the whole request is refused with 409 and nothing is deleted; the message lists\r\nthe blocking time entries. Deleting an already-deleted ticket succeeds without repeating any\r\nof that, so a retried request is safe.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tickets/{ticketId}","href":"/pt-br/api-reference/tickets/deletes-a-ticket-and-its-time-entries"},{"title":"Partially updates a ticket. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/tickets/{ticketId}","href":"/pt-br/api-reference/tickets/partially-updates-a-ticket-send-only-the-fields-you-want-to-change"},{"title":"Gets a ticket comment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}/comments/{commentId}","href":"/pt-br/api-reference/tickets/gets-a-ticket-comment"},{"title":"Deletes a private comment from a ticket.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tickets/{ticketId}/comments/{commentId}","href":"/pt-br/api-reference/tickets/deletes-a-private-comment-from-a-ticket"},{"title":"Lists the ticket statuses configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/statuses","href":"/pt-br/api-reference/tickets/lists-the-ticket-statuses-configured-for-the-service-provider"},{"title":"Lists the ticket tags configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/tags","href":"/pt-br/api-reference/tickets/lists-the-ticket-tags-configured-for-the-service-provider"},{"title":"Lists the ticket types configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/types","href":"/pt-br/api-reference/tickets/lists-the-ticket-types-configured-for-the-service-provider"},{"title":"Lists ticket comments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}/comments","href":"/pt-br/api-reference/tickets/lists-ticket-comments"},{"title":"Adds a comment to a ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tickets/{ticketId}/comments","href":"/pt-br/api-reference/tickets/adds-a-comment-to-a-ticket"},{"title":"Lists ticket conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}/conversations","href":"/pt-br/api-reference/tickets/lists-ticket-conversations"},{"title":"Gets a ticket approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}/approvals/{approvalId}","href":"/pt-br/api-reference/tickets/gets-a-ticket-approval"},{"title":"Creates an approval on a ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tickets/{ticketId}/conversations/approval","href":"/pt-br/api-reference/tickets/creates-an-approval-on-a-ticket"},{"title":"Creates a side conversation on a ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tickets/{ticketId}/conversations/side-conversation","href":"/pt-br/api-reference/tickets/creates-a-side-conversation-on-a-ticket"}]}]}]}]},{"language":"fr-CA","pages":[{"title":"fr-CA","href":"/fr-ca/api-reference/tickets/gets-a-single-ticket"}]},{"language":"ca","pages":[{"title":"ca","href":"/ca/api-reference/tickets/gets-a-single-ticket"}]},{"language":"cn","pages":[{"title":"cn","href":"/cn/api-reference/tickets/gets-a-single-ticket"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/tickets/gets-a-single-ticket"}]}]},"title":"Gets a single ticket. - Gorelo Documentation","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-R3M_BF4L.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}