Organisation API key. Scoped operations carry x-triggr-scope; the scopes themselves are described in x-triggr-scopes.
Path Parameters
clientId
string
required
Response
OK
createdAt
string<date-time>
required
environment
enum<string>
required
Available options:
cloudOnly,
onPremOnly,
cloudAndOnPremSeparate,
cloudAndOnPremSynced
googleWorkspaceDomains
string[]
required
id
string
required
integrationMappingIds
object
required
The client's id in each client-mapped integration (PSA company, RMM site, …), keyed by that integration's mapping key — e.g. haloId, connectwiseId, autotaskId, dattoSiteId. Only keys that are set appear; several ids are joined by commas (no spaces). {} when unmapped.
Show child attributes
microsoftDomain
string
required
microsoftTenantId
string
required
name
string
required
⌘I
curl
curl -X GET "https://api.triggr-app.com/api/v1/clients/<clientId>" \ -H "Authorization: Bearer $TRIGGR_API_KEY"
const res = await fetch("https://api.triggr-app.com/api/v1/clients/<clientId>", {
method: "GET",
headers: {
"Authorization": `Bearer ${process.env.TRIGGR_API_KEY}`,
},
});
if (!res.ok) throw new Error(`Triggr ${res.status}: ${await res.text()}`);
const data = await res.json();
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Triggr University","description":"Set up and run Triggr Core and Triggr Studio, and connect the tools your workflows use.","colors":{"primary":"#4A7FC7","light":"#6A9FE0","dark":"#3A6CB5"},"logo":{"light":"https://mintcdn.com/triggr/dXDzJtUmPBaHtkPV/logo/msp-process-light.png?fit=max\u0026auto=format\u0026n=dXDzJtUmPBaHtkPV\u0026q=85\u0026s=17a36d837b83a230254e3e7f6b1553fd","dark":"https://mintcdn.com/triggr/dXDzJtUmPBaHtkPV/logo/msp-process-dark.png?fit=max\u0026auto=format\u0026n=dXDzJtUmPBaHtkPV\u0026q=85\u0026s=4d9cef71289332e83394ec9c6357ac63"},"favicon":"https://mintcdn.com/triggr/MwzXHG3UWzFixdSz/favicon.svg?fit=max\u0026auto=format\u0026n=MwzXHG3UWzFixdSz\u0026q=85\u0026s=c356f429061b4109f2c5aeb090381353","appearance":{"default":"dark"},"background":{"color":{"light":"#FFFFFF","dark":"#0F0F17"}},"fonts":{"heading":{"family":"Geist","weight":500},"body":{"family":"Geist","weight":400}},"contextual":{"options":["copy","view","chatgpt","claude","mcp","add-mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"triggr","hasAudioNarration":false,"actualSubdomain":"triggr","customDomains":["kb.mspprocess.com"],"gitSource":{"type":"github","owner":"phishr-ai","repo":"triggr-university","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6af76c587b1d5fddacc840cf","clientVersion":"0.0.4138","searchFilterCounts":[{"language":"default","tag":"Triggr","count":233},{"language":"default","tag":"MSP Process","count":148},{"language":"default","tag":"Integrations","count":104},{"language":"default","tag":"API reference","count":50},{"language":"default","tag":"Triggr Core","count":50},{"language":"default","tag":"Endpoints","count":49},{"language":"default","tag":"Triggr Studio","count":34},{"language":"default","tag":"Workflows","count":33},{"language":"default","tag":"Settings","count":33},{"language":"default","tag":"AI Service Desk","count":26}]},"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":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","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}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":"#page-title,#content h2,#content h3,#content h4{font-weight:500}html:root{background:#EEEEF2!important}html.dark:root{background:#08080E!important}"}],"page":{"pagePath":"api-reference/organisation/get-a-client","slug":"/api-reference/organisation/get-a-client","pageMetadata":{"title":"Get a client","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/clients/{clientId}","href":"/api-reference/organisation/get-a-client","autogeneratedByOpenApi":true},"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":"Get a client","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/clients/{clientId}","href":"/api-reference/organisation/get-a-client","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"parameters":["ba896b86-df5a-4b67-a3db-4d99a7f33f03"],"responses":{"200":"2f31921b-0a02-4d5f-a73b-c1d0788ef280","401":"9d962011-68b8-4483-8fa2-fbd29a29f53e","404":"c23b6a9e-f68e-4767-9cc1-89240e44c5b3"},"security":["955cdb5f-3a97-4911-841c-7dce45b2a2b0"],"summary":"Get a client","tags":["Organisation"],"x-codeSamples":[{"label":"curl","lang":"curl","source":"curl -X GET \"https://api.triggr-app.com/api/v1/clients/\u003cclientId>\" \\\n -H \"Authorization: Bearer $TRIGGR_API_KEY\""},{"label":"Node","lang":"node","source":"const res = await fetch(\"https://api.triggr-app.com/api/v1/clients/\u003cclientId>\", {\n method: \"GET\",\n headers: {\n \"Authorization\": `Bearer ${process.env.TRIGGR_API_KEY}`,\n },\n});\nif (!res.ok) throw new Error(`Triggr ${res.status}: ${await res.text()}`);\nconst data = await res.json();"},{"label":"PowerShell","lang":"powershell","source":"$headers = @{\n Authorization = \"Bearer $env:TRIGGR_API_KEY\"\n}\nInvoke-RestMethod -Method Get -Uri 'https://api.triggr-app.com/api/v1/clients/\u003cclientId>' -Headers $headers"}],"method":"get","type":"path","servers":["5fb80506-6137-47ca-8953-7a4f237b6e26"],"path":"/api/v1/clients/{clientId}","baseUrlOptions":["https://api.triggr-app.com"],"title":"Get a client","description":"","codeSamples":[{"label":"curl","lang":"curl","source":"curl -X GET \"https://api.triggr-app.com/api/v1/clients/\u003cclientId>\" \\\n -H \"Authorization: Bearer $TRIGGR_API_KEY\""},{"label":"Node","lang":"node","source":"const res = await fetch(\"https://api.triggr-app.com/api/v1/clients/\u003cclientId>\", {\n method: \"GET\",\n headers: {\n \"Authorization\": `Bearer ${process.env.TRIGGR_API_KEY}`,\n },\n});\nif (!res.ok) throw new Error(`Triggr ${res.status}: ${await res.text()}`);\nconst data = await res.json();"},{"label":"PowerShell","lang":"powershell","source":"$headers = @{\n Authorization = \"Bearer $env:TRIGGR_API_KEY\"\n}\nInvoke-RestMethod -Method Get -Uri 'https://api.triggr-app.com/api/v1/clients/\u003cclientId>' -Headers $headers"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"ba896b86-df5a-4b67-a3db-4d99a7f33f03":{"in":"path","name":"clientId","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"2f31921b-0a02-4d5f-a73b-c1d0788ef280":{"content":{"application/json":{"example":{"createdAt":"2026-03-01T09:00:00Z","environment":"cloudOnly","googleWorkspaceDomains":[],"id":"c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f","integrationMappingIds":{"haloId":"42"},"microsoftDomain":"acme.com","microsoftTenantId":"72f988bf-86f1-41af-91ab-2d7cd011db47","name":"Acme Ltd"},"schema":{"properties":{"createdAt":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"environment":{"enum":["cloudOnly","onPremOnly","cloudAndOnPremSeparate","cloudAndOnPremSynced"],"type":"string","isRequired":true,"uniqueKey":"environment","typeLabel":"enum\u003cstring>"},"googleWorkspaceDomains":{"items":{"type":"string","uniqueKey":"googleWorkspaceDomains.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"googleWorkspaceDomains","typeLabel":"string[]"},"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"integrationMappingIds":{"additionalProperties":{"type":"string","uniqueKey":"integrationMappingIds.additionalProperties","typeLabel":"string"},"description":"The client's id in each client-mapped integration (PSA company, RMM site, …), keyed by that integration's mapping key — e.g. `haloId`, `connectwiseId`, `autotaskId`, `dattoSiteId`. Only keys that are set appear; several ids are joined by commas (no spaces). `{}` when unmapped.","type":"object","isRequired":true,"uniqueKey":"integrationMappingIds","typeLabel":"object"},"microsoftDomain":{"type":"string","isRequired":true,"uniqueKey":"microsoftDomain","typeLabel":"string"},"microsoftTenantId":{"type":"string","isRequired":true,"uniqueKey":"microsoftTenantId","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"}},"required":["id","name","environment","microsoftTenantId","microsoftDomain","googleWorkspaceDomains","integrationMappingIds","createdAt"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"createdAt":"2026-03-01T09:00:00Z","environment":"cloudOnly","googleWorkspaceDomains":[],"id":"c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f","integrationMappingIds":{"haloId":"42"},"microsoftDomain":"acme.com","microsoftTenantId":"72f988bf-86f1-41af-91ab-2d7cd011db47","name":"Acme Ltd"}}},"exampleType":"examples"}},"description":"OK","exampleType":"examples"},"9d962011-68b8-4483-8fa2-fbd29a29f53e":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Missing, invalid, revoked, or expired API key","exampleType":"generated"},"c23b6a9e-f68e-4767-9cc1-89240e44c5b3":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Not found (or belongs to another organisation)","exampleType":"generated"}},"security":{"955cdb5f-3a97-4911-841c-7dce45b2a2b0":{"ApiKeyAuth":{"bearerFormat":"tpk_…","description":"Organisation API key. Scoped operations carry x-triggr-scope; the scopes themselves are described in x-triggr-scopes.","scheme":"bearer","type":"http","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"5fb80506-6137-47ca-8953-7a4f237b6e26":{"url":"https://api.triggr-app.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"tpk_…","description":"Organisation API key. Scoped operations carry x-triggr-scope; the scopes themselves are described in x-triggr-scopes.","scheme":"bearer","type":"http","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Organisation API key. Scoped operations carry x-triggr-scope; the scopes themselves are described in x-triggr-scopes.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"triggr","siteName":"Triggr University","title":"Get a client - Triggr University","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T12:36:52.099Z","originalFileLocation":"api-reference/organisation/get-a-client.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=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Triggr University\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/triggr/CuZTa4V6vBELhOxx/_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/triggr/CuZTa4V6vBELhOxx/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/triggr/CuZTa4V6vBELhOxx/_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/triggr/CuZTa4V6vBELhOxx/_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/triggr/CuZTa4V6vBELhOxx/_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/triggr/CuZTa4V6vBELhOxx/_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/triggr/CuZTa4V6vBELhOxx/_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/triggr/CuZTa4V6vBELhOxx/_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/triggr/CuZTa4V6vBELhOxx/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a client - Triggr University\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Triggr University\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://kb.mspprocess.com/api-reference/organisation/get-a-client\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://triggr.mintlify.site/_mintlify/api/og/v2?division=Organisation\u0026amp;title=Get+a+client\u0026amp;theme=e7a72cf8d9edb61355a1be42\u0026amp;signature=8f28a2996d691927c94f9b1d5c291168429721d3d328a8b6bcd8107b2ab3b3e1\">\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 a client - Triggr University\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://triggr.mintlify.site/_mintlify/api/og/v2?division=Organisation\u0026amp;title=Get+a+client\u0026amp;theme=e7a72cf8d9edb61355a1be42\u0026amp;signature=8f28a2996d691927c94f9b1d5c291168429721d3d328a8b6bcd8107b2ab3b3e1\">\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/triggr/CuZTa4V6vBELhOxx/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Triggr University\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4A7FC7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://kb.mspprocess.com/api-reference/organisation/get-a-client\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/organisation/get-a-client.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://kb.mspprocess.com/#organization\",\"name\":\"Triggr University\",\"url\":\"https://kb.mspprocess.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/triggr/dXDzJtUmPBaHtkPV/logo/msp-process-light.png?fit=max\u0026auto=format\u0026n=dXDzJtUmPBaHtkPV\u0026q=85\u0026s=17a36d837b83a230254e3e7f6b1553fd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://kb.mspprocess.com#website\",\"name\":\"Triggr University\",\"url\":\"https://kb.mspprocess.com\",\"publisher\":{\"@id\":\"https://kb.mspprocess.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://kb.mspprocess.com/api-reference/organisation/get-a-client#webpage\",\"url\":\"https://kb.mspprocess.com/api-reference/organisation/get-a-client\",\"name\":\"Get a client\",\"dateModified\":\"2026-11-03T12:36:52.099Z\",\"isPartOf\":{\"@id\":\"https://kb.mspprocess.com#website\"},\"breadcrumb\":{\"@id\":\"https://kb.mspprocess.com/api-reference/organisation/get-a-client#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://kb.mspprocess.com/api-reference/organisation/get-a-client#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://kb.mspprocess.com/api-reference/approvals-\u0026-manual-steps/list-approvals\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Organisation\",\"item\":\"https://kb.mspprocess.com/api-reference/organisation/the-organisations-public-branding\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a client\",\"item\":\"https://kb.mspprocess.com/api-reference/organisation/get-a-client\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://kb.mspprocess.com/api-reference/organisation/get-a-client#apireference\",\"headline\":\"Get a client\",\"name\":\"Get a client\",\"url\":\"https://kb.mspprocess.com/api-reference/organisation/get-a-client\",\"mainEntityOfPage\":{\"@id\":\"https://kb.mspprocess.com/api-reference/organisation/get-a-client#webpage\"},\"dateModified\":\"2026-11-03T12:36:52.099Z\",\"publisher\":{\"@id\":\"https://kb.mspprocess.com/#organization\"},\"isPartOf\":{\"@id\":\"https://kb.mspprocess.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Triggr University\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Triggr University\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/organisation/get-a-client.md","siteName":"Triggr University","nav":{"global":null,"tabs":[{"tab":"MSP Process","pages":[{"title":"MSP Process","href":"/msp-process/overview"}]},{"tab":"Triggr","menu":[{"item":"Triggr Core","pages":[{"title":"Triggr Core","href":"/core/introduction"}]},{"item":"Triggr Studio","pages":[{"title":"Triggr Studio","href":"/studio/introduction"}]},{"item":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"item":"API reference","groups":[{"group":"Get started","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"Approvals \u0026 manual steps","pages":[{"title":"List approvals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/approvals","href":"/api-reference/approvals-\u0026-manual-steps/list-approvals"},{"title":"Get an approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/approvals/{approvalId}","href":"/api-reference/approvals-\u0026-manual-steps/get-an-approval"},{"title":"Approve","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/approvals/{approvalId}/approve","href":"/api-reference/approvals-\u0026-manual-steps/approve"},{"title":"Reject","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/approvals/{approvalId}/reject","href":"/api-reference/approvals-\u0026-manual-steps/reject"},{"title":"List manual steps","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/manual-steps","href":"/api-reference/approvals-\u0026-manual-steps/list-manual-steps"},{"title":"Get a manual step","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/manual-steps/{manualStepId}","href":"/api-reference/approvals-\u0026-manual-steps/get-a-manual-step"},{"title":"Complete a manual step","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/manual-steps/{manualStepId}/complete","href":"/api-reference/approvals-\u0026-manual-steps/complete-a-manual-step"}]},{"group":"Organisation","pages":[{"title":"The organisation's public branding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/branding","href":"/api-reference/organisation/the-organisations-public-branding"},{"title":"List clients","description":"Every client (tenant) with the identifiers you map your own records onto.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/clients","href":"/api-reference/organisation/list-clients"},{"title":"Get a client","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/clients/{clientId}","href":"/api-reference/organisation/get-a-client"},{"title":"The organisation this key belongs to","description":"Also returns the organisation's canonical embed origins — the exact value to store as your embed host and compare against `new URL(embedUrl).origin` (see Embedding).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/me","href":"/api-reference/organisation/the-organisation-this-key-belongs-to"}]},{"group":"Core forms","pages":[{"title":"The Core form catalogue","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/catalogue","href":"/api-reference/core-forms/the-core-form-catalogue"},{"title":"List configured Core forms with status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/forms","href":"/api-reference/core-forms/list-configured-core-forms-with-status"},{"title":"Get a Core form's status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/forms/{slug}","href":"/api-reference/core-forms/get-a-core-forms-status"},{"title":"Start an embedded session for a Core form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/core/forms/{slug}/sessions","href":"/api-reference/core-forms/start-an-embedded-session-for-a-core-form"},{"title":"List Core requests with live status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/requests","href":"/api-reference/core-forms/list-core-requests-with-live-status"},{"title":"Get a Core request with its answers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/requests/{requestId}","href":"/api-reference/core-forms/get-a-core-request-with-its-answers"}]},{"group":"Core run","pages":[{"title":"Check UPN availability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/core/forms/{slug}/check-upns","href":"/api-reference/core-run/check-upn-availability"},{"title":"Resolve a dynamic field's options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/core/forms/{slug}/fields/{fieldId}/options","href":"/api-reference/core-run/resolve-a-dynamic-fields-options"},{"title":"Submit a Core form as a technician","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/core/forms/{slug}/run","href":"/api-reference/core-run/submit-a-core-form-as-a-technician"},{"title":"The run form for a client","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/forms/{slug}/run-form","href":"/api-reference/core-run/the-run-form-for-a-client"}]},{"group":"Core configuration","pages":[{"title":"Read a Core form's base config and a client's override","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/forms/{slug}/config","href":"/api-reference/core-configuration/read-a-core-forms-base-config-and-a-clients-override"},{"title":"Write the base config (merge)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/core/forms/{slug}/config","href":"/api-reference/core-configuration/write-the-base-config-merge"},{"title":"Write a client's override (merge)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/core/forms/{slug}/config/clients/{clientId}","href":"/api-reference/core-configuration/write-a-clients-override-merge"},{"title":"Remove a client's override","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/core/forms/{slug}/config/clients/{clientId}","href":"/api-reference/core-configuration/remove-a-clients-override"},{"title":"Preview the merged run form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/forms/{slug}/preview","href":"/api-reference/core-configuration/preview-the-merged-run-form"},{"title":"Microsoft 365 picker data for a client","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/options/microsoft","href":"/api-reference/core-configuration/microsoft-365-picker-data-for-a-client"},{"title":"A synced client's on-prem AD groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/options/onprem-groups","href":"/api-reference/core-configuration/a-synced-clients-on-prem-ad-groups"},{"title":"A synced client's on-prem AD OUs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/options/onprem-ous","href":"/api-reference/core-configuration/a-synced-clients-on-prem-ad-ous"},{"title":"Option sets from the organisation's PSA","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/options/psa","href":"/api-reference/core-configuration/option-sets-from-the-organisations-psa"},{"title":"The Core config schema","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/core/schema","href":"/api-reference/core-configuration/the-core-config-schema"}]},{"group":"Workflows \u0026 executions","pages":[{"title":"List executions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/executions","href":"/api-reference/workflows-\u0026-executions/list-executions"},{"title":"Get an execution's status and outcome","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/executions/{executionId}","href":"/api-reference/workflows-\u0026-executions/get-an-executions-status-and-outcome"},{"title":"Cancel a running execution","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/executions/{executionId}/cancel","href":"/api-reference/workflows-\u0026-executions/cancel-a-running-execution"},{"title":"Retry an execution","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/executions/{executionId}/retry","href":"/api-reference/workflows-\u0026-executions/retry-an-execution"},{"title":"List an execution's steps","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/executions/{executionId}/steps","href":"/api-reference/workflows-\u0026-executions/list-an-executions-steps"},{"title":"List active Studio workflows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/workflows","href":"/api-reference/workflows-\u0026-executions/list-active-studio-workflows"}]},{"group":"Studio forms","pages":[{"title":"List Studio forms","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/forms","href":"/api-reference/studio-forms/list-studio-forms"},{"title":"Get a Studio form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/forms/{formId}","href":"/api-reference/studio-forms/get-a-studio-form"},{"title":"Start an embedded form session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/forms/{formId}/sessions","href":"/api-reference/studio-forms/start-an-embedded-form-session"}]},{"group":"Meta","pages":[{"title":"This document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/openapi.json","href":"/api-reference/meta/this-document"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Register a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/webhooks","href":"/api-reference/webhooks/register-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/webhooks/{webhookId}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"List a webhook's recent deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/webhooks/{webhookId}/deliveries","href":"/api-reference/webhooks/list-a-webhooks-recent-deliveries"},{"title":"Re-send a past delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver","href":"/api-reference/webhooks/re-send-a-past-delivery"},{"title":"Re-enable a disabled webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/webhooks/{webhookId}/enable","href":"/api-reference/webhooks/re-enable-a-disabled-webhook"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/webhooks/{webhookId}/rotate-secret","href":"/api-reference/webhooks/rotate-the-signing-secret"},{"title":"Send a test (ping) event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/webhooks/{webhookId}/test","href":"/api-reference/webhooks/send-a-test-ping-event"}]}]}]}]}]},"basePath":"","title":"Get a client - Triggr University","buildId":"dpl_715YoAgvjTGBDdo8RtXmHKM22b5p","deploymentId":"dpl_715YoAgvjTGBDdo8RtXmHKM22b5p","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-BvKnMd7F.js","utils-BMt52org.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CGXZuDGO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dl57XWH2.js","snippetPresets-CWd8CxSk.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-Chgj7sZe.js","ApiExamples-BR-Wkc_D.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-YMmi08aZ.js","shallow-DBC1OB78.js","getApiPlaygroundDisplay-Be7mmEzP.js","CodeSnippet-B14o1TgQ.js","CodeSnippets-CJ2q3fTq.js","getPastedJson-DnpLXm8x.js","icon-BpkSFtdK.js","MethodPill-BO3zPf-g.js","DuplicateIcon-Bib3qwfw.js","createIcon-CY2noFo3.js","DynamicMarkdown-TAXIW2vN.js","SectionHeading-Dfs3Fmfw.js","axios-vUo_bRtp.js","Markdown-CGAo_eqA.js","clsx-BNa-H6W6.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-r2tNEC1n.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-B7oWe6jc.js"]}