Refreshes a FILTER smart group from its saved rules or a SYNCED group from the integration data already stored in Windmill. It does not fetch new data from the connected provider. Returns archived:false with current group details. If the linked source is archived or inactive, the group is archived and the response contains archived:true and group:null. MANUAL and SCIM groups return 400. Requires permission to read and edit the group. A missing linked integration group returns 404.
Use an API key or OAuth access token. Enter only the token in the authorization dialog; requests send it as Authorization: Bearer <TOKEN>.
Create an API key in your workspace's Settings → API keys. Keys start with wm_api_ and only work in the workspace where they were created. Read-only keys can read data; creating, updating, or deleting data requires a read-write key.
Authorization: Bearer wm_api_example
OAuth access tokens are issued for connected Windmill applications.
Authorization: Bearer <OAUTH_ACCESS_TOKEN>
Both token types use the authenticated user's workspace permissions. Each endpoint's permission requirements and the sharing settings of the requested items still apply.
Path Parameters
companyId
string
required
Company ID. A URL slug is also accepted. The caller must have access to this company.
Required string length: 1 - 128
Example:
"company-acme"
groupId
string
required
Opaque employee group identifier in this company.
Example:
"group-engineering"
Response
Refreshed or archived group.
Group refresh response
Group refresh response
Refreshed group details, or archived:true and group:null when its linked source is unavailable.
archived
enum<boolean>
required
True when sync archived the group instead of returning refreshed details.
Available options:
false
Example:
false
group
Group · object
required
Refreshed group details, or null when the linked source caused the group to be archived.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Windmill Help Site","colors":{"primary":"#4084FB","light":"#7aadff","dark":"#1758c1"},"logo":{"light":"https://mintcdn.com/windmill/438SkEPmWnjrcDyT/logo/light.svg?fit=max\u0026auto=format\u0026n=438SkEPmWnjrcDyT\u0026q=85\u0026s=911e75d2985851400d148f9e5e20c94f","dark":"https://mintcdn.com/windmill/438SkEPmWnjrcDyT/logo/dark.svg?fit=max\u0026auto=format\u0026n=438SkEPmWnjrcDyT\u0026q=85\u0026s=3942c2e1a12a8a71050cdb71a6613cf0"},"favicon":"https://mintcdn.com/windmill/438SkEPmWnjrcDyT/favicon.svg?fit=max\u0026auto=format\u0026n=438SkEPmWnjrcDyT\u0026q=85\u0026s=d0f6bb9380e55bd874dafc8c7a0bf0cc","navbar":{"links":[{"href":"mailto:support@gowindmill.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.gowindmill.com"}},"footer":{"socials":{"x":"https://x.com/trywindmill","linkedin":"https://www.linkedin.com/company/gowindmill"}},"seo":{"metatags":{"og:site_name":"Windmill Help Center"}},"contextual":{"options":["copy","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"windmill","hasAudioNarration":false,"actualSubdomain":"windmill","customDomains":["help.gowindmill.com"],"gitSource":{"type":"github","owner":"windmill-dev","repo":"windmill-help","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aff06a676e1397cafb01751","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Platform","count":143},{"language":"default","tag":"Review Cycles","count":50},{"language":"default","tag":"API reference","count":48},{"language":"default","tag":"Integrations","count":44},{"language":"default","tag":"Endpoints","count":39},{"language":"default","tag":"Productivity","count":30},{"language":"default","tag":"Pulse surveys","count":28},{"language":"default","tag":"Features","count":17},{"language":"default","tag":"Getting started","count":16},{"language":"default","tag":"Groups","count":16}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"loom-embed.css","content":"[data-loom]{position:relative;aspect-ratio:16 / 9;background:#000;border-radius:0.75rem;overflow:hidden;margin-bottom:1rem}[data-loom]>a{position:absolute;inset:0;display:block}[data-loom] img{width:100%;height:100%;margin:0;border-radius:0;object-fit:contain;object-position:center}[data-loom]::before{content:attr(data-title);position:absolute;inset:0;z-index:1;pointer-events:none;padding:1rem 1.25rem;color:#fff;font-weight:600;font-size:1.25rem;line-height:1.25;text-shadow:0 1px 4px rgba(0, 0, 0, 0.4);background:linear-gradient(\n to bottom,\n rgba(0, 0, 0, 0.75) 0%,\n rgba(0, 0, 0, 0.28) 45%,\n rgba(0, 0, 0, 0.28) 100%\n );transition:opacity 0.5s}[data-loom][data-duration]::after{content:attr(data-duration);position:absolute;bottom:0.75rem;right:0.75rem;z-index:1;pointer-events:none;border-radius:0.375rem;background:rgba(0, 0, 0, 0.7);padding:0.125rem 0.5rem;font-size:0.75rem;font-weight:500;font-variant-numeric:tabular-nums;color:#fff;transition:opacity 0.5s}[data-loom]>a::after{content:\"\";position:absolute;inset:0;z-index:1;margin:auto;width:clamp(72px, 15%, 124px);aspect-ratio:1;border-radius:100%;box-shadow:0 1px 6px rgba(0, 0, 0, 0.25);background:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 90 90' fill='none'%3E%3Cpath fill='%23ffffff' opacity='0.3' d='M45 90C69.8529 90 90 69.8527 90 44.9999C90 20.1471 69.8529 0 45 0C20.1472 0 0 20.1471 0 44.9999C0 69.8527 20.1472 90 45 90Z'/%3E%3Cpath fill='%23ffffff' d='M45 85C67.0914 85 85 67.0913 85 44.9999C85 22.9086 67.0914 5 45 5C22.9086 5 5 22.9086 5 44.9999C5 67.0913 22.9086 85 45 85Z'/%3E%3Cpath fill='%23000000' opacity='0.8' d='M35 33.268V56.732C35 58.5212 37.0582 59.6083 38.6432 58.6344L57.8999 46.9025C59.3667 46.0192 59.3667 43.9808 57.8999 43.0749L38.6432 31.3656C37.0582 30.3917 35 31.4788 35 33.268Z'/%3E%3C/svg%3E\")\n center / contain no-repeat;transition:transform 0.2s, opacity 0.5s}[data-loom]:hover>a::after,[data-loom]:focus-within>a::after{transform:scale(1.1)}[data-loom]>iframe{position:absolute;inset:0;width:100%;height:100%;z-index:2;border:0;opacity:0;pointer-events:none;transition:opacity 0.5s}[data-loom][data-playing]>iframe{opacity:1;pointer-events:auto}[data-loom][data-playing]::before,[data-loom][data-playing]::after,[data-loom][data-playing]>a::after{opacity:0}[data-loom]>button{position:absolute;inset:0;width:100%;height:100%;z-index:3;cursor:pointer;background:transparent;border:0;padding:0}"}]}
{"page":{"pagePath":"api-reference/groups/refresh-an-employee-group","slug":"/api-reference/groups/refresh-an-employee-group","pageMetadata":{"title":"Refresh an employee group","description":"Refreshes a FILTER smart group from its saved rules or a SYNCED group from the integration data already stored in Windmill. It does not fetch new data from the connected provider. Returns archived:false with current group details. If the linked source is archived or inactive, the group is archived and the response contains archived:true and group:null. MANUAL and SCIM groups return 400. Requires permission to read and edit the group. A missing linked integration group returns 404.","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/{groupId}/sync","href":"/api-reference/groups/refresh-an-employee-group","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Refreshes a FILTER smart group from its saved rules or a SYNCED group from the integration data already stored in Windmill. It does not fetch new data from the connected provider. Returns archived:false with current group details. If the linked source is archived or inactive, the group is archived and the response contains archived:true and group:null. MANUAL and SCIM groups return 400. Requires permission to read and edit the group. A missing linked integration group returns 404.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Refresh an employee group","description":"Refreshes a FILTER smart group from its saved rules or a SYNCED group from the integration data already stored in Windmill. It does not fetch new data from the connected provider. Returns archived:false with current group details. If the linked source is archived or inactive, the group is archived and the response contains archived:true and group:null. MANUAL and SCIM groups return 400. Requires permission to read and edit the group. A missing linked integration group returns 404.","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/{groupId}/sync","href":"/api-reference/groups/refresh-an-employee-group","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"groups.sync","summary":"Refresh an employee group","description":"Refreshes a FILTER smart group from its saved rules or a SYNCED group from the integration data already stored in Windmill. It does not fetch new data from the connected provider. Returns archived:false with current group details. If the linked source is archived or inactive, the group is archived and the response contains archived:true and group:null. MANUAL and SCIM groups return 400. Requires permission to read and edit the group. A missing linked integration group returns 404.","tags":["Groups"],"security":["f2a167fc-5608-46a2-a0ab-1851d598ec8c"],"parameters":["077b1f77-5b3e-4bbb-a3c3-63c002a30c53","effca009-63e6-4fab-80d8-8860087c5f7c"],"responses":{"200":"3f2e4804-48ae-4a75-80f0-2db7372185a9","400":"628d1c62-6a29-4690-b1c7-6fae132a766f","401":"55ca88b2-7c7a-4932-9368-e9e8dff47240","403":"f6cda30e-1dc5-490f-b9b4-2d6b972a1c73","404":"e54c039b-e9dc-4f70-9e85-197151fea566","429":"7055b3e2-350b-42e9-9048-34bf5e5d54e4"},"method":"post","type":"path","servers":["bc3cc9da-1158-4cfa-97b3-e455483a1d98"],"path":"/c/{companyId}/groups/{groupId}/sync","baseUrlOptions":["https://api.gowindmill.com/api/v2"],"title":"Refresh an employee group","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"077b1f77-5b3e-4bbb-a3c3-63c002a30c53":{"schema":{"type":"string","minLength":1,"maxLength":128,"description":"Company ID. A URL slug is also accepted. The caller must have access to this company.","title":"Company ID","example":"company-acme","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"Company ID. A URL slug is also accepted. The caller must have access to this company.","name":"companyId","in":"path"},"effca009-63e6-4fab-80d8-8860087c5f7c":{"schema":{"type":"string","description":"Opaque employee group identifier in this company.","title":"Employee group ID","example":"group-engineering","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"Opaque employee group identifier in this company.","name":"groupId","in":"path"}},"responses":{"3f2e4804-48ae-4a75-80f0-2db7372185a9":{"description":"Refreshed or archived group.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Group refresh response","description":"Refreshed group details, or archived:true and group:null when its linked source is unavailable.","required":["archived","group"],"example":{"archived":false,"group":{"id":"group-engineering","name":"Engineering","type":"MANUAL","categoryIds":["11111111-1111-4111-8111-111111111111"],"employeeCount":1,"integrationId":null,"integrationUserGroupId":null,"integrationUserGroupExternalType":null,"createdByEmployeeId":"employee-avery","createdAt":"2026-01-15T10:00:00.000Z","updatedAt":"2026-01-15T10:00:00.000Z","sharingAccess":{"companyAccess":"read","allManagersAccess":"none","employeeAccess":[{"employeeId":"employee-avery","access":"write"}],"groupAccess":[],"subtreeAccess":[]},"canWrite":true}},"properties":{"archived":{"type":"boolean","enum":[false],"description":"True when sync archived the group instead of returning refreshed details.","title":"Group archived","example":false,"isRequired":true,"uniqueKey":"oneOf.0.archived","typeLabel":"enum\u003cboolean>"},"group":{"type":"object","title":"Group","description":"Refreshed group details, or null when the linked source caused the group to be archived.","required":["id","name","type","categoryIds","employeeCount","integrationId","integrationUserGroupId","integrationUserGroupExternalType","createdByEmployeeId","createdAt","updatedAt","sharingAccess","canWrite"],"example":{"id":"group-engineering","name":"Engineering","type":"MANUAL","categoryIds":["11111111-1111-4111-8111-111111111111"],"employeeCount":1,"integrationId":null,"integrationUserGroupId":null,"integrationUserGroupExternalType":null,"createdByEmployeeId":"employee-avery","createdAt":"2026-01-15T10:00:00.000Z","updatedAt":"2026-01-15T10:00:00.000Z","sharingAccess":{"companyAccess":"read","allManagersAccess":"none","employeeAccess":[{"employeeId":"employee-avery","access":"write"}],"groupAccess":[],"subtreeAccess":[]},"canWrite":true},"properties":{"id":{"type":"string","description":"Opaque employee group identifier in this company.","title":"Employee group ID","example":"group-engineering","isRequired":true,"uniqueKey":"oneOf.0.group.id","typeLabel":"string"},"name":{"type":"string","description":"Employee group display name.","title":"Group name","example":"Engineering","isRequired":true,"uniqueKey":"oneOf.0.group.name","typeLabel":"string"},"type":{"type":"string","enum":["MANUAL","FILTER","SYNCED","SCIM"],"description":"MANUAL has an explicit roster; FILTER uses employee rules; SYNCED follows an integration group; SCIM is provisioned.","title":"Group type","example":"MANUAL","isRequired":true,"uniqueKey":"oneOf.0.group.type","typeLabel":"enum\u003cstring>"},"categoryIds":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.group.categoryIds.items.[INDEX]","typeLabel":"string"},"description":"Active category UUIDs assigned to the group. A group can belong to multiple categories.","title":"Category IDs","example":["11111111-1111-4111-8111-111111111111"],"isRequired":true,"uniqueKey":"oneOf.0.group.categoryIds","typeLabel":"string[]"},"employeeCount":{"type":"number","description":"Number of non-archived employees currently in this group, independently of workspace membership.","title":"Employee count","example":1,"isRequired":true,"uniqueKey":"oneOf.0.group.employeeCount","typeLabel":"number"},"integrationId":{"oneOf":[{"type":"string","description":"Owning integration identifier, or null for groups without an integration link.","title":"Integration ID","isRequired":true,"uniqueKey":"oneOf.0.group.integrationId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Owning integration identifier, or null for groups without an integration link.","title":"Integration ID","isRequired":true,"uniqueKey":"oneOf.0.group.integrationId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.group.integrationId","typeLabel":"string | null"},"integrationUserGroupId":{"oneOf":[{"type":"string","description":"Identifier of the linked integration group, or null when no such link exists.","title":"Integration group ID","isRequired":true,"uniqueKey":"oneOf.0.group.integrationUserGroupId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identifier of the linked integration group, or null when no such link exists.","title":"Integration group ID","isRequired":true,"uniqueKey":"oneOf.0.group.integrationUserGroupId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.group.integrationUserGroupId","typeLabel":"string | null"},"integrationUserGroupExternalType":{"oneOf":[{"type":"string","description":"Integration-defined group type, or null when unavailable.","title":"External group type","isRequired":true,"uniqueKey":"oneOf.0.group.integrationUserGroupExternalType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Integration-defined group type, or null when unavailable.","title":"External group type","isRequired":true,"uniqueKey":"oneOf.0.group.integrationUserGroupExternalType.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.group.integrationUserGroupExternalType","typeLabel":"string | null"},"createdByEmployeeId":{"oneOf":[{"type":"string","description":"Employee who created this resource, or null when no employee creator is recorded.","title":"Creator employee ID","isRequired":true,"uniqueKey":"oneOf.0.group.createdByEmployeeId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Employee who created this resource, or null when no employee creator is recorded.","title":"Creator employee ID","isRequired":true,"uniqueKey":"oneOf.0.group.createdByEmployeeId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.group.createdByEmployeeId","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp in ISO 8601 format.","title":"Created at","example":"2026-01-15T10:00:00.000Z","isRequired":true,"uniqueKey":"oneOf.0.group.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Last recorded update timestamp in ISO 8601 format.","title":"Updated at","example":"2026-01-15T10:00:00.000Z","isRequired":true,"uniqueKey":"oneOf.0.group.updatedAt","typeLabel":"string\u003cdate-time>"},"sharingAccess":{"type":"object","properties":{"companyAccess":{"type":"string","enum":["none","read","write"],"description":"Access for everyone in this company.","title":"Company access","example":"read","isRequired":true,"uniqueKey":"oneOf.0.group.sharingAccess.companyAccess","typeLabel":"enum\u003cstring>"},"allManagersAccess":{"type":"string","enum":["none","read","write"],"description":"Access for employees who manage others.","title":"All managers access","example":"read","isRequired":true,"uniqueKey":"oneOf.0.group.sharingAccess.allManagersAccess","typeLabel":"enum\u003cstring>"},"employeeAccess":{"type":"array","items":{"type":"object","properties":{"employeeId":{"type":"string","minLength":1,"description":"Employee ID in this company.","title":"Employee ID","example":"employee-avery","isRequired":true,"uniqueKey":"oneOf.0.group.sharingAccess.employeeAccess.items.[INDEX].employeeId","typeLabel":"string"},"access":{"type":"string","enum":["none","read","write"],"description":"No access, read access, or read and edit access.","title":"Access level","example":"read","isRequired":true,"uniqueKey":"oneOf.0.group.sharingAccess.employeeAccess.items.[INDEX].access","typeLabel":"enum\u003cstring>"}},"required":["employeeId","access"],"uniqueKey":"oneOf.0.group.sharingAccess.employeeAccess.items.[INDEX]","typeLabel":"object"},"description":"Access granted directly to employees.","title":"Employee access","example":[{"employeeId":"employee-avery","access":"write"}],"isRequired":true,"uniqueKey":"oneOf.0.group.sharingAccess.employeeAccess","typeLabel":"Employee access · object[]"},"groupAccess":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","minLength":1,"description":"Employee group ID in this company.","title":"Group ID","example":"group-engineering","isRequired":true,"uniqueKey":"oneOf.0.group.sharingAccess.groupAccess.items.[INDEX].groupId","typeLabel":"string"},"access":{"type":"string","enum":["none","read","write"],"description":"No access, read access, or read and edit access.","title":"Access level","example":"read","isRequired":true,"uniqueKey":"oneOf.0.group.sharingAccess.groupAccess.items.[INDEX].access","typeLabel":"enum\u003cstring>"}},"required":["groupId","access"],"uniqueKey":"oneOf.0.group.sharingAccess.groupAccess.items.[INDEX]","typeLabel":"object"},"description":"Access granted to members of employee groups.","title":"Group access","example":[],"isRequired":true,"uniqueKey":"oneOf.0.group.sharingAccess.groupAccess","typeLabel":"Group access · object[]"},"subtreeAccess":{"type":"array","items":{"type":"object","properties":{"employeeId":{"type":"string","minLength":1,"description":"Employee ID in this company.","title":"Employee ID","example":"employee-avery","isRequired":true,"uniqueKey":"oneOf.0.group.sharingAccess.subtreeAccess.items.[INDEX].employeeId","typeLabel":"string"},"access":{"type":"string","enum":["none","read","write"],"description":"No access, read access, or read and edit access.","title":"Access level","example":"read","isRequired":true,"uniqueKey":"oneOf.0.group.sharingAccess.subtreeAccess.items.[INDEX].access","typeLabel":"enum\u003cstring>"}},"required":["employeeId","access"],"uniqueKey":"oneOf.0.group.sharingAccess.subtreeAccess.items.[INDEX]","typeLabel":"object"},"description":"Access granted to employees in the specified reporting subtrees.","title":"Reporting subtree access","example":[],"isRequired":true,"uniqueKey":"oneOf.0.group.sharingAccess.subtreeAccess","typeLabel":"Reporting subtree access · object[]"}},"required":["companyAccess","allManagersAccess","employeeAccess","groupAccess","subtreeAccess"],"title":"Sharing access","description":"Who can read or edit this employee group.","isRequired":true,"uniqueKey":"oneOf.0.group.sharingAccess","typeLabel":"Sharing access · object"},"canWrite":{"type":"boolean","description":"Whether you have permission to edit this group.","title":"Can edit","example":true,"isRequired":true,"uniqueKey":"oneOf.0.group.canWrite","typeLabel":"boolean"},"rules":{"type":"object","title":"Employee rules","description":"Employee filter for a FILTER group. Group references are rejected at every depth; relative start dates must be tenure ranges.","example":{"status":"CURRENT"},"properties":{"hasDirectReports":{"oneOf":[{"type":"boolean","description":"True selects managers with a direct report; false selects employees without direct reports.","title":"Has direct reports","example":true,"uniqueKey":"oneOf.0.group.rules.hasDirectReports.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True selects managers with a direct report; false selects employees without direct reports.","title":"Has direct reports","example":true,"uniqueKey":"oneOf.0.group.rules.hasDirectReports.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.hasDirectReports","typeLabel":"boolean | null"},"hasManager":{"oneOf":[{"type":"boolean","description":"True selects employees with an assigned manager; false selects employees without a manager.","title":"Has a manager","example":true,"uniqueKey":"oneOf.0.group.rules.hasManager.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True selects employees with an assigned manager; false selects employees without a manager.","title":"Has a manager","example":true,"uniqueKey":"oneOf.0.group.rules.hasManager.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.hasManager","typeLabel":"boolean | null"},"employeeGroupId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select employees belonging to this employee group.","title":"Employee group ID","example":"group-engineering","uniqueKey":"oneOf.0.group.rules.employeeGroupId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select employees belonging to this employee group.","title":"Employee group ID","example":"group-engineering","uniqueKey":"oneOf.0.group.rules.employeeGroupId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.employeeGroupId","typeLabel":"string | null"},"employeeGroupIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.employeeGroupIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select members of any listed employee group. Up to 1000 IDs.","title":"Employee group IDs","example":["group-engineering"],"uniqueKey":"oneOf.0.group.rules.employeeGroupIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select members of any listed employee group. Up to 1000 IDs.","title":"Employee group IDs","example":["group-engineering"],"uniqueKey":"oneOf.0.group.rules.employeeGroupIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.employeeGroupIds","typeLabel":"string[] | null"},"jobTitle":{"oneOf":[{"type":"string","maxLength":256,"description":"Select employees whose job title exactly matches this value.","title":"Exact job title","example":"Engineer","uniqueKey":"oneOf.0.group.rules.jobTitle.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":256,"description":"Select employees whose job title exactly matches this value.","title":"Exact job title","example":"Engineer","uniqueKey":"oneOf.0.group.rules.jobTitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.jobTitle","typeLabel":"string | null"},"jobTitles":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":256,"uniqueKey":"oneOf.0.group.rules.jobTitles.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees whose job title exactly matches any listed value. Up to 1000 titles.","title":"Exact job titles","example":["Engineer","Designer"],"uniqueKey":"oneOf.0.group.rules.jobTitles.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","maxLength":256},"maxItems":1000,"description":"Select employees whose job title exactly matches any listed value. Up to 1000 titles.","title":"Exact job titles","example":["Engineer","Designer"],"uniqueKey":"oneOf.0.group.rules.jobTitles.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.jobTitles","typeLabel":"string[] | null"},"countries":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees whose HRIS work country matches any listed country code. Up to 1000 values.","title":"Work countries","example":["US"],"uniqueKey":"oneOf.0.group.rules.countries.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select employees whose HRIS work country matches any listed country code. Up to 1000 values.","title":"Work countries","example":["US"],"uniqueKey":"oneOf.0.group.rules.countries.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.countries","typeLabel":"string[] | null"},"emails":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":320,"format":"email","uniqueKey":"oneOf.0.group.rules.emails.oneOf.0.items.[INDEX]","typeLabel":"string\u003cemail>"},"maxItems":1000,"description":"Select employees associated with any listed email address. Up to 1000 valid addresses.","title":"Employee email addresses","example":["avery@example.test"],"uniqueKey":"oneOf.0.group.rules.emails.oneOf.0","typeLabel":"string\u003cemail>[]"},{"type":"null","items":{"type":"string","maxLength":320,"format":"email"},"maxItems":1000,"description":"Select employees associated with any listed email address. Up to 1000 valid addresses.","title":"Employee email addresses","example":["avery@example.test"],"uniqueKey":"oneOf.0.group.rules.emails.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.emails","typeLabel":"string\u003cemail>[] | null"},"emailDomains":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":254,"uniqueKey":"oneOf.0.group.rules.emailDomains.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees with an email address on any listed domain. A domain matches exactly, so subdomains are listed separately. Up to 1000 values.","title":"Employee email domains","example":["example.test"],"uniqueKey":"oneOf.0.group.rules.emailDomains.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","maxLength":254},"maxItems":1000,"description":"Select employees with an email address on any listed domain. A domain matches exactly, so subdomains are listed separately. Up to 1000 values.","title":"Employee email domains","example":["example.test"],"uniqueKey":"oneOf.0.group.rules.emailDomains.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.emailDomains","typeLabel":"string[] | null"},"employeeId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select a single employee by ID.","title":"Employee ID","example":"employee-avery","uniqueKey":"oneOf.0.group.rules.employeeId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select a single employee by ID.","title":"Employee ID","example":"employee-avery","uniqueKey":"oneOf.0.group.rules.employeeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.employeeId","typeLabel":"string | null"},"employeeIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.employeeIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees with any listed ID. Up to 1000 IDs.","title":"Employee IDs","example":["employee-avery"],"uniqueKey":"oneOf.0.group.rules.employeeIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select employees with any listed ID. Up to 1000 IDs.","title":"Employee IDs","example":["employee-avery"],"uniqueKey":"oneOf.0.group.rules.employeeIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.employeeIds","typeLabel":"string[] | null"},"excludedEmployeeId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Exclude this employee from the results.","title":"Excluded employee ID","example":"employee-excluded","uniqueKey":"oneOf.0.group.rules.excludedEmployeeId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Exclude this employee from the results.","title":"Excluded employee ID","example":"employee-excluded","uniqueKey":"oneOf.0.group.rules.excludedEmployeeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.excludedEmployeeId","typeLabel":"string | null"},"excludedEmployeeIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.excludedEmployeeIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Exclude employees with any listed ID. Use this field for exclusions in API bulk mutations. Up to 1000 IDs.","title":"Excluded employee IDs","example":["employee-excluded"],"uniqueKey":"oneOf.0.group.rules.excludedEmployeeIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Exclude employees with any listed ID. Use this field for exclusions in API bulk mutations. Up to 1000 IDs.","title":"Excluded employee IDs","example":["employee-excluded"],"uniqueKey":"oneOf.0.group.rules.excludedEmployeeIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.excludedEmployeeIds","typeLabel":"string[] | null"},"managerId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select direct reports of this manager; exclude deeper reports.","title":"Direct manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.managerId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select direct reports of this manager; exclude deeper reports.","title":"Direct manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.managerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.managerId","typeLabel":"string | null"},"managerIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.managerIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select direct reports of any listed manager, at depth 1. Up to 1000 manager IDs.","title":"Direct manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.managerIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select direct reports of any listed manager, at depth 1. Up to 1000 manager IDs.","title":"Direct manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.managerIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.managerIds","typeLabel":"string[] | null"},"ancestorManagerId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select direct and indirect reports below this manager at any depth.","title":"Ancestor manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.ancestorManagerId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select direct and indirect reports below this manager at any depth.","title":"Ancestor manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.ancestorManagerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.ancestorManagerId","typeLabel":"string | null"},"ancestorManagerIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.ancestorManagerIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select anyone below any listed manager, at depth 1 or greater. Up to 1000 manager IDs.","title":"Ancestor manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.ancestorManagerIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select anyone below any listed manager, at depth 1 or greater. Up to 1000 manager IDs.","title":"Ancestor manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.ancestorManagerIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.ancestorManagerIds","typeLabel":"string[] | null"},"indirectManagerId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select reports at depth 2 or greater below this manager; exclude direct reports.","title":"Indirect manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.indirectManagerId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select reports at depth 2 or greater below this manager; exclude direct reports.","title":"Indirect manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.indirectManagerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.indirectManagerId","typeLabel":"string | null"},"indirectManagerIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.indirectManagerIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select reports at depth 2 or greater below any listed manager. Up to 1000 manager IDs.","title":"Indirect manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.indirectManagerIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select reports at depth 2 or greater below any listed manager. Up to 1000 manager IDs.","title":"Indirect manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.indirectManagerIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.indirectManagerIds","typeLabel":"string[] | null"},"isMember":{"oneOf":[{"type":"boolean","description":"True selects employees with active workspace membership; false selects employees without a member link or with inactive membership.","title":"Has active workspace membership","example":true,"uniqueKey":"oneOf.0.group.rules.isMember.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True selects employees with active workspace membership; false selects employees without a member link or with inactive membership.","title":"Has active workspace membership","example":true,"uniqueKey":"oneOf.0.group.rules.isMember.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.isMember","typeLabel":"boolean | null"},"memberRole":{"oneOf":[{"type":"string","enum":["admin","hr-admin","integration-manager","data-analyst","team-member",null],"description":"Select employees associated with this workspace member role.","title":"Workspace role","example":"team-member","uniqueKey":"oneOf.0.group.rules.memberRole.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["admin","hr-admin","integration-manager","data-analyst","team-member",null],"description":"Select employees associated with this workspace member role.","title":"Workspace role","example":"team-member","uniqueKey":"oneOf.0.group.rules.memberRole.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.memberRole","typeLabel":"enum\u003cstring> | null"},"query":{"oneOf":[{"type":"string","maxLength":256,"description":"Search employee name, email, and job title. A top-level query controls the default relevance ordering.","title":"Employee search text","example":"Avery","uniqueKey":"oneOf.0.group.rules.query.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":256,"description":"Search employee name, email, and job title. A top-level query controls the default relevance ordering.","title":"Employee search text","example":"Avery","uniqueKey":"oneOf.0.group.rules.query.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.query","typeLabel":"string | null"},"platformAccess":{"oneOf":[{"type":"string","enum":["HAS_ACCESS","INVITE_PENDING","NO_ACCESS",null],"description":"HAS_ACCESS selects active access; INVITE_PENDING selects pending invitations; NO_ACCESS selects employees without access.","title":"Workspace access status","example":"HAS_ACCESS","uniqueKey":"oneOf.0.group.rules.platformAccess.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["HAS_ACCESS","INVITE_PENDING","NO_ACCESS",null],"description":"HAS_ACCESS selects active access; INVITE_PENDING selects pending invitations; NO_ACCESS selects employees without access.","title":"Workspace access status","example":"HAS_ACCESS","uniqueKey":"oneOf.0.group.rules.platformAccess.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.platformAccess","typeLabel":"enum\u003cstring> | null"},"startDate":{"oneOf":[{"type":"object","title":"Start-date range","description":"Select start dates within inclusive date bounds or a supported named date range.","required":["range"],"properties":{"range":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"oneOf.0.group.rules.startDate.oneOf.0.range","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.0.group.rules.startDate.oneOf.0","typeLabel":"Start-date range · object"},{"type":"object","title":"Start-date range","description":"Select start dates within inclusive date bounds or a supported named date range.","example":{"from":"2025-01-01","to":"2025-12-31"},"properties":{"from":{"oneOf":[{"type":"string","description":"ISO 8601 date or datetime. Inclusive lower bound.","format":"date","uniqueKey":"oneOf.0.group.rules.startDate.oneOf.1.from.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"string","description":"ISO 8601 date or datetime. Inclusive lower bound.","format":"date-time","uniqueKey":"oneOf.0.group.rules.startDate.oneOf.1.from.oneOf.1","typeLabel":"string\u003cdate-time>"}],"uniqueKey":"oneOf.0.group.rules.startDate.oneOf.1.from","typeLabel":"string\u003cdate> | string\u003cdate-time>"},"to":{"oneOf":[{"type":"string","description":"ISO 8601 date or datetime. Inclusive upper bound.","format":"date","uniqueKey":"oneOf.0.group.rules.startDate.oneOf.1.to.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"string","description":"ISO 8601 date or datetime. Inclusive upper bound.","format":"date-time","uniqueKey":"oneOf.0.group.rules.startDate.oneOf.1.to.oneOf.1","typeLabel":"string\u003cdate-time>"}],"uniqueKey":"oneOf.0.group.rules.startDate.oneOf.1.to","typeLabel":"string\u003cdate> | string\u003cdate-time>"}},"additionalProperties":false,"uniqueKey":"oneOf.0.group.rules.startDate.oneOf.1","typeLabel":"Start-date range · object"},{"type":"null","title":"Start-date range","description":"Select start dates within inclusive date bounds or a supported named date range.","example":{"from":"2025-01-01","to":"2025-12-31"},"uniqueKey":"oneOf.0.group.rules.startDate.oneOf.2","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.startDate","typeLabel":"Start-date range · object · Start-date range · object · null"},"isAccountAdmin":{"oneOf":[{"type":"boolean","description":"True selects account administrators; false selects employees who are not account administrators.","title":"Account administrator","example":false,"uniqueKey":"oneOf.0.group.rules.isAccountAdmin.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True selects account administrators; false selects employees who are not account administrators.","title":"Account administrator","example":false,"uniqueKey":"oneOf.0.group.rules.isAccountAdmin.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.isAccountAdmin","typeLabel":"boolean | null"},"hasIntegrationIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.hasIntegrationIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees linked to every listed integration identifier. Up to 1000 IDs.","title":"Linked integrations","example":["slack"],"uniqueKey":"oneOf.0.group.rules.hasIntegrationIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select employees linked to every listed integration identifier. Up to 1000 IDs.","title":"Linked integrations","example":["slack"],"uniqueKey":"oneOf.0.group.rules.hasIntegrationIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.hasIntegrationIds","typeLabel":"string[] | null"},"lacksIntegrationIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.lacksIntegrationIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees without links to the listed integration identifiers. Up to 1000 IDs.","title":"Unlinked integrations","example":["slack"],"uniqueKey":"oneOf.0.group.rules.lacksIntegrationIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select employees without links to the listed integration identifiers. Up to 1000 IDs.","title":"Unlinked integrations","example":["slack"],"uniqueKey":"oneOf.0.group.rules.lacksIntegrationIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.lacksIntegrationIds","typeLabel":"string[] | null"},"status":{"type":"string","enum":["CURRENT","FORMER","ALL"],"default":"CURRENT","description":"CURRENT selects unarchived employees, FORMER selects archived employees, and ALL includes both. Defaults to CURRENT.","title":"Employment status","example":"CURRENT","uniqueKey":"oneOf.0.group.rules.status","typeLabel":"enum\u003cstring>"},"and":{"type":"array","items":{"type":"object","properties":{"hasDirectReports":{"oneOf":[{"type":"boolean","description":"True selects managers with a direct report; false selects employees without direct reports.","title":"Has direct reports","example":true,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].hasDirectReports.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True selects managers with a direct report; false selects employees without direct reports.","title":"Has direct reports","example":true,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].hasDirectReports.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].hasDirectReports","typeLabel":"boolean | null"},"hasManager":{"oneOf":[{"type":"boolean","description":"True selects employees with an assigned manager; false selects employees without a manager.","title":"Has a manager","example":true,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].hasManager.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True selects employees with an assigned manager; false selects employees without a manager.","title":"Has a manager","example":true,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].hasManager.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].hasManager","typeLabel":"boolean | null"},"employeeGroupId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select employees belonging to this employee group.","title":"Employee group ID","example":"group-engineering","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeGroupId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select employees belonging to this employee group.","title":"Employee group ID","example":"group-engineering","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeGroupId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeGroupId","typeLabel":"string | null"},"employeeGroupIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeGroupIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select members of any listed employee group. Up to 1000 IDs.","title":"Employee group IDs","example":["group-engineering"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeGroupIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select members of any listed employee group. Up to 1000 IDs.","title":"Employee group IDs","example":["group-engineering"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeGroupIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeGroupIds","typeLabel":"string[] | null"},"jobTitle":{"oneOf":[{"type":"string","maxLength":256,"description":"Select employees whose job title exactly matches this value.","title":"Exact job title","example":"Engineer","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].jobTitle.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":256,"description":"Select employees whose job title exactly matches this value.","title":"Exact job title","example":"Engineer","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].jobTitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].jobTitle","typeLabel":"string | null"},"jobTitles":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":256,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].jobTitles.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees whose job title exactly matches any listed value. Up to 1000 titles.","title":"Exact job titles","example":["Engineer","Designer"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].jobTitles.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","maxLength":256},"maxItems":1000,"description":"Select employees whose job title exactly matches any listed value. Up to 1000 titles.","title":"Exact job titles","example":["Engineer","Designer"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].jobTitles.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].jobTitles","typeLabel":"string[] | null"},"countries":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees whose HRIS work country matches any listed country code. Up to 1000 values.","title":"Work countries","example":["US"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].countries.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select employees whose HRIS work country matches any listed country code. Up to 1000 values.","title":"Work countries","example":["US"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].countries.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].countries","typeLabel":"string[] | null"},"emails":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":320,"format":"email","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].emails.oneOf.0.items.[INDEX]","typeLabel":"string\u003cemail>"},"maxItems":1000,"description":"Select employees associated with any listed email address. Up to 1000 valid addresses.","title":"Employee email addresses","example":["avery@example.test"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].emails.oneOf.0","typeLabel":"string\u003cemail>[]"},{"type":"null","items":{"type":"string","maxLength":320,"format":"email"},"maxItems":1000,"description":"Select employees associated with any listed email address. Up to 1000 valid addresses.","title":"Employee email addresses","example":["avery@example.test"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].emails.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].emails","typeLabel":"string\u003cemail>[] | null"},"emailDomains":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":254,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].emailDomains.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees with an email address on any listed domain. A domain matches exactly, so subdomains are listed separately. Up to 1000 values.","title":"Employee email domains","example":["example.test"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].emailDomains.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","maxLength":254},"maxItems":1000,"description":"Select employees with an email address on any listed domain. A domain matches exactly, so subdomains are listed separately. Up to 1000 values.","title":"Employee email domains","example":["example.test"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].emailDomains.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].emailDomains","typeLabel":"string[] | null"},"employeeId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select a single employee by ID.","title":"Employee ID","example":"employee-avery","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select a single employee by ID.","title":"Employee ID","example":"employee-avery","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeId","typeLabel":"string | null"},"employeeIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees with any listed ID. Up to 1000 IDs.","title":"Employee IDs","example":["employee-avery"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select employees with any listed ID. Up to 1000 IDs.","title":"Employee IDs","example":["employee-avery"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].employeeIds","typeLabel":"string[] | null"},"excludedEmployeeId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Exclude this employee from the results.","title":"Excluded employee ID","example":"employee-excluded","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].excludedEmployeeId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Exclude this employee from the results.","title":"Excluded employee ID","example":"employee-excluded","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].excludedEmployeeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].excludedEmployeeId","typeLabel":"string | null"},"excludedEmployeeIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].excludedEmployeeIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Exclude employees with any listed ID. Use this field for exclusions in API bulk mutations. Up to 1000 IDs.","title":"Excluded employee IDs","example":["employee-excluded"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].excludedEmployeeIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Exclude employees with any listed ID. Use this field for exclusions in API bulk mutations. Up to 1000 IDs.","title":"Excluded employee IDs","example":["employee-excluded"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].excludedEmployeeIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].excludedEmployeeIds","typeLabel":"string[] | null"},"managerId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select direct reports of this manager; exclude deeper reports.","title":"Direct manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].managerId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select direct reports of this manager; exclude deeper reports.","title":"Direct manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].managerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].managerId","typeLabel":"string | null"},"managerIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].managerIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select direct reports of any listed manager, at depth 1. Up to 1000 manager IDs.","title":"Direct manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].managerIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select direct reports of any listed manager, at depth 1. Up to 1000 manager IDs.","title":"Direct manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].managerIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].managerIds","typeLabel":"string[] | null"},"ancestorManagerId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select direct and indirect reports below this manager at any depth.","title":"Ancestor manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].ancestorManagerId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select direct and indirect reports below this manager at any depth.","title":"Ancestor manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].ancestorManagerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].ancestorManagerId","typeLabel":"string | null"},"ancestorManagerIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].ancestorManagerIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select anyone below any listed manager, at depth 1 or greater. Up to 1000 manager IDs.","title":"Ancestor manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].ancestorManagerIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select anyone below any listed manager, at depth 1 or greater. Up to 1000 manager IDs.","title":"Ancestor manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].ancestorManagerIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].ancestorManagerIds","typeLabel":"string[] | null"},"indirectManagerId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select reports at depth 2 or greater below this manager; exclude direct reports.","title":"Indirect manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].indirectManagerId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select reports at depth 2 or greater below this manager; exclude direct reports.","title":"Indirect manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].indirectManagerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].indirectManagerId","typeLabel":"string | null"},"indirectManagerIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].indirectManagerIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select reports at depth 2 or greater below any listed manager. Up to 1000 manager IDs.","title":"Indirect manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].indirectManagerIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select reports at depth 2 or greater below any listed manager. Up to 1000 manager IDs.","title":"Indirect manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].indirectManagerIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].indirectManagerIds","typeLabel":"string[] | null"},"isMember":{"oneOf":[{"type":"boolean","description":"True selects employees with active workspace membership; false selects employees without a member link or with inactive membership.","title":"Has active workspace membership","example":true,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].isMember.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True selects employees with active workspace membership; false selects employees without a member link or with inactive membership.","title":"Has active workspace membership","example":true,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].isMember.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].isMember","typeLabel":"boolean | null"},"memberRole":{"oneOf":[{"type":"string","enum":["admin","hr-admin","integration-manager","data-analyst","team-member",null],"description":"Select employees associated with this workspace member role.","title":"Workspace role","example":"team-member","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].memberRole.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["admin","hr-admin","integration-manager","data-analyst","team-member",null],"description":"Select employees associated with this workspace member role.","title":"Workspace role","example":"team-member","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].memberRole.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].memberRole","typeLabel":"enum\u003cstring> | null"},"query":{"oneOf":[{"type":"string","maxLength":256,"description":"Search employee name, email, and job title. A top-level query controls the default relevance ordering.","title":"Employee search text","example":"Avery","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].query.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":256,"description":"Search employee name, email, and job title. A top-level query controls the default relevance ordering.","title":"Employee search text","example":"Avery","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].query.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].query","typeLabel":"string | null"},"platformAccess":{"oneOf":[{"type":"string","enum":["HAS_ACCESS","INVITE_PENDING","NO_ACCESS",null],"description":"HAS_ACCESS selects active access; INVITE_PENDING selects pending invitations; NO_ACCESS selects employees without access.","title":"Workspace access status","example":"HAS_ACCESS","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].platformAccess.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["HAS_ACCESS","INVITE_PENDING","NO_ACCESS",null],"description":"HAS_ACCESS selects active access; INVITE_PENDING selects pending invitations; NO_ACCESS selects employees without access.","title":"Workspace access status","example":"HAS_ACCESS","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].platformAccess.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].platformAccess","typeLabel":"enum\u003cstring> | null"},"startDate":{"oneOf":[{"type":"object","title":"Start-date range","description":"Select start dates within inclusive date bounds or a supported named date range.","required":["range"],"properties":{"range":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].startDate.oneOf.0.range","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].startDate.oneOf.0","typeLabel":"Start-date range · object"},{"type":"object","title":"Start-date range","description":"Select start dates within inclusive date bounds or a supported named date range.","example":{"from":"2025-01-01","to":"2025-12-31"},"properties":{"from":{"oneOf":[{"type":"string","description":"ISO 8601 date or datetime. Inclusive lower bound.","format":"date","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].startDate.oneOf.1.from.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"string","description":"ISO 8601 date or datetime. Inclusive lower bound.","format":"date-time","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].startDate.oneOf.1.from.oneOf.1","typeLabel":"string\u003cdate-time>"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].startDate.oneOf.1.from","typeLabel":"string\u003cdate> | string\u003cdate-time>"},"to":{"oneOf":[{"type":"string","description":"ISO 8601 date or datetime. Inclusive upper bound.","format":"date","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].startDate.oneOf.1.to.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"string","description":"ISO 8601 date or datetime. Inclusive upper bound.","format":"date-time","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].startDate.oneOf.1.to.oneOf.1","typeLabel":"string\u003cdate-time>"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].startDate.oneOf.1.to","typeLabel":"string\u003cdate> | string\u003cdate-time>"}},"additionalProperties":false,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].startDate.oneOf.1","typeLabel":"Start-date range · object"},{"type":"null","title":"Start-date range","description":"Select start dates within inclusive date bounds or a supported named date range.","example":{"from":"2025-01-01","to":"2025-12-31"},"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].startDate.oneOf.2","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].startDate","typeLabel":"Start-date range · object · Start-date range · object · null"},"isAccountAdmin":{"oneOf":[{"type":"boolean","description":"True selects account administrators; false selects employees who are not account administrators.","title":"Account administrator","example":false,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].isAccountAdmin.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True selects account administrators; false selects employees who are not account administrators.","title":"Account administrator","example":false,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].isAccountAdmin.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].isAccountAdmin","typeLabel":"boolean | null"},"hasIntegrationIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].hasIntegrationIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees linked to every listed integration identifier. Up to 1000 IDs.","title":"Linked integrations","example":["slack"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].hasIntegrationIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select employees linked to every listed integration identifier. Up to 1000 IDs.","title":"Linked integrations","example":["slack"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].hasIntegrationIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].hasIntegrationIds","typeLabel":"string[] | null"},"lacksIntegrationIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].lacksIntegrationIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees without links to the listed integration identifiers. Up to 1000 IDs.","title":"Unlinked integrations","example":["slack"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].lacksIntegrationIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select employees without links to the listed integration identifiers. Up to 1000 IDs.","title":"Unlinked integrations","example":["slack"],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].lacksIntegrationIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].lacksIntegrationIds","typeLabel":"string[] | null"},"status":{"type":"string","enum":["CURRENT","FORMER","ALL"],"default":"CURRENT","description":"CURRENT selects unarchived employees, FORMER selects archived employees, and ALL includes both. Defaults to CURRENT.","title":"Employment status","example":"CURRENT","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"and":{"type":"array","items":{"$circularRef":"57306fba-2272-49d7-a2c1-89a0ce15a9a2"},"maxItems":49,"description":"All child filters must match, in addition to the other predicates in this filter. Up to 49 children.","title":"All conditions","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].and","typeLabel":"All conditions · array"},"or":{"type":"array","items":{"$circularRef":"57306fba-2272-49d7-a2c1-89a0ce15a9a2"},"maxItems":49,"description":"At least one child filter must match, in addition to the other predicates in this filter. Up to 49 children.","title":"Any condition","uniqueKey":"oneOf.0.group.rules.and.items.[INDEX].or","typeLabel":"Any condition · array"}},"additionalProperties":false,"uniqueKey":"oneOf.0.group.rules.and.items.[INDEX]","typeLabel":"object"},"maxItems":49,"description":"All child filters must match, in addition to the other predicates in this filter. Up to 49 children.","title":"All conditions","uniqueKey":"oneOf.0.group.rules.and","typeLabel":"All conditions · object[]"},"or":{"type":"array","items":{"type":"object","properties":{"hasDirectReports":{"oneOf":[{"type":"boolean","description":"True selects managers with a direct report; false selects employees without direct reports.","title":"Has direct reports","example":true,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].hasDirectReports.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True selects managers with a direct report; false selects employees without direct reports.","title":"Has direct reports","example":true,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].hasDirectReports.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].hasDirectReports","typeLabel":"boolean | null"},"hasManager":{"oneOf":[{"type":"boolean","description":"True selects employees with an assigned manager; false selects employees without a manager.","title":"Has a manager","example":true,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].hasManager.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True selects employees with an assigned manager; false selects employees without a manager.","title":"Has a manager","example":true,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].hasManager.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].hasManager","typeLabel":"boolean | null"},"employeeGroupId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select employees belonging to this employee group.","title":"Employee group ID","example":"group-engineering","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeGroupId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select employees belonging to this employee group.","title":"Employee group ID","example":"group-engineering","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeGroupId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeGroupId","typeLabel":"string | null"},"employeeGroupIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeGroupIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select members of any listed employee group. Up to 1000 IDs.","title":"Employee group IDs","example":["group-engineering"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeGroupIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select members of any listed employee group. Up to 1000 IDs.","title":"Employee group IDs","example":["group-engineering"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeGroupIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeGroupIds","typeLabel":"string[] | null"},"jobTitle":{"oneOf":[{"type":"string","maxLength":256,"description":"Select employees whose job title exactly matches this value.","title":"Exact job title","example":"Engineer","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].jobTitle.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":256,"description":"Select employees whose job title exactly matches this value.","title":"Exact job title","example":"Engineer","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].jobTitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].jobTitle","typeLabel":"string | null"},"jobTitles":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":256,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].jobTitles.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees whose job title exactly matches any listed value. Up to 1000 titles.","title":"Exact job titles","example":["Engineer","Designer"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].jobTitles.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","maxLength":256},"maxItems":1000,"description":"Select employees whose job title exactly matches any listed value. Up to 1000 titles.","title":"Exact job titles","example":["Engineer","Designer"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].jobTitles.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].jobTitles","typeLabel":"string[] | null"},"countries":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees whose HRIS work country matches any listed country code. Up to 1000 values.","title":"Work countries","example":["US"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].countries.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select employees whose HRIS work country matches any listed country code. Up to 1000 values.","title":"Work countries","example":["US"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].countries.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].countries","typeLabel":"string[] | null"},"emails":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":320,"format":"email","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].emails.oneOf.0.items.[INDEX]","typeLabel":"string\u003cemail>"},"maxItems":1000,"description":"Select employees associated with any listed email address. Up to 1000 valid addresses.","title":"Employee email addresses","example":["avery@example.test"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].emails.oneOf.0","typeLabel":"string\u003cemail>[]"},{"type":"null","items":{"type":"string","maxLength":320,"format":"email"},"maxItems":1000,"description":"Select employees associated with any listed email address. Up to 1000 valid addresses.","title":"Employee email addresses","example":["avery@example.test"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].emails.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].emails","typeLabel":"string\u003cemail>[] | null"},"emailDomains":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":254,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].emailDomains.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees with an email address on any listed domain. A domain matches exactly, so subdomains are listed separately. Up to 1000 values.","title":"Employee email domains","example":["example.test"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].emailDomains.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","maxLength":254},"maxItems":1000,"description":"Select employees with an email address on any listed domain. A domain matches exactly, so subdomains are listed separately. Up to 1000 values.","title":"Employee email domains","example":["example.test"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].emailDomains.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].emailDomains","typeLabel":"string[] | null"},"employeeId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select a single employee by ID.","title":"Employee ID","example":"employee-avery","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select a single employee by ID.","title":"Employee ID","example":"employee-avery","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeId","typeLabel":"string | null"},"employeeIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees with any listed ID. Up to 1000 IDs.","title":"Employee IDs","example":["employee-avery"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select employees with any listed ID. Up to 1000 IDs.","title":"Employee IDs","example":["employee-avery"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].employeeIds","typeLabel":"string[] | null"},"excludedEmployeeId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Exclude this employee from the results.","title":"Excluded employee ID","example":"employee-excluded","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].excludedEmployeeId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Exclude this employee from the results.","title":"Excluded employee ID","example":"employee-excluded","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].excludedEmployeeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].excludedEmployeeId","typeLabel":"string | null"},"excludedEmployeeIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].excludedEmployeeIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Exclude employees with any listed ID. Use this field for exclusions in API bulk mutations. Up to 1000 IDs.","title":"Excluded employee IDs","example":["employee-excluded"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].excludedEmployeeIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Exclude employees with any listed ID. Use this field for exclusions in API bulk mutations. Up to 1000 IDs.","title":"Excluded employee IDs","example":["employee-excluded"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].excludedEmployeeIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].excludedEmployeeIds","typeLabel":"string[] | null"},"managerId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select direct reports of this manager; exclude deeper reports.","title":"Direct manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].managerId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select direct reports of this manager; exclude deeper reports.","title":"Direct manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].managerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].managerId","typeLabel":"string | null"},"managerIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].managerIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select direct reports of any listed manager, at depth 1. Up to 1000 manager IDs.","title":"Direct manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].managerIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select direct reports of any listed manager, at depth 1. Up to 1000 manager IDs.","title":"Direct manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].managerIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].managerIds","typeLabel":"string[] | null"},"ancestorManagerId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select direct and indirect reports below this manager at any depth.","title":"Ancestor manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].ancestorManagerId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select direct and indirect reports below this manager at any depth.","title":"Ancestor manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].ancestorManagerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].ancestorManagerId","typeLabel":"string | null"},"ancestorManagerIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].ancestorManagerIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select anyone below any listed manager, at depth 1 or greater. Up to 1000 manager IDs.","title":"Ancestor manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].ancestorManagerIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select anyone below any listed manager, at depth 1 or greater. Up to 1000 manager IDs.","title":"Ancestor manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].ancestorManagerIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].ancestorManagerIds","typeLabel":"string[] | null"},"indirectManagerId":{"oneOf":[{"type":"string","minLength":1,"maxLength":128,"description":"Select reports at depth 2 or greater below this manager; exclude direct reports.","title":"Indirect manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].indirectManagerId.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":128,"description":"Select reports at depth 2 or greater below this manager; exclude direct reports.","title":"Indirect manager ID","example":"employee-morgan","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].indirectManagerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].indirectManagerId","typeLabel":"string | null"},"indirectManagerIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].indirectManagerIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select reports at depth 2 or greater below any listed manager. Up to 1000 manager IDs.","title":"Indirect manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].indirectManagerIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select reports at depth 2 or greater below any listed manager. Up to 1000 manager IDs.","title":"Indirect manager IDs","example":["employee-morgan"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].indirectManagerIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].indirectManagerIds","typeLabel":"string[] | null"},"isMember":{"oneOf":[{"type":"boolean","description":"True selects employees with active workspace membership; false selects employees without a member link or with inactive membership.","title":"Has active workspace membership","example":true,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].isMember.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True selects employees with active workspace membership; false selects employees without a member link or with inactive membership.","title":"Has active workspace membership","example":true,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].isMember.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].isMember","typeLabel":"boolean | null"},"memberRole":{"oneOf":[{"type":"string","enum":["admin","hr-admin","integration-manager","data-analyst","team-member",null],"description":"Select employees associated with this workspace member role.","title":"Workspace role","example":"team-member","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].memberRole.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["admin","hr-admin","integration-manager","data-analyst","team-member",null],"description":"Select employees associated with this workspace member role.","title":"Workspace role","example":"team-member","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].memberRole.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].memberRole","typeLabel":"enum\u003cstring> | null"},"query":{"oneOf":[{"type":"string","maxLength":256,"description":"Search employee name, email, and job title. A top-level query controls the default relevance ordering.","title":"Employee search text","example":"Avery","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].query.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":256,"description":"Search employee name, email, and job title. A top-level query controls the default relevance ordering.","title":"Employee search text","example":"Avery","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].query.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].query","typeLabel":"string | null"},"platformAccess":{"oneOf":[{"type":"string","enum":["HAS_ACCESS","INVITE_PENDING","NO_ACCESS",null],"description":"HAS_ACCESS selects active access; INVITE_PENDING selects pending invitations; NO_ACCESS selects employees without access.","title":"Workspace access status","example":"HAS_ACCESS","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].platformAccess.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["HAS_ACCESS","INVITE_PENDING","NO_ACCESS",null],"description":"HAS_ACCESS selects active access; INVITE_PENDING selects pending invitations; NO_ACCESS selects employees without access.","title":"Workspace access status","example":"HAS_ACCESS","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].platformAccess.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].platformAccess","typeLabel":"enum\u003cstring> | null"},"startDate":{"oneOf":[{"type":"object","title":"Start-date range","description":"Select start dates within inclusive date bounds or a supported named date range.","required":["range"],"properties":{"range":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].startDate.oneOf.0.range","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].startDate.oneOf.0","typeLabel":"Start-date range · object"},{"type":"object","title":"Start-date range","description":"Select start dates within inclusive date bounds or a supported named date range.","example":{"from":"2025-01-01","to":"2025-12-31"},"properties":{"from":{"oneOf":[{"type":"string","description":"ISO 8601 date or datetime. Inclusive lower bound.","format":"date","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].startDate.oneOf.1.from.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"string","description":"ISO 8601 date or datetime. Inclusive lower bound.","format":"date-time","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].startDate.oneOf.1.from.oneOf.1","typeLabel":"string\u003cdate-time>"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].startDate.oneOf.1.from","typeLabel":"string\u003cdate> | string\u003cdate-time>"},"to":{"oneOf":[{"type":"string","description":"ISO 8601 date or datetime. Inclusive upper bound.","format":"date","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].startDate.oneOf.1.to.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"string","description":"ISO 8601 date or datetime. Inclusive upper bound.","format":"date-time","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].startDate.oneOf.1.to.oneOf.1","typeLabel":"string\u003cdate-time>"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].startDate.oneOf.1.to","typeLabel":"string\u003cdate> | string\u003cdate-time>"}},"additionalProperties":false,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].startDate.oneOf.1","typeLabel":"Start-date range · object"},{"type":"null","title":"Start-date range","description":"Select start dates within inclusive date bounds or a supported named date range.","example":{"from":"2025-01-01","to":"2025-12-31"},"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].startDate.oneOf.2","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].startDate","typeLabel":"Start-date range · object · Start-date range · object · null"},"isAccountAdmin":{"oneOf":[{"type":"boolean","description":"True selects account administrators; false selects employees who are not account administrators.","title":"Account administrator","example":false,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].isAccountAdmin.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True selects account administrators; false selects employees who are not account administrators.","title":"Account administrator","example":false,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].isAccountAdmin.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].isAccountAdmin","typeLabel":"boolean | null"},"hasIntegrationIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].hasIntegrationIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees linked to every listed integration identifier. Up to 1000 IDs.","title":"Linked integrations","example":["slack"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].hasIntegrationIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select employees linked to every listed integration identifier. Up to 1000 IDs.","title":"Linked integrations","example":["slack"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].hasIntegrationIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].hasIntegrationIds","typeLabel":"string[] | null"},"lacksIntegrationIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].lacksIntegrationIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":1000,"description":"Select employees without links to the listed integration identifiers. Up to 1000 IDs.","title":"Unlinked integrations","example":["slack"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].lacksIntegrationIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":128},"maxItems":1000,"description":"Select employees without links to the listed integration identifiers. Up to 1000 IDs.","title":"Unlinked integrations","example":["slack"],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].lacksIntegrationIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].lacksIntegrationIds","typeLabel":"string[] | null"},"status":{"type":"string","enum":["CURRENT","FORMER","ALL"],"default":"CURRENT","description":"CURRENT selects unarchived employees, FORMER selects archived employees, and ALL includes both. Defaults to CURRENT.","title":"Employment status","example":"CURRENT","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"and":{"type":"array","items":{"$circularRef":"57306fba-2272-49d7-a2c1-89a0ce15a9a2"},"maxItems":49,"description":"All child filters must match, in addition to the other predicates in this filter. Up to 49 children.","title":"All conditions","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].and","typeLabel":"All conditions · array"},"or":{"type":"array","items":{"$circularRef":"57306fba-2272-49d7-a2c1-89a0ce15a9a2"},"maxItems":49,"description":"At least one child filter must match, in addition to the other predicates in this filter. Up to 49 children.","title":"Any condition","uniqueKey":"oneOf.0.group.rules.or.items.[INDEX].or","typeLabel":"Any condition · array"}},"additionalProperties":false,"uniqueKey":"oneOf.0.group.rules.or.items.[INDEX]","typeLabel":"object"},"maxItems":49,"description":"At least one child filter must match, in addition to the other predicates in this filter. Up to 49 children.","title":"Any condition","uniqueKey":"oneOf.0.group.rules.or","typeLabel":"Any condition · object[]"}},"additionalProperties":false,"uniqueKey":"oneOf.0.group.rules","typeLabel":"Employee rules · object"}},"isRequired":true,"uniqueKey":"oneOf.0.group","typeLabel":"Group · object"}},"uniqueKey":"oneOf.0","typeLabel":"Group refresh response · object"},{"type":"object","title":"Group refresh response","description":"Refreshed group details, or archived:true and group:null when its linked source is unavailable.","required":["archived","group"],"example":{"archived":false,"group":{"id":"group-engineering","name":"Engineering","type":"MANUAL","categoryIds":["11111111-1111-4111-8111-111111111111"],"employeeCount":1,"integrationId":null,"integrationUserGroupId":null,"integrationUserGroupExternalType":null,"createdByEmployeeId":"employee-avery","createdAt":"2026-01-15T10:00:00.000Z","updatedAt":"2026-01-15T10:00:00.000Z","sharingAccess":{"companyAccess":"read","allManagersAccess":"none","employeeAccess":[{"employeeId":"employee-avery","access":"write"}],"groupAccess":[],"subtreeAccess":[]},"canWrite":true}},"properties":{"archived":{"type":"boolean","enum":[true],"description":"True when sync archived the group instead of returning refreshed details.","title":"Group archived","example":true,"isRequired":true,"uniqueKey":"oneOf.1.archived","typeLabel":"enum\u003cboolean>"},"group":{"type":"null","description":"Refreshed group details, or null when the linked source caused the group to be archived.","title":"Group","isRequired":true,"uniqueKey":"oneOf.1.group","typeLabel":"null"}},"uniqueKey":"oneOf.1","typeLabel":"Group refresh response · object"}],"uniqueKey":"","typeLabel":"Group refresh response · object"},"examples":{"Example":{"title":"Example","value":{"archived":false,"group":{"id":"group-engineering","name":"Engineering","type":"MANUAL","categoryIds":["11111111-1111-4111-8111-111111111111"],"employeeCount":1,"integrationId":null,"integrationUserGroupId":null,"integrationUserGroupExternalType":null,"createdByEmployeeId":"employee-avery","createdAt":"2026-01-15T10:00:00.000Z","updatedAt":"2026-01-15T10:00:00.000Z","sharingAccess":{"companyAccess":"read","allManagersAccess":"none","employeeAccess":[{"employeeId":"employee-avery","access":"write"}],"groupAccess":[],"subtreeAccess":[]},"canWrite":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"628d1c62-6a29-4690-b1c7-6fae132a766f":{"description":"Bad request or request validation failed","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST"],"isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.requestId","typeLabel":"string"}},"required":["code","message","requestId"],"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR"],"isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.requestId","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.error.details.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.1.error.details.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"oneOf.1.error.details.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"isRequired":true,"uniqueKey":"oneOf.1.error.details.items.[INDEX].path","typeLabel":"(string | number)[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.details.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"oneOf.1.error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.1.error.details","typeLabel":"object[]"}},"required":["code","message","requestId","details"],"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"BAD_REQUEST","message":"\u003cstring>","requestId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"55ca88b2-7c7a-4932-9368-e9e8dff47240":{"description":"Authentication is missing or invalid. Send a valid API key or OAuth access token in the Authorization: Bearer \u003cTOKEN> header before retrying.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"required":["code","message","requestId"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"\u003cstring>","requestId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"f6cda30e-1dc5-490f-b9b4-2d6b972a1c73":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["FORBIDDEN"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"required":["code","message","requestId"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"FORBIDDEN","message":"\u003cstring>","requestId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e54c039b-e9dc-4f70-9e85-197151fea566":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["NOT_FOUND"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"required":["code","message","requestId"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"\u003cstring>","requestId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7055b3e2-350b-42e9-9048-34bf5e5d54e4":{"description":"The API-client request budget is exhausted. API keys allow 500 requests per minute per key; OAuth clients allow 500 per minute per client and workspace. Reads and writes share the budget. One HTTP request counts once, including bulk requests. Wait for the Retry-After delay before retrying.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","required":true,"schema":{"type":"integer","minimum":0,"example":42}},"RateLimit":{"description":"Current request budget: limit is the maximum count, remaining is the unused count, and reset is seconds until the window resets, not a timestamp.","required":true,"schema":{"type":"string","example":"limit=500, remaining=0, reset=42"}},"RateLimit-Policy":{"description":"Request limit and window length in seconds, formatted as \u003climit>;w=\u003cseconds>.","required":true,"schema":{"type":"string","example":"500;w=60"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["RATE_LIMITED"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"required":["code","message","requestId"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMITED","message":"\u003cstring>","requestId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f2a167fc-5608-46a2-a0ab-1851d598ec8c":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Use an API key or OAuth access token. Enter only the token in the authorization dialog; requests send it as `Authorization: Bearer \u003cTOKEN>`.\n\nCreate an API key in your workspace's **Settings → API keys**. Keys start with `wm_api_` and only work in the workspace where they were created. Read-only keys can read data; creating, updating, or deleting data requires a read-write key.\n\n```http\nAuthorization: Bearer wm_api_example\n```\n\nOAuth access tokens are issued for connected Windmill applications.\n\n```http\nAuthorization: Bearer \u003cOAUTH_ACCESS_TOKEN>\n```\n\nBoth token types use the authenticated user's workspace permissions. Each endpoint's permission requirements and the sharing settings of the requested items still apply.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"bc3cc9da-1158-4cfa-97b3-e455483a1d98":{"url":"https://api.gowindmill.com/api/v2"}},"schemas":{"57306fba-2272-49d7-a2c1-89a0ce15a9a2":{"type":"object","properties":{"hasDirectReports":{"oneOf":[{"type":"boolean","title":"Has direct reports","description":"True selects managers with a direct report; false selects employees without direct reports.","example":true},{"type":"null","title":"Has direct reports","description":"True selects managers with a direct report; false selects employees without direct reports.","example":true}]},"hasManager":{"oneOf":[{"type":"boolean","title":"Has a manager","description":"True selects employees with an assigned manager; false selects employees without a manager.","example":true},{"type":"null","title":"Has a manager","description":"True selects employees with an assigned manager; false selects employees without a manager.","example":true}]},"employeeGroupId":{"oneOf":[{"type":"string","title":"Employee group ID","description":"Select employees belonging to this employee group.","maxLength":128,"minLength":1,"example":"group-engineering"},{"type":"null","title":"Employee group ID","description":"Select employees belonging to this employee group.","maxLength":128,"minLength":1,"example":"group-engineering"}]},"employeeGroupIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128},"title":"Employee group IDs","description":"Select members of any listed employee group. Up to 1000 IDs.","maxItems":1000,"example":["group-engineering"]},{"type":"null","title":"Employee group IDs","description":"Select members of any listed employee group. Up to 1000 IDs.","maxItems":1000,"example":["group-engineering"]}]},"jobTitle":{"oneOf":[{"type":"string","title":"Exact job title","description":"Select employees whose job title exactly matches this value.","maxLength":256,"example":"Engineer"},{"type":"null","title":"Exact job title","description":"Select employees whose job title exactly matches this value.","maxLength":256,"example":"Engineer"}]},"jobTitles":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":256},"title":"Exact job titles","description":"Select employees whose job title exactly matches any listed value. Up to 1000 titles.","maxItems":1000,"example":["Engineer","Designer"]},{"type":"null","title":"Exact job titles","description":"Select employees whose job title exactly matches any listed value. Up to 1000 titles.","maxItems":1000,"example":["Engineer","Designer"]}]},"countries":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128},"title":"Work countries","description":"Select employees whose HRIS work country matches any listed country code. Up to 1000 values.","maxItems":1000,"example":["US"]},{"type":"null","title":"Work countries","description":"Select employees whose HRIS work country matches any listed country code. Up to 1000 values.","maxItems":1000,"example":["US"]}]},"emails":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":320,"format":"email"},"title":"Employee email addresses","description":"Select employees associated with any listed email address. Up to 1000 valid addresses.","maxItems":1000,"example":["avery@example.test"]},{"type":"null","title":"Employee email addresses","description":"Select employees associated with any listed email address. Up to 1000 valid addresses.","maxItems":1000,"example":["avery@example.test"]}]},"emailDomains":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":254},"title":"Employee email domains","description":"Select employees with an email address on any listed domain. A domain matches exactly, so subdomains are listed separately. Up to 1000 values.","maxItems":1000,"example":["example.test"]},{"type":"null","title":"Employee email domains","description":"Select employees with an email address on any listed domain. A domain matches exactly, so subdomains are listed separately. Up to 1000 values.","maxItems":1000,"example":["example.test"]}]},"employeeId":{"oneOf":[{"type":"string","title":"Employee ID","description":"Select a single employee by ID.","maxLength":128,"minLength":1,"example":"employee-avery"},{"type":"null","title":"Employee ID","description":"Select a single employee by ID.","maxLength":128,"minLength":1,"example":"employee-avery"}]},"employeeIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128},"title":"Employee IDs","description":"Select employees with any listed ID. Up to 1000 IDs.","maxItems":1000,"example":["employee-avery"]},{"type":"null","title":"Employee IDs","description":"Select employees with any listed ID. Up to 1000 IDs.","maxItems":1000,"example":["employee-avery"]}]},"excludedEmployeeId":{"oneOf":[{"type":"string","title":"Excluded employee ID","description":"Exclude this employee from the results.","maxLength":128,"minLength":1,"example":"employee-excluded"},{"type":"null","title":"Excluded employee ID","description":"Exclude this employee from the results.","maxLength":128,"minLength":1,"example":"employee-excluded"}]},"excludedEmployeeIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128},"title":"Excluded employee IDs","description":"Exclude employees with any listed ID. Use this field for exclusions in API bulk mutations. Up to 1000 IDs.","maxItems":1000,"example":["employee-excluded"]},{"type":"null","title":"Excluded employee IDs","description":"Exclude employees with any listed ID. Use this field for exclusions in API bulk mutations. Up to 1000 IDs.","maxItems":1000,"example":["employee-excluded"]}]},"managerId":{"oneOf":[{"type":"string","title":"Direct manager ID","description":"Select direct reports of this manager; exclude deeper reports.","maxLength":128,"minLength":1,"example":"employee-morgan"},{"type":"null","title":"Direct manager ID","description":"Select direct reports of this manager; exclude deeper reports.","maxLength":128,"minLength":1,"example":"employee-morgan"}]},"managerIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128},"title":"Direct manager IDs","description":"Select direct reports of any listed manager, at depth 1. Up to 1000 manager IDs.","maxItems":1000,"example":["employee-morgan"]},{"type":"null","title":"Direct manager IDs","description":"Select direct reports of any listed manager, at depth 1. Up to 1000 manager IDs.","maxItems":1000,"example":["employee-morgan"]}]},"ancestorManagerId":{"oneOf":[{"type":"string","title":"Ancestor manager ID","description":"Select direct and indirect reports below this manager at any depth.","maxLength":128,"minLength":1,"example":"employee-morgan"},{"type":"null","title":"Ancestor manager ID","description":"Select direct and indirect reports below this manager at any depth.","maxLength":128,"minLength":1,"example":"employee-morgan"}]},"ancestorManagerIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128},"title":"Ancestor manager IDs","description":"Select anyone below any listed manager, at depth 1 or greater. Up to 1000 manager IDs.","maxItems":1000,"example":["employee-morgan"]},{"type":"null","title":"Ancestor manager IDs","description":"Select anyone below any listed manager, at depth 1 or greater. Up to 1000 manager IDs.","maxItems":1000,"example":["employee-morgan"]}]},"indirectManagerId":{"oneOf":[{"type":"string","title":"Indirect manager ID","description":"Select reports at depth 2 or greater below this manager; exclude direct reports.","maxLength":128,"minLength":1,"example":"employee-morgan"},{"type":"null","title":"Indirect manager ID","description":"Select reports at depth 2 or greater below this manager; exclude direct reports.","maxLength":128,"minLength":1,"example":"employee-morgan"}]},"indirectManagerIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128},"title":"Indirect manager IDs","description":"Select reports at depth 2 or greater below any listed manager. Up to 1000 manager IDs.","maxItems":1000,"example":["employee-morgan"]},{"type":"null","title":"Indirect manager IDs","description":"Select reports at depth 2 or greater below any listed manager. Up to 1000 manager IDs.","maxItems":1000,"example":["employee-morgan"]}]},"isMember":{"oneOf":[{"type":"boolean","title":"Has active workspace membership","description":"True selects employees with active workspace membership; false selects employees without a member link or with inactive membership.","example":true},{"type":"null","title":"Has active workspace membership","description":"True selects employees with active workspace membership; false selects employees without a member link or with inactive membership.","example":true}]},"memberRole":{"oneOf":[{"type":"string","title":"Workspace role","description":"Select employees associated with this workspace member role.","enum":["admin","hr-admin","integration-manager","data-analyst","team-member",null],"example":"team-member"},{"type":"null","title":"Workspace role","description":"Select employees associated with this workspace member role.","enum":["admin","hr-admin","integration-manager","data-analyst","team-member",null],"example":"team-member"}]},"query":{"oneOf":[{"type":"string","title":"Employee search text","description":"Search employee name, email, and job title. A top-level query controls the default relevance ordering.","maxLength":256,"example":"Avery"},{"type":"null","title":"Employee search text","description":"Search employee name, email, and job title. A top-level query controls the default relevance ordering.","maxLength":256,"example":"Avery"}]},"platformAccess":{"oneOf":[{"type":"string","title":"Workspace access status","description":"HAS_ACCESS selects active access; INVITE_PENDING selects pending invitations; NO_ACCESS selects employees without access.","enum":["HAS_ACCESS","INVITE_PENDING","NO_ACCESS",null],"example":"HAS_ACCESS"},{"type":"null","title":"Workspace access status","description":"HAS_ACCESS selects active access; INVITE_PENDING selects pending invitations; NO_ACCESS selects employees without access.","enum":["HAS_ACCESS","INVITE_PENDING","NO_ACCESS",null],"example":"HAS_ACCESS"}]},"startDate":{"oneOf":[{"type":"object","title":"Start-date range","description":"Select start dates within inclusive date bounds or a supported named date range.","required":["range"],"properties":{"range":{"type":"string","minLength":1,"maxLength":128,"isRequired":true}},"additionalProperties":false},{"type":"object","title":"Start-date range","description":"Select start dates within inclusive date bounds or a supported named date range.","example":{"from":"2025-01-01","to":"2025-12-31"},"properties":{"from":{"oneOf":[{"type":"string","description":"ISO 8601 date or datetime. Inclusive lower bound.","format":"date"},{"type":"string","description":"ISO 8601 date or datetime. Inclusive lower bound.","format":"date-time"}]},"to":{"oneOf":[{"type":"string","description":"ISO 8601 date or datetime. Inclusive upper bound.","format":"date"},{"type":"string","description":"ISO 8601 date or datetime. Inclusive upper bound.","format":"date-time"}]}},"additionalProperties":false},{"type":"null","title":"Start-date range","description":"Select start dates within inclusive date bounds or a supported named date range.","example":{"from":"2025-01-01","to":"2025-12-31"}}]},"isAccountAdmin":{"oneOf":[{"type":"boolean","title":"Account administrator","description":"True selects account administrators; false selects employees who are not account administrators.","example":false},{"type":"null","title":"Account administrator","description":"True selects account administrators; false selects employees who are not account administrators.","example":false}]},"hasIntegrationIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128},"title":"Linked integrations","description":"Select employees linked to every listed integration identifier. Up to 1000 IDs.","maxItems":1000,"example":["slack"]},{"type":"null","title":"Linked integrations","description":"Select employees linked to every listed integration identifier. Up to 1000 IDs.","maxItems":1000,"example":["slack"]}]},"lacksIntegrationIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":128},"title":"Unlinked integrations","description":"Select employees without links to the listed integration identifiers. Up to 1000 IDs.","maxItems":1000,"example":["slack"]},{"type":"null","title":"Unlinked integrations","description":"Select employees without links to the listed integration identifiers. Up to 1000 IDs.","maxItems":1000,"example":["slack"]}]},"status":{"type":"string","enum":["CURRENT","FORMER","ALL"],"default":"CURRENT","description":"CURRENT selects unarchived employees, FORMER selects archived employees, and ALL includes both. Defaults to CURRENT.","title":"Employment status","example":"CURRENT"},"and":{"type":"array","items":{"$circularRef":"57306fba-2272-49d7-a2c1-89a0ce15a9a2"},"maxItems":49,"description":"All child filters must match, in addition to the other predicates in this filter. Up to 49 children.","title":"All conditions"},"or":{"type":"array","items":{"$circularRef":"57306fba-2272-49d7-a2c1-89a0ce15a9a2"},"maxItems":49,"description":"At least one child filter must match, in addition to the other predicates in this filter. Up to 49 children.","title":"Any condition"}},"additionalProperties":false}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Use an API key or OAuth access token. Enter only the token in the authorization dialog; requests send it as `Authorization: Bearer \u003cTOKEN>`.\n\nCreate an API key in your workspace's **Settings → API keys**. Keys start with `wm_api_` and only work in the workspace where they were created. Read-only keys can read data; creating, updating, or deleting data requires a read-write key.\n\n```http\nAuthorization: Bearer wm_api_example\n```\n\nOAuth access tokens are issued for connected Windmill applications.\n\n```http\nAuthorization: Bearer \u003cOAUTH_ACCESS_TOKEN>\n```\n\nBoth token types use the authenticated user's workspace permissions. Each endpoint's permission requirements and the sharing settings of the requested items still apply.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use an API key or OAuth access token. Enter only the token in the authorization dialog; requests send it as `Authorization: Bearer \u003cTOKEN>`.\n\nCreate an API key in your workspace's **Settings → API keys**. Keys start with `wm_api_` and only work in the workspace where they were created. Read-only keys can read data; creating, updating, or deleting data requires a read-write key.\n\n```http\nAuthorization: Bearer wm_api_example\n```\n\nOAuth access tokens are issued for connected Windmill applications.\n\n```http\nAuthorization: Bearer \u003cOAUTH_ACCESS_TOKEN>\n```\n\nBoth token types use the authenticated user's workspace permissions. Each endpoint's permission requirements and the sharing settings of the requested items still apply.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://api.gowindmill.com/api/v2/openapi.json"},"subdomain":"windmill","siteName":"Windmill Help Site","title":"Refresh an employee group - Windmill Help Site","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T14:24:43.978Z","originalFileLocation":"api-reference/groups/refresh-an-employee-group.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=\"Refreshes a FILTER smart group from its saved rules or a SYNCED group from the integration data already stored in Windmill. It does not fetch new data from the connected provider. Returns archived:false with current group details. If the linked source is archived or inactive, the group is archived and the response contains archived:true and group:null. MANUAL and SCIM groups return 400. Requires permission to read and edit the group. A missing linked integration group returns 404.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Windmill Help Site\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/windmill/W7N_zh2zYbm8zD54/_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/windmill/W7N_zh2zYbm8zD54/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/windmill/W7N_zh2zYbm8zD54/_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/windmill/W7N_zh2zYbm8zD54/_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/windmill/W7N_zh2zYbm8zD54/_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/windmill/W7N_zh2zYbm8zD54/_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/windmill/W7N_zh2zYbm8zD54/_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/windmill/W7N_zh2zYbm8zD54/_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/windmill/W7N_zh2zYbm8zD54/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Refresh an employee group - Windmill Help Site\">\u003cmeta data-mint-head property=\"og:description\" content=\"Refreshes a FILTER smart group from its saved rules or a SYNCED group from the integration data already stored in Windmill. It does not fetch new data from the connected provider. Returns archived:false with current group details. If the linked source is archived or inactive, the group is archived and the response contains archived:true and group:null. MANUAL and SCIM groups return 400. Requires permission to read and edit the group. A missing linked integration group returns 404.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Windmill Help Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.gowindmill.com/api-reference/groups/refresh-an-employee-group\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://windmill.mintlify.site/_mintlify/api/og/v2?division=Groups\u0026amp;title=Refresh+an+employee+group\u0026amp;description=Refreshes+a+FILTER+smart+group+from+its+saved+rules+or+a+SYNCED+group+from+the+integration+data+already+stored+in+Windmill.+It+does+not+fetch+new+data+from+the+\u0026amp;theme=819f4f407f94f51efe0e1a0f\u0026amp;signature=4db6668c6ea2d57f8ed512cf831cbe5db71191b3dd4116d05c48dbe26703c22a\">\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=\"Refresh an employee group - Windmill Help Site\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Refreshes a FILTER smart group from its saved rules or a SYNCED group from the integration data already stored in Windmill. It does not fetch new data from the connected provider. Returns archived:false with current group details. If the linked source is archived or inactive, the group is archived and the response contains archived:true and group:null. MANUAL and SCIM groups return 400. Requires permission to read and edit the group. A missing linked integration group returns 404.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://windmill.mintlify.site/_mintlify/api/og/v2?division=Groups\u0026amp;title=Refresh+an+employee+group\u0026amp;description=Refreshes+a+FILTER+smart+group+from+its+saved+rules+or+a+SYNCED+group+from+the+integration+data+already+stored+in+Windmill.+It+does+not+fetch+new+data+from+the+\u0026amp;theme=819f4f407f94f51efe0e1a0f\u0026amp;signature=4db6668c6ea2d57f8ed512cf831cbe5db71191b3dd4116d05c48dbe26703c22a\">\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/windmill/W7N_zh2zYbm8zD54/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Windmill Help Site\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4084FB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.gowindmill.com/api-reference/groups/refresh-an-employee-group\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/groups/refresh-an-employee-group.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.gowindmill.com/#organization\",\"name\":\"Windmill Help Site\",\"url\":\"https://help.gowindmill.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/windmill/438SkEPmWnjrcDyT/logo/light.svg?fit=max\u0026auto=format\u0026n=438SkEPmWnjrcDyT\u0026q=85\u0026s=911e75d2985851400d148f9e5e20c94f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.gowindmill.com#website\",\"name\":\"Windmill Help Site\",\"url\":\"https://help.gowindmill.com\",\"publisher\":{\"@id\":\"https://help.gowindmill.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.gowindmill.com/api-reference/groups/refresh-an-employee-group#webpage\",\"url\":\"https://help.gowindmill.com/api-reference/groups/refresh-an-employee-group\",\"name\":\"Refresh an employee group\",\"description\":\"Refreshes a FILTER smart group from its saved rules or a SYNCED group from the integration data already stored in Windmill. It does not fetch new data from the connected provider. Returns archived:false with current group details. If the linked source is archived or inactive, the group is archived and the response contains archived:true and group:null. MANUAL and SCIM groups return 400. Requires permission to read and edit the group. A missing linked integration group returns 404.\",\"dateModified\":\"2026-11-19T14:24:43.978Z\",\"isPartOf\":{\"@id\":\"https://help.gowindmill.com#website\"},\"breadcrumb\":{\"@id\":\"https://help.gowindmill.com/api-reference/groups/refresh-an-employee-group#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.gowindmill.com/api-reference/groups/refresh-an-employee-group#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://help.gowindmill.com/api-reference/employees/search-employee-profiles\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Groups\",\"item\":\"https://help.gowindmill.com/api-reference/groups/list-readable-employee-groups\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Refresh an employee group\",\"item\":\"https://help.gowindmill.com/api-reference/groups/refresh-an-employee-group\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.gowindmill.com/api-reference/groups/refresh-an-employee-group#apireference\",\"headline\":\"Refresh an employee group\",\"name\":\"Refresh an employee group\",\"description\":\"Refreshes a FILTER smart group from its saved rules or a SYNCED group from the integration data already stored in Windmill. It does not fetch new data from the connected provider. Returns archived:false with current group details. If the linked source is archived or inactive, the group is archived and the response contains archived:true and group:null. MANUAL and SCIM groups return 400. Requires permission to read and edit the group. A missing linked integration group returns 404.\",\"url\":\"https://help.gowindmill.com/api-reference/groups/refresh-an-employee-group\",\"mainEntityOfPage\":{\"@id\":\"https://help.gowindmill.com/api-reference/groups/refresh-an-employee-group#webpage\"},\"dateModified\":\"2026-11-19T14:24:43.978Z\",\"publisher\":{\"@id\":\"https://help.gowindmill.com/#organization\"},\"isPartOf\":{\"@id\":\"https://help.gowindmill.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Windmill Help Site\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Windmill Help Site\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/groups/refresh-an-employee-group.md","siteName":"Windmill Help Site","nav":{"global":null,"tabs":[{"tab":"Platform","pages":[{"title":"Platform","href":""}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/integrations"}]},{"tab":"API reference","groups":[{"group":"Getting started","icon":"code","pages":[{"title":"API overview","href":"/api-reference/overview"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"OAuth","href":"/api-reference/oauth"},{"title":"Making requests","href":"/api-reference/making-requests"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Rate limits","href":"/api-reference/rate-limits"},{"title":"Versioning","href":"/api-reference/versioning"},{"title":"API changelog","href":"/api-reference/changelog"}]},{"group":"Endpoints","icon":"plug","pages":[{"group":"Employees","pages":[{"title":"Search employee profiles","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/employees/search","href":"/api-reference/employees/search-employee-profiles"},{"title":"Get an employee profile","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/employees/{employeeId}","href":"/api-reference/employees/get-an-employee-profile"},{"title":"Search employee IDs","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/employees/search/ids","href":"/api-reference/employees/search-employee-ids"},{"title":"Count matching employees","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/employees/count","href":"/api-reference/employees/count-matching-employees"},{"title":"Create an employee","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/employees","href":"/api-reference/employees/create-an-employee"},{"title":"Update an employee profile","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json patch /c/{companyId}/employees/{employeeId}","href":"/api-reference/employees/update-an-employee-profile"},{"title":"Set an employee's employment status","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json put /c/{companyId}/employees/{employeeId}/employment-status","href":"/api-reference/employees/set-an-employees-employment-status"},{"title":"Create employees in bulk","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/employees/bulk","href":"/api-reference/employees/create-employees-in-bulk"}]},{"group":"Field sources","pages":[{"title":"List available employee field sources","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/field-sources/available-sources","href":"/api-reference/employee-field-sources/list-available-employee-field-sources"},{"title":"List company employee field defaults","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/field-sources/defaults","href":"/api-reference/employee-field-sources/list-company-employee-field-defaults"},{"title":"List employee field source overrides","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/employees/{employeeId}/field-sources","href":"/api-reference/employee-field-sources/list-employee-field-source-overrides"},{"title":"Resolve effective employee field sources","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/field-sources/resolve","href":"/api-reference/employee-field-sources/resolve-effective-employee-field-sources"},{"title":"Set a company employee field source","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json put /c/{companyId}/field-sources/defaults/{fieldKey}","href":"/api-reference/employee-field-sources/set-a-company-employee-field-source"},{"title":"Set an employee field source override","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json put /c/{companyId}/employees/{employeeId}/field-sources/{fieldKey}","href":"/api-reference/employee-field-sources/set-an-employee-field-source-override"},{"title":"Remove an employee field source override","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json delete /c/{companyId}/employees/{employeeId}/field-sources/{fieldKey}","href":"/api-reference/employee-field-sources/remove-an-employee-field-source-override"},{"title":"Remove a company employee field default","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json delete /c/{companyId}/field-sources/defaults/{fieldKey}","href":"/api-reference/employee-field-sources/remove-a-company-employee-field-default"}]},{"group":"Groups","pages":[{"title":"List readable employee groups","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups","href":"/api-reference/groups/list-readable-employee-groups"},{"title":"Count readable employee groups","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/count","href":"/api-reference/groups/count-readable-employee-groups"},{"title":"Get an employee group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/{groupId}","href":"/api-reference/groups/get-an-employee-group"},{"title":"Create an employee group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups","href":"/api-reference/groups/create-an-employee-group"},{"title":"Update an employee group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json patch /c/{companyId}/groups/{groupId}","href":"/api-reference/groups/update-an-employee-group"},{"title":"List employees in a group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/{groupId}/members","href":"/api-reference/groups/list-employees-in-a-group"},{"title":"Count employee group members","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/{groupId}/members/count","href":"/api-reference/groups/count-employee-group-members"},{"title":"Add employees to a manual group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/{groupId}/members","href":"/api-reference/groups/add-employees-to-a-manual-group"},{"title":"Remove employees from a manual group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/{groupId}/members/remove","href":"/api-reference/groups/remove-employees-from-a-manual-group"},{"title":"Replace smart group employee rules","description":"Replaces all employee rules for a FILTER smart group that you can edit. Membership is updated before the response, which includes counts of employees added and removed. Rules cannot refer to other groups at any nesting level; relative start dates must use supported tenure ranges. The rules determine the entire employee list, so this request can both add and remove employees. Other group types return 400.","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json put /c/{companyId}/groups/{groupId}/rules","href":"/api-reference/groups/replace-smart-group-employee-rules"},{"title":"Refresh an employee group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/{groupId}/sync","href":"/api-reference/groups/refresh-an-employee-group"},{"title":"Replace employee group sharing","description":"Replaces sharing settings for everyone in the company, managers, selected employees, employee groups, and reporting subtrees. All five fields are required, with up to 500 entries per recipient list. An empty list removes that kind of direct sharing. Access supplied by workspace permissions and automations is retained, including edit access for members who can manage groups. Everyone who can edit can also read. Works for every group type and requires existing permission to edit the group. You can remove your own directly granted access.","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json put /c/{companyId}/groups/{groupId}/access","href":"/api-reference/groups/replace-employee-group-sharing"},{"title":"Upload and review a group member CSV","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/{groupId}/members/imports/uploads","href":"/api-reference/groups/upload-and-review-a-group-member-csv"},{"title":"Submit a reviewed group member import","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/{groupId}/members/imports","href":"/api-reference/groups/submit-a-reviewed-group-member-import"},{"title":"Get group member import progress","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/{groupId}/members/imports/{importId}","href":"/api-reference/groups/get-group-member-import-progress"},{"title":"Delete an employee group","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json delete /c/{companyId}/groups/{groupId}","href":"/api-reference/groups/delete-an-employee-group"}]},{"group":"Group categories","pages":[{"title":"List employee group categories","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/categories","href":"/api-reference/group-categories/list-employee-group-categories"},{"title":"Get an employee group category","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/categories/{categoryId}","href":"/api-reference/group-categories/get-an-employee-group-category"},{"title":"Create an employee group category","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/categories","href":"/api-reference/group-categories/create-an-employee-group-category"},{"title":"Update an employee group category","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json patch /c/{companyId}/groups/categories/{categoryId}","href":"/api-reference/group-categories/update-an-employee-group-category"},{"title":"Add employee groups to a category","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/categories/{categoryId}/groups","href":"/api-reference/group-categories/add-employee-groups-to-a-category"},{"title":"Remove employee groups from a category","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups/categories/{categoryId}/groups/remove","href":"/api-reference/group-categories/remove-employee-groups-from-a-category"},{"title":"Delete an employee group category","deprecated":null,"version":null,"openapi":"https://api.gowindmill.com/api/v2/openapi.json delete /c/{companyId}/groups/categories/{categoryId}","href":"/api-reference/group-categories/delete-an-employee-group-category"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Best practices","pages":[{"title":"Best practices","href":"/introducing-windmill"}]}]},"basePath":"","title":"Refresh an employee group - Windmill Help Site","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}