{"docsConfig":{"theme":"sequoia","$schema":"https://mintlify.com/docs.json","name":"Siit API Reference","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/siit-79/RWwwEa8457bnWNSb/logo/Logo_Siit_Green.png?fit=max\u0026auto=format\u0026n=RWwwEa8457bnWNSb\u0026q=85\u0026s=65469e302ddb3bab0d6e830e6f350265","dark":"https://mintcdn.com/siit-79/RWwwEa8457bnWNSb/logo/Logo_Siit_White.png?fit=max\u0026auto=format\u0026n=RWwwEa8457bnWNSb\u0026q=85\u0026s=51b7b80adf39946c3e0c4028a0413201"},"favicon":"https://mintcdn.com/siit-79/RWwwEa8457bnWNSb/favicon.png?fit=max\u0026auto=format\u0026n=RWwwEa8457bnWNSb\u0026q=85\u0026s=15d69af236bb4413289e7958c15af45e","api":{"openapi":"api-reference/openapi.yml"},"navbar":{"links":[{"icon":"timeline","href":"https://www.siit.io/changelog","label":"Changelog"},{"icon":"newspaper","href":"https://www.siit.io/blog","label":"Blog"},{"icon":"info","href":"https://help.siit.io","label":"Help center"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.siit.io"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/siit-app","instagram":"https://www.instagram.com/siit_app","github":"https://github.com/siitapp","twitter":"https://x.com/siitapp"}},"styling":{"eyebrows":"breadcrumbs","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"siit-79","hasAudioNarration":false,"actualSubdomain":"siit-79","customDomains":["developer.siit.io"],"gitSource":{"type":"github","owner":"siitapp","repo":"siit-public-api-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad8ad1493e72255238cb672","collectionId":"e53d40ba-f9fd-4691-b20a-e3209067fd7e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad8ad1493e72255238cb672"},"entitlements":{"REMOVE_BRANDING":{"status":"ENABLED"}},"buildId":"6ad8ad1493e72255238cb672","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":110},{"language":"default","tag":"Request","count":18},{"language":"default","tag":"Application","count":11},{"language":"default","tag":"Custom Integrations","count":10},{"language":"default","tag":"Article","count":9},{"language":"default","tag":"User","count":8},{"language":"default","tag":"Equipment","count":7},{"language":"default","tag":"App Access Role","count":6},{"language":"default","tag":"Get Started","count":6},{"language":"default","tag":"Department","count":5}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/user/list-users","slug":"/api-reference/user/list-users","pageMetadata":{"openapi":"get /v1/users","title":"List Users","description":"Fetch Users","href":"/api-reference/user/list-users"},"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: \"Fetch Users\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={em:`em`,li:`li`,ol:`ol`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`introduction`,children:`Introduction`}),`\n`,_jsx(_components.p,{children:`Notes:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Fields that are disabled or restricted will `,_jsx(_components.em,{children:`not`}),` be returned.`]}),`\n`,_jsxs(_components.li,{children:[`Archived users are `,_jsx(_components.strong,{children:`NOT`}),` returned by default.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`usage`,children:`Usage`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /v1/users","title":"List Users","description":"Fetch Users","href":"/api-reference/user/list-users"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Introduction","slug":"introduction","depth":2,"children":[]},{"title":"Usage","slug":"usage","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"List Users","description":"Fetch Users","tags":["User"],"security":["8270ee87-1f78-4442-94e4-41150566b009"],"parameters":["e3b0b952-1e4f-46bc-95a8-a87991d9d7e9","1572128b-dab8-440b-9b48-d646ecdede2c","d326c402-d7bb-46da-9d71-12256b9cb36b","44ac12c0-2518-49c9-ab54-2489b0a17976","19ed2bf7-2a31-4904-89d7-27465f8204fd","e178e86f-8aa5-4d7e-948f-e0fd53b989c2","4bc830f0-e61e-4820-9e92-438651aa4fb7","0d8c0153-3a3e-4516-b753-b0e1b04da9e0","d7358c49-b4a6-4811-89a7-8bcbd76797fb","749c718b-a3ba-4e97-ad66-6d6bcf401c7b","4ea4242f-26b7-4643-b5ce-7819c6672f7f","1016fd6c-899f-4fdd-9e44-19f7f58abb72","ef734b3c-fa91-4127-a92a-25903cffa8e9","6d385406-ef97-4578-8768-62b8cfa2e9a4","30ae22db-156e-4194-87e0-20c79bebc6ff","3de44245-753f-4734-855e-e452d3f637f5","8b2a6726-08c8-4c16-ad46-2b13b99ab31f","0b630b3e-bfa2-4f44-9ff6-35d85681a86f","b3cb4afe-7635-4c2b-b4c2-414f1e8fd337"],"responses":{"200":"8425a2b1-7483-482f-952c-3ffc5c1663c0","400":"fffa8553-5d17-40ec-ab56-45b17f02a32a","401":"9c9734ca-3495-4f8b-96c0-0fef1ac5fe96"},"method":"get","type":"path","servers":["b8ae7231-db68-4bca-b40f-eed521434a49"],"path":"/v1/users","baseUrlOptions":["https://api.siit.io"],"title":"List Users","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e3b0b952-1e4f-46bc-95a8-a87991d9d7e9":{"name":"expand[]","in":"query","schema":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"isRequired":false,"description":"Fields to expand into full objects. Example: ?expand[]=assignee_admin\u0026expand[]=tags","uniqueKey":"","typeLabel":"string[]"},"description":"Fields to expand into full objects. Example: ?expand[]=assignee_admin\u0026expand[]=tags","required":false},"1572128b-dab8-440b-9b48-d646ecdede2c":{"name":"search","in":"query","required":false,"description":"Free-text search across name and email addresses.","schema":{"type":"string","isRequired":false,"description":"Free-text search across name and email addresses.","uniqueKey":"","typeLabel":"string"}},"d326c402-d7bb-46da-9d71-12256b9cb36b":{"name":"email_in[]","in":"query","schema":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"isRequired":false,"description":"Filter by User's work emails.","uniqueKey":"","typeLabel":"string[]"},"required":false,"style":"form","explode":true,"description":"Filter by User's work emails."},"44ac12c0-2518-49c9-ab54-2489b0a17976":{"name":"personal_email_in[]","in":"query","schema":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"isRequired":false,"description":"Filter by User's personal email.","uniqueKey":"","typeLabel":"string[]"},"required":false,"style":"form","explode":true,"description":"Filter by User's personal email."},"19ed2bf7-2a31-4904-89d7-27465f8204fd":{"name":"status_in[]","in":"query","schema":{"type":"array","items":{"type":"string","enum":["alumni","employee","external","hired"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Filter by User's status.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"},"required":false,"style":"form","explode":true,"description":"Filter by User's status."},"e178e86f-8aa5-4d7e-948f-e0fd53b989c2":{"name":"role_in[]","in":"query","schema":{"type":"array","items":{"type":"string","enum":["owner","admin","it","hr","ops","finance","custom","user"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Filter by User's role.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"},"required":false,"style":"form","explode":true,"description":"Filter by User's role."},"4bc830f0-e61e-4820-9e92-438651aa4fb7":{"name":"employee_number_eq","in":"query","schema":{"type":"string","isRequired":false,"description":"Only returns users with matcher `employee_number`.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Only returns users with matcher `employee_number`."},"0d8c0153-3a3e-4516-b753-b0e1b04da9e0":{"name":"team_uid","in":"query","schema":{"type":"string","isRequired":false,"description":"Only returns members of the Team with this UID, or users in no Team with `none`.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Only returns members of the Team with this UID, or users in no Team with `none`."},"d7358c49-b4a6-4811-89a7-8bcbd76797fb":{"name":"department_uid","in":"query","schema":{"type":"string","isRequired":false,"description":"Only returns members of the Department with this UID, or users in no Department with `none`.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Only returns members of the Department with this UID, or users in no Department with `none`."},"749c718b-a3ba-4e97-ad66-6d6bcf401c7b":{"name":"office_location_uid","in":"query","schema":{"type":"string","isRequired":false,"description":"Only returns members of the Office Location with this UID, or users in no Office Location with `none`.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Only returns members of the Office Location with this UID, or users in no Office Location with `none`."},"4ea4242f-26b7-4643-b5ce-7819c6672f7f":{"name":"legal_entity_uid","in":"query","schema":{"type":"string","isRequired":false,"description":"Only returns members of the Legal Entity with this UID, or users in no Legal Entity with `none`.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Only returns members of the Legal Entity with this UID, or users in no Legal Entity with `none`."},"1016fd6c-899f-4fdd-9e44-19f7f58abb72":{"name":"include_archived","in":"query","schema":{"type":"boolean","default":false,"isRequired":false,"description":"Whether the response should include archived users.","uniqueKey":"","typeLabel":"boolean"},"required":false,"description":"Whether the response should include archived users."},"ef734b3c-fa91-4127-a92a-25903cffa8e9":{"name":"created_after","in":"query","schema":{"type":"string","format":"date-time","isRequired":false,"description":"Filter Users created after a DateTime (ISO 8601).","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"description":"Filter Users created after a DateTime (ISO 8601)."},"6d385406-ef97-4578-8768-62b8cfa2e9a4":{"name":"created_before","in":"query","schema":{"type":"string","format":"date-time","isRequired":false,"description":"Filter Users created before a DateTime (ISO 8601).","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"description":"Filter Users created before a DateTime (ISO 8601)."},"30ae22db-156e-4194-87e0-20c79bebc6ff":{"name":"updated_after","in":"query","schema":{"type":"string","format":"date-time","isRequired":false,"description":"Filter Users updated after a DateTime (ISO 8601).","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"description":"Filter Users updated after a DateTime (ISO 8601)."},"3de44245-753f-4734-855e-e452d3f637f5":{"name":"updated_before","in":"query","schema":{"type":"string","format":"date-time","isRequired":false,"description":"Filter Users updated before a DateTime (ISO 8601).","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"description":"Filter Users updated before a DateTime (ISO 8601)."},"8b2a6726-08c8-4c16-ad46-2b13b99ab31f":{"name":"metadata","in":"query","schema":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"additionalProperties","typeLabel":"string"},"isRequired":false,"description":"Filter by exact metadata key/value pairs (e.g. ?metadata[environment]=production). Several pairs combine with AND.","uniqueKey":"","typeLabel":"object"},"required":false,"style":"deepObject","explode":true,"description":"Filter by exact metadata key/value pairs (e.g. ?metadata[environment]=production). Several pairs combine with AND."},"0b630b3e-bfa2-4f44-9ff6-35d85681a86f":{"name":"page","in":"query","required":false,"description":"The current page","schema":{"type":"integer","isRequired":false,"description":"The current page","uniqueKey":"","typeLabel":"integer"}},"b3cb4afe-7635-4c2b-b4c2-414f1e8fd337":{"name":"per_page","in":"query","required":false,"description":"Number of results retrieved per page.","schema":{"type":"integer","isRequired":false,"description":"Number of results retrieved per page.","uniqueKey":"","typeLabel":"integer"}}},"responses":{"8425a2b1-7483-482f-952c-3ffc5c1663c0":{"description":"Successful","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"count":{"type":"integer","uniqueKey":"meta.count","typeLabel":"integer"},"current_page":{"type":"integer","uniqueKey":"meta.current_page","typeLabel":"integer"},"next_page_link":{"oneOf":[{"type":"string","uniqueKey":"meta.next_page_link.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"meta.next_page_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.next_page_link","typeLabel":"string | null"},"per_page":{"type":"integer","default":20,"maximum":200,"uniqueKey":"meta.per_page","typeLabel":"integer"},"previous_page_link":{"oneOf":[{"type":"string","uniqueKey":"meta.previous_page_link.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"meta.previous_page_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.previous_page_link","typeLabel":"string | null"},"total":{"type":"integer","uniqueKey":"meta.total","typeLabel":"integer"}},"uniqueKey":"meta","typeLabel":"object"},"results":{"type":"array","items":{"type":"object","properties":{"birthday_date":{"oneOf":[{"type":"string","format":"date","description":"date formatted as ISO 8601 (e.g. \"2020-12-15\")","uniqueKey":"results.items.[INDEX].birthday_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"date formatted as ISO 8601 (e.g. \"2020-12-15\")","uniqueKey":"results.items.[INDEX].birthday_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].birthday_date","typeLabel":"string\u003cdate> | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"results.items.[INDEX].city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.items.[INDEX].city.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].city","typeLabel":"string | null"},"contract_type":{"oneOf":[{"type":"string","enum":["contract","expat","fulltime","intern","parttime","temporary"],"uniqueKey":"results.items.[INDEX].contract_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["contract","expat","fulltime","intern","parttime","temporary"],"uniqueKey":"results.items.[INDEX].contract_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].contract_type","typeLabel":"enum\u003cstring> | null"},"country":{"oneOf":[{"type":"string","description":"ISO3166 alpha-2 country code (e.g: \"PT\")","uniqueKey":"results.items.[INDEX].country.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO3166 alpha-2 country code (e.g: \"PT\")","uniqueKey":"results.items.[INDEX].country.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].country","typeLabel":"string | null"},"employee_number":{"oneOf":[{"type":"string","uniqueKey":"results.items.[INDEX].employee_number.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.items.[INDEX].employee_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].employee_number","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","uniqueKey":"results.items.[INDEX].first_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.items.[INDEX].first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].first_name","typeLabel":"string | null"},"gender":{"oneOf":[{"type":"string","enum":["female","male","non_binary","other","prefer_not_to_disclose"],"uniqueKey":"results.items.[INDEX].gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["female","male","non_binary","other","prefer_not_to_disclose"],"uniqueKey":"results.items.[INDEX].gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].gender","typeLabel":"enum\u003cstring> | null"},"hire_date":{"oneOf":[{"type":"string","format":"date","description":"date formatted as ISO 8601 (e.g. \"2020-12-15\")","uniqueKey":"results.items.[INDEX].hire_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"date formatted as ISO 8601 (e.g. \"2020-12-15\")","uniqueKey":"results.items.[INDEX].hire_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].hire_date","typeLabel":"string\u003cdate> | null"},"job_leave_date":{"oneOf":[{"type":"string","format":"date","description":"date formatted as ISO 8601 (e.g. \"2020-12-15\")","uniqueKey":"results.items.[INDEX].job_leave_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"date formatted as ISO 8601 (e.g. \"2020-12-15\")","uniqueKey":"results.items.[INDEX].job_leave_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].job_leave_date","typeLabel":"string\u003cdate> | null"},"job_start_date":{"oneOf":[{"type":"string","format":"date","description":"date formatted as ISO 8601 (e.g. \"2020-12-15\")","uniqueKey":"results.items.[INDEX].job_start_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"date formatted as ISO 8601 (e.g. \"2020-12-15\")","uniqueKey":"results.items.[INDEX].job_start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].job_start_date","typeLabel":"string\u003cdate> | null"},"job_title":{"oneOf":[{"type":"string","uniqueKey":"results.items.[INDEX].job_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.items.[INDEX].job_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].job_title","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"results.items.[INDEX].last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.items.[INDEX].last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].last_name","typeLabel":"string | null"},"last_working_date":{"oneOf":[{"type":"string","format":"date","description":"date formatted as ISO 8601 (e.g. \"2020-12-15\")","uniqueKey":"results.items.[INDEX].last_working_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"date formatted as ISO 8601 (e.g. \"2020-12-15\")","uniqueKey":"results.items.[INDEX].last_working_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].last_working_date","typeLabel":"string\u003cdate> | null"},"metadata":{"type":"object","description":"Arbitrary key/value pairs attached to the User (max 10 keys, string values of at most 255 characters). Passed keys are merged into the existing metadata: absent keys are preserved, passing a key with an empty or null value removes it, and passing metadata as an empty string removes all keys.","maxProperties":10,"additionalProperties":{"type":"string","maxLength":255,"uniqueKey":"results.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"results.items.[INDEX].metadata","typeLabel":"object"},"preferred_language":{"oneOf":[{"type":"string","description":"A language in IETF format (en-US, pt-PT, fr-FR...)","uniqueKey":"results.items.[INDEX].preferred_language.oneOf.0","typeLabel":"string"},{"type":"null","description":"A language in IETF format (en-US, pt-PT, fr-FR...)","uniqueKey":"results.items.[INDEX].preferred_language.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].preferred_language","typeLabel":"string | null"},"probation_end_date":{"oneOf":[{"type":"string","format":"date","description":"date formatted as ISO 8601 (e.g. \"2020-12-15\")","uniqueKey":"results.items.[INDEX].probation_end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"date formatted as ISO 8601 (e.g. \"2020-12-15\")","uniqueKey":"results.items.[INDEX].probation_end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].probation_end_date","typeLabel":"string\u003cdate> | null"},"work_phone":{"oneOf":[{"type":"string","uniqueKey":"results.items.[INDEX].work_phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.items.[INDEX].work_phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].work_phone","typeLabel":"string | null"},"uid":{"type":"string","description":"The UID of the User","readOnly":true,"uniqueKey":"results.items.[INDEX].uid","typeLabel":"string"},"admin_permalink_url":{"type":"string","description":"The link to the User in Siit admin dashboard","readOnly":true,"uniqueKey":"results.items.[INDEX].admin_permalink_url","typeLabel":"string"},"archived_at":{"oneOf":[{"type":"string","format":"date-time","readOnly":true,"description":"datetime formatted as ISO 8601 (e.g. \"2020-12-15T03:34:13.000Z\")","uniqueKey":"results.items.[INDEX].archived_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","readOnly":true,"description":"datetime formatted as ISO 8601 (e.g. \"2020-12-15T03:34:13.000Z\")","uniqueKey":"results.items.[INDEX].archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].archived_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","description":"datetime formatted as ISO 8601 (e.g. \"2020-12-15T03:34:13.000Z\")","readOnly":true,"uniqueKey":"results.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"department":{"oneOf":[{"type":"string","description":"The department this user belongs to. Pass `?expand[]=field_name` for full object.","uniqueKey":"results.items.[INDEX].department.oneOf.0","typeLabel":"string"},{"type":"object","description":"The department this user belongs to. Pass `?expand[]=field_name` for full object.","properties":{"uid":{"type":"string","readOnly":true,"description":"The UID of the Department","uniqueKey":"results.items.[INDEX].department.oneOf.1.uid","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"datetime formatted as ISO 8601 (e.g. \"2020-12-15T03:34:13.000Z\")","readOnly":true,"uniqueKey":"results.items.[INDEX].department.oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"datetime formatted as ISO 8601 (e.g. \"2020-12-15T03:34:13.000Z\")","readOnly":true,"uniqueKey":"results.items.[INDEX].department.oneOf.1.updated_at","typeLabel":"string\u003cdate-time>"},"value":{"type":"string","description":"The Department name","uniqueKey":"results.items.[INDEX].department.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].department.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"results.items.[INDEX].department.oneOf.2","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].department","typeLabel":"string | object | null"},"department_uid":{"oneOf":[{"type":"string","description":"DEPRECATED: Use `department` instead. A Department UID","deprecated":true,"uniqueKey":"results.items.[INDEX].department_uid.oneOf.0","typeLabel":"string"},{"type":"null","description":"DEPRECATED: Use `department` instead. A Department UID","deprecated":true,"uniqueKey":"results.items.[INDEX].department_uid.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].department_uid","typeLabel":"string | null"},"emails":{"type":"array","description":"An array of all the known emails for this User","readOnly":true,"items":{"type":"string","uniqueKey":"results.items.[INDEX].emails.items.[INDEX]","typeLabel":"string"},"uniqueKey":"results.items.[INDEX].emails","typeLabel":"string[]"},"full_name":{"oneOf":[{"type":"string","description":"The full name of the User","readOnly":true,"uniqueKey":"results.items.[INDEX].full_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full name of the User","readOnly":true,"uniqueKey":"results.items.[INDEX].full_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].full_name","typeLabel":"string | null"},"legal_entity":{"oneOf":[{"type":"string","description":"The legal entity this user belongs to. Pass `?expand[]=field_name` for full object.","uniqueKey":"results.items.[INDEX].legal_entity.oneOf.0","typeLabel":"string"},{"type":"object","description":"The legal entity this user belongs to. Pass `?expand[]=field_name` for full object.","properties":{"uid":{"type":"string","readOnly":true,"description":"The UID of the Legal Entity","uniqueKey":"results.items.[INDEX].legal_entity.oneOf.1.uid","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"datetime formatted as ISO 8601 (e.g. \"2020-12-15T03:34:13.000Z\")","readOnly":true,"uniqueKey":"results.items.[INDEX].legal_entity.oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"datetime formatted as ISO 8601 (e.g. \"2020-12-15T03:34:13.000Z\")","readOnly":true,"uniqueKey":"results.items.[INDEX].legal_entity.oneOf.1.updated_at","typeLabel":"string\u003cdate-time>"},"value":{"type":"string","description":"The Legal Entity name","uniqueKey":"results.items.[INDEX].legal_entity.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].legal_entity.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"results.items.[INDEX].legal_entity.oneOf.2","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].legal_entity","typeLabel":"string | object | null"},"legal_entity_uid":{"oneOf":[{"type":"string","description":"DEPRECATED: Use `legal_entity` instead. A Legal Entity UID","deprecated":true,"uniqueKey":"results.items.[INDEX].legal_entity_uid.oneOf.0","typeLabel":"string"},{"type":"null","description":"DEPRECATED: Use `legal_entity` instead. A Legal Entity UID","deprecated":true,"uniqueKey":"results.items.[INDEX].legal_entity_uid.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].legal_entity_uid","typeLabel":"string | null"},"microsoft_entra_ids":{"description":"The Microsoft Entra IDs (Azure Directory) associated with that User","type":"array","readOnly":true,"items":{"type":"string","uniqueKey":"results.items.[INDEX].microsoft_entra_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"results.items.[INDEX].microsoft_entra_ids","typeLabel":"string[]"},"microsoft_entra_group_ids":{"description":"The Microsoft Entra Group IDs (Azure Directory) associated to that User","type":"array","readOnly":true,"items":{"type":"string","uniqueKey":"results.items.[INDEX].microsoft_entra_group_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"results.items.[INDEX].microsoft_entra_group_ids","typeLabel":"string[]"},"office_location":{"oneOf":[{"type":"string","description":"The office location of this user. Pass `?expand[]=field_name` for full object.","uniqueKey":"results.items.[INDEX].office_location.oneOf.0","typeLabel":"string"},{"type":"object","description":"The office location of this user. Pass `?expand[]=field_name` for full object.","properties":{"uid":{"type":"string","readOnly":true,"description":"The UID of the Office Location","uniqueKey":"results.items.[INDEX].office_location.oneOf.1.uid","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"datetime formatted as ISO 8601 (e.g. \"2020-12-15T03:34:13.000Z\")","readOnly":true,"uniqueKey":"results.items.[INDEX].office_location.oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"datetime formatted as ISO 8601 (e.g. \"2020-12-15T03:34:13.000Z\")","readOnly":true,"uniqueKey":"results.items.[INDEX].office_location.oneOf.1.updated_at","typeLabel":"string\u003cdate-time>"},"value":{"type":"string","description":"The Office Location name","uniqueKey":"results.items.[INDEX].office_location.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].office_location.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"results.items.[INDEX].office_location.oneOf.2","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].office_location","typeLabel":"string | object | null"},"office_location_uid":{"oneOf":[{"type":"string","description":"DEPRECATED: Use `office_location` instead. An Office Location UID","deprecated":true,"uniqueKey":"results.items.[INDEX].office_location_uid.oneOf.0","typeLabel":"string"},{"type":"null","description":"DEPRECATED: Use `office_location` instead. An Office Location UID","deprecated":true,"uniqueKey":"results.items.[INDEX].office_location_uid.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].office_location_uid","typeLabel":"string | null"},"report_to":{"oneOf":[{"type":"string","description":"The manager of this user. Pass `?expand[]=field_name` for full object.","uniqueKey":"results.items.[INDEX].report_to.oneOf.0","typeLabel":"string"},{"description":"The manager of this user. Pass `?expand[]=field_name` for full object.","uniqueKey":"results.items.[INDEX].report_to.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"results.items.[INDEX].report_to.oneOf.2","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].report_to","typeLabel":"string | any | null"},"report_to_uid":{"oneOf":[{"type":"string","description":"DEPRECATED: Use `report_to` instead. The UID of the manager of this user","deprecated":true,"uniqueKey":"results.items.[INDEX].report_to_uid.oneOf.0","typeLabel":"string"},{"type":"null","description":"DEPRECATED: Use `report_to` instead. The UID of the manager of this user","deprecated":true,"uniqueKey":"results.items.[INDEX].report_to_uid.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].report_to_uid","typeLabel":"string | null"},"role_name":{"type":"string","description":"The role of the User","readOnly":true,"enum":["owner","admin","it","hr","ops","finance","custom","user"],"uniqueKey":"results.items.[INDEX].role_name","typeLabel":"enum\u003cstring>"},"slack_user_id":{"oneOf":[{"type":"string","description":"The Slack user ID of the User (e.g. U0G9QF9C6)","readOnly":true,"uniqueKey":"results.items.[INDEX].slack_user_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Slack user ID of the User (e.g. U0G9QF9C6)","readOnly":true,"uniqueKey":"results.items.[INDEX].slack_user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].slack_user_id","typeLabel":"string | null"},"status":{"type":"string","description":"The status of the User","readOnly":true,"enum":["alumni","employee","external","hired"],"default":"employee","uniqueKey":"results.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"team_uids":{"type":"array","description":"DEPRECATED: Use `teams` instead. An array of Team UIDs","items":{"type":"string","uniqueKey":"results.items.[INDEX].team_uids.items.[INDEX]","typeLabel":"string"},"deprecated":true,"uniqueKey":"results.items.[INDEX].team_uids","typeLabel":"string[]"},"teams":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"results.items.[INDEX].teams.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Teams this user belongs to. Pass `?expand[]=field_name` for full objects.","uniqueKey":"results.items.[INDEX].teams.oneOf.0","typeLabel":"string[]"},{"type":"array","items":{"type":"object","properties":{"uid":{"type":"string","readOnly":true,"description":"The UID of the Team","uniqueKey":"results.items.[INDEX].teams.oneOf.1.items.[INDEX].uid","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"datetime formatted as ISO 8601 (e.g. \"2020-12-15T03:34:13.000Z\")","readOnly":true,"uniqueKey":"results.items.[INDEX].teams.oneOf.1.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"datetime formatted as ISO 8601 (e.g. \"2020-12-15T03:34:13.000Z\")","readOnly":true,"uniqueKey":"results.items.[INDEX].teams.oneOf.1.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"value":{"type":"string","description":"The Team name","uniqueKey":"results.items.[INDEX].teams.oneOf.1.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].teams.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"Teams this user belongs to. Pass `?expand[]=field_name` for full objects.","uniqueKey":"results.items.[INDEX].teams.oneOf.1","typeLabel":"object[]"},{"type":"null","uniqueKey":"results.items.[INDEX].teams.oneOf.2","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].teams","typeLabel":"string[] | object[] | null"},"timezone":{"oneOf":[{"type":"string","description":"","readOnly":true,"uniqueKey":"results.items.[INDEX].timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"","readOnly":true,"uniqueKey":"results.items.[INDEX].timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].timezone","typeLabel":"string | null"},"updated_at":{"type":"string","format":"date-time","description":"datetime formatted as ISO 8601 (e.g. \"2020-12-15T03:34:13.000Z\")","readOnly":true,"uniqueKey":"results.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"meta":{"count":123,"current_page":123,"next_page_link":"\u003cstring>","per_page":20,"previous_page_link":"\u003cstring>","total":123},"results":[{"birthday_date":"2023-12-25","city":"\u003cstring>","contract_type":"contract","country":"\u003cstring>","employee_number":"\u003cstring>","first_name":"\u003cstring>","gender":"female","hire_date":"2023-12-25","job_leave_date":"2023-12-25","job_start_date":"2023-12-25","job_title":"\u003cstring>","last_name":"\u003cstring>","last_working_date":"2023-12-25","metadata":{},"preferred_language":"\u003cstring>","probation_end_date":"2023-12-25","work_phone":"\u003cstring>","uid":"\u003cstring>","admin_permalink_url":"\u003cstring>","archived_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","department":"\u003cstring>","department_uid":"\u003cstring>","emails":["\u003cstring>"],"full_name":"\u003cstring>","legal_entity":"\u003cstring>","legal_entity_uid":"\u003cstring>","microsoft_entra_ids":["\u003cstring>"],"microsoft_entra_group_ids":["\u003cstring>"],"office_location":"\u003cstring>","office_location_uid":"\u003cstring>","report_to":"\u003cstring>","report_to_uid":"\u003cstring>","role_name":"owner","slack_user_id":"\u003cstring>","status":"employee","team_uids":["\u003cstring>"],"teams":["\u003cstring>"],"timezone":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"fffa8553-5d17-40ec-ab56-45b17f02a32a":{"description":"Invalid filter: blank or several people group UIDs, or an unknown status_in / role_in value","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"troubleshoot":{"type":"string","uniqueKey":"troubleshoot","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","troubleshoot":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9c9734ca-3495-4f8b-96c0-0fef1ac5fe96":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"8270ee87-1f78-4442-94e4-41150566b009":{"bearer":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer"}}},"servers":{"b8ae7231-db68-4bca-b40f-eed521434a49":{"url":"https://api.siit.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.yml"},"subdomain":"siit-79","siteName":"Siit API Reference","title":"List Users - Siit API Reference","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-17T11:27:09.040Z","originalFileLocation":"api-reference/user/list-users.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=\"Fetch Users\">\u003cmeta data-mint-head name=\"application-name\" content=\"Siit API Reference\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/siit-79/JpruI7zJCo0K1tE9/_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/siit-79/JpruI7zJCo0K1tE9/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/siit-79/JpruI7zJCo0K1tE9/_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/siit-79/JpruI7zJCo0K1tE9/_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/siit-79/JpruI7zJCo0K1tE9/_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/siit-79/JpruI7zJCo0K1tE9/_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/siit-79/JpruI7zJCo0K1tE9/_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/siit-79/JpruI7zJCo0K1tE9/_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/siit-79/JpruI7zJCo0K1tE9/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Users - Siit API Reference\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch Users\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Siit API Reference\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.siit.io/api-reference/user/list-users\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://siit-79.mintlify.app/_mintlify/api/og/v2?division=User\u0026amp;title=List+Users\u0026amp;description=Fetch+Users\u0026amp;theme=12875ae86032456079f16e37\u0026amp;signature=584887a92bc7132cb07905a4c06e6cb4cffd1c86b69d0529d974675a5d22b27b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List Users - Siit API Reference\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch Users\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://siit-79.mintlify.app/_mintlify/api/og/v2?division=User\u0026amp;title=List+Users\u0026amp;description=Fetch+Users\u0026amp;theme=12875ae86032456079f16e37\u0026amp;signature=584887a92bc7132cb07905a4c06e6cb4cffd1c86b69d0529d974675a5d22b27b\">\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/siit-79/JpruI7zJCo0K1tE9/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Siit API Reference\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.siit.io/api-reference/user/list-users\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/user/list-users.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.siit.io/#organization\",\"name\":\"Siit API Reference\",\"url\":\"https://developer.siit.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/siit-79/RWwwEa8457bnWNSb/logo/Logo_Siit_Green.png?fit=max\u0026auto=format\u0026n=RWwwEa8457bnWNSb\u0026q=85\u0026s=65469e302ddb3bab0d6e830e6f350265\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.siit.io#website\",\"name\":\"Siit API Reference\",\"url\":\"https://developer.siit.io\",\"publisher\":{\"@id\":\"https://developer.siit.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.siit.io/api-reference/user/list-users#webpage\",\"url\":\"https://developer.siit.io/api-reference/user/list-users\",\"name\":\"List Users\",\"description\":\"Fetch Users\",\"dateModified\":\"2025-09-17T11:27:09.040Z\",\"isPartOf\":{\"@id\":\"https://developer.siit.io#website\"},\"breadcrumb\":{\"@id\":\"https://developer.siit.io/api-reference/user/list-users#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.siit.io/api-reference/user/list-users#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Siit API Reference\",\"item\":\"https://developer.siit.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Users\",\"item\":\"https://developer.siit.io/api-reference/user/list-users\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.siit.io/api-reference/user/list-users#apireference\",\"headline\":\"List Users\",\"name\":\"List Users\",\"description\":\"Fetch Users\",\"url\":\"https://developer.siit.io/api-reference/user/list-users\",\"mainEntityOfPage\":{\"@id\":\"https://developer.siit.io/api-reference/user/list-users#webpage\"},\"dateModified\":\"2025-09-17T11:27:09.040Z\",\"publisher\":{\"@id\":\"https://developer.siit.io/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.siit.io#website\"}}]}\u003c/script>","siteName":"Siit API Reference","nav":{"global":null,"anchors":[{"anchor":"API Reference","groups":[{"group":"Get Started","pages":[{"title":"Siit Developers","href":""},{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Errors","href":"/api-reference/errors"},{"title":"MCP Server","href":"/api-reference/mcp"}]},{"group":"Application","pages":[{"openapi":"get /v1/applications","title":"List Applications","href":"/api-reference/application/list-applications"},{"openapi":"post /v1/applications","title":"Create Application","href":"/api-reference/application/create-application"},{"openapi":"get /v1/applications/{uid}","title":"Retrieve an Application","href":"/api-reference/application/retrieve-an-application"},{"openapi":"put /v1/applications/{uid}","title":"Update an Application","href":"/api-reference/application/update-an-application"},{"openapi":"patch /v1/applications/{uid}/archive","title":"Archive an Application","href":"/api-reference/application/archive-an-application"},{"openapi":"patch /v1/applications/{uid}/unarchive","title":"Unarchive an Application","href":"/api-reference/application/unarchive-an-application"},{"openapi":"get /v1/applications/{uid}/users","title":"List Users of an Application","href":"/api-reference/application/list-users-of-an-application"},{"openapi":"post /v1/applications/{uid}/users","title":"Add a User to an Application","href":"/api-reference/application/add-a-user-to-an-application"},{"openapi":"delete /v1/applications/{uid}/users/{id}","title":"Remove a User from an Application","href":"/api-reference/application/remove-a-user-from-an-application"},{"openapi":"post /v1/applications/{uid}/instances","title":"Create an Application Instance","href":"/api-reference/application-instance/create-an-application-instance"},{"openapi":"delete /v1/applications/{uid}/instances/{instance_uid}","title":"Delete an Application Instance","href":"/api-reference/application-instance/delete-an-application-instance"}]},{"group":"App Access Role","pages":[{"openapi":"get /v1/app_access/roles","title":"List App Access Roles","href":"/api-reference/app-access-role/list-app-access-roles"},{"openapi":"post /v1/app_access/roles","title":"Create an App Access Role","href":"/api-reference/app-access-role/create-an-app-access-role"},{"openapi":"get /v1/app_access/roles/provisioning_actions_schema","title":"Retrieve the App Access Role actions JSON Schema","href":"/api-reference/app-access-role/retrieve-the-app-access-role-actions-json-schema"},{"openapi":"get /v1/app_access/roles/{uid}","title":"Retrieve an App Access Role","href":"/api-reference/app-access-role/retrieve-an-app-access-role"},{"openapi":"put /v1/app_access/roles/{uid}","title":"Update an App Access Role","href":"/api-reference/app-access-role/update-an-app-access-role"},{"openapi":"delete /v1/app_access/roles/{uid}","title":"Delete an App Access Role","href":"/api-reference/app-access-role/delete-an-app-access-role"}]},{"group":"Article","pages":[{"openapi":"get /v1/articles","title":"List all Articles","href":"/api-reference/article/list-all-articles"},{"openapi":"post /v1/articles","title":"Create an Article","href":"/api-reference/article/create-an-article"},{"openapi":"get /v1/articles/{uid}","title":"Retrieve an Article","href":"/api-reference/article/retrieve-an-article"},{"openapi":"put /v1/articles/{uid}","title":"Update an Article","href":"/api-reference/article/update-an-article"},{"openapi":"patch /v1/articles/{uid}/publish","title":"Publish an Article","href":"/api-reference/article/publish-an-article"},{"openapi":"patch /v1/articles/{uid}/unpublish","title":"Unpublish an Article","href":"/api-reference/article/unpublish-an-article"},{"openapi":"patch /v1/articles/{uid}/archive","title":"Archive an Article","href":"/api-reference/article/archive-an-article"},{"openapi":"patch /v1/articles/{uid}/unarchive","title":"Unarchive an Article","href":"/api-reference/article/unarchive-an-article"},{"openapi":"get /v1/articles/categories","title":"List Categories","href":"/api-reference/article/list-categories"}]},{"group":"Company","pages":[{"openapi":"get /v1/company","title":"Retrieve the current Company","href":"/api-reference/company/retrieve-the-current-company"}]},{"group":"Department","pages":[{"openapi":"get /v1/departments","title":"List Departments","href":"/api-reference/department/list-departments"},{"openapi":"post /v1/departments","title":"Create a Department","href":"/api-reference/department/create-a-department"},{"openapi":"get /v1/departments/{uid}","title":"Retrieve a Department","href":"/api-reference/department/retrieve-a-department"},{"openapi":"put /v1/departments/{uid}","title":"Update a Department","href":"/api-reference/department/update-a-department"},{"openapi":"delete /v1/departments/{uid}","title":"Delete a Department","href":"/api-reference/department/delete-a-department"}]},{"group":"Equipment","pages":[{"openapi":"get /v1/equipments","title":"List all Equipments","href":"/api-reference/equipment/list-all-equipments"},{"openapi":"post /v1/equipments","title":"Create an Equipment","href":"/api-reference/equipment/create-an-equipment"},{"openapi":"get /v1/equipments/{uid}","title":"Retrieve an Equipment","href":"/api-reference/equipment/retrieve-an-equipment"},{"openapi":"put /v1/equipments/{uid}","title":"Update an Equipment","href":"/api-reference/equipment/update-an-equipment"},{"openapi":"patch /v1/equipments/{uid}/archive","title":"Archive an Equipment","href":"/api-reference/equipment/archive-an-equipment"},{"openapi":"patch /v1/equipments/{uid}/unarchive","title":"Unarchive an Equipment","href":"/api-reference/equipment/unarchive-an-equipment"},{"openapi":"get /v1/equipments/categories","title":"List Categories","href":"/api-reference/equipment/list-categories"}]},{"group":"Legal Entity","pages":[{"openapi":"get /v1/legal_entities","title":"List Legal Entities","href":"/api-reference/legal-entity/list-legal-entities"},{"openapi":"post /v1/legal_entities","title":"Create a Legal Entity","href":"/api-reference/legal-entity/create-a-legal-entity"},{"openapi":"get /v1/legal_entities/{uid}","title":"Retrieve a Legal Entity","href":"/api-reference/legal-entity/retrieve-a-legal-entity"},{"openapi":"put /v1/legal_entities/{uid}","title":"Update a Legal Entity","href":"/api-reference/legal-entity/update-a-legal-entity"},{"openapi":"delete /v1/legal_entities/{uid}","title":"Delete a Legal Entity","href":"/api-reference/legal-entity/delete-a-legal-entity"}]},{"group":"Office Location","pages":[{"openapi":"get /v1/office_locations","title":"List Office Locations","href":"/api-reference/office-location/list-office-locations"},{"openapi":"post /v1/office_locations","title":"Create an Office Location","href":"/api-reference/office-location/create-an-office-location"},{"openapi":"get /v1/office_locations/{uid}","title":"Retrieve a Office Location","href":"/api-reference/office-location/retrieve-an-office-location"},{"openapi":"put /v1/office_locations/{uid}","title":"Update an Office Location","href":"/api-reference/office-location/update-an-office-location"},{"openapi":"delete /v1/office_locations/{uid}","title":"Delete an Office Location","href":"/api-reference/office-location/delete-an-office-location"}]},{"group":"Request","pages":[{"openapi":"get /v1/requests","title":"List Requests","href":"/api-reference/request/list-requests"},{"openapi":"get /v1/requests/grouped","title":"List grouped Requests","href":"/api-reference/request/list-grouped-requests"},{"title":"Create a Request","openapi":"post /v1/requests","href":"/api-reference/request/create-a-request"},{"openapi":"get /v1/requests/{uid}","title":"Retrieve a Request","href":"/api-reference/request/retrieve-a-request"},{"openapi":"put /v1/requests/{uid}","title":"Update a Request","href":"/api-reference/request/update-a-request"},{"openapi":"patch /v1/requests/{uid}/status","title":"Update status","href":"/api-reference/request/update-status"},{"openapi":"patch /v1/requests/{uid}/assignee","title":"Update assignees","href":"/api-reference/request/update-assignees"},{"openapi":"patch /v1/requests/{uid}/archive","title":"Archive a Request","href":"/api-reference/request/archive-a-request"},{"openapi":"patch /v1/requests/{uid}/unarchive","title":"Unarchive a Request","href":"/api-reference/request/unarchive-a-request"},{"openapi":"post /v1/requests/{uid}/followers","title":"Add followers","href":"/api-reference/request/add-followers"},{"openapi":"delete /v1/requests/{uid}/followers/{follower_uid}","title":"Unset a follower","href":"/api-reference/request/unset-a-follower"},{"openapi":"get /v1/requests/{request_uid}/messages","title":"List all messages","href":"/api-reference/request/list-all-messages"},{"openapi":"post /v1/requests/{request_uid}/messages","title":"Send a message","href":"/api-reference/request/send-a-message"},{"openapi":"post /v1/requests/{request_uid}/notes","title":"Send a private note","href":"/api-reference/request/send-a-private-note"},{"openapi":"post /v1/requests/{request_uid}/approvals","title":"Request an approval","href":"/api-reference/request/request-an-approval"},{"openapi":"get /v1/requests/{request_uid}/approvals","title":"List approvals","href":"/api-reference/approval/list-approvals-for-a-request"},{"openapi":"post /v1/requests/batch_import","title":"Import past Requests","href":"/api-reference/request/import-past-requests"},{"title":"Create a Request [Slack Automations]","openapi":"post /v1/requests/slack","href":"/api-reference/request/create-a-request-directly-using-slack-informations"}]},{"group":"Approval","pages":[{"openapi":"get /v1/approvals","title":"List Approvals","href":"/api-reference/approval/list-approvals"},{"openapi":"get /v1/approvals/{uid}","title":"Retrieve an Approval","href":"/api-reference/approval/retrieve-an-approval"}]},{"group":"Request Tag","pages":[{"openapi":"get /v1/request_tags","title":"List Request Tags","href":"/api-reference/request-tag/list-request-tags"},{"openapi":"get /v1/request_tags/{uid}","title":"Retrieve a Request Tag","href":"/api-reference/request-tag/retrieve-a-request-tag"}]},{"group":"Service","pages":[{"openapi":"get /v1/services","title":"List Services","href":"/api-reference/service/list-services"},{"openapi":"post /v1/services","title":"Create a Service","href":"/api-reference/service/create-a-service"},{"openapi":"get /v1/services/{uid}","title":"Retrieve a Service","href":"/api-reference/service/retrieve-a-service"},{"openapi":"put /v1/services/{uid}","title":"Update a Service","href":"/api-reference/service/update-a-service"}]},{"group":"Tag","pages":[{"tag":"DEPRECATED","title":null,"href":"/api-reference/tag/list-tags"},{"tag":"DEPRECATED","title":null,"href":"/api-reference/tag/retrieve-a-tag"}]},{"group":"Team","pages":[{"openapi":"get /v1/teams","title":"List Teams","href":"/api-reference/team/list-teams"},{"openapi":"post /v1/teams","title":"Create a Team","href":"/api-reference/team/create-a-team"},{"openapi":"get /v1/teams/{uid}","title":"Retrieve a Team","href":"/api-reference/team/retrieve-a-team"},{"openapi":"put /v1/teams/{uid}","title":"Update a Team","href":"/api-reference/team/update-a-team"},{"openapi":"delete /v1/teams/{uid}","title":"Delete a Team","href":"/api-reference/team/delete-a-team"}]},{"group":"Team inbox","pages":[{"openapi":"get /v1/team_inboxes","title":"List Team inboxes","href":"/api-reference/team-inbox/list-team-inboxes"},{"openapi":"get /v1/team_inboxes/{uid}","title":"Retrieve a Team inbox","description":null,"href":"/api-reference/team-inbox/retrieve-a-team-inbox"}]},{"group":"User","pages":[{"openapi":"get /v1/users","title":"List Users","href":"/api-reference/user/list-users"},{"openapi":"post /v1/users","title":"Create User","description":null,"href":"/api-reference/user/create-user"},{"openapi":"get /v1/users/{uid}","title":"Retrieve a User","href":"/api-reference/user/retrieve-a-user"},{"openapi":"put /v1/users/{uid}","title":"Update a User","href":"/api-reference/user/update-a-user"},{"openapi":"patch /v1/users/batch_update","title":"Update several Users","href":"/api-reference/user/batch-update-users"},{"openapi":"patch /v1/users/{uid}/archive","title":"Archive a User","href":"/api-reference/user/archive-a-user"},{"openapi":"patch /v1/users/{uid}/unarchive","title":"Unarchive a User","href":"/api-reference/user/unarchive-a-user"},{"openapi":"patch /v1/users/{uid}/merge","title":"Merge User","href":"/api-reference/user/merge-user"}]},{"group":"Workflow","pages":[{"openapi":"get /v1/workflows","title":"List Workflows","href":"/api-reference/workflow/list-workflows"},{"openapi":"get /v1/workflows/{uid}","title":"Retrieve a Workflow","href":"/api-reference/workflow/retrieve-a-workflow"}]},{"group":"Custom Integrations","pages":[{"openapi":"get /v1/custom_integrations","title":"List Custom Integrations","href":"/api-reference/custom-integration/list-custom-integrations"},{"openapi":"post /v1/custom_integrations","title":"Create a Custom Integration","href":"/api-reference/custom-integration/create-a-custom-integration"},{"openapi":"get /v1/custom_integrations/{uid}","title":"Retrieve a Custom Integration","href":"/api-reference/custom-integration/retrieve-a-custom-integration"},{"openapi":"put /v1/custom_integrations/{uid}","title":"Update a Custom Integration","href":"/api-reference/custom-integration/update-a-custom-integration"},{"openapi":"delete /v1/custom_integrations/{uid}","title":"Archive a Custom Integration","href":"/api-reference/custom-integration/archive-a-custom-integration"},{"openapi":"get /v1/custom_integrations/{custom_integration_uid}/custom_actions","title":"List Custom Actions","href":"/api-reference/custom-action/list-custom-actions"},{"openapi":"post /v1/custom_integrations/{custom_integration_uid}/custom_actions","title":"Create a Custom Action","href":"/api-reference/custom-action/create-a-custom-action"},{"openapi":"get /v1/custom_integrations/{custom_integration_uid}/custom_actions/{uid}","title":"Retrieve a Custom Action","href":"/api-reference/custom-action/retrieve-a-custom-action"},{"openapi":"put /v1/custom_integrations/{custom_integration_uid}/custom_actions/{uid}","title":"Update a Custom Action","href":"/api-reference/custom-action/update-a-custom-action"},{"openapi":"delete /v1/custom_integrations/{custom_integration_uid}/custom_actions/{uid}","title":"Archive a Custom Action","href":"/api-reference/custom-action/archive-a-custom-action"}]}]}]},"title":"List Users - Siit API Reference","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-kQh739Uz.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}