New! Use the 1Password Credential Broker to give CI/CD and other machine workflows short-lived access to secrets, without managing service account tokens.
using RestSharp;
var options = new RestClientOptions("https://api.1password.com/v1/accounts/{account}/users");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://api.1password.com/v1/accounts/{account}/users");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
Use the filter query parameter to return only active users (user.isActive()) or only suspended users (user.isSuspended()). Omit the filter to return both. Users in any other state aren’t included.This endpoint supports pagination. Use max_page_size to set the number of users returned per page (100 by default, up to 1000). Pass the next_page_token from each response in the page_token query parameter to fetch the next page, along with the same filter value.
OAuth 2.0 access token authentication. Request an access token from the OAuth token endpoint using the client credentials for the OAuth application in your 1Password account, then include it in the Authorization header of every request as Bearer <token>. Access tokens expire after 15 minutes (900 seconds).
An identifiable user agent for your integration, in the format <CompanyOrProductName>/<version>, so requests can be attributed to a specific integration for support, troubleshooting, and usage analytics.
Filter users by state. Supported values (case-sensitive): user.isActive() or user.isSuspended().
Omit or leave empty to return both active and suspended users. Any other value returns 400 Bad Request with an invalid_argument error.
The maximum number of users to return per page. Defaults to 100 when omitted or set to 0. The maximum is 1000; values greater than 1000 are limited to 1000, and negative values return 400 Bad Request. Ignored when page_token is provided.
The pagination token that identifies the page of results to return. Use the next_page_token value from a previous response, and send the same filter value as the original request. Tokens are opaque and don't expire.
An opaque token to retrieve the next page of results. Pass it in the page_token query parameter of the next request. Omitted when there are no more results. A page with no results is returned as an empty object ({}).
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"1Password Developer","colors":{"primary":"#104ebb","light":"#b8d7ff","dark":"#303136"},"logo":{"light":"https://mintcdn.com/ab-634991b8/lHrfVfSCdefFz8U5/static/img/logo-dark.svg?fit=max\u0026auto=format\u0026n=lHrfVfSCdefFz8U5\u0026q=85\u0026s=29d1c9358888a723dddd8a89a3b6f71d","dark":"https://mintcdn.com/ab-634991b8/lHrfVfSCdefFz8U5/static/img/logo-light.svg?fit=max\u0026auto=format\u0026n=lHrfVfSCdefFz8U5\u0026q=85\u0026s=119233092720e49043d6f42ff71125f1"},"favicon":"https://mintcdn.com/ab-634991b8/s4Wjy03jBRs6hcHb/favicon.ico?fit=max\u0026auto=format\u0026n=s4Wjy03jBRs6hcHb\u0026q=85\u0026s=dd03b4bc604b342373aa4d3e21be4310","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","node","python","go","dotnet","java","php","powershell","ruby"]}},"background":{"color":{"light":"#fbf8f4","dark":"#1a1b1e"}},"navbar":{"links":[{"href":"/community","label":"Community"},{"href":"https://www.1password.academy/path/1password-developer-tools","label":"Academy"}],"primary":{"type":"button","label":"GitHub","href":"https://github.com/1Password"}},"footer":{"socials":{"github":"https://github.com/1Password","x":"https://twitter.com/1Password","reddit":"https://www.reddit.com/r/1Password","linkedin":"https://www.linkedin.com/company/1password","youtube":"https://www.youtube.com/1PasswordVideos","facebook":"https://www.facebook.com/1Password","instagram":"https://www.instagram.com/1password"},"links":[{"header":"Legal","items":[{"label":"Terms of Service","href":"https://1password.com/legal/terms-of-service"},{"label":"Privacy Policy","href":"https://1password.com/legal/privacy"},{"label":"Cookie Policy","href":"https://1password.com/legal/cookies"},{"label":"Accessibility","href":"https://1password.com/legal/accessibility"}]},{"header":"Community","items":[{"label":"Developer community","href":"/community"},{"label":"Code of Conduct","href":"/code-of-conduct"},{"label":"Community projects disclaimer","href":"/community/disclaimer"}]},{"header":"Resources","items":[{"label":"1Password University","href":"https://www.1password.university/?utm_ref=website-footer"},{"label":"Blog RSS","href":"https://blog.1password.com/index.xml"},{"label":"Newsletter","href":"https://1password.com/developer-newsletter"}]}]},"seo":{"metatags":{"canonical":"https://www.1password.dev","google-site-verification":"YserOhXnJUjFfIZ4K3qgxkVSlQZQdXtIbBiKzZ35Nvs"}},"fonts":{"heading":{"family":"Public Sans"},"body":{"family":"Public Sans"}},"banner":{"content":"**New!** Use the [1Password Credential Broker](https://www.1password.dev/brokered-access) to give CI/CD and other machine workflows short-lived access to secrets, without managing service account tokens.","dismissible":true,"color":{"light":"#145fe4","dark":"#145fe4"}},"errors":{"404":{"redirect":false,"title":"This page can't be found","description":"Our docs have moved to [www.1password.dev](https://www.1password.dev). Try searching for what you need or selecting from the list of tools."}},"contextual":{"options":["copy","view","mcp","cursor","vscode","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ab-634991b8","hasAudioNarration":false,"actualSubdomain":"ab-634991b8","customDomains":["www.1password.dev"],"gitSource":{"type":"github","owner":"1password","repo":"1password.dev","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"contextualFeedback":{"allowEmail":false},"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aed09f917f063f212f7ad66","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"More Tools","count":272},{"language":"default","tag":"Shell Plugins","count":208},{"language":"default","tag":"CLI","count":114},{"language":"default","tag":"Plugins","count":97},{"language":"default","tag":"Secrets Automation","count":94},{"language":"default","tag":"SaaS Manager API","count":88},{"language":"default","tag":"API Reference","count":64},{"language":"default","tag":"Reference","count":58},{"language":"default","tag":"Events API","count":56},{"language":"default","tag":"SDKs","count":53}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"email":"support@1password.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":":root{--op-secure-blue: #104ebb;--op-secure-blue-hover: #0e46a8;--op-iron-ore: #303136;--op-page-bg-dark: #1a1b1e;--op-white: #ffffff;--op-icy-blue: #dcebff;--op-cornflower: #b8d7ff;--op-biscuit: #fbf8f4;--op-sunbeam: #fad785;--op-tangerine: #ff8f78;--op-enable-mint: #76e0bd;--op-gold: #cbb88e;--op-status-success: #10622f;--op-status-warning: #8a4006;--op-status-error: #a71c1c;--op-status-info: var(--op-secure-blue);--op-border-ui: #949494;--op-border-ui-dark: #6b7280;--op-border-subtle: rgb(3 7 18 / 0.12);--op-border-subtle-dark: rgb(251 248 244 / 0.25);--op-border-footer-dark: rgb(251 248 244 / 0.37);--op-border-navbar-light: rgb(107 114 128 / 0.05);--op-border-navbar-dark: rgb(209 213 219 / 0.06);--op-border-card-light: rgb(3 7 18 / 0.1);--op-border-card-dark: rgb(255 255 255 / 0.1);--op-border-hero-light: rgb(255 255 255 / 0.08);--op-border-hero-dark: rgb(255 255 255 / 0.12);--op-border-badge-light: rgb(16 78 187 / 0.2);--op-border-badge-dark: rgb(184 215 255 / 0.25);--op-border-workflow-dark: rgb(251 248 244 / 0.2);--op-text-body: var(--op-iron-ore);--op-text-body-dark: var(--op-biscuit);--op-surface-card-light: var(--op-white);--op-surface-card-dark: #25262a;--op-surface-callout-light: rgb(220 235 255 / 0.45);--op-surface-callout-dark: rgb(184 215 255 / 0.08)}#content.prose{--tw-prose-body: var(--op-text-body)}.dark #content.prose{--tw-prose-body: var(--op-text-body-dark)}#content.prose :where(p,span[data-as=\"p\"],li,td,th,blockquote,figcaption):not(a.op-cta-primary span){color:var(--op-text-body)}.dark #content.prose :where(p,span[data-as=\"p\"],li,td,th,blockquote,figcaption):not(a.op-cta-primary span){color:var(--op-text-body-dark)}#content :is(p,li,div,span,button,h1,h2,h3,h4,h5,h6).text-gray-600,#content :is(p,li,div,span,button,h1,h2,h3,h4,h5,h6).text-gray-700,#content :is(p,li,span,button,h1,h2,h3,h4,h5,h6).text-gray-500{color:var(--op-text-body)}.dark #content :is(p,li,div,span,button,h1,h2,h3,h4,h5,h6).dark\\:text-gray-400,.dark #content :is(p,li,div,span,button,h1,h2,h3,h4,h5,h6).dark\\:text-gray-300,.dark #content :is(p,li,span,button,h1,h2,h3,h4,h5,h6).dark\\:text-gray-500{color:var(--op-text-body-dark)}#content .text-gray-400:not(:is(p,li,span,button,h1,h2,h3,h4,h5,h6)){color:var(--op-border-ui)}.dark #content .text-gray-400:not(:is(p,li,span,button,h1,h2,h3,h4,h5,h6)),.dark #content .text-gray-500:not(:is(p,li,span,button,h1,h2,h3,h4,h5,h6)){color:var(--op-border-ui-dark)}.dark .card-group{--background-dark: 37 38 42}.dark .card-group .card{background-color:rgb(var(--background-dark))!important}.card-group .card{border-color:var(--op-border-card-light)!important}.dark .card-group .card{border-color:var(--op-border-card-dark)!important}.op-card-surface{border:1px solid var(--op-border-card-light)}.dark .op-card-surface{border-color:var(--op-border-card-dark)}#content .hover\\:border-gray-300:hover{border-color:var(--op-iron-ore)}.dark #content .hover\\:border-gray-600:hover{border-color:var(--op-biscuit)}.community-card{border:1px solid var(--op-border-card-light);border-radius:0.5rem;background-color:var(--op-surface-card-light)}.dark .community-card{border-color:var(--op-border-card-dark);background-color:var(--op-surface-card-dark)}.community-card .community-card-chevron{color:var(--op-border-ui)}.dark .community-card .community-card-chevron{color:var(--op-cornflower)}a.community-card:hover{border-color:var(--op-secure-blue)}.dark a.community-card:hover{border-color:var(--op-cornflower)}.community-callout{border:1px solid var(--op-border-card-light);border-radius:0.5rem;background-color:var(--op-surface-callout-light)}.dark .community-callout{border-color:var(--op-border-card-dark);background-color:var(--op-surface-callout-dark)}.community-link{color:var(--op-secure-blue);text-decoration:none}.community-link:hover{color:var(--op-secure-blue-hover);text-decoration:underline}.dark .community-link{color:var(--op-cornflower)}.dark .community-link:hover{color:var(--op-white)}:is(#sidebar-content a:not([aria-current=\"page\"]),#table-of-contents,#table-of-contents a,#navbar .nav-tabs-item:not([data-active]),#navbar nav ul>li:not(#topbar-cta-button)>a,#search-bar-entry,#search-bar-entry-mobile,#assistant-entry,#assistant-entry-mobile,[data-component-name=\"theme-toggle\"]){color:var(--op-text-body)}.dark :is(#sidebar-content a:not([aria-current=\"page\"]),#table-of-contents,#table-of-contents a,#navbar .nav-tabs-item:not([data-active]),#navbar nav ul>li:not(#topbar-cta-button)>a,#search-bar-entry,#search-bar-entry-mobile,#assistant-entry,#assistant-entry-mobile,[data-component-name=\"theme-toggle\"]){color:var(--op-text-body-dark)}:is(#search-bar-entry,#search-bar-entry-mobile,#assistant-entry,#assistant-entry-mobile,[data-component-name=\"theme-toggle\"]) svg{color:inherit}#footer a.h-fit svg{background-color:var(--op-biscuit)}#footer a.h-fit:hover svg{background-color:var(--op-white)}.hero-background{background-color:var(--op-iron-ore);background-image:radial-gradient(\n ellipse 75% 100% at 100% 50%,\n rgb(20 95 228 / 0.55) 0%,\n rgb(20 95 228 / 0.2) 40%,\n transparent 70%\n )}.dark .hero-background{background-color:var(--op-page-bg-dark);background-image:radial-gradient(\n ellipse 80% 100% at 100% 50%,\n rgb(20 95 228 / 0.7) 0%,\n rgb(20 95 228 / 0.3) 45%,\n transparent 75%\n )}.hero-section{border-bottom:1px solid var(--op-border-hero-light)}.dark .hero-section{border-bottom-color:var(--op-border-hero-dark)}.hero-cta{background-color:var(--op-secure-blue);color:var(--op-white);box-shadow:0 1px 3px rgb(0 0 0 / 0.25)}.hero-cta svg,.hero-cta svg path{fill:currentColor!important;color:currentColor!important}.hero-cta:hover{background-color:var(--op-secure-blue-hover)}#content.prose a.op-cta-primary,#content a.op-cta-primary{background-color:var(--op-secure-blue);color:var(--op-white)!important;text-decoration:none}#content.prose a.op-cta-primary span[data-as=\"p\"],#content.prose a.op-cta-primary span,#content a.op-cta-primary span[data-as=\"p\"],#content a.op-cta-primary span{color:var(--op-white)!important}#content.prose a.op-cta-primary:hover,#content a.op-cta-primary:hover{background-color:var(--op-secure-blue-hover);color:var(--op-white)!important}#content.prose a.op-cta-primary:hover span[data-as=\"p\"],#content.prose a.op-cta-primary:hover span,#content a.op-cta-primary:hover span[data-as=\"p\"],#content a.op-cta-primary:hover span{color:var(--op-white)!important}#topbar-cta-button a>span.absolute{background-color:var(--op-secure-blue)!important}#topbar-cta-button a:hover>span.absolute{background-color:var(--op-secure-blue-hover)!important}#topbar-cta-button a span.z-10{color:var(--op-white)!important}#topbar-cta-button a svg{color:var(--op-white)!important}.card-group{gap:1rem}#content .card-group img[src*=\"/homepage-icons/brand/\"]{width:32px;height:32px;flex-shrink:0}.homepage-card-title{display:inline-flex;flex-wrap:wrap;align-items:center;gap:0.25rem 0.5rem}.image-button-link img{margin:10px 0}.dark #content a>div>span{color:var(--op-cornflower)!important}.docs-higlight-cards{display:grid;grid-template-columns:repeat(auto-fill, minmax(250px, 1fr));gap:1rem;margin-bottom:1rem}.highlight-card-link{color:var(--op-secure-blue)!important}.highlight-card-link:hover{color:var(--op-secure-blue-hover)!important}.dark .highlight-card-link{color:var(--op-cornflower)!important}.dark .highlight-card-link:hover{color:var(--op-white)!important}.highlight-card-link svg{background-color:var(--op-secure-blue)!important}.dark .highlight-card-link svg{background-color:var(--op-cornflower)!important}.coloredCodeWrapper .code-block>div:nth-child(3){--fade-color-light: transparent !important;--fade-color-dark: transparent !important}.badge{border-radius:0.4rem;color:var(--op-white);font-weight:700;line-height:1;padding:3px 5px}.badge--primary{background-color:var(--op-secure-blue)}.badge--secondary{background-color:var(--op-biscuit);color:var(--op-iron-ore)}.op-status-badge{display:inline-flex;flex-shrink:0;align-items:center;white-space:nowrap;vertical-align:middle;border:1px solid var(--op-border-badge-light);border-radius:0.25rem;background-color:var(--op-icy-blue);color:var(--op-iron-ore);padding:0.125rem 0.625rem;font-size:0.75rem;line-height:1rem;font-weight:600}.dark .op-status-badge{border-color:var(--op-border-badge-dark);background-color:rgb(184 215 255 / 0.12);color:var(--op-icy-blue)}.op-workflow-guide-badge{display:inline-flex;flex-shrink:0;align-items:center;white-space:nowrap;margin-top:0.75rem;border:1px solid transparent;border-radius:0.25rem;background-color:var(--op-biscuit);color:var(--op-iron-ore);padding:0.125rem 0.625rem;font-size:0.75rem;line-height:1rem;font-weight:600}.dark .op-workflow-guide-badge{border-color:var(--op-border-workflow-dark);background-color:rgb(251 248 244 / 0.1);color:var(--op-biscuit)}.op-beta-badge-inline{display:inline-flex;align-items:center;margin-left:0.5rem;vertical-align:middle}.mdx-content a[href^=\"http\"]:not([href*=\"://1password.com/\"],[href$=\"://1password.com\"],[href*=\".1password.com/\"],[href$=\".1password.com\"],[href*=\"://1password.dev/\"],[href$=\"://1password.dev\"],[href*=\".1password.dev/\"],[href$=\".1password.dev\"],[href*=\"://1password.ca/\"],[href$=\"://1password.ca\"],[href*=\".1password.ca/\"],[href$=\".1password.ca\"],[href*=\"://1password.eu/\"],[href$=\"://1password.eu\"],[href*=\".1password.eu/\"],[href$=\".1password.eu\"],[href*=\"://1password.io/\"],[href$=\"://1password.io\"],[href*=\".1password.io/\"],[href$=\".1password.io\"],[href*=\"://1password.university/\"],[href$=\"://1password.university\"],[href*=\".1password.university/\"],[href$=\".1password.university\"],[href*=\"://agilebits.com/\"],[href$=\"://agilebits.com\"],[href*=\".agilebits.com/\"],[href$=\".agilebits.com\"],[href*=\"://b5dev.com/\"],[href$=\"://b5dev.com\"],[href*=\".b5dev.com/\"],[href$=\".b5dev.com\"],[href*=\"://b5local.com/\"],[href$=\"://b5local.com\"],[href*=\".b5local.com/\"],[href$=\".b5local.com\"],[href*=\"://1infra.dev/\"],[href$=\"://1infra.dev\"],[href*=\".1infra.dev/\"],[href$=\".1infra.dev\"],[href*=\"://kolide.com/\"],[href$=\"://kolide.com\"],[href*=\".kolide.com/\"],[href$=\".kolide.com\"],[href*=\"://trelica.app/\"],[href$=\"://trelica.app\"],[href*=\".trelica.app/\"],[href$=\".trelica.app\"],[href*=\"://trelica.eu/\"],[href$=\"://trelica.eu\"],[href*=\".trelica.eu/\"],[href$=\".trelica.eu\"],[href*=\"://trelica.com/\"],[href$=\"://trelica.com\"],[href*=\".trelica.com/\"],[href$=\".trelica.com\"],[href*=\"://1password.community/\"],[href$=\"://1password.community\"],[href*=\".1password.community/\"],[href$=\".1password.community\"],[href*=\"://1pw.ca/\"],[href$=\"://1pw.ca\"],[href*=\".1pw.ca/\"],[href$=\".1pw.ca\"]):not(.card *,.op-card-surface *,.image-button-link,.community-card,.community-card *,pre *,:has(img))::after{content:\"\";display:inline-block;width:1em;height:1em;margin-left:0.25em;vertical-align:-0.125em;background-color:currentColor;-webkit-mask:var(--op-link-icon, url(\"/static/img/icons/external-link.svg\")) no-repeat center / contain;mask:var(--op-link-icon, url(\"/static/img/icons/external-link.svg\")) no-repeat center / contain}.mdx-content a:is([href*=\"://github.com/\"],[href$=\"://github.com\"],[href*=\".github.com/\"],[href$=\".github.com\"],[href*=\"://github.blog/\"],[href$=\"://github.blog\"]){--op-link-icon: url(\"/static/img/logos/github.svg\")}#content>h5,#content>h6{font-weight:700}.dark #content>h5,.dark #content>h6{color:var(--op-white)}.accordion{background-color:var(--op-icy-blue)}.dark .accordion{background-color:var(--op-surface-card-dark)}.accordion .mint-bg-white{padding:1rem}.accordion .mint-bg-white [class*=\"-mx-\"]{margin:0!important;padding:0!important;width:100%!important;--page-padding: 0px}#footer>div>div.flex.flex-col.md\\:flex-row.gap-8.justify-between.min-h-\\[76px\\]>div.flex.flex-col.sm\\:grid.max-md\\:\\!grid-cols-2.gap-8.flex-1>div>div>p{display:none!important}footer#footer.advanced-footer{display:flex!important}footer#footer{align-items:unset;background-color:var(--op-iron-ore);color:var(--op-white)}#footer img.nav-logo.dark\\:hidden{display:none!important}#footer img.nav-logo.dark\\:block{display:block!important}#footer p.font-semibold,#footer a{color:var(--op-white)}#footer>div.flex.w-full.flex-col.gap-12.justify-between.px-8.py-16.md\\:py-20.lg\\:py-28.z-20>div.h-\\[1px\\].w-full.bg-gray-100.dark\\:bg-white\\/5{background-color:var(--op-border-footer-dark)}#footer>div.flex.w-full.flex-col.gap-12.justify-between.px-8.py-16.md\\:py-20.lg\\:py-28.z-20{margin:0 auto}footer .email_form{max-width:650px;margin:auto}.codeblock_accordion{margin-top:10px}.codeblock_accordion .code-block{margin:0!important}.codeblock_accordion>div>.code-block,.codeblock_accordion>div>.code-block>div:nth-child(2){border-bottom-left-radius:0;border-bottom-right-radius:0}.codeblock_accordion .see_results_container{border-bottom-left-radius:1rem;border-bottom-right-radius:1rem}.codeblock_accordion .see_results_container .code-block,.codeblock_accordion .see_results_container .code-block>div:nth-child(2){border-top-left-radius:0;border-top-right-radius:0}.hide_bullets ul li{padding-left:0!important}.hide_bullets ul li::before{content:none!important}#navigation-items a[href^=\"/\"]:not([href^=\"//\"])>div>div:nth-child(2){display:none}a[href^=\"http\"] .flex-shrink-0 svg,a[href^=\"//\"] .flex-shrink-0 svg{display:block}h1 code,h2 code,h3 code,h4 code,h5 code,h6 code{white-space:nowrap}h2.flex.whitespace-pre-wrap span.cursor-pointer svg.icon,h4.flex.whitespace-pre-wrap span.cursor-pointer svg.icon{margin:0;vertical-align:baseline}table thead tr th code{padding-left:0!important;padding-right:0!important}.tabs.tab-container{padding:0 0.8rem 1rem;border:1px solid var(--op-border-subtle);border-radius:4px}.dark .tabs.tab-container{border-color:var(--op-border-subtle-dark)}nav-tabs-item:nth-child(3),.nav-tabs-item:nth-child(3){--tab-gap-before-divider: 8px;--nav-tabs-item-gap: 0.5rem;margin-left:var(--tab-gap-before-divider)!important;padding-left:calc(\n var(--tab-gap-before-divider) + var(--nav-tabs-item-gap)\n )!important;border-left:1px solid var(--op-border-navbar-light)}.dark nav-tabs-item:nth-child(3),.dark .nav-tabs-item:nth-child(3){border-left-color:var(--op-border-navbar-dark)}.peer.is-center~div:has(.tutorial-explorer){max-width:84rem!important}@media (max-width: 639px){.tutorial-filter-bar{display:grid!important;grid-template-columns:minmax(0, 1fr)}.tutorial-filter-search{grid-column:1 / -1;width:100%}.tutorial-filter-search input{width:100%!important}.tutorial-filter-topic,.tutorial-filter-tools{grid-column:1 / -1;width:100%}.tutorial-filter-dropdown>button,.tutorial-filter-menu{width:100%}.tutorial-filter-dropdown>button{justify-content:space-between}.tutorial-filter-menu{min-width:0!important}.tutorial-filter-sort{grid-column:1 / -1;justify-self:end;margin-left:0!important}}#navbar.is-custom .nav-tabs-item[data-active]{color:var(--op-text-body);text-shadow:none}.dark #navbar.is-custom .nav-tabs-item[data-active]{color:var(--op-text-body-dark)}#navbar.is-custom .nav-tabs-item[data-active]>div{background-color:transparent!important}#navbar.is-custom .nav-tabs-item[data-active]:hover>div{background-color:rgb(229 231 235)!important}.dark #navbar.is-custom .nav-tabs-item[data-active]:hover>div{background-color:rgb(55 65 81)!important}#footer .api-sdk-terms-notice{margin:0;padding:0 0 1.25rem;font-size:0.875rem;font-style:italic;line-height:1.5;text-align:center;color:rgb(251 248 244 / 0.8);pointer-events:auto}#footer .api-sdk-terms-notice a{position:relative;z-index:2;color:var(--op-cornflower);text-decoration:underline;text-underline-offset:2px;pointer-events:auto;cursor:pointer}"}],"page":{"pagePath":"users-api/list-users","slug":"/users-api/list-users","pageMetadata":{"title":"List users","sidebarTitle":"List users","openapi":"openapi/users_api.yaml GET /v1/accounts/{account}/users","description":"Retrieve a list of users in a 1Password account.","href":"/users-api/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: \"Retrieve a list of users in a 1Password account.\"\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={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Use the `,_jsx(_components.code,{children:`filter`}),` query parameter to return only active users (`,_jsx(_components.code,{children:`user.isActive()`}),`) or only suspended users (`,_jsx(_components.code,{children:`user.isSuspended()`}),`). Omit the filter to return both. Users in any other `,_jsx(_components.a,{href:`/users-api/conventions#user-states`,children:`state`}),` aren’t included.`]}),`\n`,_jsxs(_components.p,{children:[`This endpoint supports `,_jsx(_components.a,{href:`/users-api/conventions#pagination`,children:`pagination`}),`. Use `,_jsx(_components.code,{children:`max_page_size`}),` to set the number of users returned per page (100 by default, up to 1000). Pass the `,_jsx(_components.code,{children:`next_page_token`}),` from each response in the `,_jsx(_components.code,{children:`page_token`}),` query parameter to fetch the next page, along with the same `,_jsx(_components.code,{children:`filter`}),` value.`]})]})}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":"List users","sidebarTitle":"List users","openapi":"openapi/users_api.yaml GET /v1/accounts/{account}/users","description":"Retrieve a list of users in a 1Password account.","href":"/users-api/list-users"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ab-634991b8/5ebc0d10523e8210/static/js/analytics.js","/_mintlify/custom/ab-634991b8/5bb7437b1c9dcb44/static/js/gtag-prod-sst.js","/_mintlify/custom/ab-634991b8/ee8ea0eeb20ecd1e/static/js/gtag-sst.js","/_mintlify/custom/ab-634991b8/f2b239f3d459dc67/api-sdk-terms-notice.js","/_mintlify/custom/ab-634991b8/3604035e212f8294/homepage-card-icons.js"],"openApiReferenceData":{"operation":{"tags":["Users"],"summary":"List users","description":"Retrieve a list of users in a 1Password account.","x-original-description":"List users in an account.","operationId":"listUsers","parameters":["ec74fa28-1234-4b18-99ab-a0b9d2243582","358ad3f9-15d4-437e-9788-af26c11ce7ec","c7b651ec-03b6-427a-9a29-9ce102b62cc7","7fdb4ed0-c0aa-44aa-8eed-9cbd3b74a6a6","538eb3e7-bc76-49d2-9a7c-c1e27cf5d790"],"responses":{"200":"10e02ad6-5beb-4d96-8cdb-d6d123857aae","400":"be91744b-db38-48ae-8959-685618d42752","401":"b9591c38-3dda-476b-9852-3b4297d1788d","403":"deaafaec-2c0d-4a04-a4c3-4d4da6219a0b","404":"69599b17-e23f-4e3d-9b91-d90080649d71","429":"0feb9f1c-9eb2-47dc-b78b-c0cdc2932f85","500":"95da8ba6-9ade-4055-913f-a4c72d29cc61","503":"5b4ac934-7098-4c8d-8ffa-7f3ea0287093"},"method":"get","type":"path","servers":["183330b2-d124-4ee5-8a98-82c2a783133a","3a21adb3-20fa-4ab0-9673-e42dee85b587","44a0a6c8-88ea-45e6-8d6b-be6f272211f9","61fb7f13-084d-410f-8b1c-a409c2fc6f7e"],"security":["1e353e17-1717-4c6e-b28e-9ac78deb6da6"],"path":"/v1/accounts/{account}/users","baseUrlOptions":["https://api.1password.com","https://api.1password.ca","https://api.1password.eu","https://api.ent.1password.com"],"title":"List users","codeSamples":[],"requestExampleLanguages":["bash","node","python","go","dotnet","java","php","powershell","ruby"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ec74fa28-1234-4b18-99ab-a0b9d2243582":{"name":"account","in":"path","description":"The unique identifier of the 1Password account, a 26-character uppercase ID. A malformed ID returns `400 Bad Request`.","x-original-description":"The account id.","required":true,"example":"WX52YXL2MVEPBK43P3R4XMWKXI","schema":{"type":"string","minLength":26,"maxLength":26,"isRequired":true,"description":"The unique identifier of the 1Password account, a 26-character uppercase ID. A malformed ID returns `400 Bad Request`.","uniqueKey":"","typeLabel":"string"}},"358ad3f9-15d4-437e-9788-af26c11ce7ec":{"name":"filter","in":"query","description":"Filter users by state. Supported values (case-sensitive): `user.isActive()` or `user.isSuspended()`.\nOmit or leave empty to return both active and suspended users. Any other value returns `400 Bad Request` with an `invalid_argument` error.","x-original-description":"Filter value: \"user.isActive()\" or \"user.isSuspended()\".\n Omit or leave empty for both. Invalid values result in InvalidArgument.","required":false,"example":"user.isSuspended()","schema":{"type":"string","isRequired":false,"description":"Filter users by state. Supported values (case-sensitive): `user.isActive()` or `user.isSuspended()`.\nOmit or leave empty to return both active and suspended users. Any other value returns `400 Bad Request` with an `invalid_argument` error.","uniqueKey":"","typeLabel":"string"}},"c7b651ec-03b6-427a-9a29-9ce102b62cc7":{"name":"max_page_size","in":"query","description":"The maximum number of users to return per page. Defaults to 100 when omitted or set to 0. The maximum is 1000; values greater than 1000 are limited to 1000, and negative values return `400 Bad Request`. Ignored when `page_token` is provided.","x-original-description":"The maximum number of users to return per page.","required":false,"example":100,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":1000,"default":100,"isRequired":false,"description":"The maximum number of users to return per page. Defaults to 100 when omitted or set to 0. The maximum is 1000; values greater than 1000 are limited to 1000, and negative values return `400 Bad Request`. Ignored when `page_token` is provided.","uniqueKey":"","typeLabel":"integer\u003cint32>"}},"7fdb4ed0-c0aa-44aa-8eed-9cbd3b74a6a6":{"name":"page_token","in":"query","description":"The pagination token that identifies the page of results to return. Use the `next_page_token` value from a previous response, and send the same `filter` value as the original request. Tokens are opaque and don't expire.","x-original-description":"A page token from a previous ListUsers call.","required":false,"schema":{"type":"string","isRequired":false,"description":"The pagination token that identifies the page of results to return. Use the `next_page_token` value from a previous response, and send the same `filter` value as the original request. Tokens are opaque and don't expire.","uniqueKey":"","typeLabel":"string"}},"538eb3e7-bc76-49d2-9a7c-c1e27cf5d790":{"name":"User-Agent","in":"header","description":"An identifiable user agent for your integration, in the format `\u003cCompanyOrProductName>/\u003cversion>`, so requests can be attributed to a specific integration for support, troubleshooting, and usage analytics.","required":false,"example":"AcmeSOAR/1.0.0","schema":{"type":"string","isRequired":false,"description":"An identifiable user agent for your integration, in the format `\u003cCompanyOrProductName>/\u003cversion>`, so requests can be attributed to a specific integration for support, troubleshooting, and usage analytics.","uniqueKey":"","typeLabel":"string"}}},"responses":{"10e02ad6-5beb-4d96-8cdb-d6d123857aae":{"description":"A paginated list of users in the account.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier (UUID) of the user.","readOnly":true,"uniqueKey":"results.items.[INDEX].id","typeLabel":"string"},"email":{"type":"string","description":"The email address of the user.","uniqueKey":"results.items.[INDEX].email","typeLabel":"string"},"display_name":{"type":"string","description":"The display name of the user.","uniqueKey":"results.items.[INDEX].display_name","typeLabel":"string"},"state":{"type":"string","description":"The current state of the user. Omitted when the user is neither active nor suspended, for example while pending confirmation or in account recovery.","enum":["STATE_UNSPECIFIED","ACTIVE","SUSPENDED"],"uniqueKey":"results.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"create_time":{"type":"string","format":"date-time","description":"The date and time the user was created, in RFC 3339 format.","readOnly":true,"uniqueKey":"results.items.[INDEX].create_time","typeLabel":"string\u003cdate-time>"},"path":{"type":"string","description":"The resource path of the user.\nFormat: `accounts/{account}/users/{user}`","readOnly":true,"uniqueKey":"results.items.[INDEX].path","typeLabel":"string"}},"additionalProperties":false,"description":"A user within a 1Password account.","x-aep-resource":{"singular":"user"},"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"description":"The list of users returned for this page. Only active and suspended users are included.","uniqueKey":"results","typeLabel":"object[]"},"next_page_token":{"type":"string","description":"An opaque token to retrieve the next page of results. Pass it in the `page_token` query parameter of the next request. Omitted when there are no more results. A page with no results is returned as an empty object (`{}`).","uniqueKey":"next_page_token","typeLabel":"string"}},"additionalProperties":false,"description":"The paginated list of users.","x-original-description":"Response message for listing users.","uniqueKey":"","typeLabel":"object"},"example":{"results":[{"id":"IR7VJHJ36JHINBFAD7V2T5MP3E","email":"wendy_appleseed@agilebits.com","display_name":"Wendy Appleseed","state":"ACTIVE","create_time":"2024-01-15T10:30:00Z","path":"accounts/WX52YXL2MVEPBK43P3R4XMWKXI/users/IR7VJHJ36JHINBFAD7V2T5MP3E"},{"id":"56YE2TYN2VFYRLNSHKPW5NVT5E","email":"riley_smith@example.com","display_name":"Riley Smith","state":"SUSPENDED","create_time":"2024-03-20T09:15:00Z","path":"accounts/WX52YXL2MVEPBK43P3R4XMWKXI/users/56YE2TYN2VFYRLNSHKPW5NVT5E"}],"next_page_token":"CAIQAg"},"examples":{"Example":{"title":"Example","value":{"results":[{"id":"IR7VJHJ36JHINBFAD7V2T5MP3E","email":"wendy_appleseed@agilebits.com","display_name":"Wendy Appleseed","state":"ACTIVE","create_time":"2024-01-15T10:30:00Z","path":"accounts/WX52YXL2MVEPBK43P3R4XMWKXI/users/IR7VJHJ36JHINBFAD7V2T5MP3E"},{"id":"56YE2TYN2VFYRLNSHKPW5NVT5E","email":"riley_smith@example.com","display_name":"Riley Smith","state":"SUSPENDED","create_time":"2024-03-20T09:15:00Z","path":"accounts/WX52YXL2MVEPBK43P3R4XMWKXI/users/56YE2TYN2VFYRLNSHKPW5NVT5E"}],"next_page_token":"CAIQAg"}}},"exampleType":"examples"}},"exampleType":"examples"},"be91744b-db38-48ae-8959-685618d42752":{"description":"Bad Request - A request parameter is invalid, for example an unsupported `filter` value, an unsupported query parameter, an invalid `page_token`, a negative `max_page_size`, or a malformed account or user ID. Also returned when the `Authorization` header is malformed.","content":{"application/json":{"schema":{"type":"object","description":"An error response with a machine-readable `code` and a human-readable `message`. This format is provisional and may change in a future release.","properties":{"code":{"type":"string","description":"A machine-readable error code, for example `invalid_argument`, `failed_precondition`, `unauthenticated`, `permission_denied`, `not_found`, `resource_exhausted`, `internal`, or `unavailable`.","example":"invalid_argument","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"invalid_argument":{"title":"invalid_argument","value":{"code":"invalid_argument","message":"invalid filter \"user.isDeleted()\": must be \"user.isActive()\" or \"user.isSuspended()\""}},"malformed_authorization":{"title":"malformed_authorization","value":{"code":"invalid_argument","message":"malformed authorization header"}}},"exampleType":"examples"}},"exampleType":"examples"},"b9591c38-3dda-476b-9852-3b4297d1788d":{"description":"Unauthorized - The request doesn't include a valid access token. The `Authorization` header is missing, or the bearer token is invalid, expired, or revoked. Also returned for tokens that weren't issued by the OAuth API, such as tokens from the legacy OAuth service. Request a new access token.","headers":{"WWW-Authenticate":{"description":"The Bearer authentication challenge (RFC 6750). Includes `error=\"invalid_token\"` when a token was sent but isn't valid.","schema":{"type":"string"},"example":"Bearer realm=\"1Password\", error=\"invalid_token\", error_description=\"invalid access token\""}},"content":{"application/json":{"schema":{"type":"object","description":"An error response with a machine-readable `code` and a human-readable `message`. This format is provisional and may change in a future release.","properties":{"code":{"type":"string","description":"A machine-readable error code, for example `invalid_argument`, `failed_precondition`, `unauthenticated`, `permission_denied`, `not_found`, `resource_exhausted`, `internal`, or `unavailable`.","example":"invalid_argument","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"missing_token":{"title":"missing_token","value":{"code":"unauthenticated","message":"authentication required"}},"invalid_token":{"title":"invalid_token","value":{"code":"unauthenticated","message":"invalid access token"}},"legacy_token":{"title":"legacy_token","value":{"code":"unauthenticated","message":"Token is inactive or expired: inactive_token"}}},"exampleType":"examples"}},"exampleType":"examples"},"deaafaec-2c0d-4a04-a4c3-4d4da6219a0b":{"description":"Forbidden - The token doesn't include the scope required for this endpoint, the account in the path doesn't belong to the OAuth application's account, or the action isn't allowed for the target user.","content":{"application/json":{"schema":{"type":"object","description":"An error response with a machine-readable `code` and a human-readable `message`. This format is provisional and may change in a future release.","properties":{"code":{"type":"string","description":"A machine-readable error code, for example `invalid_argument`, `failed_precondition`, `unauthenticated`, `permission_denied`, `not_found`, `resource_exhausted`, `internal`, or `unavailable`.","example":"invalid_argument","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"missing_scope":{"title":"missing_scope","value":{"code":"permission_denied","message":"Permission denied: permission_denied"}},"account_mismatch":{"title":"account_mismatch","value":{"code":"permission_denied","message":"Account UUID does not match token: account_uuid_mismatch"}}},"exampleType":"examples"}},"exampleType":"examples"},"69599b17-e23f-4e3d-9b91-d90080649d71":{"description":"Not Found - The user doesn't exist.","content":{"application/json":{"schema":{"type":"object","description":"An error response with a machine-readable `code` and a human-readable `message`. This format is provisional and may change in a future release.","properties":{"code":{"type":"string","description":"A machine-readable error code, for example `invalid_argument`, `failed_precondition`, `unauthenticated`, `permission_denied`, `not_found`, `resource_exhausted`, `internal`, or `unavailable`.","example":"invalid_argument","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"not_found","message":"no_user_exists"},"examples":{"Example":{"title":"Example","value":{"code":"not_found","message":"no_user_exists"}}},"exampleType":"examples"}},"exampleType":"examples"},"0feb9f1c-9eb2-47dc-b78b-c0cdc2932f85":{"description":"Too Many Requests - The rate limit of 100 requests per minute or 6,000 requests per hour for this endpoint was exceeded.","headers":{"Retry-After":{"description":"How long to wait before retrying, in seconds.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"The request limit for the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"The number of requests remaining in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"When the current window resets, as a Unix timestamp in seconds.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","description":"An error response with a machine-readable `code` and a human-readable `message`. This format is provisional and may change in a future release.","properties":{"code":{"type":"string","description":"A machine-readable error code, for example `invalid_argument`, `failed_precondition`, `unauthenticated`, `permission_denied`, `not_found`, `resource_exhausted`, `internal`, or `unavailable`.","example":"invalid_argument","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"resource_exhausted","message":"rate limit exceeded"},"examples":{"Example":{"title":"Example","value":{"code":"resource_exhausted","message":"rate limit exceeded"}}},"exampleType":"examples"}},"exampleType":"examples"},"95da8ba6-9ade-4055-913f-a4c72d29cc61":{"description":"Internal Server Error - An unexpected error occurred. Retry the request later.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"5b4ac934-7098-4c8d-8ffa-7f3ea0287093":{"description":"Service Unavailable - The service is temporarily unavailable. Retry the request later.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"1e353e17-1717-4c6e-b28e-9ac78deb6da6":{"BearerAuth":{"type":"http","scheme":"bearer","description":"OAuth 2.0 access token authentication. Request an access token from the OAuth token endpoint using the client credentials for the OAuth application in your 1Password account, then include it in the Authorization header of every request as `Bearer \u003ctoken>`. Access tokens expire after 15 minutes (900 seconds).","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"183330b2-d124-4ee5-8a98-82c2a783133a":{"url":"https://api.1password.com","description":"1Password.com (United States)"},"3a21adb3-20fa-4ab0-9673-e42dee85b587":{"url":"https://api.1password.ca","description":"1Password.ca (Canada)"},"44a0a6c8-88ea-45e6-8d6b-be6f272211f9":{"url":"https://api.1password.eu","description":"1Password.eu (Europe)"},"61fb7f13-084d-410f-8b1c-a409c2fc6f7e":{"url":"https://api.ent.1password.com","description":"ent.1password.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"OAuth 2.0 access token authentication. Request an access token from the OAuth token endpoint using the client credentials for the OAuth application in your 1Password account, then include it in the Authorization header of every request as `Bearer \u003ctoken>`. Access tokens expire after 15 minutes (900 seconds).","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"OAuth 2.0 access token authentication. Request an access token from the OAuth token endpoint using the client credentials for the OAuth application in your 1Password account, then include it in the Authorization header of every request as `Bearer \u003ctoken>`. Access tokens expire after 15 minutes (900 seconds).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi/users_api.yaml"},"subdomain":"ab-634991b8","siteName":"1Password Developer","title":"List users - 1Password Developer","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"contextualStarterQuestions":[{"_id":"6ac7bcb05466178fbe502162","deploymentId":"68a8af9a517ab813d3b84097","questionText":"What's the max page size limit?","status":"active","generatedBy":"contextual","path":"users-api/list-users","createdAt":"2026-10-08T15:54:24.487Z","updatedAt":"2026-10-08T15:54:24.487Z","__v":0},{"_id":"6ac7bcb05466178fbe502163","deploymentId":"68a8af9a517ab813d3b84097","questionText":"How do I paginate results?","status":"active","generatedBy":"contextual","path":"users-api/list-users","createdAt":"2026-10-08T15:54:24.487Z","updatedAt":"2026-10-08T15:54:24.487Z","__v":0},{"_id":"6ac7bcb05466178fbe502161","deploymentId":"68a8af9a517ab813d3b84097","questionText":"How do I filter active users?","status":"active","generatedBy":"contextual","path":"users-api/list-users","createdAt":"2026-10-08T15:54:24.487Z","updatedAt":"2026-10-08T15:54:24.487Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-08T15:54:18.100Z","originalFileLocation":"users-api/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=\"Retrieve a list of users in a 1Password account.\">\u003cmeta data-mint-head name=\"application-name\" content=\"1Password Developer\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ab-634991b8/cic7o6CrHhA6877e/_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/ab-634991b8/cic7o6CrHhA6877e/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ab-634991b8/cic7o6CrHhA6877e/_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/ab-634991b8/cic7o6CrHhA6877e/_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/ab-634991b8/cic7o6CrHhA6877e/_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/ab-634991b8/cic7o6CrHhA6877e/_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/ab-634991b8/cic7o6CrHhA6877e/_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/ab-634991b8/cic7o6CrHhA6877e/_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/ab-634991b8/cic7o6CrHhA6877e/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List users - 1Password Developer\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a list of users in a 1Password account.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"1Password Developer\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.1password.dev/users-api/list-users\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ab-634991b8.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=List+users\u0026amp;description=Retrieve+a+list+of+users+in+a+1Password+account.\u0026amp;theme=476cbf6ff7a6088524ad5611\u0026amp;signature=3ae0e81f856141c0cc398d35d4dcb180200c2c2c238e7e4bcb92e6c3d00d1afa\">\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 - 1Password Developer\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a list of users in a 1Password account.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ab-634991b8.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=List+users\u0026amp;description=Retrieve+a+list+of+users+in+a+1Password+account.\u0026amp;theme=476cbf6ff7a6088524ad5611\u0026amp;signature=3ae0e81f856141c0cc398d35d4dcb180200c2c2c238e7e4bcb92e6c3d00d1afa\">\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/ab-634991b8/cic7o6CrHhA6877e/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"1Password Developer\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#104ebb\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"YserOhXnJUjFfIZ4K3qgxkVSlQZQdXtIbBiKzZ35Nvs\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.1password.dev/users-api/list-users\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/users-api/list-users.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.1password.dev/#organization\",\"name\":\"1Password Developer\",\"url\":\"https://www.1password.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ab-634991b8/lHrfVfSCdefFz8U5/static/img/logo-dark.svg?fit=max\u0026auto=format\u0026n=lHrfVfSCdefFz8U5\u0026q=85\u0026s=29d1c9358888a723dddd8a89a3b6f71d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.1password.dev#website\",\"name\":\"1Password Developer\",\"url\":\"https://www.1password.dev\",\"publisher\":{\"@id\":\"https://www.1password.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.1password.dev/users-api/list-users#webpage\",\"url\":\"https://www.1password.dev/users-api/list-users\",\"name\":\"List users\",\"description\":\"Retrieve a list of users in a 1Password account.\",\"dateModified\":\"2026-10-08T15:54:18.100Z\",\"isPartOf\":{\"@id\":\"https://www.1password.dev#website\"},\"breadcrumb\":{\"@id\":\"https://www.1password.dev/users-api/list-users#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.1password.dev/users-api/list-users#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Users API\",\"item\":\"https://www.1password.dev/users-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API reference\",\"item\":\"https://www.1password.dev/users-api/reference\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List users\",\"item\":\"https://www.1password.dev/users-api/list-users\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.1password.dev/users-api/list-users#apireference\",\"headline\":\"List users\",\"name\":\"List users\",\"description\":\"Retrieve a list of users in a 1Password account.\",\"url\":\"https://www.1password.dev/users-api/list-users\",\"mainEntityOfPage\":{\"@id\":\"https://www.1password.dev/users-api/list-users#webpage\"},\"dateModified\":\"2026-10-08T15:54:18.100Z\",\"publisher\":{\"@id\":\"https://www.1password.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://www.1password.dev#website\"}}]}\u003c/script>","siteName":"1Password Developer","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/get-started"}]},{"tab":"Tutorials","pages":[{"title":"Tutorials","href":"/tutorials"}]},{"tab":"Security for AI","pages":[{"title":"Security for AI","href":"/security-for-ai"}]},{"tab":"Environments","pages":[{"title":"Environments","href":"/environments"}]},{"tab":"SSH \u0026 Git","pages":[{"title":"SSH \u0026 Git","href":"/ssh"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks"}]},{"tab":"More Tools","menu":[{"item":"VS Code","icon":"laptop","pages":[{"title":"VS Code","href":"/vscode"}]},{"item":"Shell Plugins","icon":"puzzle-piece","pages":[{"title":"Shell Plugins","href":"/cli/shell-plugins"}]},{"item":"Integrations","icon":"puzzle","pages":[{"title":"Integrations","href":"/integrations"}]},{"item":"Secrets Automation","icon":"tablet-screen","pages":[{"title":"Secrets Automation","href":"/secrets-automation"}]},{"item":"Events API","icon":"sensor-triangle-exclamation","pages":[{"title":"Events API","href":"/events-api"}]},{"item":"Users API","icon":"id-badge","groups":[{"group":"Users API","pages":[{"title":"1Password Users API","sidebarTitle":"Overview","href":"/users-api"},{"title":"Get started with the 1Password Users API","sidebarTitle":"Get started","href":"/users-api/get-started"},{"title":"Authorize your integrations using OAuth 2.0","sidebarTitle":"OAuth 2.0 authorization","href":"/users-api/authorization"},{"title":"API conventions","sidebarTitle":"API conventions","href":"/users-api/conventions"},{"group":"API reference","pages":[{"title":"1Password Users API reference","sidebarTitle":"Overview","href":"/users-api/reference"},{"group":"OAuth tokens","pages":[{"title":"Request an access token","sidebarTitle":"Request an access token","openapi":"openapi/oauth_api.yaml POST /v1/oauth/token","playground":"simple","href":"/users-api/request-access-token"},{"title":"Introspect an access token","sidebarTitle":"Introspect an access token","openapi":"openapi/oauth_api.yaml POST /v1/oauth/introspect","playground":"simple","href":"/users-api/introspect-access-token"},{"title":"Revoke an access token","sidebarTitle":"Revoke an access token","openapi":"openapi/oauth_api.yaml POST /v1/oauth/revoke","description":"Revoke an OAuth 2.0 access token used to authorize calls to the 1Password Users API.","playground":"simple","href":"/users-api/revoke-access-token"}]},{"group":"Users","pages":[{"title":"List users","sidebarTitle":"List users","openapi":"openapi/users_api.yaml GET /v1/accounts/{account}/users","href":"/users-api/list-users"},{"title":"Get a user","sidebarTitle":"Get a user","openapi":"openapi/users_api.yaml GET /v1/accounts/{account}/users/{user}","description":"Retrieve a single user in a 1Password account.","href":"/users-api/get-user"},{"title":"Suspend a user","sidebarTitle":"Suspend a user","openapi":"openapi/users_api.yaml POST /v1/accounts/{account}/users/{user}:suspend","href":"/users-api/suspend-user"},{"title":"Reactivate a user","sidebarTitle":"Reactivate a user","openapi":"openapi/users_api.yaml POST /v1/accounts/{account}/users/{user}:reactivate","href":"/users-api/reactivate-user"}]}]}]}]},{"item":"SaaS Manager API","icon":"chart-line","pages":[{"title":"SaaS Manager API","href":"/saas-manager-api"}]},{"item":"Partnership API","icon":"users","pages":[{"title":"Partnership API","href":"/partnership-api/reference"}]},{"item":"Accounts API","icon":"user-gear","pages":[{"title":"Accounts API","href":"/accounts-api"}]},{"item":"Web Development","icon":"code","pages":[{"title":"Web Development","href":"/web/add-1password-button-website"}]},{"item":"Developer Watchtower","icon":"tower-control","pages":[{"title":"Developer Watchtower","href":"/watchtower"}]}]},{"tab":"Agentic Autofill partner guide","hidden":true,"pages":[{"title":"Agentic Autofill partner guide","href":"/agentic-autofill/partners"}]}]},"basePath":"","title":"List users - 1Password Developer","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-DV-WToSZ.js","dist-CBUH0-zX.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-CR-RHrVC.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","AssistantPageLink-BmARFYNC.js"]}