{"_id":"5715eec7893cbe0e002d74be","parentDoc":null,"project":"56d54a77075dfa0b00be98d5","user":"56d548ba075dfa0b00be98d2","version":{"_id":"56d54a77075dfa0b00be98d8","__v":13,"project":"56d54a77075dfa0b00be98d5","createdAt":"2016-03-01T07:53:27.479Z","releaseDate":"2016-03-01T07:53:27.479Z","categories":["56d54a78075dfa0b00be98d9","56d6bbf046d19315000f8ea2","56d6bbfc46d19315000f8ea3","570cefd98da5b62b00d57e3c","571491a74007610e00c803ae","5714dcd837b7e00e00de5684","5715ea6ac016190e00f04272","5715f27fc016190e00f0429f","5715f7b9893cbe0e002d74da","5715f8c2c016190e00f042b8","5715fd49a9055c0e0015fbe7","57160c7e893cbe0e002d753a","5716136a893cbe0e002d7552"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","__v":5,"category":{"_id":"5715ea6ac016190e00f04272","__v":0,"project":"56d54a77075dfa0b00be98d5","version":"56d54a77075dfa0b00be98d8","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-19T08:20:58.734Z","from_sync":false,"order":4,"slug":"client","title":"Client"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-19T08:39:35.114Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:html]\n{\n  \"html\": \"<h3>GetClients</h3>\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Columns</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Nullability\",\n    \"h-4\": \"Note\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"FALSE\",\n    \"0-4\": \"Unique identifier.\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"FALSE\",\n    \"1-4\": \"Name of client.\",\n    \"2-0\": \"`note`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"N/A\",\n    \"2-3\": \"TRUE\",\n    \"2-4\": \"A note/text of any kind.\",\n    \"3-0\": \"`address`\",\n    \"3-1\": \"Address\",\n    \"3-2\": \"N/A\",\n    \"3-3\": \"TRUE\",\n    \"3-4\": \"Geographical location.\"\n  },\n  \"cols\": 5,\n  \"rows\": 4\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"list\\\": [{\\n\\t\\t\\\"id\\\": \\\"34053\\\",\\n\\t\\t\\\"name\\\": \\\"SuperTrans\\\",\\n\\t\\t\\\"address\\\": {\\n\\t\\t\\t\\\"country\\\": \\\"DK\\\",\\n\\t\\t\\t\\\"zipCode\\\": \\\"9654\\\",\\n\\t\\t\\t\\\"city\\\": \\\"Østerby\\\",\\n\\t\\t\\t\\\"streetAddress\\\": \\\"Vestervejen 5\\\"\\n\\t\\t}\\n\\t}, {\\n\\t\\t\\\"id\\\": \\\"34067\\\",\\n\\t\\t\\\"name\\\": \\\"CargoEU\\\",\\n\\t\\t\\\"address\\\": {\\n\\t\\t\\t\\\"country\\\": \\\"DK\\\",\\n\\t\\t\\t\\\"zipCode\\\": \\\"6000\\\",\\n\\t\\t\\t\\\"city\\\": \\\"Kolding\\\",\\n\\t\\t\\t\\\"streetAddress\\\": \\\"Vestre Havnepromenade 12\\\"\\n\\t\\t}\\n\\t}, {\\n\\t\\t\\\"id\\\": \\\"34127\\\",\\n\\t\\t\\\"name\\\": \\\"Leons Spedition\\\",\\n\\t\\t\\\"address\\\": {\\n\\t\\t\\t\\\"country\\\": \\\"DE\\\",\\n\\t\\t\\t\\\"zipCode\\\": \\\"Duisburg - 0203 393400\\\",\\n\\t\\t\\t\\\"city\\\": \\\"Duisburg\\\",\\n\\t\\t\\t\\\"streetAddress\\\": \\\"Am Nordhafen 223\\\"\\n\\t\\t}\\n\\t}, {\\n\\t\\t\\\"id\\\": \\\"34139\\\",\\n\\t\\t\\\"name\\\": \\\"Ouest de transport comp\\\",\\n\\t\\t\\\"address\\\": {\\n\\t\\t\\t\\\"zipCode\\\": \\\"33023 Bordeaux \\\",\\n\\t\\t\\t\\\"city\\\": \\\"Bordeaux \\\",\\n\\t\\t\\t\\\"streetAddress\\\": \\\"10 rue des Treuils\\\"\\n\\t\\t}\\n\\t}, {\\n\\t\\t\\\"id\\\": \\\"35860\\\",\\n\\t\\t\\\"name\\\": \\\"Hansen Holding\\\",\\n\\t\\t\\\"address\\\": {\\n\\t\\t\\t\\\"country\\\": \\\"DK\\\",\\n\\t\\t\\t\\\"zipCode\\\": \\\"9000\\\",\\n\\t\\t\\t\\\"city\\\": \\\"Aalborg\\\"\\n\\t\\t}\\n\\t}]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Will list all clients.\n\nURL Structure is:\n`https://api.trackunit.com/public/Client`","slug":"clients-collection","type":"basic","title":"Clients Collection"}

Clients Collection

Will list all clients. URL Structure is: `https://api.trackunit.com/public/Client`

[block:html] { "html": "<h3>GetClients</h3>" } [/block] [block:html] { "html": "<h4><b>Columns</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Nullability", "h-4": "Note", "0-0": "`id`", "0-1": "String", "0-2": "N/A", "0-3": "FALSE", "0-4": "Unique identifier.", "1-0": "`name`", "1-1": "String", "1-2": "N/A", "1-3": "FALSE", "1-4": "Name of client.", "2-0": "`note`", "2-1": "String", "2-2": "N/A", "2-3": "TRUE", "2-4": "A note/text of any kind.", "3-0": "`address`", "3-1": "Address", "3-2": "N/A", "3-3": "TRUE", "3-4": "Geographical location." }, "cols": 5, "rows": 4 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{} ", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n\t\"list\": [{\n\t\t\"id\": \"34053\",\n\t\t\"name\": \"SuperTrans\",\n\t\t\"address\": {\n\t\t\t\"country\": \"DK\",\n\t\t\t\"zipCode\": \"9654\",\n\t\t\t\"city\": \"Østerby\",\n\t\t\t\"streetAddress\": \"Vestervejen 5\"\n\t\t}\n\t}, {\n\t\t\"id\": \"34067\",\n\t\t\"name\": \"CargoEU\",\n\t\t\"address\": {\n\t\t\t\"country\": \"DK\",\n\t\t\t\"zipCode\": \"6000\",\n\t\t\t\"city\": \"Kolding\",\n\t\t\t\"streetAddress\": \"Vestre Havnepromenade 12\"\n\t\t}\n\t}, {\n\t\t\"id\": \"34127\",\n\t\t\"name\": \"Leons Spedition\",\n\t\t\"address\": {\n\t\t\t\"country\": \"DE\",\n\t\t\t\"zipCode\": \"Duisburg - 0203 393400\",\n\t\t\t\"city\": \"Duisburg\",\n\t\t\t\"streetAddress\": \"Am Nordhafen 223\"\n\t\t}\n\t}, {\n\t\t\"id\": \"34139\",\n\t\t\"name\": \"Ouest de transport comp\",\n\t\t\"address\": {\n\t\t\t\"zipCode\": \"33023 Bordeaux \",\n\t\t\t\"city\": \"Bordeaux \",\n\t\t\t\"streetAddress\": \"10 rue des Treuils\"\n\t\t}\n\t}, {\n\t\t\"id\": \"35860\",\n\t\t\"name\": \"Hansen Holding\",\n\t\t\"address\": {\n\t\t\t\"country\": \"DK\",\n\t\t\t\"zipCode\": \"9000\",\n\t\t\t\"city\": \"Aalborg\"\n\t\t}\n\t}]\n}", "language": "json" } ] } [/block]