{"id":24257,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/getusers-1\/"},"modified":"2025-02-17T10:01:13","modified_gmt":"2025-02-17T18:01:13","slug":"getusers-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/","title":{"rendered":"get_users"},"content":{"rendered":"

This command retrieves the list of users within ExtraView.<\/p>\n

\n\tSYNTAX<\/h3>\n

http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action?
\n\tuser_id=username
\n\t&password=password<\/span> <\/span>OR <\/span>[&access_token=token-value]
\n\t&statevar=get_users
\n\t&disabled=[Y|N|ONLY]
\n\t&filter=pattern
\n\t&filter_type=[ID|FIRST|LAST]<\/span><\/p>\n

\n\tNOTES<\/h3>\n

The disabled parameter is optional. If provided, the optional values are:<\/p>\n\n\n\n\n\n
\n\t\t\t\tY<\/td>\n\n\t\t\t\tReturn disabled users as well as enabled users<\/td>\n<\/tr>\n
\n\t\t\t\tN<\/td>\n\n\t\t\t\tReturn enabled users only. This is the default<\/td>\n<\/tr>\n
\n\t\t\t\tONLY<\/td>\n\n\t\t\t\tOnly return disabled users<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\n\tThe filter parameter is optional. This allows you to perform a wildcard pattern search for specific user records. The wildcard character is an asterisk (*) and you may have more than one of them in the pattern. For example:<\/p>\n\n\n\n\n
\n\t\t\t\t*OB<\/td>\n\n\t\t\t\tReturn all records where the user ID ends with the letters OB. For example, this will return BOB but not ROBERT<\/td>\n<\/tr>\n
\n\t\t\t\t*OB*<\/td>\n\n\t\t\t\tThis would return both BOB and ROBERT<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\n\tThe filter_type parameter is optional. If provided, the optional values are as follows. You may provide multiple filter_type parameters in a single get_users call, each with one of the three possible values.<\/p>\n\n\n\n\n\n
\n\t\t\t\tID<\/td>\n\n\t\t\t\tThis returns the User ID, from the security_user.security_user_id column of the user table<\/td>\n<\/tr>\n
\n\t\t\t\tFIRST<\/td>\n\n\t\t\t\tThis returns the first name, from the security_user.first_name column of the user table<\/td>\n<\/tr>\n
\n\t\t\t\tLAST<\/td>\n\n\t\t\t\tThis returns the last name, from the security_user.last_name column of the user table<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

The optional access_token<\/code> parameter allows you to use a valid OAuth2 token obtained with the get_token<\/code> command.  If you provide the access_token<\/code> parameter, then the user_id<\/code> and password<\/code> parameters should not be provided.  This prevents the password being sent in clear text over your network connection.<\/p>\n","protected":false},"excerpt":{"rendered":"

This command retrieves the list of users within ExtraView. SYNTAX http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? user_id=username &password=password OR [&access_token=token-value] &statevar=get_users &disabled=[Y|N|ONLY] &filter=pattern &filter_type=[ID|FIRST|LAST] NOTES The disabled parameter is optional. If provided, the optional values are: Y Return disabled users as well as enabled users N Return enabled users only. This is the default ONLY Only return disabled users The filter parameter…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24223,"menu_order":49,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"no","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24257","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\nget_users - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"get_users - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This command retrieves the list of users within ExtraView. SYNTAX http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? user_id=username &password=password OR [&access_token=token-value] &statevar=get_users &disabled=[Y|N|ONLY] &filter=pattern &filter_type=[ID|FIRST|LAST] NOTES The disabled parameter is optional. If provided, the optional values are: Y Return disabled users as well as enabled users N Return enabled users only. This is the default ONLY Only return disabled users The filter parameter...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-17T18:01:13+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/\",\"name\":\"get_users - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-17T18:01:13+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Application Programming Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"get_users\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"get_users - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/","og_locale":"en_US","og_type":"article","og_title":"get_users - Product Documentation","og_description":"This command retrieves the list of users within ExtraView. SYNTAX http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? user_id=username &password=password OR [&access_token=token-value] &statevar=get_users &disabled=[Y|N|ONLY] &filter=pattern &filter_type=[ID|FIRST|LAST] NOTES The disabled parameter is optional. If provided, the optional values are: Y Return disabled users as well as enabled users N Return enabled users only. This is the default ONLY Only return disabled users The filter parameter...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-17T18:01:13+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/","name":"get_users - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-17T18:01:13+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getusers-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"Application Programming Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/"},{"@type":"ListItem","position":4,"name":"get_users"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24257","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=24257"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24257\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24223"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24257"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}