{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"identifAI","colors":{"primary":"#222b48","light":"#dafe62","dark":"#222b48"},"logo":{"light":"https://mintcdn.com/identifai/zvCv8AYMgEPeD9Z1/images/logo/light.svg?fit=max\u0026auto=format\u0026n=zvCv8AYMgEPeD9Z1\u0026q=85\u0026s=b00fca990eaf6a7e1f635952e39d6e3c","dark":"https://mintcdn.com/identifai/zvCv8AYMgEPeD9Z1/images/logo/dark.svg?fit=max\u0026auto=format\u0026n=zvCv8AYMgEPeD9Z1\u0026q=85\u0026s=73f585260bee2c9d0eb1987dee28465e"},"favicon":"https://mintcdn.com/identifai/zvCv8AYMgEPeD9Z1/favicon.png?fit=max\u0026auto=format\u0026n=zvCv8AYMgEPeD9Z1\u0026q=85\u0026s=d9524168a4c49dc00fdb50da60ddf75f","api":{"openapi":["api-reference/api-swagger-dev-documentation.json","api-v2/api-swagger-v2.json"],"playground":{"display":"none"},"mdx":{"auth":{"method":"key","name":"X-Api-Key"}}},"background":{"color":{"light":"#fefbff","dark":"#131726"}},"navbar":{"links":[{"href":"https://identifai.net/contact/","label":"Support"}],"primary":{"type":"button","label":"Go to Dashboard","href":"https://web.identifai.net"}},"footer":{"socials":{"github":"https://github.com/identifAI-find-origin","linkedin":"https://www.linkedin.com/company/identifai-find-origin?originalSubdomain=it","website":"https://identifai.net/"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"identifai","hasAudioNarration":false,"actualSubdomain":"identifai","customDomains":["docs.identifai.net"],"gitSource":{"type":"github","owner":"identifai-find-origin","repo":"identifai-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae85142ed2f58cb10edc8b8","collectionId":"ee28bc73-2c36-4c02-a82f-14f8522cbb45","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae85142ed2f58cb10edc8b8"},"entitlements":{},"buildId":"6ae85142ed2f58cb10edc8b8","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":26},{"language":"default","tag":"Classification","count":17},{"language":"default","tag":"Documentation","count":10},{"language":"default","tag":"API V2 Reference (BETA)","count":5},{"language":"default","tag":"Get Started","count":5},{"language":"default","tag":"Partner","count":4},{"language":"default","tag":"Classification API","count":4},{"language":"default","tag":"API Documentation","count":3},{"language":"default","tag":"API v2 Documentation","count":2},{"language":"default","tag":"Tampering Detection","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"vite-origin","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":"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":false},"customCss":[],"page":{"pagePath":"api-reference/partner/retrieve-users","slug":"/api-reference/partner/retrieve-users","pageMetadata":{"openapi":"get /api/partner/users","title":"Retrieve users","description":"Fetches a list of users based on the specified filters.","href":"/api-reference/partner/retrieve-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: \"Fetches a list of users based on the specified filters.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /api/partner/users","title":"Retrieve users","description":"Fetches a list of users based on the specified filters.","href":"/api-reference/partner/retrieve-users"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Retrieve users","description":"Fetches a list of users based on the specified filters.","tags":["Partner"],"security":["808450e8-b13b-45bb-add7-91d0f394ea96"],"parameters":["2cb403e8-76b9-4a95-86be-de5af2fb953a","960dde5d-98e5-414a-ba96-6583928f794d","08cc9d22-a759-4928-8418-171314dd76fc","87982039-ec8f-49ab-a42f-adcb62949670","dcfb38ee-e6c5-46b0-a828-4203b6eaf418"],"responses":{"200":"4c3a2bf3-7e5c-443c-8799-4b246941b887","400":"d1092d53-3014-4fdd-b715-b003bc656a49","403":"9f7fb9da-3968-4d22-9ae1-9dd7075173f4","429":"162d91f3-032a-4544-8f64-4e140e7058d2"},"method":"get","type":"path","servers":["26a4015a-3b7b-484d-bd4f-498314c331be"],"path":"/api/partner/users","baseUrlOptions":["https://backend.identifai.net"],"title":"Retrieve users","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2cb403e8-76b9-4a95-86be-de5af2fb953a":{"name":"search","in":"query","schema":{"type":"string","description":"Filter users by name or email (partial match).","uniqueKey":"","typeLabel":"string"},"description":"Filter users by name or email (partial match)."},"960dde5d-98e5-414a-ba96-6583928f794d":{"name":"pricing_id","in":"query","schema":{"type":"integer","description":"Filter users by their pricing tier ID.","uniqueKey":"","typeLabel":"integer"},"description":"Filter users by their pricing tier ID."},"08cc9d22-a759-4928-8418-171314dd76fc":{"name":"order","in":"query","schema":{"type":"string","default":"id","description":"Specify the field to sort results by.","uniqueKey":"","typeLabel":"string"},"description":"Specify the field to sort results by."},"87982039-ec8f-49ab-a42f-adcb62949670":{"name":"direction","in":"query","schema":{"type":"string","enum":["desc","asc"],"description":"Sorting direction: `asc` for ascending, `desc` for descending.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Sorting direction: `asc` for ascending, `desc` for descending."},"dcfb38ee-e6c5-46b0-a828-4203b6eaf418":{"name":"per_page","in":"query","schema":{"type":"integer","description":"Number of results per page. If omitted, all results are returned.","uniqueKey":"","typeLabel":"integer"},"description":"Number of results per page. If omitted, all results are returned."}},"responses":{"4c3a2bf3-7e5c-443c-8799-4b246941b887":{"description":"A paginated list of users matching the search criteria.","content":{"application/json":{"example":{"current_page":1,"data":[{"id":222,"name":"User","email":"User@mail.com","email_verified_at":"2025-03-03T13:28:03.000000Z","address":null,"zip":null,"city":null,"country":null,"phone":null,"contact":null,"vat":null,"created_at":"2025-03-03T13:28:03.000000Z","updated_at":"2025-03-12T09:32:43.000000Z","balance":0,"heuristic":"AverageExcludeObsolete","readonly":null,"pricing":{"id":1,"name":"TestB","sku":"testB"},"partner":{"id":221,"name":"Partner","email":"Partner@gmail.com","email_verified_at":"2025-03-03T11:22:49.000000Z","address":null,"zip":null,"city":null,"country":null,"phone":null,"contact":null,"vat":null,"created_at":"2025-03-03T11:22:49.000000Z","updated_at":"2025-03-03T13:27:06.000000Z","balance":0,"heuristic":"Average","readonly":false,"pricing":{"id":2,"name":"TestAC","sku":"testAC"},"partner":null}}],"from":1,"last_page":1,"next_page_url":null,"per_page":100,"to":1,"total":1},"schema":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number","uniqueKey":"current_page","typeLabel":"integer"},"data":{"type":"array","description":"List of users on the current page","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user.","uniqueKey":"data.items.[INDEX].id","typeLabel":"integer"},"name":{"type":"string","description":"Full name of the user.","uniqueKey":"data.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Email address of the user.","uniqueKey":"data.items.[INDEX].email","typeLabel":"string\u003cemail>"},"email_verified_at":{"type":"string","format":"date-time","description":"Timestamp when the email was verified.","uniqueKey":"data.items.[INDEX].email_verified_at","typeLabel":"string\u003cdate-time>"},"address":{"oneOf":[{"type":"string","description":"User's address.","uniqueKey":"data.items.[INDEX].address.oneOf.0","typeLabel":"string"},{"type":"null","description":"User's address.","uniqueKey":"data.items.[INDEX].address.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].address","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"Postal code of the user.","uniqueKey":"data.items.[INDEX].zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"Postal code of the user.","uniqueKey":"data.items.[INDEX].zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].zip","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City of the user.","uniqueKey":"data.items.[INDEX].city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City of the user.","uniqueKey":"data.items.[INDEX].city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Country of the user.","uniqueKey":"data.items.[INDEX].country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country of the user.","uniqueKey":"data.items.[INDEX].country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].country","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Phone number of the user.","uniqueKey":"data.items.[INDEX].phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number of the user.","uniqueKey":"data.items.[INDEX].phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].phone","typeLabel":"string | null"},"contact":{"oneOf":[{"type":"string","description":"Alternative contact information.","uniqueKey":"data.items.[INDEX].contact.oneOf.0","typeLabel":"string"},{"type":"null","description":"Alternative contact information.","uniqueKey":"data.items.[INDEX].contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].contact","typeLabel":"string | null"},"vat":{"oneOf":[{"type":"string","description":"VAT number of the user, if applicable.","uniqueKey":"data.items.[INDEX].vat.oneOf.0","typeLabel":"string"},{"type":"null","description":"VAT number of the user, if applicable.","uniqueKey":"data.items.[INDEX].vat.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].vat","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp of the user.","uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp of the user.","uniqueKey":"data.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"balance":{"type":"number","description":"The user credits balance.","uniqueKey":"data.items.[INDEX].balance","typeLabel":"number"},"heuristic":{"type":"string","description":"User's heuristic setting.","uniqueKey":"data.items.[INDEX].heuristic","typeLabel":"string"},"readonly":{"type":"boolean","description":"User can only view classification results.","uniqueKey":"data.items.[INDEX].readonly","typeLabel":"boolean"},"pricing":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the pricing plan.","uniqueKey":"data.items.[INDEX].pricing.id","typeLabel":"integer"},"name":{"type":"string","description":"Name of the pricing plan.","uniqueKey":"data.items.[INDEX].pricing.name","typeLabel":"string"},"sku":{"type":"string","description":"SKU code associated with the pricing plan.","uniqueKey":"data.items.[INDEX].pricing.sku","typeLabel":"string"}},"description":"User pricing plan.","uniqueKey":"data.items.[INDEX].pricing","typeLabel":"object"},"partner":{"$circularRef":"26e4754f-8aad-43b5-82b4-196d60e2fc7e","description":"User partner.","uniqueKey":"data.items.[INDEX].partner","typeLabel":"any"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data","typeLabel":"object[]"},"from":{"type":"integer","description":"First user index on the current page","uniqueKey":"from","typeLabel":"integer"},"last_page":{"type":"integer","description":"Total number of pages","uniqueKey":"last_page","typeLabel":"integer"},"next_page_url":{"type":"string","format":"uri","description":"URL of the next page (if available)","uniqueKey":"next_page_url","typeLabel":"string\u003curi>"},"per_page":{"type":"integer","description":"Number of users per page","uniqueKey":"per_page","typeLabel":"integer"},"to":{"type":"integer","description":"Last user index on the current page","uniqueKey":"to","typeLabel":"integer"},"total":{"type":"integer","description":"Total number of users","uniqueKey":"total","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"current_page":1,"data":[{"id":222,"name":"User","email":"User@mail.com","email_verified_at":"2025-03-03T13:28:03.000000Z","address":null,"zip":null,"city":null,"country":null,"phone":null,"contact":null,"vat":null,"created_at":"2025-03-03T13:28:03.000000Z","updated_at":"2025-03-12T09:32:43.000000Z","balance":0,"heuristic":"AverageExcludeObsolete","readonly":null,"pricing":{"id":1,"name":"TestB","sku":"testB"},"partner":{"id":221,"name":"Partner","email":"Partner@gmail.com","email_verified_at":"2025-03-03T11:22:49.000000Z","address":null,"zip":null,"city":null,"country":null,"phone":null,"contact":null,"vat":null,"created_at":"2025-03-03T11:22:49.000000Z","updated_at":"2025-03-03T13:27:06.000000Z","balance":0,"heuristic":"Average","readonly":false,"pricing":{"id":2,"name":"TestAC","sku":"testAC"},"partner":null}}],"from":1,"last_page":1,"next_page_url":null,"per_page":100,"to":1,"total":1}}},"exampleType":"examples"}},"exampleType":"examples"},"d1092d53-3014-4fdd-b715-b003bc656a49":{"description":"Invalid query parameters, missing pricing or not accessible, no more seats available for partner pricing, or incorrect password.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9f7fb9da-3968-4d22-9ae1-9dd7075173f4":{"description":"Parner not authorized to access the user or the user is not authorized to use the API.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"162d91f3-032a-4544-8f64-4e140e7058d2":{"description":"Too many requests.","content":{"application/json":{"example":{"error":"Too Many Attempts."},"examples":{"Example":{"title":"Example","value":{"error":"Too Many Attempts."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"808450e8-b13b-45bb-add7-91d0f394ea96":{"ApiKeyAuth":{"type":"apiKey","name":"X-Api-Key","in":"header","description":"Your API key.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"26a4015a-3b7b-484d-bd4f-498314c331be":{"url":"https://backend.identifai.net"}},"schemas":{"26e4754f-8aad-43b5-82b4-196d60e2fc7e":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user."},"name":{"type":"string","description":"Full name of the user."},"email":{"type":"string","format":"email","description":"Email address of the user."},"email_verified_at":{"type":"string","format":"date-time","description":"Timestamp when the email was verified."},"address":{"oneOf":[{"type":"string","description":"User's address."},{"type":"null","description":"User's address."}]},"zip":{"oneOf":[{"type":"string","description":"Postal code of the user."},{"type":"null","description":"Postal code of the user."}]},"city":{"oneOf":[{"type":"string","description":"City of the user."},{"type":"null","description":"City of the user."}]},"country":{"oneOf":[{"type":"string","description":"Country of the user."},{"type":"null","description":"Country of the user."}]},"phone":{"oneOf":[{"type":"string","description":"Phone number of the user."},{"type":"null","description":"Phone number of the user."}]},"contact":{"oneOf":[{"type":"string","description":"Alternative contact information."},{"type":"null","description":"Alternative contact information."}]},"vat":{"oneOf":[{"type":"string","description":"VAT number of the user, if applicable."},{"type":"null","description":"VAT number of the user, if applicable."}]},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp of the user."},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp of the user."},"balance":{"type":"number","description":"The user credits balance."},"heuristic":{"type":"string","description":"User's heuristic setting."},"readonly":{"type":"boolean","description":"User can only view classification results."},"pricing":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the pricing plan."},"name":{"type":"string","description":"Name of the pricing plan."},"sku":{"type":"string","description":"SKU code associated with the pricing plan."}},"description":"User pricing plan."},"partner":{"$circularRef":"26e4754f-8aad-43b5-82b4-196d60e2fc7e","description":"User partner."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-Api-Key","in":"header","description":"Your API key.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-Api-Key","type":"string","description":"Your API key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-Api-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/api-swagger-dev-documentation.json"},"subdomain":"identifai","siteName":"identifAI","title":"Retrieve users - identifAI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-10T16:09:45.533Z","originalFileLocation":"api-reference/partner/retrieve-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=\"Fetches a list of users based on the specified filters.\">\u003cmeta data-mint-head name=\"application-name\" content=\"identifAI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/identifai/moXcNkgOLd8SjPnW/_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/identifai/moXcNkgOLd8SjPnW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/identifai/moXcNkgOLd8SjPnW/_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/identifai/moXcNkgOLd8SjPnW/_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/identifai/moXcNkgOLd8SjPnW/_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/identifai/moXcNkgOLd8SjPnW/_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/identifai/moXcNkgOLd8SjPnW/_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/identifai/moXcNkgOLd8SjPnW/_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/identifai/moXcNkgOLd8SjPnW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve users - identifAI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetches a list of users based on the specified filters.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"identifAI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.identifai.net/api-reference/partner/retrieve-users\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://identifai.mintlify.site/_mintlify/api/og/v2?division=Partner\u0026amp;title=Retrieve+users\u0026amp;description=Fetches+a+list+of+users+based+on+the+specified+filters.\u0026amp;theme=510d1d39bda40444e541f003\u0026amp;signature=207c8c71374cd2efd38d975d6f027b9079d167c2063f56816821e07232652135\">\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=\"Retrieve users - identifAI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetches a list of users based on the specified filters.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://identifai.mintlify.site/_mintlify/api/og/v2?division=Partner\u0026amp;title=Retrieve+users\u0026amp;description=Fetches+a+list+of+users+based+on+the+specified+filters.\u0026amp;theme=510d1d39bda40444e541f003\u0026amp;signature=207c8c71374cd2efd38d975d6f027b9079d167c2063f56816821e07232652135\">\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/identifai/moXcNkgOLd8SjPnW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"identifAI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#222b48\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.identifai.net/api-reference/partner/retrieve-users\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/partner/retrieve-users.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.identifai.net/#organization\",\"name\":\"identifAI\",\"url\":\"https://docs.identifai.net\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/identifai/zvCv8AYMgEPeD9Z1/images/logo/light.svg?fit=max\u0026auto=format\u0026n=zvCv8AYMgEPeD9Z1\u0026q=85\u0026s=b00fca990eaf6a7e1f635952e39d6e3c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.identifai.net#website\",\"name\":\"identifAI\",\"url\":\"https://docs.identifai.net\",\"publisher\":{\"@id\":\"https://docs.identifai.net/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.identifai.net/api-reference/partner/retrieve-users#webpage\",\"url\":\"https://docs.identifai.net/api-reference/partner/retrieve-users\",\"name\":\"Retrieve users\",\"description\":\"Fetches a list of users based on the specified filters.\",\"dateModified\":\"2025-11-10T16:09:45.533Z\",\"isPartOf\":{\"@id\":\"https://docs.identifai.net#website\"},\"breadcrumb\":{\"@id\":\"https://docs.identifai.net/api-reference/partner/retrieve-users#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.identifai.net/api-reference/partner/retrieve-users#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Partner\",\"item\":\"https://docs.identifai.net/api-reference/partner/create-new-user\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve users\",\"item\":\"https://docs.identifai.net/api-reference/partner/retrieve-users\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.identifai.net/api-reference/partner/retrieve-users#apireference\",\"headline\":\"Retrieve users\",\"name\":\"Retrieve users\",\"description\":\"Fetches a list of users based on the specified filters.\",\"url\":\"https://docs.identifai.net/api-reference/partner/retrieve-users\",\"mainEntityOfPage\":{\"@id\":\"https://docs.identifai.net/api-reference/partner/retrieve-users#webpage\"},\"dateModified\":\"2025-11-10T16:09:45.533Z\",\"publisher\":{\"@id\":\"https://docs.identifai.net/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.identifai.net#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"identifAI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"identifAI","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Make an API call","href":"/api-reference/introduction"},{"title":"Rate Limits","href":"/api-reference/rate-limits"},{"title":"Changelog","icon":"clock-rotate-left","href":"/api-reference/changelog"}]},{"group":"Classification","pages":[{"openapi":"GET /api/classifications","title":"Get multiple image classifications results","href":"/api-reference/classification/get-all-classifications"},{"openapi":"get /api/classifications_video","title":"Get multiple video classifications results","href":"/api-reference/classification/get-all-classifications-video"},{"openapi":"get /api/classifications_audio","title":"Get multiple audio classifications results","href":"/api-reference/classification/get-all-classifications-audio"},{"openapi":"post /api/classification","title":"Classify an image","href":"/api-reference/classification/submit-an-image-for-classification"},{"openapi":"post /api/image_fromurl","title":"Classify an image from URL","href":"/api-reference/classification/submit-image-from-url"},{"openapi":"get /api/classification/{identifier}","title":"Get single image classification result","href":"/api-reference/classification/get-classification-result"},{"openapi":"get /api/classification/heatmap/{identifier}","title":"Get an image AI heatmap","href":"/api-reference/classification/get-classification-heatmap"},{"openapi":"post /api/classification/{hash}/override","title":"Override image classification","href":"/api-reference/classification/override-image-classification"},{"openapi":"post /api/classification_video","title":"Classify a video","href":"/api-reference/classification/submit-a-video-for-classification"},{"openapi":"post /api/video_fromurl","title":"Classify a video from URL","href":"/api-reference/classification/submit-video-from-url"},{"openapi":"get /api/classification_video/{identifier}","title":"Get single video classification result","href":"/api-reference/classification/get-classification-result-video"},{"openapi":"post /api/classification_video/{hash}/override","title":"Override video classification","href":"/api-reference/classification/override-video-classification"},{"openapi":"post /api/classification_audio","title":"Classify a speech","href":"/api-reference/classification/submit-a-speech-for-classification"},{"openapi":"post /api/audio_fromurl","title":"Classify a speech from URL","href":"/api-reference/classification/submit-speech-from-url"},{"openapi":"get /api/classification_audio/{identifier}","title":"Get single audio classification result","href":"/api-reference/classification/get-classification-result-speech"},{"openapi":"post /api/classification_audio/{hash}/override","title":"Override audio classification","href":"/api-reference/classification/override-audio-classification"},{"openapi":"post /api/validate","title":"Validate a media file","href":"/api-reference/classification/validate-media"}]},{"group":"Infrastructure","pages":[{"openapi":"get /api/health","title":"Check infrastructure health","href":"/api-reference/infrastructure/health"}]},{"group":"User","pages":[{"openapi":"get /api/user/credits","title":"Get user credits","href":"/api-reference/user/user-credits"}]},{"group":"Partner","pages":[{"openapi":"post /api/partner/user","title":"Create or update user","description":"Creates a new user or updates an existing one. Partners can only create or update users under their partnership.","href":"/api-reference/partner/create-new-user"},{"openapi":"get /api/partner/users","title":"Retrieve users","href":"/api-reference/partner/retrieve-users"},{"openapi":"post /api/partner/send_creation_email","title":"Send creation email","description":"Sends an email to the specified user containing a password reset link or account activation instructions.","href":"/api-reference/partner/send-creation-email"},{"openapi":"get /api/partner/pricings","title":"Get pricings","href":"/api-reference/partner/get-pricings"}]}]},{"tab":"API V2 Reference (BETA)","pages":[{"title":"API V2 Reference (BETA)","href":"/api-v2/introduction"}]}]},"basePath":"","title":"Retrieve users - identifAI","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}