To ensure secure communication with the Phishy API, it is essential to authenticate using an API key.
This key is unique to your user account and controls the permissions granted to your application.
Once you have your API key, you need to include it in all your API requests.
Send your API key in the request header under the name x-phishy-api-key. Here’s how to include it:
x-phishy-api-key: your_api_key_here
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Phishy","colors":{"primary":"#3371e2","light":"#3371e2","dark":"#3371e2"},"favicon":"/static/img/favicon.svg","logo":{"light":"https://demo.phishy.io/assets/public-images-83869901-097c-4750-84d9-ed581c956c0e/1729497912685-1_logo.png","dark":"https://demo.phishy.io/assets/public-images-83869901-097c-4750-84d9-ed581c956c0e/1729497912685-1_logo.png"},"background":{"decoration":null,"color":{"light":null,"dark":null}},"navbar":{"links":[],"primary":null},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/phishyio"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"phishy-2be9d018","hasAudioNarration":false,"actualSubdomain":"phishy-2be9d018","customDomains":["docs.phishy.io"],"gitSource":{"type":"github","owner":"phishy-io","repo":"docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e63903d4026a3ef768bb","collectionId":"61c17528-451b-4e1c-a8c5-35da0bf4b590","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e63903d4026a3ef768bb:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":66},{"language":"default","tag":"Endpoints","count":59},{"language":"default","tag":"Documentation","count":31},{"language":"default","tag":"Simulations","count":19},{"language":"default","tag":"Campaigns","count":19},{"language":"default","tag":"Targets","count":9},{"language":"default","tag":"Groups","count":8},{"language":"default","tag":"Templates","count":8},{"language":"default","tag":"API Documentation","count":7},{"language":"default","tag":"Pages","count":7}]},"assistantConfig":{},"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":"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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/authentication","slug":"/api-reference/authentication","pageMetadata":{"title":"Authentication","description":"Learn how to authenticate with the Phishy API","href":"/api-reference/authentication"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Learn how to authenticate with the Phishy API\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,em:`em`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:` This section provides details on how to authenticate your application with the Phishy API using the required API key. `}),`\n`,_jsx(Heading,{level:`2`,id:`api-key-authentication`,children:`API Key Authentication`}),`\n`,_jsx(_components.p,{children:`To ensure secure communication with the Phishy API, it is essential to authenticate using an API key.\nThis key is unique to your user account and controls the permissions granted to your application.`}),`\n`,_jsx(Heading,{level:`2`,id:`how-to-get-api-key`,children:`How to Get API Key`}),`\n`,_jsx(_components.p,{children:`To obtain your API key, you will need to contact us directly.`}),`\n`,_jsx(Heading,{level:`2`,id:`using-your-api-key`,children:`Using Your API Key`}),`\n`,_jsxs(_components.p,{children:[`Once you have your API key, you need to include it in all your API requests.\nSend your API key in the request header under the name `,_jsx(_components.em,{children:`x-phishy-api-key`}),`. Here’s how to include it:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`x-phishy-api-key: your_api_key_here`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Authentication","description":"Learn how to authenticate with the Phishy API","href":"/api-reference/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"API Key Authentication","slug":"api-key-authentication","depth":2,"children":[]},{"title":"How to Get API Key","slug":"how-to-get-api-key","depth":2,"children":[]},{"title":"Using Your API Key","slug":"using-your-api-key","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"phishy-2be9d018","siteName":"Phishy","title":"Authentication - Phishy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T02:42:38.947Z","originalFileLocation":"api-reference/authentication.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=\"Learn how to authenticate with the Phishy API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Phishy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/phishy-2be9d018/poGkEsU7GPFLShbo/_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/phishy-2be9d018/poGkEsU7GPFLShbo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/phishy-2be9d018/poGkEsU7GPFLShbo/_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/phishy-2be9d018/poGkEsU7GPFLShbo/_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/phishy-2be9d018/poGkEsU7GPFLShbo/_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/phishy-2be9d018/poGkEsU7GPFLShbo/_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/phishy-2be9d018/poGkEsU7GPFLShbo/_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/phishy-2be9d018/poGkEsU7GPFLShbo/_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/phishy-2be9d018/poGkEsU7GPFLShbo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Phishy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn how to authenticate with the Phishy API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Phishy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.phishy.io/api-reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://phishy-2be9d018.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Authentication\u0026amp;description=Learn+how+to+authenticate+with+the+Phishy+API\u0026amp;theme=05a8aa645296d803f3cf5c07\u0026amp;signature=7a3e4cd691d81bf98fe8199898f64334f152eee432dc752a123f78acd0a8425c\">\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=\"Authentication - Phishy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn how to authenticate with the Phishy API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://phishy-2be9d018.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Authentication\u0026amp;description=Learn+how+to+authenticate+with+the+Phishy+API\u0026amp;theme=05a8aa645296d803f3cf5c07\u0026amp;signature=7a3e4cd691d81bf98fe8199898f64334f152eee432dc752a123f78acd0a8425c\">\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/phishy-2be9d018/poGkEsU7GPFLShbo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Phishy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3371e2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.phishy.io/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.phishy.io/#organization\",\"name\":\"Phishy\",\"url\":\"https://docs.phishy.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://demo.phishy.io/assets/public-images-83869901-097c-4750-84d9-ed581c956c0e/1729497912685-1_logo.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.phishy.io#website\",\"name\":\"Phishy\",\"url\":\"https://docs.phishy.io\",\"publisher\":{\"@id\":\"https://docs.phishy.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.phishy.io/api-reference/authentication#webpage\",\"url\":\"https://docs.phishy.io/api-reference/authentication\",\"name\":\"Authentication\",\"description\":\"Learn how to authenticate with the Phishy API\",\"dateModified\":\"2026-01-07T02:42:38.947Z\",\"isPartOf\":{\"@id\":\"https://docs.phishy.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.phishy.io/api-reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.phishy.io/api-reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Documentation\",\"item\":\"https://docs.phishy.io/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.phishy.io/api-reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.phishy.io/api-reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"Learn how to authenticate with the Phishy API\",\"url\":\"https://docs.phishy.io/api-reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.phishy.io/api-reference/authentication#webpage\"},\"dateModified\":\"2026-01-07T02:42:38.947Z\",\"publisher\":{\"@id\":\"https://docs.phishy.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.phishy.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Phishy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Phishy","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","description":"Overview and integration guidelines for Phishy API","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Authorization","description":"Understanding authorization mechanisms in Phishy API","href":"/api-reference/authorization"},{"group":"Simulations","pages":[{"title":"Overview","icon":"waves-sine","href":"/api-reference/simulations"},{"title":"Email Phishing","icon":"envelopes-bulk","href":"/api-reference/email-phishing"},{"title":"Vishing","icon":"phone","href":"/api-reference/vishing"},{"title":"Smishing","icon":"message-text","href":"/api-reference/simishing"}]}]},{"group":"Endpoints","pages":[{"group":"SMTP Profiles","icon":"layer-group","pages":[{"title":"Get Profiles","openapi":"GET /profiles/","href":"/api-reference/endpoint/profiles/getProfiles"},{"title":"Get All Profiles","openapi":"GET /profiles/all","href":"/api-reference/endpoint/profiles/getAllProfiles"},{"title":"Get Profile By Id","openapi":"GET /profiles/{smtp_id}","href":"/api-reference/endpoint/profiles/getProfile"},{"title":"Create Profile","openapi":"POST /profiles","href":"/api-reference/endpoint/profiles/createProfile"},{"title":"Send Test Email","openapi":"POST /profiles/sendTestEmail","href":"/api-reference/endpoint/profiles/createTestEmail"},{"title":"Update Profile","openapi":"PUT /profiles/{smtp_id}","href":"/api-reference/endpoint/profiles/updateProfile"},{"title":"Delete Profile By Id","openapi":"DELETE /profiles/{smtp_id}","href":"/api-reference/endpoint/profiles/deleteProfile"}]},{"group":"Targets","icon":"bullseye","pages":[{"title":"Get Targets","openapi":"GET /targets","href":"/api-reference/endpoint/targets/getTargets"},{"title":"Get All Targets","openapi":"GET /targets/all","href":"/api-reference/endpoint/targets/getAllTargets"},{"title":"Create Target","openapi":"POST /targets","href":"/api-reference/endpoint/targets/createTarget"},{"title":"Update Targets","openapi":"PUT /targets/{targetid}","href":"/api-reference/endpoint/targets/updateTarget"},{"title":"Delete Target","openapi":"DELETE /targets/target/{targetid}","href":"/api-reference/endpoint/targets/deleteTarget"},{"title":"Calculate Imported Targets","openapi":"POST /targets/calculateImportedTargets","href":"/api-reference/endpoint/targets/createCalculateImportedTargets"},{"title":"Import Targets","openapi":"POST /targets/import","href":"/api-reference/endpoint/targets/createImportTargets"},{"title":"Bulk Delete","openapi":"POST /targets/bulkDelete","href":"/api-reference/endpoint/targets/createBulkDeleteTargets"},{"title":"Delete All Bulk Targets","openapi":"DELETE /targets/bulkDeleteAll","href":"/api-reference/endpoint/targets/deleteAllBulkTargets"}]},{"group":"Groups","icon":"user-group","pages":[{"title":"Get Groups","openapi":"GET /groups","href":"/api-reference/endpoint/groups/getGroups"},{"title":"Get All Groups","openapi":"GET /groups/all","href":"/api-reference/endpoint/groups/getAllGroups"},{"title":"Get All Groups Basic","openapi":"GET /groups/basic","href":"/api-reference/endpoint/groups/getAllGroupsBasic"},{"title":"Create Groups","openapi":"POST /groups","href":"/api-reference/endpoint/groups/createGroups"},{"title":"Update Group","openapi":"PUT /groups/{targetGroupid}","href":"/api-reference/endpoint/groups/updateGroup"},{"title":"Delete Group","openapi":"DELETE /groups/group/{targetGroupid}","href":"/api-reference/endpoint/groups/deleteGroup"},{"title":"Bulk Delete Groups","openapi":"POST /groups/bulkDelete","href":"/api-reference/endpoint/groups/createBulkDeleteGroups"},{"title":"Delete All Bulk Group","openapi":"DELETE /groups/bulkDeleteAll","href":"/api-reference/endpoint/groups/deleteAllBulkGroups"}]},{"group":"Pages","icon":"memo","pages":[{"title":"Get Pages","openapi":"GET /pages","href":"/api-reference/endpoint/pages/getPages"},{"title":"Get All Pages","openapi":"GET /pages/all","href":"/api-reference/endpoint/pages/getAllPages"},{"title":"Get Page","openapi":"GET /pages/{id}","href":"/api-reference/endpoint/pages/getPage"},{"title":"Create New Page","openapi":"POST /pages","href":"/api-reference/endpoint/pages/createNewPage"},{"title":"Update Pages","openapi":"PUT /pages/{id}","href":"/api-reference/endpoint/pages/updatePage"},{"title":"Clone Page","openapi":"POST /pages/{id}/clone","href":"/api-reference/endpoint/pages/createClonePage"},{"title":"Delete Pages","openapi":"DELETE /pages/{id}","href":"/api-reference/endpoint/pages/deletePage"}]},{"group":"Templates","icon":"mailbox","pages":[{"title":"Get Templates","openapi":"GET /templates","href":"/api-reference/endpoint/templates/getTemplates"},{"title":"Get All Templates","openapi":"GET /templates/all","href":"/api-reference/endpoint/templates/getAllTemplates"},{"title":"Get Templates","openapi":"GET /templates/{id}","href":"/api-reference/endpoint/templates/getTemplate"},{"title":"Get Templates","openapi":"GET /templates/{id}/html","href":"/api-reference/endpoint/templates/getHtmlFromTemplate"},{"title":"Create Template","openapi":"POST /templates","href":"/api-reference/endpoint/templates/createTemplate"},{"title":"Update Templates","openapi":"PUT /templates/{id}","href":"/api-reference/endpoint/templates/updateTemplate"},{"title":"Clone Template","openapi":"POST /templates/{id}/clone","href":"/api-reference/endpoint/templates/createCloneTemplate"},{"title":"Update Templates","openapi":"DELETE /templates/{id}","href":"/api-reference/endpoint/templates/deleteTemplate"}]},{"group":"Attachments","icon":"paperclip","pages":[{"title":"Get attachments","openapi":"GET /attachments","href":"/api-reference/endpoint/attachments/getAttachments"},{"title":"Get Attachment","openapi":"GET /templates/download/{id}","href":"/api-reference/endpoint/attachments/getAttachment"},{"title":"Create Attachment","openapi":"POST /attachments","href":"/api-reference/endpoint/attachments/createAttachment"},{"title":"DELETE Attachments","openapi":"DELETE /attachments/{id}","href":"/api-reference/endpoint/attachments/deleteAttachment"}]},{"group":"Campaigns","icon":"compass","pages":[{"title":"Get Campaigns","openapi":"GET /campaigns","href":"/api-reference/endpoint/campaigns/getCampaigns"},{"title":"Create Campaigns","openapi":"POST /campaigns","href":"/api-reference/endpoint/campaigns/createCampaign"},{"title":"Get Campaigns Details","openapi":"GET /campaigns/{id}","href":"/api-reference/endpoint/campaigns/getCampaignsDetails"},{"title":"Get Campaigns Timeline Events","openapi":"GET /campaigns/timeline/{id}","href":"/api-reference/endpoint/campaigns/getCampaignsTimelineEvents"},{"title":"Get Campaigns Event Targets","openapi":"GET /campaigns/events/{id}/{event}","href":"/api-reference/endpoint/campaigns/getCampaignsEventTargets"},{"title":"Send Test Email","openapi":"POST /campaigns/sendTestEmail/{id}","href":"/api-reference/endpoint/campaigns/createSendTestEmail"},{"title":"Schedule Campaign","openapi":"POST /campaigns/schedule/{id}","href":"/api-reference/endpoint/campaigns/createScheduleCampaign"},{"title":"Launch Campaign","openapi":"POST /campaigns/launch/{id}","href":"/api-reference/endpoint/campaigns/createLaunchCampaign"},{"title":"Pause Campaign","openapi":"POST /campaigns/pause/{id}","href":"/api-reference/endpoint/campaigns/createPauseCampaign"},{"title":"Resume Campaign","openapi":"POST /campaigns/resume/{id}","href":"/api-reference/endpoint/campaigns/createResumeCampaign"},{"title":"Complete Campaign","openapi":"POST /campaigns/complete/{id}","href":"/api-reference/endpoint/campaigns/createCompleteCampaign"},{"title":"Get Campaign Targets","openapi":"GET /campaigns/targets/{id}","href":"/api-reference/endpoint/campaigns/getCampaignTargets"},{"title":"calculate Campaign Targets","openapi":"GET /campaigns/calculateTargets/{id}","href":"/api-reference/endpoint/campaigns/getCalculateCampaignTargets"},{"title":"Generate Campaign Excel Report","openapi":"GET /campaigns/targets/{id}","href":"/api-reference/endpoint/campaigns/getGenerateCampaignExcelReport"},{"title":"Sync Campaign With Cloud","openapi":"GET /campaigns/syncCampaignWithCloud/{id}","href":"/api-reference/endpoint/campaigns/getSyncCampaignWithCloud"},{"title":"DELETE Campaigns","openapi":"DELETE /campaigns/{id}","href":"/api-reference/endpoint/campaigns/deleteCampaign"}]}]}]}]},"basePath":"","title":"Authentication - Phishy","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":[],"chunks":[]}
