{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/persons.json","auth":"required","settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"hasMore\":true,\n    \"data\":[\n        {\n            \"id\":123,\n            ...\n        },\n        {\n            \"id\":124,\n            ...\n        },\n        {\n            \"id\":125,\n            ...\n        }\n    ]\n}","name":""}]},"method":"get","examples":{"codes":[]},"params":[{"name":"page","type":"int","default":"1","desc":"page number","required":false,"in":"query","ref":"","_id":"5cbf0018d1fd9f0014a1d3f8"},{"name":"perPage","type":"int","default":"100","desc":"number of objects per page","required":false,"in":"query","ref":"","_id":"5cbf0018d1fd9f0014a1d3f7"}]},"next":{"description":"","pages":[]},"title":"/persons.json","type":"endpoint","slug":"persons-list","excerpt":"Returns a collection of persons that fits to a given criteria array.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Pagination\",\n  \"body\": \"Maximum is 100 entries, use the page parameter to get the next results.\\n\\n(with pagination: /persons.xml?page={page_number})\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Filter by criteria\"\n}\n[/block]\n/persons.json?search_id=123\n\nReturns a collection of persons that fits to the given criteria.\n\nThese criteria are currently available:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Criterion\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"8-0\": \"ids (separated by comma)\",\n    \"9-0\": \"search_id\",\n    \"9-2\": \"integer\",\n    \"8-2\": \"string\",\n    \"9-1\": \"The ID of a smart search\",\n    \"8-1\": \"A comma separated list of IDs\",\n    \"0-0\": \"salutation\",\n    \"2-0\": \"last_name\",\n    \"1-0\": \"first_name\",\n    \"3-0\": \"company\",\n    \"4-0\": \"phone\",\n    \"5-0\": \"email\",\n    \"6-0\": \"address\",\n    \"7-0\": \"tag_ids (separated by comma)\",\n    \"0-1\": \"The salutation\",\n    \"1-1\": \"The first name\",\n    \"2-1\": \"The last name\",\n    \"1-2\": \"string\",\n    \"2-2\": \"string\",\n    \"0-2\": \"Enum ( \\\"Mr.\\\", \\\"Mrs.\\\", \\\"Miss\\\", \\\"Ms.\\\", \\\"couple\\\", \\\"family\\\", \\\"diverse\\\")\",\n    \"4-2\": \"string\",\n    \"5-2\": \"string\",\n    \"7-2\": \"string\",\n    \"6-2\": \"string\",\n    \"3-2\": \"string\",\n    \"7-1\": \"A comma separated list of [tag IDs](doc:tags-list)\",\n    \"5-1\": \"An email address\",\n    \"4-1\": \"A phone number\",\n    \"6-1\": \"A part of the address (street, city or post code)\",\n    \"3-1\": \"The company name\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If no persons with these criteria exist, an empty persons container will be returned.\"\n}\n[/block]","updates":[],"order":21,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cbef68b37cadb002b5ea827","project":"571f5e8cd8667f0e00a3c498","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["571f5e8cd8667f0e00a3c49c","571f73cfcb4baa0e00d13a80","571f7451cb4baa0e00d13a88","571f7d2720695f3400f38797","571f7fb0ac2a080e0014c661","571f884be54f2d0e003ebb0a","572200c9ecb38d0e00d80ebd","572c301e7c8eff0e00aaa174","57df91b2c6348d0e0020c452","57e104db9ff1e21900a721ab","57fd04caeaa77f19008b8202","5899c7113514ce0f0014da84","5cbeda4b862d090013abd413","5e60d6278f8b380072f0b1e3"],"_id":"571f5e8cd8667f0e00a3c49b","hasDoc":true,"releaseDate":"2016-04-26T12:26:52.312Z","__v":14,"hasReference":true,"createdAt":"2016-04-26T12:26:52.312Z","project":"571f5e8cd8667f0e00a3c498"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON-REST-API (API-Package)","slug":"rest-api-json","order":9,"from_sync":false,"reference":false,"_id":"5cbeda4b862d090013abd413","project":"571f5e8cd8667f0e00a3c498","version":"571f5e8cd8667f0e00a3c49b","createdAt":"2019-04-23T09:26:35.210Z","__v":1},"user":"5720ba18c669e80e00c35051","createdAt":"2019-04-23T11:27:07.222Z","__v":7,"parentDoc":null}