Unix timestamp (in seconds) indicating when this response was generated.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Paywint API Documentation","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/paywint/EiJlm9ZH8Q15y0cZ/assets/logo/app-logo-dark.png?fit=max\u0026auto=format\u0026n=EiJlm9ZH8Q15y0cZ\u0026q=85\u0026s=f12d90d73ed14c836d511ba59f126f89","dark":"https://mintcdn.com/paywint/EiJlm9ZH8Q15y0cZ/assets/logo/app-logo-light.png?fit=max\u0026auto=format\u0026n=EiJlm9ZH8Q15y0cZ\u0026q=85\u0026s=dd0531c96945bbfd4f68f70bde733ca7"},"favicon":"https://mintcdn.com/paywint/orA5aITV2zVCFn-B/favicon.ico?fit=max\u0026auto=format\u0026n=orA5aITV2zVCFn-B\u0026q=85\u0026s=6eb5a2357ac8b399600e7997771b7068","api":{"openapi":{"source":"https://api.sandbox.paywint.com/openapi.json?v=1.0.0","directory":"api-reference"}},"navbar":{"links":[{"href":"mailto:support@paywint.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.paywint.com"}},"footer":{"socials":{"youtube":"https://www.youtube.com/@paywint","facebook":"https://www.facebook.com/paywintonline","instagram":"https://www.instagram.com/paywint","x":"https://x.com/paywint","linkedin":"https://www.linkedin.com/company/paywint","threads":"https://www.threads.net/@paywint"}},"seo":{"indexing":"all"},"fonts":{"family":"Inter","weight":400},"styling":{"eyebrows":"breadcrumbs","latex":false},"interaction":{"drilldown":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paywint","hasAudioNarration":false,"actualSubdomain":"paywint","customDomains":["developer.paywint.com"],"gitSource":{"type":"github","owner":"paywint-developer","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9292e38209ab1c632e1e9:success","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":79},{"language":"default","tag":"Cross Border Payments","count":12},{"language":"default","tag":"Bank Accounts","count":8},{"language":"default","tag":"Payments","count":7},{"language":"default","tag":"Guidelines","count":7},{"language":"default","tag":"URL Standards","count":7},{"language":"default","tag":"Cards","count":6},{"language":"default","tag":"Payee Management","count":6},{"language":"default","tag":"KYC \u0026 KYB","count":5},{"language":"default","tag":"Payee Addresses","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/users/list","slug":"/api-reference/users/list","pageMetadata":{"title":"List Users","openapi":"POST /api/platform/users/list","description":"Retrieve a list of users created under the current platform.","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: \"Retrieve a list of users created under the current platform.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List Users","openapi":"POST /api/platform/users/list","description":"Retrieve a list of users created under the current platform.","href":"/api-reference/users/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Platform Users"],"summary":"List Platform Users","description":"Retrieve a list of users created under the current platform.","operationId":"list_users_api_platform_users_list_post","parameters":["a489ae43-7a14-48c2-b68d-b7e9c25ba362","313e7432-ee98-45f4-b2e3-66b378c242d5"],"requestBody":"8a298464-0c08-40ee-b1a1-4bcecf8d25c2","responses":{"200":"c670e3c9-ae62-4d80-a90a-9256fc2d4c64","422":"ee1e8927-a61b-4494-8c6a-a23df0c407a6"},"method":"post","type":"path","servers":["44a613da-32d2-4c57-bda9-25c34c98d8e8","d63574fc-ac93-4daa-ba67-9fa825653088"],"security":[],"path":"/api/platform/users/list","baseUrlOptions":["https://api.paywint.com","https://api.sandbox.paywint.com"],"title":"List Platform Users","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a489ae43-7a14-48c2-b68d-b7e9c25ba362":{"name":"X-Platform-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.","title":"X-Platform-Id","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request."},"313e7432-ee98-45f4-b2e3-66b378c242d5":{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string","description":"HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`.","title":"X-Signature","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"rows_per_page":{"type":"integer","enum":[10,20,50,100],"title":"RowsPerPage","description":"Number of records to return per page. Accepted values are 10, 20, 50, or 100.","example":50,"isRequired":true,"uniqueKey":"rows_per_page","typeLabel":"enum\u003cinteger>"},"page_no":{"type":"integer","minimum":1,"title":"Page No","description":"Page number to retrieve, starting from 1. For example, page_no=1 returns the first page of results.","example":1,"isRequired":true,"uniqueKey":"page_no","typeLabel":"integer"}},"type":"object","required":["rows_per_page","page_no"],"title":"ExternalPaginationRequest","uniqueKey":"","typeLabel":"ExternalPaginationRequest · object"},"examples":{"Example":{"title":"Example","value":{"rows_per_page":50,"page_no":1}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c670e3c9-ae62-4d80-a90a-9256fc2d4c64":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success","description":"Indicates whether the request was processed successfully.","default":true,"example":true,"uniqueKey":"success","typeLabel":"boolean"},"status_code":{"oneOf":[{"type":"integer","title":"Status Code","description":"HTTP status code representing the result of the request.","default":200,"uniqueKey":"status_code.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Status Code","description":"HTTP status code representing the result of the request.","default":200,"uniqueKey":"status_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_code","typeLabel":"integer | null"},"message":{"oneOf":[{"type":"string","title":"Message","description":"Short, human-readable message describing the outcome of the request.","default":"Success","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Message","description":"Short, human-readable message describing the outcome of the request.","default":"Success","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"records":{"oneOf":[{"type":"array","items":{"properties":{"pw_id":{"type":"integer","title":"Pw Id","description":"Integer ID of user in paywint","example":111,"isRequired":true,"uniqueKey":"records.oneOf.0.items.[INDEX].pw_id","typeLabel":"integer"},"user_id":{"type":"string","format":"uuid","title":"User Id","description":"UUID of the user","example":"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4","uniqueKey":"records.oneOf.0.items.[INDEX].user_id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","title":"Name","example":"John Doe","uniqueKey":"records.oneOf.0.items.[INDEX].name","typeLabel":"string"},"email":{"oneOf":[{"type":"string","title":"Email","example":"john.doe@example.com","uniqueKey":"records.oneOf.0.items.[INDEX].email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","example":"john.doe@example.com","uniqueKey":"records.oneOf.0.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"uniqueKey":"records.oneOf.0.items.[INDEX].email","typeLabel":"string | null"},"phone_country_code":{"oneOf":[{"type":"string","title":"Phone Country Code","description":"International dialing code of the user’s phone number (e.g., +1 for US).","example":"+1","uniqueKey":"records.oneOf.0.items.[INDEX].phone_country_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone Country Code","description":"International dialing code of the user’s phone number (e.g., +1 for US).","example":"+1","uniqueKey":"records.oneOf.0.items.[INDEX].phone_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"records.oneOf.0.items.[INDEX].phone_country_code","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","title":"Phone","description":"User’s local phone number, excluding country code.","example":"1234567890","uniqueKey":"records.oneOf.0.items.[INDEX].phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone","description":"User’s local phone number, excluding country code.","example":"1234567890","uniqueKey":"records.oneOf.0.items.[INDEX].phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"records.oneOf.0.items.[INDEX].phone","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the user was created","example":"2025-06-10T18:10:42.000Z","uniqueKey":"records.oneOf.0.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"}},"type":"object","required":["pw_id"],"title":"PlatformUserRead","uniqueKey":"records.oneOf.0.items.[INDEX]","typeLabel":"PlatformUserRead · object"},"title":"Records","description":"List of result items returned for the current page.","uniqueKey":"records.oneOf.0","typeLabel":"PlatformUserRead · object[]"},{"type":"null","title":"Records","description":"List of result items returned for the current page.","uniqueKey":"records.oneOf.1","typeLabel":"null"}],"uniqueKey":"records","typeLabel":"PlatformUserRead · object[] | null"},"totalRecords":{"oneOf":[{"type":"integer","title":"Totalrecords","description":"Total number of matching records in the database, useful for paginating the full dataset.","default":0,"uniqueKey":"totalRecords.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Totalrecords","description":"Total number of matching records in the database, useful for paginating the full dataset.","default":0,"uniqueKey":"totalRecords.oneOf.1","typeLabel":"null"}],"uniqueKey":"totalRecords","typeLabel":"integer | null"},"queryGeneratedTime":{"oneOf":[{"type":"integer","title":"Querygeneratedtime","description":"Unix timestamp (in seconds) indicating when this response was generated.","default":1783679844,"uniqueKey":"queryGeneratedTime.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Querygeneratedtime","description":"Unix timestamp (in seconds) indicating when this response was generated.","default":1783679844,"uniqueKey":"queryGeneratedTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"queryGeneratedTime","typeLabel":"integer | null"}},"type":"object","title":"ExternalListResponse[PlatformUserRead]","uniqueKey":"","typeLabel":"ExternalListResponse[PlatformUserRead] · object"},"examples":{"Example":{"title":"Example","value":{"success":true,"status_code":200,"message":"Success","records":[{"pw_id":111,"user_id":"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4","name":"John Doe","email":"john.doe@example.com","phone_country_code":"+1","phone":"1234567890","created_at":"2025-06-10T18:10:42.000Z"}],"totalRecords":0,"queryGeneratedTime":1783679844}}},"exampleType":"generated"}},"exampleType":"generated"},"ee1e8927-a61b-4494-8c6a-a23df0c407a6":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"44a613da-32d2-4c57-bda9-25c34c98d8e8":{"url":"https://api.paywint.com"},"d63574fc-ac93-4daa-ba67-9fa825653088":{"url":"https://api.sandbox.paywint.com"}}},"originalFileLocation":"https://api.sandbox.paywint.com/openapi.json?v=1.0.0"},"subdomain":"paywint","siteName":"Paywint API Documentation","title":"List Users - Paywint API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"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=\"Retrieve a list of users created under the current platform.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paywint API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Users - Paywint API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a list of users created under the current platform.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paywint API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.paywint.com/api-reference/users/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paywint.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=List+Users\u0026amp;description=Retrieve+a+list+of+users+created+under+the+current+platform.\u0026amp;theme=797b9154450531e0ce6f7e8b\u0026amp;signature=7607e88801f4216df224fb3e332d219b0c7d3be4b5fc99ffe8b879c952f83d94\">\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 - Paywint API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a list of users created under the current platform.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paywint.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=List+Users\u0026amp;description=Retrieve+a+list+of+users+created+under+the+current+platform.\u0026amp;theme=797b9154450531e0ce6f7e8b\u0026amp;signature=7607e88801f4216df224fb3e332d219b0c7d3be4b5fc99ffe8b879c952f83d94\">\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/paywint/Rui-6qiiIEQFwPVS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paywint API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.paywint.com/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://developer.paywint.com/#organization\",\"name\":\"Paywint API Documentation\",\"url\":\"https://developer.paywint.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paywint/EiJlm9ZH8Q15y0cZ/assets/logo/app-logo-dark.png?fit=max\u0026auto=format\u0026n=EiJlm9ZH8Q15y0cZ\u0026q=85\u0026s=f12d90d73ed14c836d511ba59f126f89\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.paywint.com#website\",\"name\":\"Paywint API Documentation\",\"url\":\"https://developer.paywint.com\",\"publisher\":{\"@id\":\"https://developer.paywint.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.paywint.com/api-reference/users/list#webpage\",\"url\":\"https://developer.paywint.com/api-reference/users/list\",\"name\":\"List Users\",\"description\":\"Retrieve a list of users created under the current platform.\",\"isPartOf\":{\"@id\":\"https://developer.paywint.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.paywint.com/api-reference/users/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.paywint.com/api-reference/users/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Users\",\"item\":\"https://developer.paywint.com/api-reference/users/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Users\",\"item\":\"https://developer.paywint.com/api-reference/users/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.paywint.com/api-reference/users/list#apireference\",\"headline\":\"List Users\",\"name\":\"List Users\",\"description\":\"Retrieve a list of users created under the current platform.\",\"url\":\"https://developer.paywint.com/api-reference/users/list\",\"mainEntityOfPage\":{\"@id\":\"https://developer.paywint.com/api-reference/users/list#webpage\"},\"publisher\":{\"@id\":\"https://developer.paywint.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.paywint.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paywint API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Paywint API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/users/list.md","siteName":"Paywint API Documentation","nav":{"global":null,"tabs":[{"tab":"Get Started","icon":"rocket","pages":[{"title":"Get Started","href":"/get-started/overview"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Users","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/users/overview"},{"title":"Create User","openapi":"POST /api/platform/users/create","description":"Creates a new user account into the platform.\n\nThis endpoint enables platforms to:\n- Register a new user\n- Automatically generate a wallet for the user\n- Initialize default settings for the newly created user\n- At least one is required: provide either an email or a phone number with country code.","href":"/api-reference/users/create"},{"title":"List Users","openapi":"POST /api/platform/users/list","href":"/api-reference/users/list"},{"title":"Get User","openapi":"GET /api/platform/users/get/{user_id}","description":"Retrieve user details for a specific user ID within the platform.\n\nThis endpoint is used by platform admins to:\n- Fetch a single user by their unique ID\n- Ensure the user belongs to the platform making the request\n- Return structured user data if found","href":"/api-reference/users/get"}]},{"group":"KYC \u0026 KYB","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/compliance/overview"},{"title":"Submit KYC","openapi":"GET /api/platform/persona/platform-user/inquiry/{user_id}","href":"/api-reference/compliance/kyc/create-enquiry-link"},{"title":"Get KYC","openapi":"GET /api/platform/users/kyc/{user_id}","href":"/api-reference/compliance/kyc/get"},{"title":"Submit KYB","openapi":"POST /api/platform/kyb/submit-kyb/{user_id}","href":"/api-reference/compliance/kyb/submit"},{"title":"Get KYB","openapi":"GET /api/platform/kyb/{user_id}","href":"/api-reference/compliance/kyb/get"}]},{"group":"Wallet","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/wallet/overview"},{"title":"Get Wallet","openapi":"GET /api/platform/wallet/get/{user_id}","href":"/api-reference/wallet/get"},{"title":"Fund Wallet / ACH Pull","openapi":"POST /api/platform/wallet/fund-wallet/{user_id}","href":"/api-reference/wallet/fund"},{"title":"Withdraw Fund","openapi":"POST /api/platform/withdrawals/withdraw-fund/{user_id}","href":"/api-reference/wallet/withdraw"}]},{"group":"Payments","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payments/overview"},{"title":"Create Payment","openapi":"POST /api/platform/payment/create-payment","href":"/api-reference/payments/create"},{"title":"Mail Check","openapi":"POST /api/platform/payment/mail-check/{user_id}","href":"/api-reference/payments/mail-check"},{"title":"Get Payment Details","openapi":"GET /api/platform/payment/get-payment/{payment_id}","href":"/api-reference/payments/get"},{"title":"List Payments","openapi":"POST /api/platform/payment/list-payment","href":"/api-reference/payments/list"},{"title":"List User Payments","openapi":"POST /api/platform/payment/list-payment/{user_id}","href":"/api-reference/payments/list-sent"},{"title":"List User Received Payments","openapi":"POST /api/platform/payment/list-received-payment/{user_id}","href":"/api-reference/payments/list-received"}]},{"group":"Accept Payments","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payments/checkout/overview"},{"title":"Create Payment Link","openapi":"POST /api/platform/payment/create-payment-link/{user_id}","href":"/api-reference/payments/checkout/create-payment-link"},{"title":"Create Checkout SDK Token","openapi":"POST /api/checkout/token/platform","href":"/api-reference/payments/checkout/create-checkout-token"}]},{"group":"Cross Border Payments","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/cross-boarder-payments/overview"},{"title":"Create a Cross-Border Payment","openapi":"POST /api/platform/cross-border/create-payment","href":"/api-reference/cross-boarder-payments/create-a-cross-border-payment"},{"title":"List Payout Banks","openapi":"GET /api/platform/cross-border/payout-banks","href":"/api-reference/cross-boarder-payments/list-payout-banks"},{"title":"Get Exchange Rates","openapi":"GET /api/platform/cross-border/rates","href":"/api-reference/cross-boarder-payments/get-exchange-rates"},{"title":"Get Payee Rules (Mandatory Fields)","openapi":"GET /api/platform/cross-border/payee-rules","href":"/api-reference/cross-boarder-payments/get-payee-rules"},{"title":"Add a Payee Address","openapi":"POST /api/platform/cross-border/payee/address/{user_id}","href":"/api-reference/cross-boarder-payments/add-payee-address"},{"title":"Get a Payee Address","openapi":"GET /api/platform/cross-border/payee/address/{user_id}/{address_id}","href":"/api-reference/cross-boarder-payments/get-a-payee-address"},{"title":"Edit a Payee Address","openapi":"PATCH /api/platform/cross-border/payee/address/{user_id}/{address_id}","href":"/api-reference/cross-boarder-payments/edit-a-payee-address"},{"title":"List Payee Addresses","openapi":"GET /api/platform/cross-border/payee/addresses/{user_id}","href":"/api-reference/cross-boarder-payments/list-payee-addresses"},{"title":"Add a Payee Bank","openapi":"POST /api/platform/cross-border/payee/bank/{user_id}","href":"/api-reference/cross-boarder-payments/add-payee-bank"},{"title":"List Payee Banks","openapi":"GET /api/platform/cross-border/payee/banks/{user_id}","href":"/api-reference/cross-boarder-payments/list-payee-banks"},{"title":"Delete a Payee Bank","openapi":"DELETE /api/platform/cross-border/payee/bank/{user_id}/{bank_uuid}","href":"/api-reference/cross-boarder-payments/delete-payee-bank"}]},{"group":"Bank Accounts","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/bank-accounts/overview"},{"title":"Add Bank Account","openapi":"POST /api/platform/accounts/add-account","href":"/api-reference/bank-accounts/add"},{"title":"Get Bank Account","openapi":"GET /api/platform/accounts/get-account/{account_id}","href":"/api-reference/bank-accounts/get"},{"title":"Set Bank Account To Default","openapi":"POST /api/platform/accounts/set-default/{user_id}","href":"/api-reference/bank-accounts/set-default"},{"title":"List Bank Accounts","openapi":"GET /api/platform/accounts/list/{user_id}","href":"/api-reference/bank-accounts/list"},{"title":"Release Micro-Deposit","openapi":"POST /api/platform/accounts/release-micro-deposit/{user_id}","href":"/api-reference/bank-accounts/release-micro-deposit"},{"title":"Verify Micro-Deposit","openapi":"POST /api/platform/accounts/verify-micro-deposit/{user_id}","href":"/api-reference/bank-accounts/verify-micro-deposit"},{"title":"Delete Bank Account","openapi":"DELETE /api/platform/accounts/delete/{user_id}","href":"/api-reference/bank-accounts/delete"}]},{"group":"Paywint Bank Accounts","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/paywint-bank-accounts/overview"},{"title":"Open Paywint Bank Account","openapi":"POST /api/platform/accounts/open-pw-bank-account/{user_id}","href":"/api-reference/paywint-bank-accounts/open"},{"title":"List Paywint Bank Accounts","openapi":"GET /api/platform/accounts/list-pw-banks/{user_id}","href":"/api-reference/paywint-bank-accounts/list"},{"title":"Paywint Bank Account Withdrawal","openapi":"POST /api/platform/withdrawals/transfer-from-pw-bank/{user_id}","href":"/api-reference/paywint-bank-accounts/withdrawal"},{"title":"List Paywint Bank Account Transactions","openapi":"POST /api/platform/accounts/list-pw-transactions/{user_id}","href":"/api-reference/paywint-bank-accounts/list-transactions"}]},{"group":"Cards","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/cards/overview"},{"title":"Add Card","openapi":"POST /api/platform/card/add/secure-link/{user_id}","href":"/api-reference/cards/add"},{"title":"Update Card","openapi":"POST /api/platform/card/update/secure-link/{user_id}","href":"/api-reference/cards/update"},{"title":"Get Card","openapi":"GET /api/platform/card/get-card/{card_id}","href":"/api-reference/cards/get"},{"title":"List Cards","openapi":"GET /api/platform/card/list/{user_id}","href":"/api-reference/cards/list"},{"title":"Delete Card","openapi":"DELETE /api/platform/card/delete/{user_id}","href":"/api-reference/cards/delete"}]},{"group":"Check","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/checks/overview"},{"title":"Add Check Address","openapi":"POST /api/platform/check/add-address/{user_id}","href":"/api-reference/checks/add-address"},{"title":"Update Check Address","openapi":"PATCH /api/platform/check/update-address/{user_id}","href":"/api-reference/checks/update-address"},{"title":"Update Check Config","openapi":"POST /api/platform/check/update-config/{user_id}","href":"/api-reference/checks/update-config"}]},{"group":"Payee Management","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payees/overview"},{"title":"Create Payee","openapi":"POST /api/platform/payee/create/{user_id}","href":"/api-reference/payees/create"},{"title":"Update Payee","openapi":"PUT /api/platform/payee/update/{user_id}","href":"/api-reference/payees/update"},{"title":"Get Payee","openapi":"POST /api/platform/payee/get/{user_id}","href":"/api-reference/payees/get"},{"title":"List Payees","openapi":"POST /api/platform/payee/list-payee/{user_id}","href":"/api-reference/payees/list"},{"title":"Delete Payee","openapi":"DELETE /api/platform/payee/delete/{user_id}","href":"/api-reference/payees/delete"}]},{"group":"Payee Bank Accounts","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payees/bank-accounts/overview"},{"title":"Add Payee Bank Account","openapi":"POST /api/platform/accounts/add-payee-account/{user_id}","href":"/api-reference/payees/bank-accounts/add"},{"title":"Get Payee Bank Account","openapi":"POST /api/platform/accounts/get-payee-account/{user_id}","href":"/api-reference/payees/bank-accounts/get"},{"title":"List Payee Bank Accounts","openapi":"POST /api/platform/accounts/list-payee-account/{user_id}","href":"/api-reference/payees/bank-accounts/list"},{"title":"Delete Payee Bank Account","openapi":"DELETE /api/platform/accounts/delete-payee-account/{user_id}","href":"/api-reference/payees/bank-accounts/delete"}]},{"group":"Payee Cards","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payees/cards/overview"},{"title":"Add Payee Card","openapi":"POST /api/platform/card/add-payee-card/{user_id}","href":"/api-reference/payees/cards/add"},{"title":"Get Payee Card","openapi":"POST /api/platform/card/get-payee-card/{user_id}","href":"/api-reference/payees/cards/get"},{"title":"List Payee Cards","openapi":"POST /api/platform/card/list-payee-card/{user_id}","href":"/api-reference/payees/cards/list"},{"title":"Delete Payee Card","openapi":"DELETE /api/platform/card/delete-payee-card/{user_id}","href":"/api-reference/payees/cards/delete"}]},{"group":"Payee Addresses","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payees/addresses/overview"},{"title":"Add Payee Address","openapi":"POST /api/platform/address/create-payee-address/{user_id}","href":"/api-reference/payees/addresses/add"},{"title":"List Payee Address","openapi":"POST /api/platform/address/list-payee-address/{user_id}","href":"/api-reference/payees/addresses/list"},{"title":"Update Payee Address","openapi":"PATCH /api/platform/address/update-payee-address/{user_id}","href":"/api-reference/payees/addresses/update"},{"title":"Delete Payee Address","openapi":"DELETE /api/platform/address/delete-payee-address/{user_id}","href":"/api-reference/payees/addresses/delete"}]}]},{"tab":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/webhooks/overview"}]},{"tab":"Guidelines","icon":"list-check","pages":[{"title":"Guidelines","href":"/guidelines/url-standards/overview"}]}]},"basePath":"","title":"List Users - Paywint API Documentation","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}