import com.apollodeploy.signal.SignalClient;
SignalClient signal = new SignalClient("ap_signal_...");
var result = signal.projects().getProject(/* params */);
System.out.println(result);
import com.apollodeploy.signal.SignalClient
val signal = SignalClient("ap_signal_...")
val result = signal.projects.getProject(/* params */)
println(result)
require "apollo_signal"
signal = ApolloSignal::Client.new(api_key: "ap_signal_...")
result = signal.projects.getProject(# params)
puts result
use ApolloSignal\SignalClient;
$signal = new SignalClient("ap_signal_...");
$result = $signal->projects->getProject(/* params */);
var_dump($result);
use apollo_signal::SignalClient;
let signal = SignalClient::new("ap_signal_...");
let result = signal.projects.getProject(/* params */).await?;
println!("{:?}", result);
using ApolloSignal;
var signal = new SignalClient("ap_signal_...");
var result = await signal.Projects.GetProjectAsync(/* params */);
Console.WriteLine(result);
import com.apollodeploy.signal.SignalClient;
SignalClient signal = new SignalClient("ap_signal_...");
var result = signal.projects().getProject(/* params */);
System.out.println(result);
import com.apollodeploy.signal.SignalClient
val signal = SignalClient("ap_signal_...")
val result = signal.projects.getProject(/* params */)
println(result)
require "apollo_signal"
signal = ApolloSignal::Client.new(api_key: "ap_signal_...")
result = signal.projects.getProject(# params)
puts result
use ApolloSignal\SignalClient;
$signal = new SignalClient("ap_signal_...");
$result = $signal->projects->getProject(/* params */);
var_dump($result);
use apollo_signal::SignalClient;
let signal = SignalClient::new("ap_signal_...");
let result = signal.projects.getProject(/* params */).await?;
println!("{:?}", result);
using ApolloSignal;
var signal = new SignalClient("ap_signal_...");
var result = await signal.Projects.GetProjectAsync(/* params */);
Console.WriteLine(result);
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Apollo Deploy","description":"Documentation for Apollo Deploy and Apollo Signal — release intelligence and transactional email for developers.","colors":{"primary":"#171717","light":"#e8e4d9","dark":"#171717"},"logo":{"light":"https://mintcdn.com/apollodeploy/2tkCO7PoXSgjQkrC/logo/light.svg?fit=max\u0026auto=format\u0026n=2tkCO7PoXSgjQkrC\u0026q=85\u0026s=e4fc18ba64dc074898dfde7f40c3ad00","dark":"https://mintcdn.com/apollodeploy/2tkCO7PoXSgjQkrC/logo/dark.svg?fit=max\u0026auto=format\u0026n=2tkCO7PoXSgjQkrC\u0026q=85\u0026s=35bcfcc36dd51b5bd5e0893e68d06319","href":"https://apollodeploy.com"},"favicon":{"light":"https://mintcdn.com/apollodeploy/2tkCO7PoXSgjQkrC/favicons/signal/favicon.png?fit=max\u0026auto=format\u0026n=2tkCO7PoXSgjQkrC\u0026q=85\u0026s=1d5463e7d5e2ca968b35adc601d13a07","dark":"https://mintcdn.com/apollodeploy/2tkCO7PoXSgjQkrC/favicons/signal/favicon-dark.png?fit=max\u0026auto=format\u0026n=2tkCO7PoXSgjQkrC\u0026q=85\u0026s=2156d9f0f5a581d144fe2a23ff1f29a1"},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#ffffff","dark":"#000000"}},"navbar":{"primary":{"type":"button","label":"Get started","href":"https://auth.apollodeploy.com/register"}},"fonts":{"family":"Geist"},"styling":{"eyebrows":"section","codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"interaction":{"drilldown":false},"navigation":{"global":{"anchors":[{"anchor":"Marketing site","icon":"house","href":"https://apollodeploy.com"},{"anchor":"Support","icon":"life-ring","href":"mailto:support@apollodeploy.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"apollodeploy","hasAudioNarration":false,"actualSubdomain":"apollodeploy","customDomains":["docs.apollodeploy.com"],"gitSource":{"type":"github","owner":"apollo-deploy","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"collectionId":"12f1d3a2-e8df-400b-a958-533197edc232","liveDeploymentHistoryId":"6a94885103b74ae883b1c027","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a94885103b74ae883b1c027"},"feedback":{"thumbs":true,"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a94885103b74ae883b1c027","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Apollo Signal","count":179},{"language":"default","tag":"API Reference","count":86},{"language":"default","tag":"Documentation","count":58},{"language":"default","tag":"Knowledge base","count":35},{"language":"default","tag":"Getting started","count":26},{"language":"default","tag":"Send with","count":20},{"language":"default","tag":"Contacts","count":18},{"language":"default","tag":"Emails","count":15},{"language":"default","tag":"Webhooks","count":14},{"language":"default","tag":"Domains and DNS","count":10}]},"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":"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},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/projects/get-project","slug":"/api-reference/projects/get-project","pageMetadata":{"title":"Get project","description":"Retrieves a single project by its ID.\n\n### Requirements\n\n- **Permission:** `projects:read`.\n- **Project access:** the path project must match the API key's project.\n- **HTTP rate limit:** 60 requests per 60 seconds per API key.","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}","href":"/api-reference/projects/get-project","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 h3: \"h3\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieves a single project by its ID.\"\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Requirements\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Permission:\"\n }), \" \", _jsx(_components.code, {\n children: \"projects:read\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Project access:\"\n }), \" the path project must match the API key’s project.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"HTTP rate limit:\"\n }), \" 60 requests per 60 seconds per API key.\"]\n }), \"\\n\"]\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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Get project","description":"Retrieves a single project by its ID.\n\n### Requirements\n\n- **Permission:** `projects:read`.\n- **Project access:** the path project must match the API key's project.\n- **HTTP rate limit:** 60 requests per 60 seconds per API key.","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}","href":"/api-reference/projects/get-project","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/apollodeploy/16ba9f8ee6643672/favicon-runtime.js"],"openApiReferenceData":{"operation":{"tags":["Projects"],"summary":"Get project","description":"Retrieves a single project by its ID.\n\n### Requirements\n\n- **Permission:** `projects:read`.\n- **Project access:** the path project must match the API key's project.\n- **HTTP rate limit:** 60 requests per 60 seconds per API key.","parameters":["a1de9524-b645-4154-a62f-c09ae01c868a"],"responses":{"200":"1b161842-1529-49fd-b5e4-82b9f6b606d5","401":"e9c27a4e-37d3-44ff-96fb-35f8eb264733","403":"71f9a76a-5102-49f9-ae8a-cbfd78bd0e1e","404":"1052dbfa-8eb0-4b3b-8c22-8a6ec7715a48","429":"1b162d43-c9ca-41b1-a5dd-7d77b69cc6c7"},"deprecated":false,"x-codeSamples":[{"lang":"TypeScript","label":"TypeScript","source":"import { createApolloSignalApiClient } from \"@apollo-deploy/signal-sdk\";\n\nconst signal = createApolloSignalApiClient({ apiKey: \"ap_signal_...\" });\n\nconst result = await signal.projects.getProject(/* params */);\n\nconsole.log(result);"},{"lang":"Python","label":"Python","source":"from apollo_signal import SignalClient\n\nsignal = SignalClient(api_key=\"ap_signal_...\")\n\nresult = signal.projects.getProject(# params)\n\nprint(result)"},{"lang":"Go","label":"Go","source":"import signal \"github.com/apollo-deploy/signal-sdk-go\"\n\nclient := signal.NewClient(\"ap_signal_...\")\n\nresult, err := client.Projects.GetProject(context.Background() /* params */)\nif err != nil {\n log.Fatal(err)\n}\nfmt.Println(result)"},{"lang":"Java","label":"Java","source":"import com.apollodeploy.signal.SignalClient;\n\nSignalClient signal = new SignalClient(\"ap_signal_...\");\n\nvar result = signal.projects().getProject(/* params */);\nSystem.out.println(result);"},{"lang":"Kotlin","label":"Kotlin","source":"import com.apollodeploy.signal.SignalClient\n\nval signal = SignalClient(\"ap_signal_...\")\n\nval result = signal.projects.getProject(/* params */)\nprintln(result)"},{"lang":"Ruby","label":"Ruby","source":"require \"apollo_signal\"\n\nsignal = ApolloSignal::Client.new(api_key: \"ap_signal_...\")\n\nresult = signal.projects.getProject(# params)\nputs result"},{"lang":"PHP","label":"PHP","source":"use ApolloSignal\\SignalClient;\n\n$signal = new SignalClient(\"ap_signal_...\");\n\n$result = $signal->projects->getProject(/* params */);\nvar_dump($result);"},{"lang":"Rust","label":"Rust","source":"use apollo_signal::SignalClient;\n\nlet signal = SignalClient::new(\"ap_signal_...\");\n\nlet result = signal.projects.getProject(/* params */).await?;\nprintln!(\"{:?}\", result);"},{"lang":"C#","label":".NET","source":"using ApolloSignal;\n\nvar signal = new SignalClient(\"ap_signal_...\");\n\nvar result = await signal.Projects.GetProjectAsync(/* params */);\nConsole.WriteLine(result);"}],"operationId":"getProject","security":["70350111-cda0-46fa-90c6-94f3c7bcec10"],"x-required-permissions":["projects:read"],"x-rate-limit":{"requests":60,"seconds":60,"policy":"projects"},"method":"get","type":"path","servers":["f6001a60-13af-4ce2-b1d4-02de70ac9cc2"],"path":"/v1/projects/{projectId}","baseUrlOptions":["https://api.signal.apollodeploy.com"],"title":"Get project","codeSamples":[{"label":"TypeScript","lang":"TypeScript","source":"import { createApolloSignalApiClient } from \"@apollo-deploy/signal-sdk\";\n\nconst signal = createApolloSignalApiClient({ apiKey: \"ap_signal_...\" });\n\nconst result = await signal.projects.getProject(/* params */);\n\nconsole.log(result);"},{"label":"Python","lang":"Python","source":"from apollo_signal import SignalClient\n\nsignal = SignalClient(api_key=\"ap_signal_...\")\n\nresult = signal.projects.getProject(# params)\n\nprint(result)"},{"label":"Go","lang":"Go","source":"import signal \"github.com/apollo-deploy/signal-sdk-go\"\n\nclient := signal.NewClient(\"ap_signal_...\")\n\nresult, err := client.Projects.GetProject(context.Background() /* params */)\nif err != nil {\n log.Fatal(err)\n}\nfmt.Println(result)"},{"label":"Java","lang":"Java","source":"import com.apollodeploy.signal.SignalClient;\n\nSignalClient signal = new SignalClient(\"ap_signal_...\");\n\nvar result = signal.projects().getProject(/* params */);\nSystem.out.println(result);"},{"label":"Kotlin","lang":"Kotlin","source":"import com.apollodeploy.signal.SignalClient\n\nval signal = SignalClient(\"ap_signal_...\")\n\nval result = signal.projects.getProject(/* params */)\nprintln(result)"},{"label":"Ruby","lang":"Ruby","source":"require \"apollo_signal\"\n\nsignal = ApolloSignal::Client.new(api_key: \"ap_signal_...\")\n\nresult = signal.projects.getProject(# params)\nputs result"},{"label":"PHP","lang":"PHP","source":"use ApolloSignal\\SignalClient;\n\n$signal = new SignalClient(\"ap_signal_...\");\n\n$result = $signal->projects->getProject(/* params */);\nvar_dump($result);"},{"label":"Rust","lang":"Rust","source":"use apollo_signal::SignalClient;\n\nlet signal = SignalClient::new(\"ap_signal_...\");\n\nlet result = signal.projects.getProject(/* params */).await?;\nprintln!(\"{:?}\", result);"},{"label":".NET","lang":"C#","source":"using ApolloSignal;\n\nvar signal = new SignalClient(\"ap_signal_...\");\n\nvar result = await signal.Projects.GetProjectAsync(/* params */);\nConsole.WriteLine(result);"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"a1de9524-b645-4154-a62f-c09ae01c868a":{"name":"projectId","in":"path","description":"The unique identifier of the project.","required":true,"deprecated":false,"explode":false,"schema":{"type":"string","title":"String","isRequired":true,"description":"The unique identifier of the project.","uniqueKey":"","typeLabel":"string"}}},"responses":{"1b161842-1529-49fd-b5e4-82b9f6b606d5":{"description":"Project found.","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"createdAt":{"type":"string","title":"String","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"id":{"type":"string","title":"String","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"limits":{"type":"object","properties":{"dailySends":{"type":"integer","format":"int32","title":"Int","description":"Maximum non-test sends admitted per day.","isRequired":true,"uniqueKey":"limits.dailySends","typeLabel":"integer\u003cint32>"},"maxApiKeys":{"type":"integer","format":"int32","title":"Int","description":"Maximum API keys available to the project.","isRequired":true,"uniqueKey":"limits.maxApiKeys","typeLabel":"integer\u003cint32>"},"maxDomains":{"type":"integer","format":"int32","title":"Int","description":"Maximum sending domains registered to the project.","isRequired":true,"uniqueKey":"limits.maxDomains","typeLabel":"integer\u003cint32>"},"maxRecipientsPerMessage":{"type":"integer","format":"int32","title":"Int","description":"Maximum distinct `to`, `cc`, and `bcc` recipients per message.","isRequired":true,"uniqueKey":"limits.maxRecipientsPerMessage","typeLabel":"integer\u003cint32>"},"maxWebhooks":{"type":"integer","format":"int32","title":"Int","description":"Maximum webhook endpoints available to the project.","isRequired":true,"uniqueKey":"limits.maxWebhooks","typeLabel":"integer\u003cint32>"},"perSecondSends":{"type":"integer","format":"int32","title":"Int","description":"Maximum sends admitted per second.","isRequired":true,"uniqueKey":"limits.perSecondSends","typeLabel":"integer\u003cint32>"}},"required":["dailySends","maxApiKeys","maxDomains","maxRecipientsPerMessage","maxWebhooks","perSecondSends"],"title":"ProjectLimitsModel","description":"Operational limits applied to the project. Supply every field when replacing limits.","isRequired":true,"uniqueKey":"limits","typeLabel":"ProjectLimitsModel · object"},"name":{"type":"string","title":"String","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"region":{"type":"string","title":"String","isRequired":true,"uniqueKey":"region","typeLabel":"string"},"slug":{"type":"string","title":"String","isRequired":true,"uniqueKey":"slug","typeLabel":"string"},"status":{"type":"string","title":"String","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"trackingSettings":{"type":"object","properties":{"clickTracking":{"type":"boolean","title":"Boolean","description":"Enable tracked-link rewriting by default.","isRequired":true,"uniqueKey":"trackingSettings.clickTracking","typeLabel":"boolean"},"openTracking":{"type":"boolean","title":"Boolean","description":"Enable open-pixel tracking by default.","isRequired":true,"uniqueKey":"trackingSettings.openTracking","typeLabel":"boolean"},"readEngagement":{"type":"boolean","title":"Boolean","description":"Enable read-engagement tracking by default.","isRequired":true,"uniqueKey":"trackingSettings.readEngagement","typeLabel":"boolean"},"unsubscribeTracking":{"type":"boolean","title":"Boolean","description":"Enable unsubscribe-link handling by default.","isRequired":true,"uniqueKey":"trackingSettings.unsubscribeTracking","typeLabel":"boolean"},"scrollDepth":{"type":"boolean","title":"Boolean","description":"Enable scroll-depth tracking by default. Defaults to `false`.","default":false,"uniqueKey":"trackingSettings.scrollDepth","typeLabel":"boolean"}},"required":["openTracking","clickTracking","unsubscribeTracking","readEngagement"],"title":"ProjectTrackingSettingsModel","description":"Project defaults for email tracking. Supply every field except `scrollDepth` when replacing settings.","isRequired":true,"uniqueKey":"trackingSettings","typeLabel":"ProjectTrackingSettingsModel · object"},"updatedAt":{"type":"string","title":"String","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"suspensionReason":{"type":"string","title":"String","uniqueKey":"suspensionReason","typeLabel":"string"}},"required":["createdAt","id","limits","name","region","slug","status","trackingSettings","updatedAt"],"title":"ProjectResponse","uniqueKey":"","typeLabel":"ProjectResponse · object"},"examples":{"Example":{"title":"Example","value":{"createdAt":"\u003cstring>","id":"\u003cstring>","limits":{"dailySends":123,"maxApiKeys":123,"maxDomains":123,"maxRecipientsPerMessage":123,"maxWebhooks":123,"perSecondSends":123},"name":"\u003cstring>","region":"\u003cstring>","slug":"\u003cstring>","status":"\u003cstring>","trackingSettings":{"clickTracking":true,"openTracking":true,"readEngagement":true,"unsubscribeTracking":true,"scrollDepth":false},"updatedAt":"\u003cstring>","suspensionReason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e9c27a4e-37d3-44ff-96fb-35f8eb264733":{"description":"Missing or invalid credentials.","headers":{},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"code":{"type":"string","title":"ErrorCode","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","format":"int32","title":"Int","isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"title":{"type":"string","title":"String","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","title":"ProblemType","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"type":"string","title":"String","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","title":"String","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"pointer":{"type":"string","title":"String","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"}},"required":["detail","pointer"],"title":"FieldProblem","uniqueKey":"errors.items.[INDEX]","typeLabel":"FieldProblem · object"},"title":"List\u003cFieldProblem>","uniqueKey":"errors","typeLabel":"FieldProblem · object[]"},"instance":{"type":"string","title":"ProblemInstance","uniqueKey":"instance","typeLabel":"string"},"requestId":{"type":"string","title":"String","uniqueKey":"requestId","typeLabel":"string"}},"required":["code","status","title","type"],"title":"ApiProblem","uniqueKey":"","typeLabel":"ApiProblem · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","status":123,"title":"\u003cstring>","type":"\u003cstring>","detail":"\u003cstring>","errors":[{"detail":"\u003cstring>","pointer":"\u003cstring>"}],"instance":"\u003cstring>","requestId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"71f9a76a-5102-49f9-ae8a-cbfd78bd0e1e":{"description":"The credential lacks the required permission or cannot access this project.","headers":{},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"code":{"type":"string","title":"ErrorCode","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","format":"int32","title":"Int","isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"title":{"type":"string","title":"String","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","title":"ProblemType","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"type":"string","title":"String","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","title":"String","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"pointer":{"type":"string","title":"String","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"}},"required":["detail","pointer"],"title":"FieldProblem","uniqueKey":"errors.items.[INDEX]","typeLabel":"FieldProblem · object"},"title":"List\u003cFieldProblem>","uniqueKey":"errors","typeLabel":"FieldProblem · object[]"},"instance":{"type":"string","title":"ProblemInstance","uniqueKey":"instance","typeLabel":"string"},"requestId":{"type":"string","title":"String","uniqueKey":"requestId","typeLabel":"string"}},"required":["code","status","title","type"],"title":"ApiProblem","uniqueKey":"","typeLabel":"ApiProblem · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","status":123,"title":"\u003cstring>","type":"\u003cstring>","detail":"\u003cstring>","errors":[{"detail":"\u003cstring>","pointer":"\u003cstring>"}],"instance":"\u003cstring>","requestId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1052dbfa-8eb0-4b3b-8c22-8a6ec7715a48":{"description":"Project not found.","headers":{},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"code":{"type":"string","title":"ErrorCode","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","format":"int32","title":"Int","isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"title":{"type":"string","title":"String","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","title":"ProblemType","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"type":"string","title":"String","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","title":"String","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"pointer":{"type":"string","title":"String","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"}},"required":["detail","pointer"],"title":"FieldProblem","uniqueKey":"errors.items.[INDEX]","typeLabel":"FieldProblem · object"},"title":"List\u003cFieldProblem>","uniqueKey":"errors","typeLabel":"FieldProblem · object[]"},"instance":{"type":"string","title":"ProblemInstance","uniqueKey":"instance","typeLabel":"string"},"requestId":{"type":"string","title":"String","uniqueKey":"requestId","typeLabel":"string"}},"required":["code","status","title","type"],"title":"ApiProblem","uniqueKey":"","typeLabel":"ApiProblem · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","status":123,"title":"\u003cstring>","type":"\u003cstring>","detail":"\u003cstring>","errors":[{"detail":"\u003cstring>","pointer":"\u003cstring>"}],"instance":"\u003cstring>","requestId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1b162d43-c9ca-41b1-a5dd-7d77b69cc6c7":{"description":"The endpoint rate limit was exceeded. Wait for the `Retry-After` interval before retrying.","headers":{"Retry-After":{"description":"Whole seconds to wait before retrying.","schema":{"type":"integer","minimum":1}}},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"code":{"type":"string","title":"ErrorCode","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","format":"int32","title":"Int","isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"title":{"type":"string","title":"String","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"type":"string","title":"ProblemType","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"type":"string","title":"String","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","title":"String","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"pointer":{"type":"string","title":"String","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"}},"required":["detail","pointer"],"title":"FieldProblem","uniqueKey":"errors.items.[INDEX]","typeLabel":"FieldProblem · object"},"title":"List\u003cFieldProblem>","uniqueKey":"errors","typeLabel":"FieldProblem · object[]"},"instance":{"type":"string","title":"ProblemInstance","uniqueKey":"instance","typeLabel":"string"},"requestId":{"type":"string","title":"String","uniqueKey":"requestId","typeLabel":"string"}},"required":["code","status","title","type"],"title":"ApiProblem","uniqueKey":"","typeLabel":"ApiProblem · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","status":123,"title":"\u003cstring>","type":"\u003cstring>","detail":"\u003cstring>","errors":[{"detail":"\u003cstring>","pointer":"\u003cstring>"}],"instance":"\u003cstring>","requestId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"70350111-cda0-46fa-90c6-94f3c7bcec10":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Project-bound Apollo Signal API key. Keys begin with `ap_signal_` and must carry the permission shown on the operation.","scopes":[]}}},"servers":{"f6001a60-13af-4ce2-b1d4-02de70ac9cc2":{"url":"https://api.signal.apollodeploy.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Project-bound Apollo Signal API key. Keys begin with `ap_signal_` and must carry the permission shown on the operation.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Project-bound Apollo Signal API key. Keys begin with `ap_signal_` and must carry the permission shown on the operation.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"signal/api-reference/openapi.json"},"subdomain":"apollodeploy","siteName":"Apollo Deploy","title":"Get project - Apollo Deploy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-26T09:04:51.234Z","originalFileLocation":"api-reference/projects/get-project.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=\"Retrieves a single project by its ID. ### Requirements - Permission: projects:read. - Project access: the path project must match the API key\u0026#x27;s project. - HTTP rate limit: 60 requests per 60 seconds per API key.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Apollo Deploy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/apollodeploy/q4MGu_nnSpzYfDXv/_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/apollodeploy/q4MGu_nnSpzYfDXv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/apollodeploy/q4MGu_nnSpzYfDXv/_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/apollodeploy/q4MGu_nnSpzYfDXv/_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/apollodeploy/q4MGu_nnSpzYfDXv/_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/apollodeploy/q4MGu_nnSpzYfDXv/_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/apollodeploy/q4MGu_nnSpzYfDXv/_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/apollodeploy/q4MGu_nnSpzYfDXv/_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/apollodeploy/q4MGu_nnSpzYfDXv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get project - Apollo Deploy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves a single project by its ID. ### Requirements - Permission: projects:read. - Project access: the path project must match the API key\u0026#x27;s project. - HTTP rate limit: 60 requests per 60 seconds per API key.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Apollo Deploy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.apollodeploy.com/api-reference/projects/get-project\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://apollodeploy.mintlify.app/_mintlify/api/og/v2?division=Projects+and+email+logs\u0026amp;title=Get+project\u0026amp;description=Retrieves+a+single+project+by+its+ID.%0A%0A%23%23%23+Requirements%0A%0A-+**Permission%3A**+%60projects%3Aread%60.%0A-+**Project+access%3A**+the+path+project+must+match+the+API+key%27s+proj\u0026amp;theme=3e94fd2a68a715f99c52a168\u0026amp;signature=2c91b1c66a8a6c69c484a9838f846635a2cb90ed3d1573f5a3355a6bd4cc9785\">\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=\"Get project - Apollo Deploy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves a single project by its ID. ### Requirements - Permission: projects:read. - Project access: the path project must match the API key\u0026#x27;s project. - HTTP rate limit: 60 requests per 60 seconds per API key.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://apollodeploy.mintlify.app/_mintlify/api/og/v2?division=Projects+and+email+logs\u0026amp;title=Get+project\u0026amp;description=Retrieves+a+single+project+by+its+ID.%0A%0A%23%23%23+Requirements%0A%0A-+**Permission%3A**+%60projects%3Aread%60.%0A-+**Project+access%3A**+the+path+project+must+match+the+API+key%27s+proj\u0026amp;theme=3e94fd2a68a715f99c52a168\u0026amp;signature=2c91b1c66a8a6c69c484a9838f846635a2cb90ed3d1573f5a3355a6bd4cc9785\">\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/apollodeploy/q4MGu_nnSpzYfDXv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Apollo Deploy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#171717\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.apollodeploy.com/api-reference/projects/get-project\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/projects/get-project.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.apollodeploy.com/#organization\",\"name\":\"Apollo Deploy\",\"url\":\"https://docs.apollodeploy.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/apollodeploy/2tkCO7PoXSgjQkrC/logo/light.svg?fit=max\u0026auto=format\u0026n=2tkCO7PoXSgjQkrC\u0026q=85\u0026s=e4fc18ba64dc074898dfde7f40c3ad00\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.apollodeploy.com#website\",\"name\":\"Apollo Deploy\",\"url\":\"https://docs.apollodeploy.com\",\"publisher\":{\"@id\":\"https://docs.apollodeploy.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.apollodeploy.com/api-reference/projects/get-project#webpage\",\"url\":\"https://docs.apollodeploy.com/api-reference/projects/get-project\",\"name\":\"Get project\",\"description\":\"Retrieves a single project by its ID. ### Requirements - Permission: projects:read. - Project access: the path project must match the API key's project. - HTTP rate limit: 60 requests per 60 seconds per API key.\",\"dateModified\":\"2026-08-26T09:04:51.234Z\",\"isPartOf\":{\"@id\":\"https://docs.apollodeploy.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.apollodeploy.com/api-reference/projects/get-project#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.apollodeploy.com/api-reference/projects/get-project#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Projects and email logs\",\"item\":\"https://docs.apollodeploy.com/api-reference/projects/list-projects\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get project\",\"item\":\"https://docs.apollodeploy.com/api-reference/projects/get-project\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.apollodeploy.com/api-reference/projects/get-project#apireference\",\"headline\":\"Get project\",\"name\":\"Get project\",\"description\":\"Retrieves a single project by its ID. ### Requirements - Permission: projects:read. - Project access: the path project must match the API key's project. - HTTP rate limit: 60 requests per 60 seconds per API key.\",\"url\":\"https://docs.apollodeploy.com/api-reference/projects/get-project\",\"mainEntityOfPage\":{\"@id\":\"https://docs.apollodeploy.com/api-reference/projects/get-project#webpage\"},\"dateModified\":\"2026-08-26T09:04:51.234Z\",\"publisher\":{\"@id\":\"https://docs.apollodeploy.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.apollodeploy.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Apollo Deploy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Apollo Deploy","nav":{"global":{"anchors":[{"anchor":"Marketing site","icon":"house","href":"https://apollodeploy.com"},{"anchor":"Support","icon":"life-ring","href":"mailto:support@apollodeploy.com"}]},"products":[{"product":"Apollo Deploy","icon":"rocket","description":"Release intelligence control plane","pages":[{"title":"Apollo Deploy","href":"/deploy"}]},{"product":"Packages","icon":"box","description":"Reusable utilities and components","pages":[{"title":"Packages","href":"/packages/time"}]},{"product":"Apollo Signal","icon":"https://mintlify.s3.us-west-1.amazonaws.com/apollodeploy/logo/signal/icon.svg","description":"Transactional email for developers","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/signal"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/signal/api-reference/introduction"},{"title":"Authentication","href":"/signal/api-reference/authentication"},{"title":"Errors","href":"/signal/api-reference/errors"},{"title":"Pagination","href":"/signal/api-reference/pagination"},{"title":"Idempotency","href":"/signal/api-reference/idempotency"},{"title":"Email event streams","href":"/signal/api-reference/event-streams"},{"title":"Rate limits and sending quotas","href":"/signal/api-reference/rate-limit"}]},{"group":"Emails","pages":[{"title":"Send email","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/emails","href":"/api-reference/emails/send-email"},{"title":"Get email","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/emails/{emailId}","href":"/api-reference/emails/get-email"},{"title":"Batch send emails","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/emails/batch","href":"/api-reference/emails/batch-send-emails"},{"title":"Cancel email","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json delete /v1/emails/{emailId}","href":"/api-reference/emails/cancel-email"},{"title":"Bulk cancel scheduled emails","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json delete /v1/emails","href":"/api-reference/emails/bulk-cancel-scheduled-emails"},{"title":"Issue stream token","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/emails/{projectId}/stream/token","href":"/api-reference/emails/issue-stream-token"},{"title":"Stream email events","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/emails/stream","href":"/api-reference/emails/stream-email-events"},{"title":"Validate links in HTML","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/emails/validate","href":"/api-reference/emails/validate-links-in-html"}]},{"group":"Metrics","pages":[{"title":"Get topic engagement analytics","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/metrics/topics/{id}","href":"/api-reference/metrics/get-topic-engagement-analytics"},{"title":"Get email performance","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/metrics/emails/{id}","href":"/api-reference/metrics/get-email-performance"},{"title":"Get email read engagement","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/metrics/emails/{id}/engagement","href":"/api-reference/metrics/get-email-read-engagement"},{"title":"Get project metrics summary","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/metrics/summary","href":"/api-reference/metrics/get-project-metrics-summary"},{"title":"Get project metrics timeline","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/metrics/timeline","href":"/api-reference/metrics/get-project-metrics-timeline"},{"title":"Get deliverability advisor","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/metrics/advisor","href":"/api-reference/metrics/get-deliverability-advisor"}]},{"group":"Projects and email logs","pages":[{"title":"List projects","description":"Returns a paginated list of all projects in the authenticated organisation.\n\n### Requirements\n\n- **Permission:** `projects:read`.\n- **HTTP rate limit:** 60 requests per 60 seconds per API key.","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects","href":"/api-reference/projects/list-projects"},{"title":"Get project","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}","href":"/api-reference/projects/get-project"},{"title":"Update project","description":"Updates the name or configuration of an existing project. Omitted fields are left unchanged.\n\n### Requirements\n\n- **Permission:** `projects:write`.\n- **Project access:** the path project must match the API key's project.\n- **HTTP rate limit:** 60 requests per 60 seconds per API key.","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json patch /v1/projects/{projectId}","href":"/api-reference/projects/update-project"},{"title":"List emails","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/emails","href":"/api-reference/projects/list-emails"},{"title":"Get email","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/emails/{emailId}","href":"/api-reference/projects/get-email"},{"title":"Get email timeline","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/emails/{emailId}/events","href":"/api-reference/projects/get-email-timeline"}]},{"group":"Sending domains","pages":[{"title":"List domains","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/domains","href":"/api-reference/sending-domains/list-domains"},{"title":"Get domain","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/domains/{domainId}","href":"/api-reference/sending-domains/get-domain"},{"title":"Create domain","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/domains","href":"/api-reference/sending-domains/create-domain"},{"title":"Verify domain","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/domains/{domainId}/verify","href":"/api-reference/sending-domains/verify-domain"},{"title":"Delete domain","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json delete /v1/projects/{projectId}/domains/{domainId}","href":"/api-reference/sending-domains/delete-domain"},{"title":"Verify BIMI","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/domains/{domainId}/bimi/verify","href":"/api-reference/sending-domains/verify-bimi"},{"title":"Update BIMI","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json patch /v1/projects/{projectId}/domains/{domainId}/bimi","href":"/api-reference/sending-domains/update-bimi"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Get contact","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/contacts/{contactId}","href":"/api-reference/contacts/get-contact"},{"title":"List contact segments","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/contacts/{contactId}/segments","href":"/api-reference/contacts/list-contact-segments"},{"title":"Get contact topics","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/contacts/{contactId}/topics","href":"/api-reference/contacts/get-contact-topics"},{"title":"Create contact","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/contacts","href":"/api-reference/contacts/create-contact"},{"title":"Update contact","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json patch /v1/projects/{projectId}/contacts/{contactId}","href":"/api-reference/contacts/update-contact"},{"title":"Delete contact","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json delete /v1/projects/{projectId}/contacts/{contactId}","href":"/api-reference/contacts/delete-contact"},{"title":"Upload contact profile image","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/contacts/{contactId}/image","href":"/api-reference/contacts/upload-contact-profile-image"},{"title":"Set contact profile image URL","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json put /v1/projects/{projectId}/contacts/{contactId}/image","href":"/api-reference/contacts/set-contact-profile-image-url"},{"title":"Delete contact profile image","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json delete /v1/projects/{projectId}/contacts/{contactId}/image","href":"/api-reference/contacts/delete-contact-profile-image"},{"title":"Add contact to segment","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/contacts/{contactId}/segments","href":"/api-reference/contacts/add-contact-to-segment"},{"title":"Remove contact from segment","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json delete /v1/projects/{projectId}/contacts/{contactId}/segments/{segmentId}","href":"/api-reference/contacts/remove-contact-from-segment"},{"title":"Update contact topics","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json patch /v1/projects/{projectId}/contacts/{contactId}/topics","href":"/api-reference/contacts/update-contact-topics"},{"title":"Get contact activity","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/contacts/{contactId}/activity","href":"/api-reference/contacts/get-contact-activity"},{"title":"Get contact engagement score","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/contacts/{contactId}/engagement","href":"/api-reference/contacts/get-contact-engagement-score"},{"title":"Get contact email validation status","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/contacts/{contactId}/email-validation","href":"/api-reference/contacts/get-contact-email-validation-status"},{"title":"Refresh contact engagement score","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/contacts/{contactId}/engagement/refresh","href":"/api-reference/contacts/refresh-contact-engagement-score"},{"title":"Record email validation result","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/contacts/{contactId}/email-validation","href":"/api-reference/contacts/record-email-validation-result"}]},{"group":"Contact properties","pages":[{"title":"List contact properties","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/contact-properties","href":"/api-reference/contact-properties/list-contact-properties"},{"title":"Get contact property","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/contact-properties/{propertyId}","href":"/api-reference/contact-properties/get-contact-property"},{"title":"Create contact property","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/contact-properties","href":"/api-reference/contact-properties/create-contact-property"},{"title":"Update contact property","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json patch /v1/projects/{projectId}/contact-properties/{propertyId}","href":"/api-reference/contact-properties/update-contact-property"},{"title":"Delete contact property","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json delete /v1/projects/{projectId}/contact-properties/{propertyId}","href":"/api-reference/contact-properties/delete-contact-property"}]},{"group":"Segments","pages":[{"title":"List segments","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/segments","href":"/api-reference/segments/list-segments"},{"title":"Get segment","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/segments/{segmentId}","href":"/api-reference/segments/get-segment"},{"title":"List contacts in segment","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/segments/{segmentId}/contacts","href":"/api-reference/segments/list-contacts-in-segment"},{"title":"Create segment","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/segments","href":"/api-reference/segments/create-segment"},{"title":"Delete segment","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json delete /v1/projects/{projectId}/segments/{segmentId}","href":"/api-reference/segments/delete-segment"}]},{"group":"Topics","pages":[{"title":"List topics","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/topics","href":"/api-reference/topics/list-topics"},{"title":"Get topic","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/topics/{topicId}","href":"/api-reference/topics/get-topic"},{"title":"List opt-in contacts","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/topics/{topicId}/contacts","href":"/api-reference/topics/list-opt-in-contacts"},{"title":"Create topic","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/topics","href":"/api-reference/topics/create-topic"},{"title":"Update topic","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json patch /v1/projects/{projectId}/topics/{topicId}","href":"/api-reference/topics/update-topic"},{"title":"Delete topic","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json delete /v1/projects/{projectId}/topics/{topicId}","href":"/api-reference/topics/delete-topic"}]},{"group":"Suppressions","pages":[{"title":"List suppressions","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/suppressions","href":"/api-reference/suppressions/list-suppressions"},{"title":"Export suppressions","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/suppressions/export","href":"/api-reference/suppressions/export-suppressions"},{"title":"Add suppression","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/suppressions","href":"/api-reference/suppressions/add-suppression"},{"title":"Remove suppression","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json delete /v1/projects/{projectId}/suppressions/{email}","href":"/api-reference/suppressions/remove-suppression"},{"title":"Import suppressions","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/suppressions/import","href":"/api-reference/suppressions/import-suppressions"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Get webhook","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/webhooks/{endpointId}","href":"/api-reference/webhooks/get-webhook"},{"title":"List webhook deliveries","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/webhooks/{endpointId}/deliveries","href":"/api-reference/webhooks/list-webhook-deliveries"},{"title":"Get webhook delivery","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/webhooks/{endpointId}/deliveries/{deliveryId}","href":"/api-reference/webhooks/get-webhook-delivery"},{"title":"Create webhook","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Update webhook","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json patch /v1/projects/{projectId}/webhooks/{endpointId}","href":"/api-reference/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json delete /v1/projects/{projectId}/webhooks/{endpointId}","href":"/api-reference/webhooks/delete-webhook"},{"title":"Test webhook","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/webhooks/{endpointId}/test","href":"/api-reference/webhooks/test-webhook"},{"title":"Replay webhook delivery","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json post /v1/projects/{projectId}/webhooks/{endpointId}/replay/{deliveryId}","href":"/api-reference/webhooks/replay-webhook-delivery"}]},{"group":"API key usage","pages":[{"title":"List API keys","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/api-keys","href":"/api-reference/api-key-usage/list-api-keys"},{"title":"Get API key","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/api-keys/{keyId}","href":"/api-reference/api-key-usage/get-api-key"},{"title":"Get API key usage","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/api-keys/{keyId}/usage","href":"/api-reference/api-key-usage/get-api-key-usage"},{"title":"Export API key usage","deprecated":false,"version":null,"openapi":"/signal/api-reference/openapi.json get /v1/projects/{projectId}/api-keys/{keyId}/usage/export","href":"/api-reference/api-key-usage/export-api-key-usage"}]}]},{"tab":"Knowledge base","pages":[{"title":"Knowledge base","href":"/signal/knowledge-base/introduction"}]}]}]},"basePath":"","title":"Get project - Apollo Deploy","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Bevw23-4.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}