{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Filtering","type":"basic","slug":"filtering","excerpt":"","body":"Some GoFormz API's support a filtering syntax that is similar to OData. The filtering syntax is supported when a \"filter\" query string parameter is described in the endpoint documentation.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Logical Operators\"\n}\n[/block]\nNote:  The logical operators are Case-Sensitive\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Operator\",\n    \"h-1\": \"Definition\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"eq\",\n    \"0-1\": \"Equals\",\n    \"0-2\": \"The eq operator returns true if the left operand is equal to the right operand, otherwise it returns false.\",\n    \"1-0\": \"ne\",\n    \"1-1\": \"Not Equals\",\n    \"1-2\": \"The ne operator returns true if the left operand is not equal to the right operand, otherwise it returns false.\",\n    \"2-1\": \"Greater Than\",\n    \"2-2\": \"The gt operator returns true if the left operand is greater than the right operand, otherwise it returns false.\",\n    \"2-0\": \"gt\",\n    \"3-1\": \"Greater Than or Equal\",\n    \"3-0\": \"ge\",\n    \"3-2\": \"The ge operator returns true if the left operand is greater than or equal to the right operand, otherwise it returns false.\",\n    \"4-1\": \"Less Than\",\n    \"4-2\": \"The lt operator returns true if the left operand is less than the right operand, otherwise it returns false.\",\n    \"4-0\": \"lt\",\n    \"5-1\": \"Less Than or Equal\",\n    \"5-2\": \"The le operator returns true if the left operand is less than or equal to the right operand, otherwise it returns false.\",\n    \"5-0\": \"le\",\n    \"6-1\": \"And\",\n    \"6-2\": \"The and operator returns true if both the left and right operands evaluate to true, otherwise it returns false.\",\n    \"7-2\": \"The or operator returns false if both the left and right operands both evaluate to false, otherwise it returns true.\",\n    \"7-1\": \"Or\",\n    \"7-0\": \"or\",\n    \"6-0\": \"and\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Logical Operator Examples\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Dates\",\n  \"body\": \"Dates will use Coordinated Universal Time (UTC), eg. 2021-12-08T08:00:00Z\\n  * Include timezone offset, if necessary.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// all forms with a lastUpdatedDate greater than January 1st, 2015 (00:00 UTC time)\\nhttps://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01\\n\\n// all forms with a lastUpdatedDate greater than January 1st, 2015\\n// indcluding time\\nhttps://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01T03:01:01\\n\\n// all forms with a lastUpdatedDate greater than January 1st, 2015\\n// in PST timezone (-08:00 offset)\\nhttps://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01T08:00:00\\n\\n// all forms with a lastUpdatedDate greater than January 1st, 2015 \\n// and a lastUpdatedDate less than January 1st, 2016\\nhttps://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01 and lastupdateddate lt 2015-01-01\\n\\n//This will kept all forms for January 1, 2015 on PST time (-8:00 offset)\\nhttps://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01T08:00:00Z and lastupdateddate lt 2015-01-01T08:00:00Z\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"573e8667a233380e005db0a5","user":"5537ebf63faac70d00ff6dbe","__v":10,"version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["553591cd63cc650d00312926","553591cd63cc650d00312927","5536e4d39f7f2d0d00b1cd54","5536e55c20d5ca0d0001580a","5536e6bf7fe60f0d000fd1c0","5536f5bba171250d00c00556","553a974369c2630d00a8562e","553a97c60074c80d00621c2a","553a98332af5f20d000fc32a","553a9b9869c2630d00a85642","556e0f23d02e0b190042f13d","563249b1dcc27a1700823650","5639113f049e420d00476b03","59a5dd94aaa11d003334edb4"],"_id":"553591cd63cc650d00312925","project":"55357364e02d480d0003c6d3","releaseDate":"2015-04-20T23:54:53.134Z","__v":13,"forked_from":"55357365e02d480d0003c6d6","createdAt":"2015-04-20T23:54:53.134Z"},"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":["553591ce63cc650d00312929","553591ce63cc650d0031292a","553591ce63cc650d0031292b","553591ce63cc650d0031292c","553591ce63cc650d0031292d","553591ce63cc650d0031292e","553591ce63cc650d0031292f","553591ce63cc650d00312930"],"title":"API","slug":"api","order":0,"from_sync":false,"reference":false,"_id":"553591cd63cc650d00312926","__v":1,"createdAt":"2015-04-20T21:45:09.762Z","project":"55357364e02d480d0003c6d3","version":"553591cd63cc650d00312925"},"createdAt":"2016-05-20T03:37:11.400Z","project":"55357364e02d480d0003c6d3","parentDoc":null}

API

Formz

Templates

Groups

Users

Files

Queue

Data Sources

Form Fields

Webhooks

Filtering

Some GoFormz API's support a filtering syntax that is similar to OData. The filtering syntax is supported when a "filter" query string parameter is described in the endpoint documentation. [block:api-header] { "type": "basic", "title": "Logical Operators" } [/block] Note: The logical operators are Case-Sensitive [block:parameters] { "data": { "h-0": "Operator", "h-1": "Definition", "h-2": "Description", "0-0": "eq", "0-1": "Equals", "0-2": "The eq operator returns true if the left operand is equal to the right operand, otherwise it returns false.", "1-0": "ne", "1-1": "Not Equals", "1-2": "The ne operator returns true if the left operand is not equal to the right operand, otherwise it returns false.", "2-1": "Greater Than", "2-2": "The gt operator returns true if the left operand is greater than the right operand, otherwise it returns false.", "2-0": "gt", "3-1": "Greater Than or Equal", "3-0": "ge", "3-2": "The ge operator returns true if the left operand is greater than or equal to the right operand, otherwise it returns false.", "4-1": "Less Than", "4-2": "The lt operator returns true if the left operand is less than the right operand, otherwise it returns false.", "4-0": "lt", "5-1": "Less Than or Equal", "5-2": "The le operator returns true if the left operand is less than or equal to the right operand, otherwise it returns false.", "5-0": "le", "6-1": "And", "6-2": "The and operator returns true if both the left and right operands evaluate to true, otherwise it returns false.", "7-2": "The or operator returns false if both the left and right operands both evaluate to false, otherwise it returns true.", "7-1": "Or", "7-0": "or", "6-0": "and" }, "cols": 3, "rows": 8 } [/block] [block:api-header] { "type": "basic", "title": "Logical Operator Examples" } [/block] [block:callout] { "type": "info", "title": "Dates", "body": "Dates will use Coordinated Universal Time (UTC), eg. 2021-12-08T08:00:00Z\n * Include timezone offset, if necessary." } [/block] [block:code] { "codes": [ { "code": "// all forms with a lastUpdatedDate greater than January 1st, 2015 (00:00 UTC time)\nhttps://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01\n\n// all forms with a lastUpdatedDate greater than January 1st, 2015\n// indcluding time\nhttps://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01T03:01:01\n\n// all forms with a lastUpdatedDate greater than January 1st, 2015\n// in PST timezone (-08:00 offset)\nhttps://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01T08:00:00\n\n// all forms with a lastUpdatedDate greater than January 1st, 2015 \n// and a lastUpdatedDate less than January 1st, 2016\nhttps://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01 and lastupdateddate lt 2015-01-01\n\n//This will kept all forms for January 1, 2015 on PST time (-8:00 offset)\nhttps://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01T08:00:00Z and lastupdateddate lt 2015-01-01T08:00:00Z", "language": "text" } ] } [/block]