{"_id":"5501daae34cdd017002ec975","user":"54cba76f6d1eee0d00c33dee","githubsync":"","project":"54c0e51215af820d001a38a6","__v":2,"parentDoc":null,"category":{"_id":"5501d779f2ef1e0d003116eb","__v":7,"pages":["5501daae34cdd017002ec975","5501daf80459bd3700770e29","5501dc580459bd3700770e2b","5501dc7a64d596210042dcdc","5501dcb264d596210042dcdd","555e0c5e4f5e5a0d00836d7f","555e0c7206dfec0d00d3904c"],"project":"54c0e51215af820d001a38a6","version":"54f8de4e4339bb1900c8bffb","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-03-12T18:14:17.934Z","from_sync":false,"order":5,"slug":"contacts","title":"Contacts"},"version":{"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","forked_from":"54f8de14c6cabe23005c02a2","__v":33,"createdAt":"2015-03-05T22:53:02.044Z","releaseDate":"2015-03-05T22:53:02.044Z","categories":["54f8de4e4339bb1900c8bffc","54f8de4e4339bb1900c8bffd","54f8de4e4339bb1900c8bffe","54f8de4e4339bb1900c8bfff","54f8de4e4339bb1900c8c000","54ff6057563d7419002d666e","55007b6ecfeeea17004717dc","5501d779f2ef1e0d003116eb","55116ef89f7c7619005f853b","554bb366f245703100ddd39f","554d226b374fec0d007e64db","555e09f18ab3180d001ac605","555e0b2b4f5e5a0d00836d77","561d1f8b92a0cc350018b24f","562a956c96b5f40d0026eb60","5654c3378a26202b00c17cb8","5697a94b0b09a41900b24546","5739d89e37b52e3200a3a3cc","57ac94252c0b220e00a94570","57ac97a1ad44fc0e003be066","57ac9a3a8f312d0e00e96c75","57ac9c187ae5c60e004ba3a3","58178bee62e4500f009404f6","581a39711a63870f008b621d","581a3b4f0c65b20f00247fcb","5926e0606c729e0f00595f95","5954033ea5bbca002d27ae91","596ce53e0aeafe00157eb1ba","596ce87a8b79f4001a8f6139","598cad2e96193400190d879a","598cbcd3dc20c6000fdfb9c3","598cbd8496193400190d8955","59fcc7c9591add0026c91457","5a020b7856ea82001c8c9342","5a09bc64a91882001c56c2ed","5a71fa2de9aa84007a8bccdb","5b3a768a8a21dd0003ca080d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-03-12T18:27:58.639Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"name":"","code":"[\n  {\n    \"id\": 15,\n    \"birth_date\": \"1962-01-17\",\n    \"city\": \"Soledad\",\n    \"country\": \"US\",\n    \"custom_fields\": {\n      \"certification\": \"Class C\"\n    },\n    \"email\": \"bob:::at:::example.com\",\n    \"employee_number\": \"#217\",\n    \"first_name\": \"Bob\",\n    \"group_id\": 54,\n    \"group_name\": \"Birmingham\",\n    \"home_phone_number\": \"(921) 216-3931\",\n    \"job_title\": \"Staff Scientist\",\n    \"last_name\": \"Robertson\",\n    \"leave_date\": null,\n    \"license_class\": \"Class C\",\n    \"license_number\": \"G8U8POQ9WQZKHOQ\",\n    \"license_state\": \"AZ\",\n    \"middle_name\": \"Edwin\",\n    \"mobile_phone_number\": \"(006) 225-4642\",\n    \"other_phone_number\": \"\",\n    \"postal_code\": \"48466-2049\",\n    \"region\": \"LA\",\n    \"start_date\": \"2008-12-10\",\n    \"street_address\": \"79 Eastwood Drive\",\n    \"street_address_line_2\": \"\",\n    \"user_id\": 100,\n    \"vehicle_operator\": true,\n    \"work_phone_number\": \"(503) 033-8868\",\n    \"hourly_labor_rate\": 100.0,\n    \"user\": {\n      \"id\": 100,\n      \"first_name\": Bob,\n      \"last_name\": Robertson,\n      \"email\": \"bob@example.com\"\n    },\n    \"created_at\": \"2013-09-12T06:15:24.922-05:00\",\n    \"updated_at\": \"2014-08-25T14:13:53.745-05:00\"\n  },\n  ...\n]","language":"json","status":200}]},"examples":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"5bf342e116fb7900120ba76f","ref":"","in":"query","required":false,"desc":"Flag to include archived contacts in the results.","default":"0","type":"string","name":"include_archived"}],"url":"/contacts"},"isReference":true,"order":0,"body":"","excerpt":"Returns a list of your contacts. Defaults to only returning non-archived contacts, but you can include archived contacts in the results as well.","slug":"contacts","type":"endpoint","title":"/contacts"}

get/contacts

Returns a list of your contacts. Defaults to only returning non-archived contacts, but you can include archived contacts in the results as well.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

include_archived:
string0
Flag to include archived contacts in the results.

Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}