/<module>/filter - Filter Records

POST {{INSTANCE_URL}}/rest/v{{API_VERSION}}/{{SUGAR_MODULE}}/filter

Works the same as the GET - /<module> Request, however when working with FilterAPI, large request payloads may be better managed suing POST data rather than Query Parameters due to browser limitations of URL length.

Request Body

{"max_num"=>1, "offset"=>0, "filter"=>[{"email_addresses_primary.email_address"=>{"$in"=>["tbloking@sugarcrm.com"]}}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
OAuth-TokenstringSugar OAuth 2.0 Access Token