{"id":904,"date":"2022-01-19T15:26:10","date_gmt":"2022-01-19T15:26:10","guid":{"rendered":"https:\/\/logicbuilder.integroscrm.com\/help\/?page_id=904"},"modified":"2022-08-03T17:20:41","modified_gmt":"2022-08-03T17:20:41","slug":"retrieve-entities-by-attributes","status":"publish","type":"page","link":"https:\/\/logicbuilder.integroscrm.com\/help\/retrieve-entities-by-attributes\/","title":{"rendered":"Retrieve Entities By Attributes"},"content":{"rendered":"\n<p><a name=\"abstract\"><\/a>Returns records by the values of the given fields. Similar to how users use Filters in Sugar interface, this operator returns records by provided filters. Records can be found only by direct fields&#8217; values, it is not possible to provide ranges (e.g. greater than, after, max), instead of this filter out records after <span style=\"color:#ec8f45;\">Retrieve Entities by Attributes<\/span> using <span style=\"color:#ec8f45;\">conditions<\/span> and <a href=\"https:\/\/logicbuilder.integroscrm.com\/help\/branch\/\">Branch<\/a>.<\/p>\n\n\n\n<p><strong>inputs:&nbsp;<\/strong><\/p>\n\n\n\n<p><span style=\"color:#9ed267;\">module<\/span> &#8211; select directly in the operator module from the module list which records are needed.&nbsp;<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li>Required: yes<\/li><\/ul>\n\n\n\n<p>in the&nbsp;<em>following dropdown(s)<\/em>&nbsp;select a field name, by which value you want to filter records. As values you may use <span style=\"color:#ec8f45;\">Constants<\/span> or the output from <a href=\"https:\/\/logicbuilder.integroscrm.com\/help\/get-entity-attributes\/\">Get Entity Attributes<\/a> operator. At least one filter must be entered.&nbsp;Use &#8220;+&#8221; to add another field name. Between all selected fields there is logical AND.&nbsp;&nbsp;<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li>Required: yes<\/li><\/ul>\n\n\n<div style=\"background-color: #ddeaff; border-left: 6px solid #0072b3; padding: 12px;\">\n<p>If it is needed to retrieve all records from some module, use the filter by field Deleted = 0<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"wp-image-558\" src=\"https:\/\/logicbuilder.integroscrm.com\/help\/wp-content\/uploads\/2021\/12\/img-88-87141328d105469fbbeabf49e1a421fc.png\" alt=\"\" width=\"627\" height=\"221\" srcset=\"https:\/\/logicbuilder.integroscrm.com\/help\/wp-content\/uploads\/2021\/12\/img-88-87141328d105469fbbeabf49e1a421fc.png 911w, https:\/\/logicbuilder.integroscrm.com\/help\/wp-content\/uploads\/2021\/12\/img-88-87141328d105469fbbeabf49e1a421fc-300x106.png 300w, https:\/\/logicbuilder.integroscrm.com\/help\/wp-content\/uploads\/2021\/12\/img-88-87141328d105469fbbeabf49e1a421fc-768x271.png 768w\" sizes=\"auto, (max-width: 627px) 100vw, 627px\" \/><\/p>\n<\/div>\n\n\n<p><\/p>\n\n\n<div style=\"background-color: #ddeaff; border-left: 6px solid #0072b3; padding: 12px;\">\n<p>When records are needed to be filtered out by date using another date from Sugar field, use <a href=\"https:\/\/logicbuilder.integroscrm.com\/help\/get-string-from-date\/\">Get String From Date<\/a> prior to Retrieve Entities by Attributes:<\/p>\n<p><a href=\"https:\/\/logicbuilder.integroscrm.com\/help\/wp-content\/uploads\/2021\/12\/img-88-b9852cedb75e4b9192cfb51cb3489919.png\" rel=\"prettyPhoto\"><img decoding=\"async\" src=\"https:\/\/logicbuilder.integroscrm.com\/help\/wp-content\/uploads\/2021\/12\/img-88-b9852cedb75e4b9192cfb51cb3489919-1024x219.png\" alt=\"\" class=\"wp-image-378\"><\/a><\/p>\n<\/div>\n\n\n<p><strong>outputs:&nbsp;<\/strong><\/p>\n\n\n\n<p><span style=\"color:#ef6950;\">entities<\/span> &#8211; contains all found entities by the provided filters. Usually, this output is linked with input in <a href=\"https:\/\/logicbuilder.integroscrm.com\/help\/for-each-entity\/\">For Each Entity<\/a>.<\/p>\n\n\n\n<p><span style=\"color:#b197cb;\">entities number<\/span> &#8211; the number of found records<\/p>\n\n\n\n<p><span style=\"color:#ef6950;\">single entity<\/span> &#8211; contains one random record from the filtered ones. May be used if it is expected for only one record to be retrieved.<\/p>\n\n\n<p><a href=\"https:\/\/logicbuilder.integroscrm.com\/help\/wp-content\/uploads\/2021\/12\/img-88-35ef8f02362a430c937340b3c7dce559.png\" rel=\"prettyPhoto\"><img decoding=\"async\" src=\"https:\/\/logicbuilder.integroscrm.com\/help\/wp-content\/uploads\/2021\/12\/img-88-35ef8f02362a430c937340b3c7dce559-1024x270.png\" alt=\"\" class=\"wp-image-378\"><\/a><\/p><div style=\"text-align:left\" class=\"yasr-auto-insert-visitor\"><!--Yasr Visitor Votes Shortcode--><div id='yasr_visitor_votes_904' class='yasr-visitor-votes'><div class=\"yasr-custom-text-vv-before yasr-custom-text-vv-before-904\">Click to rate this post!<\/div><div id='yasr-vv-second-row-container-963936d9f1ec8' \n                                        class='yasr-vv-second-row-container'><div id='yasr-visitor-votes-rater-963936d9f1ec8'\n                                      class='yasr-rater-stars-vv'\n                                      data-rater-postid='904' \n                                      data-rating='0'\n                                      data-rater-starsize='24'\n                                      data-rater-readonly='false'\n                                      data-rater-nonce='60508256f2' \n                                      data-issingular='false'\n                                    ><\/div><div class=\"yasr-vv-stats-text-container\" id=\"yasr-vv-stats-text-container-963936d9f1ec8\"><svg xmlns=\"https:\/\/www.w3.org\/2000\/svg\" width=\"20\" height=\"20\" \n                               class=\"yasr-dashicons-visitor-stats\"\n                               data-postid=\"904\" \n                               id=\"yasr-stats-dashicon-963936d9f1ec8\">\n                            <path d=\"M18 18v-16h-4v16h4zM12 18v-11h-4v11h4zM6 18v-8h-4v8h4z\"><\/path>\n                          <\/svg><span id=\"yasr-vv-text-container-963936d9f1ec8\" class=\"yasr-vv-text-container\">[Total: <span id=\"yasr-vv-votes-number-container-963936d9f1ec8\">0<\/span>  Average: <span id=\"yasr-vv-average-container-963936d9f1ec8\">0<\/span>]<\/span><\/div><div id='yasr-vv-loader-963936d9f1ec8' class='yasr-vv-container-loader'><\/div><\/div><div id='yasr-vv-bottom-container-963936d9f1ec8' class='yasr-vv-bottom-container'><\/div><\/div><!--End Yasr Visitor Votes Shortcode--><\/div>","protected":false},"excerpt":{"rendered":"<p>Returns records by the values of the given fields. Similar to how users use Filters in Sugar interface, this operator returns records by provided filters. Records can be found only by direct fields&#8217; values, it is not possible to provide ranges (e.g. greater than, after, max), instead of this filter out records after Retrieve Entities &hellip;<\/p>\n<p class=\"read-more\"> <a class=\"\" href=\"https:\/\/logicbuilder.integroscrm.com\/help\/retrieve-entities-by-attributes\/\"> <span class=\"screen-reader-text\">Retrieve Entities By Attributes<\/span> Read More &raquo;<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"yasr_overall_rating":0,"yasr_post_is_review":"","yasr_auto_insert_disabled":"","yasr_review_type":"","footnotes":""},"tags":[],"class_list":["post-904","page","type-page","status-publish","hentry"],"yasr_visitor_votes":{"number_of_votes":0,"sum_votes":0,"stars_attributes":{"read_only":false,"span_bottom":false}},"_links":{"self":[{"href":"https:\/\/logicbuilder.integroscrm.com\/help\/wp-json\/wp\/v2\/pages\/904","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/logicbuilder.integroscrm.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/logicbuilder.integroscrm.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/logicbuilder.integroscrm.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/logicbuilder.integroscrm.com\/help\/wp-json\/wp\/v2\/comments?post=904"}],"version-history":[{"count":6,"href":"https:\/\/logicbuilder.integroscrm.com\/help\/wp-json\/wp\/v2\/pages\/904\/revisions"}],"predecessor-version":[{"id":2062,"href":"https:\/\/logicbuilder.integroscrm.com\/help\/wp-json\/wp\/v2\/pages\/904\/revisions\/2062"}],"wp:attachment":[{"href":"https:\/\/logicbuilder.integroscrm.com\/help\/wp-json\/wp\/v2\/media?parent=904"}],"wp:term":[{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/logicbuilder.integroscrm.com\/help\/wp-json\/wp\/v2\/tags?post=904"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}