🐰 New: Triage — a self-updating cross-repository queue that prioritizes pull requests by value and risk, so you always know what to review next. Explore Triage →
With a workspace API token, omit org_id and pass linked=true or linked=false to filter the workspace-wide SSO roster. linked=true returns users who have an email address and at least one active linked provider account. linked=false returns users who have no email address or no active linked provider accounts.CodeRabbit applies the filter before cursor pagination. The filter is available only for workspace-wide SSO user listings; organization-scoped and non-SSO requests that include linked return 400 INVALID_REQUEST.For workspace-token examples and identity-management guidance, see SSO user management API.
Cursor for the next page of results, or null if no more results
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CodeRabbit","description":"Guides for Agentic Change Management: review, prioritize, understand, and secure changes across pull requests, your IDE, CLI, and team chat.","colors":{"primary":"#FF570A","light":"#FF570A","dark":"#FF570A"},"logo":{"light":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/coderabbit-logo-light.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=d2bf9e91be0e760ec9cb468676fa6ab6","dark":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/coderabbit-logo-dark.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=feeb1667ed4a2768a15b271f130395c0","href":"/"},"favicon":{"light":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/favicon-light.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=c0b0fbea23b48949cc631606f2a30022","dark":"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/favicon-dark.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=4db7fc04860b6907c7f236f05b37f5c6"},"api":{"openapi":"openapi.json","playground":{"display":"simple"}},"navbar":{"primary":{"type":"button","label":"Sign up","href":"https://app.coderabbit.ai/login?free-trial="}},"footer":{"socials":{"x":"https://x.com/coderabbitai","linkedin":"https://www.linkedin.com/company/coderabbitai","github":"https://github.com/coderabbitai","discord":"https://discord.gg/GsXnASn26c"},"links":[{"header":"Resources","items":[{"label":"Blog","href":"https://coderabbit.ai/blog"},{"label":"Pricing","href":"https://www.coderabbit.ai/pricing"},{"label":"Changelog","href":"https://docs.coderabbit.ai/changelog"},{"label":"Support knowledge base","href":"https://kb.coderabbit.ai"}]},{"header":"Quick links","items":[{"label":"Schedule a demo","href":"https://www.coderabbit.ai/contact-us/sales"},{"label":"Get support","href":"https://docs.coderabbit.ai/support"},{"label":"Status page","href":"https://status.coderabbit.ai"},{"label":"Terms of service","href":"https://www.coderabbit.ai/terms-of-service"},{"label":"Privacy Policy","href":"https://coderabbit.ai/privacy-policy"}]}]},"seo":{"metatags":{"description":"Guides for Agentic Change Management: review, prioritize, understand, and secure changes across pull requests, your IDE, CLI, and team chat.","og:type":"website","og:site_name":"CodeRabbit Documentation","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@coderabbitai","canonical":"https://docs.coderabbit.ai"}},"fonts":{"heading":{"family":"Geist"},"body":{"family":"Geist"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"gtm":{"tagId":"GTM-5BWLXJRC"},"posthog":{"apiKey":"phc_6fDZRN9hYzB83I7Fk2GNHYqas4WMIdGBQ58aZ6EOZR0"}},"banner":{"content":"🐰 New: **Triage** — a self-updating cross-repository queue that prioritizes pull requests by value and risk, so you always know what to review next. [Explore Triage →](/triage)","dismissible":true,"type":"info","color":{"light":"#171717","dark":"#171717"}},"errors":{"404":{"redirect":false,"title":"Page Not Found. Sorry!","description":"Try **Search** or **Ask AI** to find what you're looking for.\nPress \u003ckbd>⌘K\u003c/kbd> (Mac) or \u003ckbd>Ctrl+K\u003c/kbd> (Windows/Linux) to open the search.\n\n\nNeed help? [Get support](/support)."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Quickstart","icon":"rocket","hidden":false,"href":"/getting-started/quickstart"},{"anchor":"Blog","icon":"pen-line","hidden":true,"href":"https://coderabbit.ai/blog"},{"anchor":"Changelog","icon":"history","href":"/changelog"},{"anchor":"Support","icon":"life-buoy","href":"/support"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/coderabbit"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"coderabbit","hasAudioNarration":false,"actualSubdomain":"coderabbit","customDomains":["docs.coderabbit.ai"],"gitSource":{"type":"github","owner":"coderabbitai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae06be2b64cd9c8a5d3308b","collectionId":"c0e0c2d8-6d18-4047-b347-d10658cdadad","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae06be2b64cd9c8a5d3308b"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae078fa83d301a35cf45519","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"CodeRabbit Platform","count":156},{"language":"default","tag":"Management","count":76},{"language":"default","tag":"Tools","count":62},{"language":"default","tag":"Per-tool guides","count":59},{"language":"default","tag":"Languages","count":39},{"language":"default","tag":"CodeRabbit API","count":23},{"language":"default","tag":"API Reference","count":21},{"language":"default","tag":"Agent for Slack and Discord","count":20},{"language":"default","tag":"CLI and IDE tools","count":20},{"language":"default","tag":"Agent for Slack","count":14}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"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":"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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/users-list","slug":"/api-reference/users-list","pageMetadata":{"openapi":"get /v1/users","title":"Users","description":"List all users in your organization with optional filtering by seat assignment and role status. Supports cursor-based pagination.","href":"/api-reference/users-list"},"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: \"List all users in your organization with optional filtering by seat assignment and role status. Supports cursor-based pagination.\"\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];const EnterprisePlanBadge=({tip=`This feature is available exclusively as part of the Enterprise plan. Please refer to our pricing page for more information about our plans and features.`,title=`Enterprise Plan`,cta=`Read more`,href=`https://coderabbit.ai/pricing`,disabled=false})=>{const{Badge,Tooltip}=_provideComponents()||{};if(!Badge)_missingMdxReference(`Badge`,true);if(!Tooltip)_missingMdxReference(`Tooltip`,true);return _jsx(Tooltip,{tip,cta,href,children:_jsx(Badge,{icon:`building-2`,disabled:disabled||undefined,children:title})})};function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading,Info,_MdxComponentBoundary}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_MdxComponentBoundary,{name:`EnterprisePlanBadge`,children:_jsx(EnterprisePlanBadge,{})}),`\n`,_jsx(Heading,{level:`2`,id:`users-list`,children:`Users List`}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Requires `,_jsx(_components.strong,{children:`Admin`}),` role. See `,_jsx(_components.a,{href:`/management/roles`,children:`Role-based access`}),` for details.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`filter-an-sso-workspace-roster-by-linked-status`,children:`Filter an SSO workspace roster by linked status`}),`\n`,_jsxs(_components.p,{children:[`With a workspace API token, omit `,_jsx(_components.code,{children:`org_id`}),` and pass `,_jsx(_components.code,{children:`linked=true`}),` or `,_jsx(_components.code,{children:`linked=false`}),` to filter the workspace-wide SSO roster. `,_jsx(_components.code,{children:`linked=true`}),` returns users who have an email address and at least one active linked provider account. `,_jsx(_components.code,{children:`linked=false`}),` returns users who have no email address or no active linked provider accounts.`]}),`\n`,_jsxs(_components.p,{children:[`CodeRabbit applies the filter before cursor pagination. The filter is available only for workspace-wide SSO user listings; organization-scoped and non-SSO requests that include `,_jsx(_components.code,{children:`linked`}),` return `,_jsx(_components.code,{children:`400 INVALID_REQUEST`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`For workspace-token examples and identity-management guidance, see `,_jsx(_components.a,{href:`/management/sso/user-management-api`,children:`SSO user management API`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{EnterprisePlanBadge,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":"Users","description":"List all users in your organization with optional filtering by seat assignment and role status. Supports cursor-based pagination.","href":"/api-reference/users-list"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[155,686,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[{"title":"Users List","slug":"users-list","depth":2,"children":[]},{"title":"Filter an SSO workspace roster by linked status","slug":"filter-an-sso-workspace-roster-by-linked-status","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/coderabbit/c83587702ff75216/inkeep.js","/_mintlify/custom/coderabbit/b7ecafa4358af1c7/yaml-editor.js","/_mintlify/custom/coderabbit/44fd990531d7b83e/acquisition.js"],"openApiReferenceData":{"operation":{"operationId":"list-users","summary":"Users","description":"List all users in your organization with optional filtering by seat assignment and role status. Supports cursor-based pagination.","x-codeSamples":[{"lang":"Shell","label":"cURL","source":"curl --request GET \\\n --url 'https://api.coderabbit.ai/v1/users?seat_filter=all\u0026role_filter=all\u0026limit=100' \\\n --header 'x-coderabbitai-api-key: \u003capi-key>'"},{"lang":"Python","label":"Python","source":"import requests\n\nurl = 'https://api.coderabbit.ai/v1/users'\n\nheaders = {'x-coderabbitai-api-key': '\u003capi-key>'}\n\nparams = {'seat_filter': 'all', 'role_filter': 'all', 'limit': 100}\n\nresponse = requests.get(url, headers=headers, params=params)\n\nprint(response.text)"},{"lang":"JavaScript","label":"JavaScript","source":"const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '\u003capi-key>'}};\n\nfetch('https://api.coderabbit.ai/v1/users?seat_filter=all\u0026role_filter=all\u0026limit=100', options)\n .then(res => res.json())\n .then(res => console.log(res))\n .catch(err => console.error(err));"},{"lang":"Go","label":"Go","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io\"\n)\n\nfunc main() {\n\n\turl := \"https://api.coderabbit.ai/v1/users?seat_filter=all\u0026role_filter=all\u0026limit=100\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"x-coderabbitai-api-key\", \"\u003capi-key>\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := io.ReadAll(res.Body)\n\n\tfmt.Println(string(body))\n\n}"}],"parameters":["d71132ee-ec51-4ca5-b09f-b556359cd4e2","838d6727-cc28-408a-8e4c-48856dae47e4","9b0b59ef-1a18-4cf0-9397-3d7957a48e33","cc32b7a2-d509-44c1-bb13-6333f79443a0","d46c16f5-2b72-433c-adb3-daa564fe8d6f"],"responses":{"200":"e691340c-c839-45bb-a5c2-43e425440409","400":"eac7988a-9e24-4092-aa3d-c4ddcec7d533","401":"848c751c-cbf8-4af7-b36b-fa51fd3dd89f","403":"86ffd50a-61fd-4134-b68f-2e0d6136bc26","410":"c9edb1f1-0c28-4162-a52f-b1e1ebd1d5a8","429":"7ccb639c-27e6-49f3-88af-848e925be037","500":"f5f538ba-8cce-4321-8261-a8e5eea783fa"},"security":["e578868c-7cb1-4e86-b1b8-2847249532b8"],"method":"get","type":"path","servers":["7e78e78e-0bf5-4102-9e15-4e0e299566e8"],"path":"/v1/users","baseUrlOptions":["https://api.coderabbit.ai"],"title":"Users","codeSamples":[{"label":"cURL","lang":"Shell","source":"curl --request GET \\\n --url 'https://api.coderabbit.ai/v1/users?seat_filter=all\u0026role_filter=all\u0026limit=100' \\\n --header 'x-coderabbitai-api-key: \u003capi-key>'"},{"label":"Python","lang":"Python","source":"import requests\n\nurl = 'https://api.coderabbit.ai/v1/users'\n\nheaders = {'x-coderabbitai-api-key': '\u003capi-key>'}\n\nparams = {'seat_filter': 'all', 'role_filter': 'all', 'limit': 100}\n\nresponse = requests.get(url, headers=headers, params=params)\n\nprint(response.text)"},{"label":"JavaScript","lang":"JavaScript","source":"const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '\u003capi-key>'}};\n\nfetch('https://api.coderabbit.ai/v1/users?seat_filter=all\u0026role_filter=all\u0026limit=100', options)\n .then(res => res.json())\n .then(res => console.log(res))\n .catch(err => console.error(err));"},{"label":"Go","lang":"Go","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io\"\n)\n\nfunc main() {\n\n\turl := \"https://api.coderabbit.ai/v1/users?seat_filter=all\u0026role_filter=all\u0026limit=100\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"x-coderabbitai-api-key\", \"\u003capi-key>\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := io.ReadAll(res.Body)\n\n\tfmt.Println(string(body))\n\n}"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"d71132ee-ec51-4ca5-b09f-b556359cd4e2":{"name":"x-coderabbitai-api-key","description":"Your CodeRabbit API key","required":true,"example":"cr-xxxxxxxxxx","schema":{"type":"string","isRequired":true,"description":"Your CodeRabbit API key","uniqueKey":"","typeLabel":"string"},"in":"header"},"838d6727-cc28-408a-8e4c-48856dae47e4":{"name":"seat_filter","description":"Filter users by seat assignment status","required":false,"schema":{"type":"string","enum":["all","assigned","unassigned"],"default":"all","isRequired":false,"description":"Filter users by seat assignment status","uniqueKey":"","typeLabel":"enum\u003cstring>"},"in":"query"},"9b0b59ef-1a18-4cf0-9397-3d7957a48e33":{"name":"role_filter","description":"Filter users by role","required":false,"schema":{"type":"string","enum":["all","member","admin"],"default":"all","isRequired":false,"description":"Filter users by role","uniqueKey":"","typeLabel":"enum\u003cstring>"},"in":"query"},"cc32b7a2-d509-44c1-bb13-6333f79443a0":{"name":"limit","description":"Maximum number of users to return per page","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":100,"isRequired":false,"description":"Maximum number of users to return per page","uniqueKey":"","typeLabel":"integer"},"in":"query"},"d46c16f5-2b72-433c-adb3-daa564fe8d6f":{"name":"cursor","description":"Pagination cursor from previous response's next_cursor field","required":false,"schema":{"type":"string","isRequired":false,"description":"Pagination cursor from previous response's next_cursor field","uniqueKey":"","typeLabel":"string"},"in":"query"}},"responses":{"e691340c-c839-45bb-a5c2-43e425440409":{"description":"List of users with seat and subscription info","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed per time window (10)","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in current window","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp when the rate limit resets","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"seats_purchased":{"type":"integer","description":"Total number of seats purchased in the subscription","isRequired":true,"uniqueKey":"seats_purchased","typeLabel":"integer"},"seats_assigned":{"type":"integer","description":"Number of seats currently assigned to users","isRequired":true,"uniqueKey":"seats_assigned","typeLabel":"integer"},"seat_assignment_mode":{"type":"string","enum":["automatic","manual"],"description":"The seat assignment mode for the organization","isRequired":true,"uniqueKey":"seat_assignment_mode","typeLabel":"enum\u003cstring>"},"users":{"type":"array","items":{"type":"object","description":"A user in the organization","properties":{"user_id":{"type":"string","description":"Unique identifier assigned by the Git provider","isRequired":true,"uniqueKey":"users.items.[INDEX].user_id","typeLabel":"string"},"seat_assigned":{"type":"boolean","description":"Whether the user has a seat assigned","isRequired":true,"uniqueKey":"users.items.[INDEX].seat_assigned","typeLabel":"boolean"},"role":{"type":"string","description":"User role","isRequired":true,"uniqueKey":"users.items.[INDEX].role","typeLabel":"string"}},"required":["user_id","seat_assigned","role"],"additionalProperties":false,"uniqueKey":"users.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"users","typeLabel":"object[]"},"next_cursor":{"oneOf":[{"type":"string","description":"Cursor for the next page of results, or null if no more results","uniqueKey":"next_cursor.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cursor for the next page of results, or null if no more results","uniqueKey":"next_cursor.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_cursor","typeLabel":"string | null"}},"required":["seats_purchased","seats_assigned","seat_assignment_mode","users"],"uniqueKey":"","typeLabel":"object"},"example":{"seats_purchased":50,"seats_assigned":30,"seat_assignment_mode":"manual","users":[{"user_id":"121358802","seat_assigned":true,"role":"cr_admin"},{"user_id":"22605247","seat_assigned":false,"role":"cr_member"}],"next_cursor":"MjI2MDUyNDc="},"examples":{"Example":{"title":"Example","value":{"seats_purchased":50,"seats_assigned":30,"seat_assignment_mode":"manual","users":[{"user_id":"121358802","seat_assigned":true,"role":"cr_admin"},{"user_id":"22605247","seat_assigned":false,"role":"cr_member"}],"next_cursor":"MjI2MDUyNDc="}}},"exampleType":"examples"}},"exampleType":"examples"},"eac7988a-9e24-4092-aa3d-c4ddcec7d533":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","description":"Standard API error response","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"invalid_filter":{"title":"invalid_filter","value":{"error":{"code":"INVALID_REQUEST","message":"Invalid seat_filter. Must be one of: \"all\", \"assigned\", \"unassigned\""}}},"invalid_cursor":{"title":"invalid_cursor","value":{"error":{"code":"INVALID_REQUEST","message":"Invalid cursor format"}}}},"exampleType":"examples"}},"exampleType":"examples"},"848c751c-cbf8-4af7-b36b-fa51fd3dd89f":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","description":"Standard API error response","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNAUTHORIZED","message":"Invalid or inactive API key"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"Invalid or inactive API key"}}}},"exampleType":"examples"}},"exampleType":"examples"},"86ffd50a-61fd-4134-b68f-2e0d6136bc26":{"description":"Forbidden - Not an admin or missing Enterprise plan","content":{"application/json":{"schema":{"type":"object","description":"Standard API error response","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"NOT_ADMIN","message":"Only administrators can perform seat management operations"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_ADMIN","message":"Only administrators can perform seat management operations"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c9edb1f1-0c28-4162-a52f-b1e1ebd1d5a8":{"description":"Legacy API key - deprecated and no longer supported for user management","content":{"application/json":{"schema":{"type":"object","description":"Standard API error response","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"LEGACY_API_KEY","message":"You are using a legacy API key. We are deprecating use of legacy keys. Regenerate a new API key and retry the request."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"LEGACY_API_KEY","message":"You are using a legacy API key. We are deprecating use of legacy keys. Regenerate a new API key and retry the request."}}}},"exampleType":"examples"}},"exampleType":"examples"},"7ccb639c-27e6-49f3-88af-848e925be037":{"description":"Rate limit exceeded (10 requests per 60 seconds per organization)","content":{"application/json":{"schema":{"type":"object","description":"Standard API error response","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Rate limit exceeded. Max 10 requests per 60 seconds"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Rate limit exceeded. Max 10 requests per 60 seconds"}}}},"exampleType":"examples"}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait before retrying"},"X-RateLimit-Limit":{"description":"Maximum requests allowed per time window","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Always 0 when rate limited","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp when the rate limit resets","schema":{"type":"integer"}}},"exampleType":"examples"},"f5f538ba-8cce-4321-8261-a8e5eea783fa":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Standard API error response","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INTERNAL_ERROR","message":"Internal server error while listing users"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTERNAL_ERROR","message":"Internal server error while listing users"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e578868c-7cb1-4e86-b1b8-2847249532b8":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-coderabbitai-api-key","description":"API key for authentication. You can create an API key from the CodeRabbit dashboard.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"7e78e78e-0bf5-4102-9e15-4e0e299566e8":{"url":"https://api.coderabbit.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-coderabbitai-api-key","description":"API key for authentication. You can create an API key from the CodeRabbit dashboard.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-coderabbitai-api-key","type":"string","description":"API key for authentication. You can create an API key from the CodeRabbit dashboard.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-coderabbitai-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"coderabbit","siteName":"CodeRabbit","title":"Users - CodeRabbit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-28T16:09:56.403Z","originalFileLocation":"api-reference/users-list.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=\"List all users in your organization with optional filtering by seat assignment and role status. Supports cursor-based pagination.\">\u003cmeta data-mint-head name=\"application-name\" content=\"CodeRabbit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_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/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/coderabbit/d4muCEkFHyXyjg4k/_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/coderabbit/d4muCEkFHyXyjg4k/_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/coderabbit/d4muCEkFHyXyjg4k/_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/coderabbit/d4muCEkFHyXyjg4k/_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/coderabbit/d4muCEkFHyXyjg4k/_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/coderabbit/d4muCEkFHyXyjg4k/_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/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Users - CodeRabbit\">\u003cmeta data-mint-head property=\"og:description\" content=\"List all users in your organization with optional filtering by seat assignment and role status. Supports cursor-based pagination.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CodeRabbit Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.coderabbit.ai/api-reference/users-list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://coderabbit.mintlify.app/_mintlify/api/og/v2?division=User+Management\u0026amp;title=Users\u0026amp;description=List+all+users+in+your+organization+with+optional+filtering+by+seat+assignment+and+role+status.+Supports+cursor-based+pagination.\u0026amp;theme=eb8011b6d836a1ac186d66ac\u0026amp;signature=ad87c2685e7578e4570814c8b203801c1db63de0e7aa22e1ccc9a2685597aee1\">\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=\"Users - CodeRabbit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List all users in your organization with optional filtering by seat assignment and role status. Supports cursor-based pagination.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://coderabbit.mintlify.app/_mintlify/api/og/v2?division=User+Management\u0026amp;title=Users\u0026amp;description=List+all+users+in+your+organization+with+optional+filtering+by+seat+assignment+and+role+status.+Supports+cursor-based+pagination.\u0026amp;theme=eb8011b6d836a1ac186d66ac\u0026amp;signature=ad87c2685e7578e4570814c8b203801c1db63de0e7aa22e1ccc9a2685597aee1\">\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/coderabbit/d4muCEkFHyXyjg4k/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CodeRabbit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF570A\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.coderabbit.ai/api-reference/users-list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/users-list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.coderabbit.ai/#organization\",\"name\":\"CodeRabbit\",\"url\":\"https://docs.coderabbit.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/coderabbit/qAZa_d7FrwPO_w-O/coderabbit-logo-light.svg?fit=max\u0026auto=format\u0026n=qAZa_d7FrwPO_w-O\u0026q=85\u0026s=d2bf9e91be0e760ec9cb468676fa6ab6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.coderabbit.ai#website\",\"name\":\"CodeRabbit\",\"url\":\"https://docs.coderabbit.ai\",\"publisher\":{\"@id\":\"https://docs.coderabbit.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.coderabbit.ai/api-reference/users-list#webpage\",\"url\":\"https://docs.coderabbit.ai/api-reference/users-list\",\"name\":\"Users\",\"description\":\"List all users in your organization with optional filtering by seat assignment and role status. Supports cursor-based pagination.\",\"dateModified\":\"2026-08-28T16:09:56.403Z\",\"isPartOf\":{\"@id\":\"https://docs.coderabbit.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.coderabbit.ai/api-reference/users-list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.coderabbit.ai/api-reference/users-list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CodeRabbit API\",\"item\":\"https://docs.coderabbit.ai/api/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.coderabbit.ai/api-reference/metrics-data-api\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Users\",\"item\":\"https://docs.coderabbit.ai/api-reference/users-list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.coderabbit.ai/api-reference/users-list#apireference\",\"headline\":\"Users\",\"name\":\"Users\",\"description\":\"List all users in your organization with optional filtering by seat assignment and role status. Supports cursor-based pagination.\",\"url\":\"https://docs.coderabbit.ai/api-reference/users-list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.coderabbit.ai/api-reference/users-list#webpage\"},\"dateModified\":\"2026-08-28T16:09:56.403Z\",\"publisher\":{\"@id\":\"https://docs.coderabbit.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.coderabbit.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CodeRabbit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"CodeRabbit","nav":{"global":{"anchors":[{"anchor":"Quickstart","icon":"rocket","hidden":false,"href":"/getting-started/quickstart"},{"anchor":"Blog","icon":"pen-line","hidden":true,"href":"https://coderabbit.ai/blog"},{"anchor":"Changelog","icon":"history","href":"/changelog"},{"anchor":"Support","icon":"life-buoy","href":"/support"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/coderabbit"}]},"tabs":[{"tab":"CodeRabbit Platform","icon":"layers","pages":[{"title":"CodeRabbit Platform","href":""}]},{"tab":"CLI and IDE tools","icon":"square-terminal","pages":[{"title":"CLI and IDE tools","href":"/cli"}]},{"tab":"Coding Agent","icon":"square-code","pages":[{"title":"Coding Agent","href":"/code"}]},{"tab":"Agent for Slack and Discord","icon":"bot","pages":[{"title":"Agent for Slack and Discord","href":"/agent"}]},{"tab":"Management","icon":"wrench","pages":[{"title":"Management overview","sidebarTitle":"Overview","mode":"wide","href":"/management"},{"group":"Repository Configuration","icon":"folder-git-2","pages":[{"title":"Overview","href":"/platforms/overview"},{"group":"Supported Git platforms","expanded":false,"pages":[{"title":"GitHub","icon":"github","href":"/platforms/github-com"},{"title":"GitHub Enterprise Server","icon":"github","href":"/platforms/github-enterprise-server"},{"title":"GitLab","icon":"gitlab","href":"/platforms/gitlab-com"},{"title":"Self-managed GitLab","sidebarTitle":"GitLab self-managed","icon":"gitlab","href":"/platforms/self-hosted-gitlab"},{"title":"Azure DevOps","icon":"microsoft","href":"/platforms/azure-devops"},{"title":"Bitbucket Cloud","icon":"bitbucket","href":"/platforms/bitbucket-cloud"},{"title":"Bitbucket Data Center","icon":"bitbucket","href":"/platforms/bitbucket-data-center"}]}]},{"group":"Subscription \u0026 billing","icon":"credit-card","pages":[{"title":"Plans and pricing","sidebarTitle":"Plans and pricing","href":"/management/plans"},{"title":"Review rate limits","sidebarTitle":"Rate limits","href":"/management/rate-limits"},{"title":"Billing and changing plans","sidebarTitle":"Billing and changing plans","href":"/management/billing"},{"title":"Enterprise seat true-up","sidebarTitle":"Enterprise seat true-up","href":"/management/enterprise-seat-true-up"},{"title":"Usage-based reviews","sidebarTitle":"Usage-based reviews","href":"/management/usage-based-addon"},{"title":"Subscription management","sidebarTitle":"Subscription management","href":"/management/subscription-management"}]},{"group":"Connections","icon":"plug","pages":[{"title":"Connections","sidebarTitle":"Connections","href":"/connections/index"},{"title":"Scopes overview","sidebarTitle":"Scopes","href":"/connections/scopes"},{"title":"Review scopes","sidebarTitle":"Review scopes","href":"/connections/scopes-review"},{"title":"Connect MCP servers","sidebarTitle":"MCP servers","href":"/connections/mcp-servers"},{"group":"Issue trackers","root":{"title":"Issue trackers","href":"/connections/issue-trackers"},"pages":[{"title":"Jira Integration","icon":"jira","href":"/connections/jira"},{"title":"Linear Integration","icon":"linear","href":"/connections/linear"}]},{"group":"CI/CD tools","pages":[{"title":"CircleCI integration","sidebarTitle":"CircleCI","href":"/connections/circleci"},{"title":"Jenkins integration","sidebarTitle":"Jenkins","href":"/connections/jenkins"}]}]},{"group":"Dashboard","icon":"layout-dashboard","pages":[{"title":"Overview","href":"/guides/dashboard"},{"title":"Git platform review metrics","href":"/guides/dashboard-metrics"},{"title":"IDE/CLI review metrics","href":"/guides/ide-cli-dashboard-metrics"},{"title":"Review Usage dashboard","sidebarTitle":"Review Usage","href":"/management/review-usage-dashboard"},{"title":"Data Export","href":"/guides/data-export"}]},{"group":"Reports","icon":"text-search","pages":[{"title":"Reports","href":"/management/reports"},{"title":"Schedule reports","href":"/guides/scheduled-reports"},{"title":"Legacy Report Testing","href":"/guides/ondemand-reports"},{"title":"Customize CodeRabbit pull request reports with prompts","sidebarTitle":"Custom reports","href":"/guides/custom-reports"}]},{"group":"Organization administration","icon":"user-cog","pages":[{"title":"Seat assignment","href":"/management/seat-assignment"},{"title":"Role-based access","href":"/management/roles"},{"title":"Custom roles and permissions","href":"/management/custom-roles"},{"title":"Set up Multi-Org","sidebarTitle":"Multiple organizations","href":"/management/multi-org"},{"title":"Add organizations","href":"/management/adding-organizations"},{"title":"Set permissions","href":"/management/upgrading-permissions"},{"title":"Audit Logs","href":"/management/audit-logs"}]},{"group":"Enterprise SSO","icon":"key","pages":[{"title":"Sso","href":"/management/sso"},{"title":"Okta SAML SSO setup","sidebarTitle":"Okta SAML","href":"/management/sso/okta-saml"},{"title":"Google Workspace self-serve SSO setup","sidebarTitle":"Google Workspace","href":"/management/sso/google-workspace-saml"},{"title":"Microsoft Entra ID SSO setup","sidebarTitle":"Microsoft Entra ID","href":"/management/sso/microsoft-entra-saml"},{"title":"SAML 2.0 provider SSO setup","sidebarTitle":"Other SAML 2.0 providers","href":"/management/sso/custom-saml"},{"title":"Prepare self-hosted Git providers for SSO","sidebarTitle":"Self-hosted Git providers","href":"/management/sso/self-hosted-git-providers"},{"title":"Azure DevOps Server setup","sidebarTitle":"Azure DevOps Server","href":"/management/sso/azure-devops-server"},{"title":"SCIM directory sync","sidebarTitle":"SCIM directory sync","href":"/management/sso/scim"},{"title":"SSO user management API","sidebarTitle":"User management API","href":"/management/sso/user-management-api"}]},{"group":"Self-hosted CodeRabbit","icon":"server","pages":[{"title":"Self-hosted CodeRabbit","sidebarTitle":"Overview","href":"/self-hosted/overview"},{"group":"Reverse Tunnel","pages":[{"title":"CodeRabbit Reverse Tunnel","sidebarTitle":"Reverse Tunnel overview","href":"/self-hosted/coderabbit-reverse-tunnel"},{"title":"Reverse Tunnel connector configuration","sidebarTitle":"Connector configuration","href":"/self-hosted/reverse-tunnel-connector-configuration"}]}]},{"group":"CodeRabbit API","icon":"braces","pages":[{"title":"CodeRabbit API","sidebarTitle":"Overview","href":"/api/index"},{"title":"Workspace API tokens","href":"/api/workspace-api-tokens"},{"group":"API Reference","expanded":false,"pages":[{"group":"Metrics","pages":[{"openapi":"get /v1/metrics/reviews","title":"Metrics Data","href":"/api-reference/metrics-data-api"},{"openapi":"get /v1/metrics/review-comments","title":"Review comment metrics","href":"/api-reference/review-comment-metrics"},{"openapi":"get /v1/metrics/mcp","title":"MCP server usage","href":"/api-reference/mcp-metrics"}]},{"group":"Learnings","pages":[{"openapi":"get /v1/learnings","title":"Learnings","href":"/api-reference/learnings-list"},{"openapi":"patch /v1/learnings/{learning_id}","title":"Update Learning","href":"/api-reference/learnings-update"},{"openapi":"delete /v1/learnings/{learning_id}","title":"Delete Learning","href":"/api-reference/learnings-delete"}]},{"group":"Security","pages":[{"openapi":"get /v1/security/scans/code","title":"Deep Scan code findings","href":"/api-reference/security-scans-code-list"}]},{"group":"Organizations","pages":[{"title":"List organizations","openapi":"get /v1/organizations","href":"/api-reference/organizations-list"},{"title":"List organization repositories","openapi":"get /v1/organizations/{organization_id}/repositories","description":"Lists repositories that CodeRabbit currently records as active for an organization. The organization_id is the CodeRabbit organization UUID returned by GET /organizations. Enterprise plan only.","href":"/api-reference/organization-repositories-list"}]},{"group":"User Management","pages":[{"openapi":"get /v1/users","title":"Users","href":"/api-reference/users-list"},{"openapi":"post /v1/users/seats","title":"Seats","description":"Bulk assign or unassign seats for up to 500 users. The request format depends on the type of API key used. **Organization and self-hosted instance API keys** address users by provider user ID with the `action` + `user_ids` format, where the `action` field determines the operation type. **Workspace API keys** address users by email or CodeRabbit user ID (`cr_user_id`) with the `members` format, where each entry declares its desired seat state via `seat_assigned`. Sending the `action` + `user_ids` format with a workspace API key (or the `members` format with an organization key) fails with an `INVALID_REQUEST` error.","href":"/api-reference/users-manage-seats"},{"openapi":"post /v1/users/seats/assignment","title":"Seat Assignment Mode","href":"/api-reference/users-seat-assignment-mode"}]},{"group":"Roles","pages":[{"openapi":"get /v1/roles","title":"List Roles","href":"/api-reference/roles-list"},{"openapi":"post /v1/roles","title":"Create Role","href":"/api-reference/roles-create"},{"openapi":"get /v1/roles/permissions","title":"Role permissions","href":"/api-reference/roles-permissions"},{"openapi":"get /v1/roles/{roleId}","title":"Get Role","href":"/api-reference/roles-get"},{"openapi":"patch /v1/roles/{roleId}","title":"Update Role","href":"/api-reference/roles-update"},{"openapi":"delete /v1/roles/{roleId}","title":"Delete Role","href":"/api-reference/roles-delete"},{"openapi":"post /v1/users/roles","title":"Assign roles","href":"/api-reference/users-change-roles"}]},{"group":"Audit Logs","pages":[{"openapi":"get /v1/audit-logs","title":"Audit Logs","href":"/api-reference/audit-logs"}]},{"group":"Legacy APIs","pages":[{"openapi":"post /api/v1/report.generate","title":"","href":"/api-reference/report-generate"}]}]}]},{"title":"Caching","href":"/reference/caching"},{"title":"Early Access Program","href":"/early-access"}]}]},"title":"Users - CodeRabbit","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-BVNUlwBc.js","dist-aeztFa9U.js","lib--scc4DXi.js","lib-B8HbPgcC.js","clsx-rL8ZCCw4.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","AssistantPageLink-BywkCr5C.js"]}