List an app’s secrets by name, with where each is injected. Values are never returned. An app secret is a value Effective adds to the app’s outbound HTTPS requests to the hosts you name, so the app’s code never holds it.
Needs build permission on the app. Read-only and safe to retry.
App ID: app- followed by lowercase letters, digits and hyphens, ending in a letter or digit. It is part of the app’s hostname, so your organization’s subdomain and the ID together must fit 63 characters.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Effective","description":"Research insurance markets with the Effective API and analyze premiums locally with Relativities.","colors":{"primary":"#171717","light":"#EAEBE6","dark":"#171717"},"logo":{"light":"https://mintcdn.com/effective-ai-canary/XwQAlB9iZgv01g6C/logo/light.svg?fit=max\u0026auto=format\u0026n=XwQAlB9iZgv01g6C\u0026q=85\u0026s=1dea6fc4d5e457e6149af14837c5112e","dark":"https://mintcdn.com/effective-ai-canary/XwQAlB9iZgv01g6C/logo/dark.svg?fit=max\u0026auto=format\u0026n=XwQAlB9iZgv01g6C\u0026q=85\u0026s=f739f525573ed266bd41eb0cfa03762e"},"favicon":"https://mintcdn.com/effective-ai-canary/XwQAlB9iZgv01g6C/favicon.svg?fit=max\u0026auto=format\u0026n=XwQAlB9iZgv01g6C\u0026q=85\u0026s=21d4037b0c44f2a18631aa8da87a6adf","api":{"playground":{"display":"interactive"}},"background":{"color":{"light":"#FDFDFC","dark":"#1F201D"}},"navbar":{"links":[{"href":"https://effectiveailabs.com/support","label":"Support"}]},"seo":{"metatags":{"canonical":"https://docs.canary.effectiveai.app","robots":"noindex"},"indexing":"navigable"},"integrations":{"posthog":{"apiKey":"phc_lqBgNxwfmrWDRHilA0uhs7vjD1fjHwUC3zALvFLGb3e","apiHost":"https://us.i.posthog.com","sessionRecording":false}},"banner":{"content":"Canary documentation. Features may not be released to production. [Production docs](https://docs.effectiveai.app).","dismissible":false},"contextual":{"options":["copy","view","chatgpt","claude","download-spec"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"effective-ai-canary","hasAudioNarration":false,"actualSubdomain":"effective-ai-canary","customDomains":["docs.canary.effectiveai.app"],"gitSource":{"type":"github","owner":"effectiveailabs","repo":"effectiveai","deployBranch":"main","contentDirectory":"docs/public","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae0c7ff6c1a15a18d9e53ca","collectionId":"109efd66-4ec8-480a-a8c6-3c5b1987bcbc","liveDeploymentHistoryId":"6ae0c7ff6c1a15a18d9e53ca","schemaVersion":"v3"},"entitlements":{},"buildId":"6ae0c7ff6c1a15a18d9e53ca","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":234},{"language":"default","tag":"Relativities","count":43},{"language":"default","tag":"OSHA","count":23},{"language":"default","tag":"Apps","count":21},{"language":"default","tag":"Managed Filings","count":21},{"language":"default","tag":"Objections","count":21},{"language":"default","tag":"Products","count":20},{"language":"default","tag":"Market Directory","count":16},{"language":"default","tag":"Build and test raters","count":16},{"language":"default","tag":"Product Hub","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":[{"filePath":"guide-index.css","content":".research-guide-index h3{font-size:1rem!important;font-weight:500!important;line-height:1.5!important;margin-top:1.25rem!important;margin-bottom:.5rem!important}.research-guide-index h3 a{font-weight:500!important;text-decoration:none!important;border-bottom:0!important}.research-guide-index h3 a[href^='/guides/']::after{content:' →';display:inline-block;margin-left:.25rem}.research-guide-index h3 a:focus-visible,.research-guide-index h3 a:hover{text-decoration:underline!important;text-underline-offset:.2em}.research-guide-index h3+p{margin-top:.5rem!important}.research-guide-index hr{margin-top:1.5rem!important;margin-bottom:1.5rem!important}"}],"page":{"pagePath":"api-reference/apps/list-app-secrets","slug":"/api-reference/apps/list-app-secrets","pageMetadata":{"title":"List app secrets","description":"List an app’s secrets by name, with where each is injected. Values are never returned. An app secret is a value Effective adds to the app’s outbound HTTPS requests to the hosts you name, so the app’s code never holds it.\n\nNeeds `build` permission on the app. Read-only and safe to retry.","deprecated":null,"version":null,"openapi":"/openapi.json get /apps/{appId}/secrets","href":"/api-reference/apps/list-app-secrets","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, 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(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"List an app’s secrets by name, with where each is injected. Values are never returned. An app secret is a value Effective adds to the app’s outbound HTTPS requests to the hosts you name, so the app’s code never holds it.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Needs \", _jsx(_components.code, {\n children: \"build\"\n }), \" permission on the app. Read-only and safe to retry.\"]\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":"List app secrets","description":"List an app’s secrets by name, with where each is injected. Values are never returned. An app secret is a value Effective adds to the app’s outbound HTTPS requests to the hosts you name, so the app’s code never holds it.\n\nNeeds `build` permission on the app. Read-only and safe to retry.","deprecated":null,"version":null,"openapi":"/openapi.json get /apps/{appId}/secrets","href":"/api-reference/apps/list-app-secrets","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Apps"],"security":["c29b4b70-6277-4ae4-af7f-94d1956c5c52"],"x-effective-authorization":{"allOf":[{"resourceType":"apps","action":"build","scope":"resource"}]},"operationId":"listAppSecrets","summary":"List app secrets","description":"List an app’s secrets by name, with where each is injected. Values are never returned. An app secret is a value Effective adds to the app’s outbound HTTPS requests to the hosts you name, so the app’s code never holds it.\n\nNeeds `build` permission on the app. Read-only and safe to retry.","parameters":["49f6bf57-6b21-4e64-82b6-818bfe3c0f1a"],"responses":{"200":"aa55ad80-bdc5-4a33-85c1-ba250357593a","400":"9312ebbb-2418-4232-8d67-6d5198447ae1","401":"08034dac-9c93-4be1-9978-445fa4a2421f","403":"e8f5fd56-46ff-4a32-9437-27075129099a","404":"f5344dd9-226c-4f14-81ec-d678d46478bc","500":"c4852a70-6046-4320-b3bb-352efb3dac8f","503":"874602b6-2ab3-40b4-b05f-f058ccec6eb9"},"method":"get","type":"path","servers":["b9b0d18c-2e8d-4b4a-9142-e9fce2448cb9"],"path":"/apps/{appId}/secrets","baseUrlOptions":["https://api.canary.effectiveai.app/api/v2"],"title":"List app secrets","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"49f6bf57-6b21-4e64-82b6-818bfe3c0f1a":{"schema":{"type":"string","maxLength":63,"pattern":"^app-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$","description":"App ID: `app-` followed by lowercase letters, digits and hyphens, ending in a letter or digit. It is part of the app’s hostname, so your organization’s subdomain and the ID together must fit 63 characters.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"App ID: `app-` followed by lowercase letters, digits and hyphens, ending in a letter or digit. It is part of the app’s hostname, so your organization’s subdomain and the ID together must fit 63 characters.","name":"appId","in":"path"}},"responses":{"aa55ad80-bdc5-4a33-85c1-ba250357593a":{"description":"The app’s secrets.","content":{"application/json":{"schema":{"type":"object","properties":{"secrets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Secret name, unique within the app.","isRequired":true,"uniqueKey":"secrets.items.[INDEX].id","typeLabel":"string"},"routes":{"type":"array","items":{"type":"object","properties":{"host":{"type":"string","description":"Hostname the app calls over HTTPS.","isRequired":true,"uniqueKey":"secrets.items.[INDEX].routes.items.[INDEX].host","typeLabel":"string"},"port":{"type":"integer","description":"HTTPS port.","isRequired":true,"uniqueKey":"secrets.items.[INDEX].routes.items.[INDEX].port","typeLabel":"integer"},"headerName":{"type":"string","description":"Header that carries the value.","isRequired":true,"uniqueKey":"secrets.items.[INDEX].routes.items.[INDEX].headerName","typeLabel":"string"},"scheme":{"oneOf":[{"type":"string","description":"For the `Authorization` header, the scheme before the value; null means `Bearer`.","isRequired":true,"uniqueKey":"secrets.items.[INDEX].routes.items.[INDEX].scheme.oneOf.0","typeLabel":"string"},{"type":"null","description":"For the `Authorization` header, the scheme before the value; null means `Bearer`.","isRequired":true,"uniqueKey":"secrets.items.[INDEX].routes.items.[INDEX].scheme.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"secrets.items.[INDEX].routes.items.[INDEX].scheme","typeLabel":"string | null"},"valueTemplate":{"oneOf":[{"type":"string","description":"Header value with `{value}` where the secret goes, or null.","isRequired":true,"uniqueKey":"secrets.items.[INDEX].routes.items.[INDEX].valueTemplate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Header value with `{value}` where the secret goes, or null.","isRequired":true,"uniqueKey":"secrets.items.[INDEX].routes.items.[INDEX].valueTemplate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"secrets.items.[INDEX].routes.items.[INDEX].valueTemplate","typeLabel":"string | null"}},"required":["host","port","headerName","scheme","valueTemplate"],"additionalProperties":false,"uniqueKey":"secrets.items.[INDEX].routes.items.[INDEX]","typeLabel":"object"},"description":"Where the app’s outbound HTTPS requests carry the value.","isRequired":true,"uniqueKey":"secrets.items.[INDEX].routes","typeLabel":"object[]"},"configured":{"type":"boolean","description":"True when a value is set and injected. A secret declared in Effective without a value of its own is false until you set one.","isRequired":true,"uniqueKey":"secrets.items.[INDEX].configured","typeLabel":"boolean"},"updatedAt":{"type":"string","format":"date-time","description":"When the secret last changed.","isRequired":true,"uniqueKey":"secrets.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","routes","configured","updatedAt"],"additionalProperties":false,"uniqueKey":"secrets.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"secrets","typeLabel":"object[]"}},"required":["secrets"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"secrets":[{"id":"\u003cstring>","routes":[{"host":"\u003cstring>","port":123,"headerName":"\u003cstring>","scheme":"\u003cstring>","valueTemplate":"\u003cstring>"}],"configured":true,"updatedAt":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"9312ebbb-2418-4232-8d67-6d5198447ae1":{"description":"Invalid request or cursor.","content":{"application/json":{"schema":{"type":"object","required":["code","error"],"properties":{"error":{"type":"string","minLength":1,"description":"Human-readable explanation of the failure.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","minLength":1,"description":"Stable error code. Clients must tolerate unknown future codes.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","enum":["path","query","header","body"],"isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"path":{"type":"array","items":{"type":"string","maxLength":64,"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"maxItems":12,"isRequired":true,"uniqueKey":"details.items.[INDEX].path","typeLabel":"string[]"},"code":{"type":"string","enum":["required","invalid_type","invalid_value","unknown_field"],"isRequired":true,"uniqueKey":"details.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"required":["location","path","code","message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Bounded safe validation issues; may omit some invalid fields.","uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","minLength":1,"maxLength":128,"description":"Existing server correlation for this HTTP attempt, when available.","uniqueKey":"requestId","typeLabel":"string"},"dataset":{"type":"string","enum":["naic","osha"],"description":"Dataset needed for dataset_not_enabled.","uniqueKey":"dataset","typeLabel":"enum\u003cstring>"},"businessCode":{"type":"string","description":"The rater’s own refusal code, for business_rejection.","uniqueKey":"businessCode","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Authored or built-in constraint code","isRequired":true,"uniqueKey":"violations.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Authored message for the failed constraint","isRequired":true,"uniqueKey":"violations.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Input path of the offending value; empty for the request","isRequired":true,"uniqueKey":"violations.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"Offending input value, size-bounded by the runtime","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"Offending input value, size-bounded by the runtime","type":"null","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].value","typeLabel":"any | null"},"constraint":{"type":"string","description":"The constraint the value failed, as text","isRequired":true,"uniqueKey":"violations.items.[INDEX].constraint","typeLabel":"string"},"cite":{"oneOf":[{"type":"string","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.0","typeLabel":"string"},{"type":"null","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].cite","typeLabel":"string | null"}},"required":["code","message","path","value","constraint","cite"],"additionalProperties":false,"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"maxItems":256,"description":"Each input constraint the submission failed, for invalid_inputs and business_rejection.","uniqueKey":"violations","typeLabel":"object[]"},"violationsTruncated":{"type":"boolean","description":"True when the rater reported more violations than violations holds.","uniqueKey":"violationsTruncated","typeLabel":"boolean"},"executionId":{"type":"string","description":"The recorded execution of a failed rating, for rater rating failures.","uniqueKey":"executionId","typeLabel":"string"},"accessUrl":{"oneOf":[{"type":"string","format":"uri","description":"Where to add the product to your account, for product_access_required.","uniqueKey":"accessUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Where to add the product to your account, for product_access_required.","uniqueKey":"accessUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"location":"path","path":["\u003cstring>"],"code":"required","message":"\u003cstring>"}],"requestId":"\u003cstring>","dataset":"naic","businessCode":"\u003cstring>","violations":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","value":"\u003cunknown>","constraint":"\u003cstring>","cite":"\u003cstring>"}],"violationsTruncated":true,"executionId":"\u003cstring>","accessUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"08034dac-9c93-4be1-9978-445fa4a2421f":{"description":"Authentication required.","content":{"application/json":{"schema":{"type":"object","required":["code","error"],"properties":{"error":{"type":"string","minLength":1,"description":"Human-readable explanation of the failure.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","minLength":1,"description":"Stable error code. Clients must tolerate unknown future codes.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","enum":["path","query","header","body"],"isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"path":{"type":"array","items":{"type":"string","maxLength":64,"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"maxItems":12,"isRequired":true,"uniqueKey":"details.items.[INDEX].path","typeLabel":"string[]"},"code":{"type":"string","enum":["required","invalid_type","invalid_value","unknown_field"],"isRequired":true,"uniqueKey":"details.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"required":["location","path","code","message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Bounded safe validation issues; may omit some invalid fields.","uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","minLength":1,"maxLength":128,"description":"Existing server correlation for this HTTP attempt, when available.","uniqueKey":"requestId","typeLabel":"string"},"dataset":{"type":"string","enum":["naic","osha"],"description":"Dataset needed for dataset_not_enabled.","uniqueKey":"dataset","typeLabel":"enum\u003cstring>"},"businessCode":{"type":"string","description":"The rater’s own refusal code, for business_rejection.","uniqueKey":"businessCode","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Authored or built-in constraint code","isRequired":true,"uniqueKey":"violations.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Authored message for the failed constraint","isRequired":true,"uniqueKey":"violations.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Input path of the offending value; empty for the request","isRequired":true,"uniqueKey":"violations.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"Offending input value, size-bounded by the runtime","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"Offending input value, size-bounded by the runtime","type":"null","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].value","typeLabel":"any | null"},"constraint":{"type":"string","description":"The constraint the value failed, as text","isRequired":true,"uniqueKey":"violations.items.[INDEX].constraint","typeLabel":"string"},"cite":{"oneOf":[{"type":"string","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.0","typeLabel":"string"},{"type":"null","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].cite","typeLabel":"string | null"}},"required":["code","message","path","value","constraint","cite"],"additionalProperties":false,"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"maxItems":256,"description":"Each input constraint the submission failed, for invalid_inputs and business_rejection.","uniqueKey":"violations","typeLabel":"object[]"},"violationsTruncated":{"type":"boolean","description":"True when the rater reported more violations than violations holds.","uniqueKey":"violationsTruncated","typeLabel":"boolean"},"executionId":{"type":"string","description":"The recorded execution of a failed rating, for rater rating failures.","uniqueKey":"executionId","typeLabel":"string"},"accessUrl":{"oneOf":[{"type":"string","format":"uri","description":"Where to add the product to your account, for product_access_required.","uniqueKey":"accessUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Where to add the product to your account, for product_access_required.","uniqueKey":"accessUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"location":"path","path":["\u003cstring>"],"code":"required","message":"\u003cstring>"}],"requestId":"\u003cstring>","dataset":"naic","businessCode":"\u003cstring>","violations":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","value":"\u003cunknown>","constraint":"\u003cstring>","cite":"\u003cstring>"}],"violationsTruncated":true,"executionId":"\u003cstring>","accessUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e8f5fd56-46ff-4a32-9437-27075129099a":{"description":"Your credential does not allow this.","content":{"application/json":{"schema":{"type":"object","required":["code","error"],"properties":{"error":{"type":"string","minLength":1,"description":"Human-readable explanation of the failure.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","minLength":1,"description":"Stable error code. Clients must tolerate unknown future codes.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","enum":["path","query","header","body"],"isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"path":{"type":"array","items":{"type":"string","maxLength":64,"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"maxItems":12,"isRequired":true,"uniqueKey":"details.items.[INDEX].path","typeLabel":"string[]"},"code":{"type":"string","enum":["required","invalid_type","invalid_value","unknown_field"],"isRequired":true,"uniqueKey":"details.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"required":["location","path","code","message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Bounded safe validation issues; may omit some invalid fields.","uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","minLength":1,"maxLength":128,"description":"Existing server correlation for this HTTP attempt, when available.","uniqueKey":"requestId","typeLabel":"string"},"dataset":{"type":"string","enum":["naic","osha"],"description":"Dataset needed for dataset_not_enabled.","uniqueKey":"dataset","typeLabel":"enum\u003cstring>"},"businessCode":{"type":"string","description":"The rater’s own refusal code, for business_rejection.","uniqueKey":"businessCode","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Authored or built-in constraint code","isRequired":true,"uniqueKey":"violations.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Authored message for the failed constraint","isRequired":true,"uniqueKey":"violations.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Input path of the offending value; empty for the request","isRequired":true,"uniqueKey":"violations.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"Offending input value, size-bounded by the runtime","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"Offending input value, size-bounded by the runtime","type":"null","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].value","typeLabel":"any | null"},"constraint":{"type":"string","description":"The constraint the value failed, as text","isRequired":true,"uniqueKey":"violations.items.[INDEX].constraint","typeLabel":"string"},"cite":{"oneOf":[{"type":"string","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.0","typeLabel":"string"},{"type":"null","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].cite","typeLabel":"string | null"}},"required":["code","message","path","value","constraint","cite"],"additionalProperties":false,"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"maxItems":256,"description":"Each input constraint the submission failed, for invalid_inputs and business_rejection.","uniqueKey":"violations","typeLabel":"object[]"},"violationsTruncated":{"type":"boolean","description":"True when the rater reported more violations than violations holds.","uniqueKey":"violationsTruncated","typeLabel":"boolean"},"executionId":{"type":"string","description":"The recorded execution of a failed rating, for rater rating failures.","uniqueKey":"executionId","typeLabel":"string"},"accessUrl":{"oneOf":[{"type":"string","format":"uri","description":"Where to add the product to your account, for product_access_required.","uniqueKey":"accessUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Where to add the product to your account, for product_access_required.","uniqueKey":"accessUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"location":"path","path":["\u003cstring>"],"code":"required","message":"\u003cstring>"}],"requestId":"\u003cstring>","dataset":"naic","businessCode":"\u003cstring>","violations":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","value":"\u003cunknown>","constraint":"\u003cstring>","cite":"\u003cstring>"}],"violationsTruncated":true,"executionId":"\u003cstring>","accessUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f5344dd9-226c-4f14-81ec-d678d46478bc":{"description":"app_not_found: missing, archived, or not an app you can open.","content":{"application/json":{"schema":{"type":"object","required":["code","error"],"properties":{"error":{"type":"string","minLength":1,"description":"Human-readable explanation of the failure.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","minLength":1,"description":"Stable error code. Clients must tolerate unknown future codes.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","enum":["path","query","header","body"],"isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"path":{"type":"array","items":{"type":"string","maxLength":64,"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"maxItems":12,"isRequired":true,"uniqueKey":"details.items.[INDEX].path","typeLabel":"string[]"},"code":{"type":"string","enum":["required","invalid_type","invalid_value","unknown_field"],"isRequired":true,"uniqueKey":"details.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"required":["location","path","code","message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Bounded safe validation issues; may omit some invalid fields.","uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","minLength":1,"maxLength":128,"description":"Existing server correlation for this HTTP attempt, when available.","uniqueKey":"requestId","typeLabel":"string"},"dataset":{"type":"string","enum":["naic","osha"],"description":"Dataset needed for dataset_not_enabled.","uniqueKey":"dataset","typeLabel":"enum\u003cstring>"},"businessCode":{"type":"string","description":"The rater’s own refusal code, for business_rejection.","uniqueKey":"businessCode","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Authored or built-in constraint code","isRequired":true,"uniqueKey":"violations.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Authored message for the failed constraint","isRequired":true,"uniqueKey":"violations.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Input path of the offending value; empty for the request","isRequired":true,"uniqueKey":"violations.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"Offending input value, size-bounded by the runtime","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"Offending input value, size-bounded by the runtime","type":"null","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].value","typeLabel":"any | null"},"constraint":{"type":"string","description":"The constraint the value failed, as text","isRequired":true,"uniqueKey":"violations.items.[INDEX].constraint","typeLabel":"string"},"cite":{"oneOf":[{"type":"string","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.0","typeLabel":"string"},{"type":"null","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].cite","typeLabel":"string | null"}},"required":["code","message","path","value","constraint","cite"],"additionalProperties":false,"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"maxItems":256,"description":"Each input constraint the submission failed, for invalid_inputs and business_rejection.","uniqueKey":"violations","typeLabel":"object[]"},"violationsTruncated":{"type":"boolean","description":"True when the rater reported more violations than violations holds.","uniqueKey":"violationsTruncated","typeLabel":"boolean"},"executionId":{"type":"string","description":"The recorded execution of a failed rating, for rater rating failures.","uniqueKey":"executionId","typeLabel":"string"},"accessUrl":{"oneOf":[{"type":"string","format":"uri","description":"Where to add the product to your account, for product_access_required.","uniqueKey":"accessUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Where to add the product to your account, for product_access_required.","uniqueKey":"accessUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"location":"path","path":["\u003cstring>"],"code":"required","message":"\u003cstring>"}],"requestId":"\u003cstring>","dataset":"naic","businessCode":"\u003cstring>","violations":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","value":"\u003cunknown>","constraint":"\u003cstring>","cite":"\u003cstring>"}],"violationsTruncated":true,"executionId":"\u003cstring>","accessUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"c4852a70-6046-4320-b3bb-352efb3dac8f":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"type":"object","required":["code","error"],"properties":{"error":{"type":"string","minLength":1,"description":"Human-readable explanation of the failure.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","minLength":1,"description":"Stable error code. Clients must tolerate unknown future codes.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","enum":["path","query","header","body"],"isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"path":{"type":"array","items":{"type":"string","maxLength":64,"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"maxItems":12,"isRequired":true,"uniqueKey":"details.items.[INDEX].path","typeLabel":"string[]"},"code":{"type":"string","enum":["required","invalid_type","invalid_value","unknown_field"],"isRequired":true,"uniqueKey":"details.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"required":["location","path","code","message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Bounded safe validation issues; may omit some invalid fields.","uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","minLength":1,"maxLength":128,"description":"Existing server correlation for this HTTP attempt, when available.","uniqueKey":"requestId","typeLabel":"string"},"dataset":{"type":"string","enum":["naic","osha"],"description":"Dataset needed for dataset_not_enabled.","uniqueKey":"dataset","typeLabel":"enum\u003cstring>"},"businessCode":{"type":"string","description":"The rater’s own refusal code, for business_rejection.","uniqueKey":"businessCode","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Authored or built-in constraint code","isRequired":true,"uniqueKey":"violations.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Authored message for the failed constraint","isRequired":true,"uniqueKey":"violations.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Input path of the offending value; empty for the request","isRequired":true,"uniqueKey":"violations.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"Offending input value, size-bounded by the runtime","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"Offending input value, size-bounded by the runtime","type":"null","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].value","typeLabel":"any | null"},"constraint":{"type":"string","description":"The constraint the value failed, as text","isRequired":true,"uniqueKey":"violations.items.[INDEX].constraint","typeLabel":"string"},"cite":{"oneOf":[{"type":"string","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.0","typeLabel":"string"},{"type":"null","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].cite","typeLabel":"string | null"}},"required":["code","message","path","value","constraint","cite"],"additionalProperties":false,"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"maxItems":256,"description":"Each input constraint the submission failed, for invalid_inputs and business_rejection.","uniqueKey":"violations","typeLabel":"object[]"},"violationsTruncated":{"type":"boolean","description":"True when the rater reported more violations than violations holds.","uniqueKey":"violationsTruncated","typeLabel":"boolean"},"executionId":{"type":"string","description":"The recorded execution of a failed rating, for rater rating failures.","uniqueKey":"executionId","typeLabel":"string"},"accessUrl":{"oneOf":[{"type":"string","format":"uri","description":"Where to add the product to your account, for product_access_required.","uniqueKey":"accessUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Where to add the product to your account, for product_access_required.","uniqueKey":"accessUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"location":"path","path":["\u003cstring>"],"code":"required","message":"\u003cstring>"}],"requestId":"\u003cstring>","dataset":"naic","businessCode":"\u003cstring>","violations":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","value":"\u003cunknown>","constraint":"\u003cstring>","cite":"\u003cstring>"}],"violationsTruncated":true,"executionId":"\u003cstring>","accessUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"874602b6-2ab3-40b4-b05f-f058ccec6eb9":{"description":"Temporarily unavailable; retry later.","content":{"application/json":{"schema":{"type":"object","required":["code","error"],"properties":{"error":{"type":"string","minLength":1,"description":"Human-readable explanation of the failure.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","minLength":1,"description":"Stable error code. Clients must tolerate unknown future codes.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","enum":["path","query","header","body"],"isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"path":{"type":"array","items":{"type":"string","maxLength":64,"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"maxItems":12,"isRequired":true,"uniqueKey":"details.items.[INDEX].path","typeLabel":"string[]"},"code":{"type":"string","enum":["required","invalid_type","invalid_value","unknown_field"],"isRequired":true,"uniqueKey":"details.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"required":["location","path","code","message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Bounded safe validation issues; may omit some invalid fields.","uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","minLength":1,"maxLength":128,"description":"Existing server correlation for this HTTP attempt, when available.","uniqueKey":"requestId","typeLabel":"string"},"dataset":{"type":"string","enum":["naic","osha"],"description":"Dataset needed for dataset_not_enabled.","uniqueKey":"dataset","typeLabel":"enum\u003cstring>"},"businessCode":{"type":"string","description":"The rater’s own refusal code, for business_rejection.","uniqueKey":"businessCode","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Authored or built-in constraint code","isRequired":true,"uniqueKey":"violations.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Authored message for the failed constraint","isRequired":true,"uniqueKey":"violations.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Input path of the offending value; empty for the request","isRequired":true,"uniqueKey":"violations.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"Offending input value, size-bounded by the runtime","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"Offending input value, size-bounded by the runtime","type":"null","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].value","typeLabel":"any | null"},"constraint":{"type":"string","description":"The constraint the value failed, as text","isRequired":true,"uniqueKey":"violations.items.[INDEX].constraint","typeLabel":"string"},"cite":{"oneOf":[{"type":"string","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.0","typeLabel":"string"},{"type":"null","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].cite","typeLabel":"string | null"}},"required":["code","message","path","value","constraint","cite"],"additionalProperties":false,"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"maxItems":256,"description":"Each input constraint the submission failed, for invalid_inputs and business_rejection.","uniqueKey":"violations","typeLabel":"object[]"},"violationsTruncated":{"type":"boolean","description":"True when the rater reported more violations than violations holds.","uniqueKey":"violationsTruncated","typeLabel":"boolean"},"executionId":{"type":"string","description":"The recorded execution of a failed rating, for rater rating failures.","uniqueKey":"executionId","typeLabel":"string"},"accessUrl":{"oneOf":[{"type":"string","format":"uri","description":"Where to add the product to your account, for product_access_required.","uniqueKey":"accessUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Where to add the product to your account, for product_access_required.","uniqueKey":"accessUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"location":"path","path":["\u003cstring>"],"code":"required","message":"\u003cstring>"}],"requestId":"\u003cstring>","dataset":"naic","businessCode":"\u003cstring>","violations":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","value":"\u003cunknown>","constraint":"\u003cstring>","cite":"\u003cstring>"}],"violationsTruncated":true,"executionId":"\u003cstring>","accessUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c29b4b70-6277-4ae4-af7f-94d1956c5c52":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Effective API key. Send Authorization: Bearer sk-eai-...","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"b9b0d18c-2e8d-4b4a-9142-e9fce2448cb9":{"url":"https://api.canary.effectiveai.app/api/v2","description":"Canary"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Effective API key. Send Authorization: Bearer sk-eai-...","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Effective API key. Send Authorization: Bearer sk-eai-...","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"effective-ai-canary","siteName":"Effective","title":"List app secrets - Effective","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T15:49:32.632Z","originalFileLocation":"api-reference/apps/list-app-secrets.mdx"},"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=\"system\"}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=\"List an app’s secrets by name, with where each is injected. Values are never returned. An app secret is a value Effective adds to the app’s outbound HTTPS requests to the hosts you name, so the app’s code never holds it. Needs build permission on the app. Read-only and safe to retry.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Effective\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List app secrets - Effective\">\u003cmeta data-mint-head property=\"og:description\" content=\"List an app’s secrets by name, with where each is injected. Values are never returned. An app secret is a value Effective adds to the app’s outbound HTTPS requests to the hosts you name, so the app’s code never holds it. Needs build permission on the app. Read-only and safe to retry.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Effective\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.canary.effectiveai.app/api-reference/apps/list-app-secrets\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://effective-ai-canary.mintlify.app/_mintlify/api/og/v2?division=Apps\u0026amp;title=List+app+secrets\u0026amp;description=List+an+app%E2%80%99s+secrets+by+name%2C+with+where+each+is+injected.+Values+are+never+returned.+An+app+secret+is+a+value+Effective+adds+to+the+app%E2%80%99s+outbound+HTTPS+reque\u0026amp;theme=d938a872e25ddaaf4fa20d46\u0026amp;signature=610646891e18462d29f06603d57f7865d172b9de96ade89edd0f51ec19660c15\">\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=\"List app secrets - Effective\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List an app’s secrets by name, with where each is injected. Values are never returned. An app secret is a value Effective adds to the app’s outbound HTTPS requests to the hosts you name, so the app’s code never holds it. Needs build permission on the app. Read-only and safe to retry.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://effective-ai-canary.mintlify.app/_mintlify/api/og/v2?division=Apps\u0026amp;title=List+app+secrets\u0026amp;description=List+an+app%E2%80%99s+secrets+by+name%2C+with+where+each+is+injected.+Values+are+never+returned.+An+app+secret+is+a+value+Effective+adds+to+the+app%E2%80%99s+outbound+HTTPS+reque\u0026amp;theme=d938a872e25ddaaf4fa20d46\u0026amp;signature=610646891e18462d29f06603d57f7865d172b9de96ade89edd0f51ec19660c15\">\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/effective-ai-canary/rQBY_xxcuFdHVIQc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Effective\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#171717\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.canary.effectiveai.app/api-reference/apps/list-app-secrets\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/apps/list-app-secrets.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.canary.effectiveai.app/#organization\",\"name\":\"Effective\",\"url\":\"https://docs.canary.effectiveai.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/effective-ai-canary/XwQAlB9iZgv01g6C/logo/light.svg?fit=max\u0026auto=format\u0026n=XwQAlB9iZgv01g6C\u0026q=85\u0026s=1dea6fc4d5e457e6149af14837c5112e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.canary.effectiveai.app#website\",\"name\":\"Effective\",\"url\":\"https://docs.canary.effectiveai.app\",\"publisher\":{\"@id\":\"https://docs.canary.effectiveai.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.canary.effectiveai.app/api-reference/apps/list-app-secrets#webpage\",\"url\":\"https://docs.canary.effectiveai.app/api-reference/apps/list-app-secrets\",\"name\":\"List app secrets\",\"description\":\"List an app’s secrets by name, with where each is injected. Values are never returned. An app secret is a value Effective adds to the app’s outbound HTTPS requests to the hosts you name, so the app’s code never holds it. Needs build permission on the app. Read-only and safe to retry.\",\"dateModified\":\"2026-10-27T15:49:32.632Z\",\"isPartOf\":{\"@id\":\"https://docs.canary.effectiveai.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.canary.effectiveai.app/api-reference/apps/list-app-secrets#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.canary.effectiveai.app/api-reference/apps/list-app-secrets#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Apps\",\"item\":\"https://docs.canary.effectiveai.app/api-reference/apps/list-apps\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List app secrets\",\"item\":\"https://docs.canary.effectiveai.app/api-reference/apps/list-app-secrets\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.canary.effectiveai.app/api-reference/apps/list-app-secrets#apireference\",\"headline\":\"List app secrets\",\"name\":\"List app secrets\",\"description\":\"List an app’s secrets by name, with where each is injected. Values are never returned. An app secret is a value Effective adds to the app’s outbound HTTPS requests to the hosts you name, so the app’s code never holds it. Needs build permission on the app. Read-only and safe to retry.\",\"url\":\"https://docs.canary.effectiveai.app/api-reference/apps/list-app-secrets\",\"mainEntityOfPage\":{\"@id\":\"https://docs.canary.effectiveai.app/api-reference/apps/list-app-secrets#webpage\"},\"dateModified\":\"2026-10-27T15:49:32.632Z\",\"publisher\":{\"@id\":\"https://docs.canary.effectiveai.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.canary.effectiveai.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Effective\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Effective","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/getting-started/overview"}]},{"tab":"Market Directory","pages":[{"title":"Market Directory","href":"/guides"}]},{"tab":"Product Hub","pages":[{"title":"Product Hub","href":"/guides/product-hub"}]},{"tab":"Apps","pages":[{"title":"Apps","href":"/guides/apps/build-an-app"}]},{"tab":"Relativities","pages":[{"title":"Relativities","href":"/relativities"}]},{"tab":"API Reference","groups":[{"group":"Managed Products","pages":[{"title":"Find products for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/products","href":"/api-reference/managed-products/find-products-for-filing-preparation"},{"title":"Create a product for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/products","href":"/api-reference/managed-products/create-a-product-for-filing-preparation"},{"title":"Get one product for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/products/{id}","href":"/api-reference/managed-products/get-one-product-for-filing-preparation"}]},{"group":"Insurance Types","pages":[{"title":"List NAIC insurance types","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/insurance-types","href":"/api-reference/insurance-types/list-naic-insurance-types"},{"title":"List subtypes for a NAIC insurance type","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/insurance-types/{toiCode}/subtypes","href":"/api-reference/insurance-types/list-subtypes-for-a-naic-insurance-type"},{"title":"Get one NAIC insurance type","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/insurance-types/{id}","href":"/api-reference/insurance-types/get-one-naic-insurance-type"},{"title":"Get one NAIC insurance subtype","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/insurance-types/{toiCode}/subtypes/{id}","href":"/api-reference/insurance-types/get-one-naic-insurance-subtype"}]},{"group":"Companies","pages":[{"title":"Find companies for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/companies","href":"/api-reference/companies/find-companies-for-filing-preparation"},{"title":"Create a company for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/companies","href":"/api-reference/companies/create-a-company-for-filing-preparation"},{"title":"Get one company for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/companies/{id}","href":"/api-reference/companies/get-one-company-for-filing-preparation"}]},{"group":"Jurisdictions","pages":[{"title":"Find jurisdictions for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/jurisdictions","href":"/api-reference/jurisdictions/find-jurisdictions-for-filing-preparation"},{"title":"Create a jurisdiction for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/jurisdictions","href":"/api-reference/jurisdictions/create-a-jurisdiction-for-filing-preparation"},{"title":"Get one jurisdiction for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/jurisdictions/{id}","href":"/api-reference/jurisdictions/get-one-jurisdiction-for-filing-preparation"}]},{"group":"Objections","pages":[{"title":"Triage an objection","deprecated":null,"version":null,"openapi":"/openapi.json post /objections/{id}/triage","href":"/api-reference/objections/triage-an-objection"},{"title":"Read objection triage progress","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}/triage/{requestId}","href":"/api-reference/objections/read-objection-triage-progress"},{"title":"Get a workspace objection","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}","href":"/api-reference/objections/get-a-workspace-objection"},{"title":"Remove a workspace objection","deprecated":null,"version":null,"openapi":"/openapi.json delete /objections/{id}","href":"/api-reference/objections/remove-a-workspace-objection"},{"title":"Edit a workspace objection","deprecated":null,"version":null,"openapi":"/openapi.json patch /objections/{id}","href":"/api-reference/objections/edit-a-workspace-objection"},{"title":"Get an objection item","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}/items/{itemId}","href":"/api-reference/objections/get-an-objection-item"},{"title":"Remove an objection item","deprecated":null,"version":null,"openapi":"/openapi.json delete /objections/{id}/items/{itemId}","href":"/api-reference/objections/remove-an-objection-item"},{"title":"Edit an objection item or response draft","deprecated":null,"version":null,"openapi":"/openapi.json patch /objections/{id}/items/{itemId}","href":"/api-reference/objections/edit-an-objection-item-or-response-draft"},{"title":"List the requests in a workspace objection","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}/items","href":"/api-reference/objections/list-the-requests-in-a-workspace-objection"},{"title":"Add a regulator request to an objection","deprecated":null,"version":null,"openapi":"/openapi.json post /objections/{id}/items","href":"/api-reference/objections/add-a-regulator-request-to-an-objection"},{"title":"Upload an objection document","deprecated":null,"version":null,"openapi":"/openapi.json post /objections/{id}/uploads","href":"/api-reference/objections/upload-an-objection-document"},{"title":"Confirm an objection document upload","deprecated":null,"version":null,"openapi":"/openapi.json post /objections/{id}/uploads/complete","href":"/api-reference/objections/confirm-an-objection-document-upload"},{"title":"List documents attached to an objection","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}/documents","href":"/api-reference/objections/list-documents-attached-to-an-objection"},{"title":"Attach an existing file to an objection","deprecated":null,"version":null,"openapi":"/openapi.json post /objections/{id}/documents","href":"/api-reference/objections/attach-an-existing-file-to-an-objection"},{"title":"Remove a document from an objection","deprecated":null,"version":null,"openapi":"/openapi.json delete /objections/{id}/documents/{fileId}","href":"/api-reference/objections/remove-a-document-from-an-objection"},{"title":"Read an objection item discussion timeline","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}/items/{itemId}/comments","href":"/api-reference/objections/read-an-objection-item-discussion-timeline"},{"title":"Comment or reply on an objection item","deprecated":null,"version":null,"openapi":"/openapi.json post /objections/{id}/items/{itemId}/comments","href":"/api-reference/objections/comment-or-reply-on-an-objection-item"},{"title":"Get one objection item comment","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}/items/{itemId}/comments/{commentId}","href":"/api-reference/objections/get-one-objection-item-comment"},{"title":"Edit a comment or resolve its discussion","deprecated":null,"version":null,"openapi":"/openapi.json patch /objections/{id}/items/{itemId}/comments/{commentId}","href":"/api-reference/objections/edit-a-comment-or-resolve-its-discussion"},{"title":"List workspace objections on a filing","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/objections","href":"/api-reference/objections/list-workspace-objections-on-a-filing"},{"title":"Record an objection letter on a managed filing","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/objections","href":"/api-reference/objections/record-an-objection-letter-on-a-managed-filing"}]},{"group":"Answers","pages":[{"title":"Schedule an answer to a question","deprecated":null,"version":null,"openapi":"/openapi.json post /answers","href":"/api-reference/answers/schedule-an-answer-to-a-question"},{"title":"Get answer status or completed result","deprecated":null,"version":null,"openapi":"/openapi.json get /answers/{id}","href":"/api-reference/answers/get-answer-status-or-completed-result"}]},{"group":"Form comparisons","pages":[{"title":"Validate knowledge files","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/form-knowledge/validate","href":"/api-reference/form-comparisons/validate-knowledge-files"},{"title":"List form comparisons","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/form-comparisons","href":"/api-reference/form-comparisons/list-form-comparisons"},{"title":"Request a form comparison","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/form-comparisons","href":"/api-reference/form-comparisons/request-a-form-comparison"},{"title":"Get a form comparison","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/form-comparisons/{id}","href":"/api-reference/form-comparisons/get-a-form-comparison"},{"title":"Delete a form comparison","deprecated":null,"version":null,"openapi":"/openapi.json delete /insurance/form-comparisons/{id}","href":"/api-reference/form-comparisons/delete-a-form-comparison"}]},{"group":"Loss reviews","pages":[{"title":"List loss reviews","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/loss-reviews","href":"/api-reference/loss-reviews/list-loss-reviews"},{"title":"Review supplied loss evidence","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/loss-reviews","href":"/api-reference/loss-reviews/review-supplied-loss-evidence"},{"title":"List saved loss matters","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/loss-reviews/{id}/items","href":"/api-reference/loss-reviews/list-saved-loss-matters"},{"title":"Get a loss review","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/loss-reviews/{id}","href":"/api-reference/loss-reviews/get-a-loss-review"},{"title":"Delete a loss review","deprecated":null,"version":null,"openapi":"/openapi.json delete /insurance/loss-reviews/{id}","href":"/api-reference/loss-reviews/delete-a-loss-review"}]},{"group":"Users","pages":[{"title":"Get current user","deprecated":null,"version":null,"openapi":"/openapi.json get /users/me","href":"/api-reference/users/get-current-user"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.json get /webhook-endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /webhook-endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Read a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json get /webhook-endpoints/{id}","href":"/api-reference/webhooks/read-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json delete /webhook-endpoints/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json patch /webhook-endpoints/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/openapi.json post /webhook-endpoints/{id}/test","href":"/api-reference/webhooks/send-a-test-event"}]},{"group":"NAIC statutory data","pages":[{"title":"List a carrier’s state results","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/state-results","href":"/api-reference/naic-statutory-data/list-a-carrier’s-state-results"},{"title":"Get a carrier state result","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/state-results/{id}","href":"/api-reference/naic-statutory-data/get-a-carrier-state-result"},{"title":"Get a carrier’s annual financial totals","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/financials","href":"/api-reference/naic-statutory-data/get-a-carrier’s-annual-financial-totals"},{"title":"List a carrier’s line results","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/line-results","href":"/api-reference/naic-statutory-data/list-a-carrier’s-line-results"},{"title":"Get a carrier line result","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/line-results/{id}","href":"/api-reference/naic-statutory-data/get-a-carrier-line-result"},{"title":"List a carrier’s state license observations","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/state-licenses","href":"/api-reference/naic-statutory-data/list-a-carrier’s-state-license-observations"},{"title":"Get a carrier state license observation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/state-licenses/{id}","href":"/api-reference/naic-statutory-data/get-a-carrier-state-license-observation"},{"title":"Get a carrier’s Schedule P interrogatories","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/loss-development/interrogatories","href":"/api-reference/naic-statutory-data/get-a-carrier’s-schedule-p-interrogatories"},{"title":"List a carrier’s Schedule P loss development rows","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/loss-development","href":"/api-reference/naic-statutory-data/list-a-carrier’s-schedule-p-loss-development-rows"},{"title":"Get a carrier Schedule P loss development row","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/loss-development/{id}","href":"/api-reference/naic-statutory-data/get-a-carrier-schedule-p-loss-development-row"}]},{"group":"Carriers","pages":[{"title":"List carriers","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers","href":"/api-reference/carriers/list-carriers"},{"title":"Get a carrier","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{id}","href":"/api-reference/carriers/get-a-carrier"}]},{"group":"Carrier groups","pages":[{"title":"List carrier groups","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carrier-groups","href":"/api-reference/carrier-groups/list-carrier-groups"},{"title":"Get a carrier group","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carrier-groups/{id}","href":"/api-reference/carrier-groups/get-a-carrier-group"}]},{"group":"MGAs","pages":[{"title":"List MGAs","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/mgas","href":"/api-reference/mgas/list-mgas"},{"title":"Get an MGA","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/mgas/{id}","href":"/api-reference/mgas/get-an-mga"}]},{"group":"Product types","pages":[{"title":"List shared type definitions","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/types","href":"/api-reference/product-types/list-shared-type-definitions"},{"title":"Get a shared type definition","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/types/{typeId}","href":"/api-reference/product-types/get-a-shared-type-definition"}]},{"group":"Products","pages":[{"title":"Discover product profile fields","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/product-profile/schema","href":"/api-reference/products/discover-product-profile-fields"},{"title":"Get conditional target-market choices","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/product-profile/options","href":"/api-reference/products/get-conditional-target-market-choices"},{"title":"Get the products you have access to","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/product-access","href":"/api-reference/products/get-the-products-you-have-access-to"},{"title":"List the lines of business products use","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/product-lines","href":"/api-reference/products/list-the-lines-of-business-products-use"},{"title":"List products","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products","href":"/api-reference/products/list-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{id}","href":"/api-reference/products/get-a-product"},{"title":"List recorded product filings in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/filings","href":"/api-reference/products/list-recorded-product-filings-in-a-state"},{"title":"Get recorded product underwriting manuals in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/uw-manuals","href":"/api-reference/products/get-recorded-product-underwriting-manuals-in-a-state"},{"title":"Get recorded product rate manuals in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/rate-manuals","href":"/api-reference/products/get-recorded-product-rate-manuals-in-a-state"},{"title":"Get recorded product forms in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/forms","href":"/api-reference/products/get-recorded-product-forms-in-a-state"},{"title":"Get recorded product marketing in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/marketing","href":"/api-reference/products/get-recorded-product-marketing-in-a-state"},{"title":"List published product events in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/events","href":"/api-reference/products/list-published-product-events-in-a-state"},{"title":"List published events across a product’s states","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/events","href":"/api-reference/products/list-published-events-across-a-product’s-states"},{"title":"Get one recorded product event","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/events/{id}","href":"/api-reference/products/get-one-recorded-product-event"},{"title":"Get a product profile","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/profile","href":"/api-reference/products/get-a-product-profile"},{"title":"List associated product resources","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/resources","href":"/api-reference/products/list-associated-product-resources"},{"title":"Get an associated product resource","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/resources/{resourceId}","href":"/api-reference/products/get-an-associated-product-resource"},{"title":"List your organization's rating plan requests for a product","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/rating-plan-requests","href":"/api-reference/products/list-your-organizations-rating-plan-requests-for-a-product"},{"title":"Request rating plans for product states","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/products/{productId}/rating-plan-requests","href":"/api-reference/products/request-rating-plans-for-product-states"},{"title":"List which rating program versions rate a product in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/rating-programs","href":"/api-reference/products/list-which-rating-program-versions-rate-a-product-in-a-state"}]},{"group":"Product timelines","pages":[{"title":"Get a product's timeline","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/timeline","href":"/api-reference/product-timelines/get-a-products-timeline"},{"title":"Get a digest of a product's timeline","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/timeline/digest","href":"/api-reference/product-timelines/get-a-digest-of-a-products-timeline"}]},{"group":"Rating programs","pages":[{"title":"List rating programs","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs","href":"/api-reference/rating-programs/list-rating-programs"},{"title":"Get a rating program","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs/{id}","href":"/api-reference/rating-programs/get-a-rating-program"},{"title":"Subscribe to a rating program","deprecated":null,"version":null,"openapi":"/openapi.json put /insurance/rating-programs/{id}/subscription","href":"/api-reference/rating-programs/subscribe-to-a-rating-program"},{"title":"Unsubscribe from a rating program","deprecated":null,"version":null,"openapi":"/openapi.json delete /insurance/rating-programs/{id}/subscription","href":"/api-reference/rating-programs/unsubscribe-from-a-rating-program"},{"title":"List program versions","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs/{id}/versions","href":"/api-reference/rating-programs/list-program-versions"},{"title":"Get a program version","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs/{id}/versions/{version}","href":"/api-reference/rating-programs/get-a-program-version"},{"title":"Download a program version","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs/{id}/versions/{version}/download","href":"/api-reference/rating-programs/download-a-program-version"},{"title":"Get the input and output schemas of a program version","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs/{id}/versions/{version}/contract","href":"/api-reference/rating-programs/get-the-input-and-output-schemas-of-a-program-version"},{"title":"Rate a submission using the latest program version","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/rating-programs/{id}/rate","href":"/api-reference/rating-programs/rate-a-submission-using-the-latest-program-version"},{"title":"Rate a submission","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/rating-programs/{id}/versions/{version}/rate","href":"/api-reference/rating-programs/rate-a-submission"}]},{"group":"Underwriting","pages":[{"title":"List a product's underwriting guidelines","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/uw-guidelines","href":"/api-reference/underwriting/list-a-products-underwriting-guidelines"},{"title":"Add underwriting guidelines to a product","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/uw-guidelines","href":"/api-reference/underwriting/add-underwriting-guidelines-to-a-product"},{"title":"Get underwriting guidelines","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/uw-guidelines/{guidelinesId}","href":"/api-reference/underwriting/get-underwriting-guidelines"},{"title":"Save a new version of underwriting guidelines","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/uw-guidelines/{guidelinesId}/versions","href":"/api-reference/underwriting/save-a-new-version-of-underwriting-guidelines"},{"title":"List underwriting submissions","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/uw-submissions","href":"/api-reference/underwriting/list-underwriting-submissions"},{"title":"Start an underwriting submission","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/uw-submissions","href":"/api-reference/underwriting/start-an-underwriting-submission"},{"title":"Get an underwriting submission","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/uw-submissions/{submissionId}","href":"/api-reference/underwriting/get-an-underwriting-submission"},{"title":"Get a submission's underwriting file","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/uw-submissions/{submissionId}/file","href":"/api-reference/underwriting/get-a-submissions-underwriting-file"},{"title":"Open a submission's underwriting file","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/uw-submissions/{submissionId}/file","href":"/api-reference/underwriting/open-a-submissions-underwriting-file"},{"title":"List an underwriting file's inputs","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/uw-submissions/{submissionId}/file/inputs","href":"/api-reference/underwriting/list-an-underwriting-files-inputs"},{"title":"Record an input on an underwriting file","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/uw-submissions/{submissionId}/file/inputs","href":"/api-reference/underwriting/record-an-input-on-an-underwriting-file"},{"title":"Get one underwriting file input","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/uw-submissions/{submissionId}/file/inputs/{inputId}","href":"/api-reference/underwriting/get-one-underwriting-file-input"}]},{"group":"Filings","pages":[{"title":"Search filings","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/filings/search","href":"/api-reference/filings/search-filings"},{"title":"List catalog filings","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filings","href":"/api-reference/filings/list-catalog-filings"},{"title":"Get a catalog filing","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filings/{filingId}","href":"/api-reference/filings/get-a-catalog-filing"},{"title":"List stored filing files","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filings/{filingId}/files","href":"/api-reference/filings/list-stored-filing-files"},{"title":"List extracted filing forms","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filings/{filingId}/forms","href":"/api-reference/filings/list-extracted-filing-forms"},{"title":"Get extracted filing rate impact","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filings/{filingId}/rate-impact","href":"/api-reference/filings/get-extracted-filing-rate-impact"},{"title":"Get one extracted filing form","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filings/{filingId}/forms/{id}","href":"/api-reference/filings/get-one-extracted-filing-form"}]},{"group":"Files","pages":[{"title":"Download one immutable file version","deprecated":null,"version":null,"openapi":"/openapi.json get /files/{fileId}/download","href":"/api-reference/files/download-one-immutable-file-version"},{"title":"Read a bounded chunk of existing extracted text","deprecated":null,"version":null,"openapi":"/openapi.json get /files/{fileId}/text","href":"/api-reference/files/read-a-bounded-chunk-of-existing-extracted-text"},{"title":"Get file metadata and content links","deprecated":null,"version":null,"openapi":"/openapi.json get /files/{fileId}","href":"/api-reference/files/get-file-metadata-and-content-links"}]},{"group":"Managed Filings","pages":[{"title":"Find supporting requirements before creating a filing","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/requirements","href":"/api-reference/managed-filings/find-supporting-requirements-before-creating-a-filing"},{"title":"Read full supporting requirement instructions","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/requirements/{requirementId}","href":"/api-reference/managed-filings/read-full-supporting-requirement-instructions"},{"title":"Find supporting requirements for an existing filing","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/requirements","href":"/api-reference/managed-filings/find-supporting-requirements-for-an-existing-filing"},{"title":"Check staging credentials","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/staging","href":"/api-reference/managed-filings/check-staging-credentials"},{"title":"Authorize and start SERFF staging","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/staging","href":"/api-reference/managed-filings/authorize-and-start-serff-staging"},{"title":"Sync a managed filing from SERFF","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/serff-sync","href":"/api-reference/managed-filings/sync-a-managed-filing-from-serff"},{"title":"List accessible filings","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings","href":"/api-reference/managed-filings/list-accessible-filings"},{"title":"Create a filing","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings","href":"/api-reference/managed-filings/create-a-filing"},{"title":"Read a filing Record","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}","href":"/api-reference/managed-filings/read-a-filing-record"},{"title":"Edit working filing details","deprecated":null,"version":null,"openapi":"/openapi.json patch /insurance/managed-filings/{filingId}","href":"/api-reference/managed-filings/edit-working-filing-details"},{"title":"List filing items","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/items","href":"/api-reference/managed-filings/list-filing-items"},{"title":"Attach a document to a working filing","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/items","href":"/api-reference/managed-filings/attach-a-document-to-a-working-filing"},{"title":"Get one filing item","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/items/{itemId}","href":"/api-reference/managed-filings/get-one-filing-item"},{"title":"Remove a working filing item","deprecated":null,"version":null,"openapi":"/openapi.json delete /insurance/managed-filings/{filingId}/items/{itemId}","href":"/api-reference/managed-filings/remove-a-working-filing-item"},{"title":"Edit or replace a working document reference","deprecated":null,"version":null,"openapi":"/openapi.json patch /insurance/managed-filings/{filingId}/items/{itemId}","href":"/api-reference/managed-filings/edit-or-replace-a-working-document-reference"},{"title":"List filing comments","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/comments","href":"/api-reference/managed-filings/list-filing-comments"},{"title":"Add a filing comment or reply","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/comments","href":"/api-reference/managed-filings/add-a-filing-comment-or-reply"},{"title":"Get one filing comment","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/comments/{commentId}","href":"/api-reference/managed-filings/get-one-filing-comment"},{"title":"Edit a comment or update its discussion","deprecated":null,"version":null,"openapi":"/openapi.json patch /insurance/managed-filings/{filingId}/comments/{commentId}","href":"/api-reference/managed-filings/edit-a-comment-or-update-its-discussion"},{"title":"Upload a filing document","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/uploads","href":"/api-reference/managed-filings/upload-a-filing-document"},{"title":"Confirm a filing document upload","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/uploads/complete","href":"/api-reference/managed-filings/confirm-a-filing-document-upload"}]},{"group":"Managed Filing Checks","pages":[{"title":"List filing checks","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/checks","href":"/api-reference/managed-filing-checks/list-filing-checks"},{"title":"Create an organization filing check","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/checks","href":"/api-reference/managed-filing-checks/create-an-organization-filing-check"},{"title":"Read a filing check","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/checks/{checkId}","href":"/api-reference/managed-filing-checks/read-a-filing-check"},{"title":"Revise filing check instructions","deprecated":null,"version":null,"openapi":"/openapi.json patch /insurance/managed-filings/checks/{checkId}","href":"/api-reference/managed-filing-checks/revise-filing-check-instructions"},{"title":"Start filing pre-review","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/pre-reviews","href":"/api-reference/managed-filing-checks/start-filing-pre-review"},{"title":"Resume an accepted filing pre-review","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/pre-reviews/{runId}/resume","href":"/api-reference/managed-filing-checks/resume-an-accepted-filing-pre-review"},{"title":"Read the latest filing pre-review","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/pre-reviews/latest","href":"/api-reference/managed-filing-checks/read-the-latest-filing-pre-review"},{"title":"Read filing pre-review progress","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/pre-reviews/{runId}","href":"/api-reference/managed-filing-checks/read-filing-pre-review-progress"},{"title":"Read combined filing check status","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/pre-review-status","href":"/api-reference/managed-filing-checks/read-combined-filing-check-status"}]},{"group":"Filing objections","pages":[{"title":"Find extracted objection letters","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filing-objections","href":"/api-reference/filing-objections/find-extracted-objection-letters"},{"title":"Read an extracted objection letter","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filing-objections/{objectionId}","href":"/api-reference/filing-objections/read-an-extracted-objection-letter"}]},{"group":"Regulatory documents","pages":[{"title":"Find regulatory documents","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/regulatory-documents","href":"/api-reference/regulatory-documents/find-regulatory-documents"},{"title":"Get a regulatory document","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/regulatory-documents/{documentId}","href":"/api-reference/regulatory-documents/get-a-regulatory-document"},{"title":"Read a regulatory document's text in chunks","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/regulatory-documents/{documentId}/text","href":"/api-reference/regulatory-documents/read-a-regulatory-documents-text-in-chunks"},{"title":"List citations out of or into a regulatory document","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/regulatory-documents/{documentId}/references","href":"/api-reference/regulatory-documents/list-citations-out-of-or-into-a-regulatory-document"},{"title":"List form checklist requirements across states","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/regulatory-requirements","href":"/api-reference/regulatory-documents/list-form-checklist-requirements-across-states"},{"title":"Get a form checklist requirement","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/regulatory-requirements/{requirementId}","href":"/api-reference/regulatory-documents/get-a-form-checklist-requirement"}]},{"group":"OSHA","pages":[{"title":"Match an employer","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/employers/match","href":"/api-reference/osha/match-an-employer"},{"title":"Get an employer","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/employers/{employerId}","href":"/api-reference/osha/get-an-employer"},{"title":"List an employer’s sites","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/employers/{employerId}/sites","href":"/api-reference/osha/list-an-employer’s-sites"},{"title":"Get an employer’s site","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/employers/{employerId}/sites/{siteId}","href":"/api-reference/osha/get-an-employer’s-site"},{"title":"List an employer’s events","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/employers/{employerId}/events","href":"/api-reference/osha/list-an-employer’s-events"},{"title":"Get an employer’s OSHA profile","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/employers/{employerId}/osha-profile","href":"/api-reference/osha/get-an-employer’s-osha-profile"},{"title":"List OSHA Form 300A summaries","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/300a-summaries","href":"/api-reference/osha/list-osha-form-300a-summaries"},{"title":"Get an OSHA Form 300A summary","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/300a-summaries/{id}","href":"/api-reference/osha/get-an-osha-form-300a-summary"},{"title":"List OSHA case details","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/case-details","href":"/api-reference/osha/list-osha-case-details"},{"title":"Get an OSHA case detail","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/case-details/{id}","href":"/api-reference/osha/get-an-osha-case-detail"},{"title":"List OSHA severe injury reports","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/severe-injury-reports","href":"/api-reference/osha/list-osha-severe-injury-reports"},{"title":"Get an OSHA severe injury report","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/severe-injury-reports/{id}","href":"/api-reference/osha/get-an-osha-severe-injury-report"},{"title":"List OSHA inspections","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/inspections","href":"/api-reference/osha/list-osha-inspections"},{"title":"Get an OSHA inspection","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/inspections/{activityNr}","href":"/api-reference/osha/get-an-osha-inspection"},{"title":"List an inspection’s violations","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/inspections/{activityNr}/violations","href":"/api-reference/osha/list-an-inspection’s-violations"},{"title":"Get a violation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/inspections/{activityNr}/violations/{citationId}","href":"/api-reference/osha/get-a-violation"},{"title":"List a violation’s history","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/inspections/{activityNr}/violations/{citationId}/events","href":"/api-reference/osha/list-a-violation’s-history"},{"title":"List an inspection’s related activities","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/inspections/{activityNr}/related-activities","href":"/api-reference/osha/list-an-inspection’s-related-activities"},{"title":"List OSHA accident investigations","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/accidents","href":"/api-reference/osha/list-osha-accident-investigations"},{"title":"Get an OSHA accident investigation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/accidents/{summaryNr}","href":"/api-reference/osha/get-an-osha-accident-investigation"},{"title":"List an accident’s injured workers","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/accidents/{summaryNr}/injuries","href":"/api-reference/osha/list-an-accident’s-injured-workers"},{"title":"Search OSHA narratives","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/search","href":"/api-reference/osha/search-osha-narratives"},{"title":"Get OSHA incidence rates for an industry","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/incidence-rates","href":"/api-reference/osha/get-osha-incidence-rates-for-an-industry"}]},{"group":"SERFF Imports","pages":[{"title":"Open your SERFF import conversation","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/serff-import-sessions","href":"/api-reference/serff-imports/open-your-serff-import-conversation"},{"title":"List your saved import selections","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/serff-import-items","href":"/api-reference/serff-imports/list-your-saved-import-selections"},{"title":"Save selected SERFF filings for import","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/serff-import-items","href":"/api-reference/serff-imports/save-selected-serff-filings-for-import"},{"title":"Read a saved import selection","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/serff-import-items/{id}","href":"/api-reference/serff-imports/read-a-saved-import-selection"},{"title":"Edit your saved import selection","deprecated":null,"version":null,"openapi":"/openapi.json patch /insurance/serff-import-items/{id}","href":"/api-reference/serff-imports/edit-your-saved-import-selection"},{"title":"Cancel a pending import selection","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/serff-import-items/{id}/cancel","href":"/api-reference/serff-imports/cancel-a-pending-import-selection"},{"title":"Restore a cancelled import selection","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/serff-import-items/{id}/retry","href":"/api-reference/serff-imports/restore-a-cancelled-import-selection"}]},{"group":"SERFF Insurance Types","pages":[{"title":"List current SERFF TOI/sub-TOI combinations","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/serff-insurance-types/combinations","href":"/api-reference/serff-insurance-types/list-current-serff-toisub-toi-combinations"},{"title":"Get a current SERFF TOI/sub-TOI combination","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/serff-insurance-types/combinations/{combinationId}","href":"/api-reference/serff-insurance-types/get-a-current-serff-toisub-toi-combination"}]},{"group":"Raters","pages":[{"title":"List raters","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters","href":"/api-reference/raters/list-raters"},{"title":"Get a rater","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters/{id}","href":"/api-reference/raters/get-a-rater"},{"title":"List rater releases","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters/{id}/releases","href":"/api-reference/raters/list-rater-releases"},{"title":"Get a rater release","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters/{id}/releases/{releaseVersion}","href":"/api-reference/raters/get-a-rater-release"},{"title":"Get the input and output schemas of a rater release","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters/{id}/releases/{releaseVersion}/contract","href":"/api-reference/raters/get-the-input-and-output-schemas-of-a-rater-release"},{"title":"Download a rater release bundle","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters/{id}/releases/{releaseVersion}/download","href":"/api-reference/raters/download-a-rater-release-bundle"},{"title":"Rate a submission with a rater release","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/raters/{id}/releases/{releaseVersion}/rate","href":"/api-reference/raters/rate-a-submission-with-a-rater-release"},{"title":"Rate a submission with a rater’s latest release","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/raters/{id}/rate","href":"/api-reference/raters/rate-a-submission-with-a-rater’s-latest-release"}]},{"group":"Sessions","pages":[{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi.json get /sessions","href":"/api-reference/sessions/list-sessions"},{"title":"Start a session with the Effective agent","deprecated":null,"version":null,"openapi":"/openapi.json post /sessions","href":"/api-reference/sessions/start-a-session-with-the-effective-agent"},{"title":"Read a session","deprecated":null,"version":null,"openapi":"/openapi.json get /sessions/{id}","href":"/api-reference/sessions/read-a-session"},{"title":"List the conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /sessions/{id}/messages","href":"/api-reference/sessions/list-the-conversation"},{"title":"Send a message to a session","deprecated":null,"version":null,"openapi":"/openapi.json post /sessions/{id}/messages","href":"/api-reference/sessions/send-a-message-to-a-session"},{"title":"Read a sent message and its reply","deprecated":null,"version":null,"openapi":"/openapi.json get /sessions/{id}/messages/{messageId}","href":"/api-reference/sessions/read-a-sent-message-and-its-reply"},{"title":"List files the agent produced","deprecated":null,"version":null,"openapi":"/openapi.json get /sessions/{id}/files","href":"/api-reference/sessions/list-files-the-agent-produced"}]},{"group":"Apps","pages":[{"title":"List apps","deprecated":null,"version":null,"openapi":"/openapi.json get /apps","href":"/api-reference/apps/list-apps"},{"title":"Create an app","deprecated":null,"version":null,"openapi":"/openapi.json post /apps","href":"/api-reference/apps/create-an-app"},{"title":"Get an app","deprecated":null,"version":null,"openapi":"/openapi.json get /apps/{appId}","href":"/api-reference/apps/get-an-app"},{"title":"Delete an app","deprecated":null,"version":null,"openapi":"/openapi.json delete /apps/{appId}","href":"/api-reference/apps/delete-an-app"},{"title":"Update an app","deprecated":null,"version":null,"openapi":"/openapi.json patch /apps/{appId}","href":"/api-reference/apps/update-an-app"},{"title":"Upload an app release bundle","deprecated":null,"version":null,"openapi":"/openapi.json post /apps/{appId}/release-uploads","href":"/api-reference/apps/upload-an-app-release-bundle"},{"title":"List app deployments","deprecated":null,"version":null,"openapi":"/openapi.json get /apps/{appId}/deployments","href":"/api-reference/apps/list-app-deployments"},{"title":"Deploy an app","deprecated":null,"version":null,"openapi":"/openapi.json post /apps/{appId}/deployments","href":"/api-reference/apps/deploy-an-app"},{"title":"Get an app deployment","deprecated":null,"version":null,"openapi":"/openapi.json get /apps/{appId}/deployments/{deploymentId}","href":"/api-reference/apps/get-an-app-deployment"},{"title":"Archive an app","deprecated":null,"version":null,"openapi":"/openapi.json post /apps/{appId}/archive","href":"/api-reference/apps/archive-an-app"},{"title":"Restore an archived app","description":"Bring back an archived app with its source, deployments and secrets, and return it. Restoring an app that is not archived returns it unchanged.\n\nNeeds `manage` permission on the app. 409 `app_purged` means its deletion started, so it cannot come back.","deprecated":null,"version":null,"openapi":"/openapi.json post /apps/{appId}/restore","href":"/api-reference/apps/restore-an-archived-app"},{"title":"List app secrets","deprecated":null,"version":null,"openapi":"/openapi.json get /apps/{appId}/secrets","href":"/api-reference/apps/list-app-secrets"},{"title":"Get an app secret","description":"Get one of an app’s secrets: where it is injected and whether a value is set, never the value.\n\nNeeds `build` permission on the app. Read-only and safe to retry.","deprecated":null,"version":null,"openapi":"/openapi.json get /apps/{appId}/secrets/{name}","href":"/api-reference/apps/get-an-app-secret"},{"title":"Set an app secret","deprecated":null,"version":null,"openapi":"/openapi.json put /apps/{appId}/secrets/{name}","href":"/api-reference/apps/set-an-app-secret"},{"title":"Delete an app secret","deprecated":null,"version":null,"openapi":"/openapi.json delete /apps/{appId}/secrets/{name}","href":"/api-reference/apps/delete-an-app-secret"},{"title":"List app API calls","deprecated":null,"version":null,"openapi":"/openapi.json get /apps/{appId}/api-calls","href":"/api-reference/apps/list-app-api-calls"},{"title":"Sign a browser in to an app","deprecated":null,"version":null,"openapi":"/openapi.json post /apps/{appId}/sign-ins","href":"/api-reference/apps/sign-a-browser-in-to-an-app"},{"title":"Call an app’s API","deprecated":null,"version":null,"openapi":"/openapi.json post /apps/{appId}/calls","href":"/api-reference/apps/call-an-app’s-api"}]},{"group":"Device sign-in","pages":[{"title":"Start a browser sign-in for an agent","deprecated":null,"version":null,"openapi":"/openapi.json post /device-authorizations","href":"/api-reference/device-sign-in/start-a-browser-sign-in-for-an-agent"},{"title":"Check a browser sign-in and receive its API key","deprecated":null,"version":null,"openapi":"/openapi.json post /device-authorizations/exchange","href":"/api-reference/device-sign-in/check-a-browser-sign-in-and-receive-its-api-key"}]},{"group":"Shares","pages":[{"title":"Download a published share attachment","deprecated":null,"version":null,"openapi":"/openapi.json get /shares/{slug}/files/{fileId}/download","href":"/api-reference/shares/download-a-published-share-attachment"}]},{"group":"Filing reviews","pages":[{"title":"Read a filing review from its link","deprecated":null,"version":null,"openapi":"/openapi.json get /filing-reviews/{reviewId}","href":"/api-reference/filing-reviews/read-a-filing-review-from-its-link"},{"title":"Read a filing a review's link covers","deprecated":null,"version":null,"openapi":"/openapi.json get /filing-reviews/{reviewId}/filings/{filingId}","href":"/api-reference/filing-reviews/read-a-filing-a-reviews-link-covers"},{"title":"List objection letters on a filing a review's link covers","deprecated":null,"version":null,"openapi":"/openapi.json get /filing-reviews/{reviewId}/filings/{filingId}/objections","href":"/api-reference/filing-reviews/list-objection-letters-on-a-filing-a-reviews-link-covers"}]}]}]},"title":"List app secrets - Effective","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-BVNUlwBc.js","dist-aeztFa9U.js","lib--scc4DXi.js","lib-B8HbPgcC.js","clsx-rL8ZCCw4.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","AssistantPageLink-BywkCr5C.js"]}