{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/persons/:id.json","auth":"required","examples":{"codes":[]},"settings":"","results":{"codes":[{"name":"","code":"{\n    \"id\":729,\n    \"company_id\":null,\n    \"salutation\":\"Mr.\",\n    \"title\":\"Dr\",\n    \"first_name\":\"John\",\n    \"last_name\":\"Doe\",\n    \"birthday\":\"2010-03-25\",\n    \"position\":\"CTO\",\n    \"info\":\"A really nice guy\",\n    \"wants_mailing\":false,\n    \"wants_newsletter\":true,\n    \"wants_no_email\":false,\n    \"wants_no_post\":false,\n    \"wants_no_call\":false,\n    \"greeting\":\"\",\n    \"external_person_id\":\"EXtern411d\",\n    \"created_at\":\"2019-04-23 14:23:20\",\n    \"updated_at\":\"2019-04-23 14:23:20\",\n    \"fb_custom_fields\":[\n        {\n            \"id\":9,\n            \"name\":\"Favorite color\",\n            \"value\":\"yellow\"\n        },\n        {\n            \"id\":2,\n            \"name\":\"size\",\n            \"value\":\"167cm\"\n        },\n    ],\n    \"fb_person_addresss\":[\n    \t\t{\n        \t\t\"id\":204,\n            \"fb_person_id\":729,\n            \"address\":\"Test street 123\",\n            \"post_code\":\"12345\",\n            \"city\":\"API City\",\n            \"state\":\"NRW\",\n            \"country\":\"DE\",\n            \"type\":\"home\",\n            \"is_main\":false\n    \t\t},\n    ],\n    \"fb_person_phones\":[\n    \t\t{\n            \"id\":264,\n            \"fb_person_id\":729,\n            \"phone\":\"0123456789\",\n            \"type\":\"home\",\n            \"is_main\":true\n        },\n    ],\n    \"fb_person_email_addresss\":[\n    \t\t{\n        \t\t\"id\":348,\n            \"fb_person_id\":729,\n            \"email\":\"john.doe:::at:::example.com\",\n            \"type\":\"work\",\n            \"is_main\":true\n        },\n    ],\n    \"fb_person_websites\":[\n    \t\t{\n            \"id\":230,\n            \"fb_person_id\":729,\n            \"url\":\"http:\\/\\/www.website.xy\",\n            \"type\":\"work\",\n            \"website_type\":\"homepage\"\n        },\n    ],\n    \"fb_person_instant_messengers\":[\n    \t\t{\n            \"id\":29,\n            \"fb_person_id\":729,\n            \"name\":\"johndoe123\",\n            \"messenger\":\"gtalk\",\n        \t\t\"type\":\"other\"\n        },\n    ],\n    \"fb_person_bank_accounts\":[\n    \t\t{\n        \t\t\"id\":115,\n            \"fb_person_id\":729,\n            \"bank_account_owner\":\"John Doe\",\n            \"bank_number\":\"\",\n            \"bank_account_number\":\"\",\n            \"bank_iban\":\"121212\",\n            \"bank_bic\":\"121212\",\n            \"bank_name\":\"Testbank\",\n            \"bank_country\":\"DE\",\n            \"is_main\":true\n         },\n    ],\n    \"fb_person_credit_cards\":[\n    \t\t{\n        \t\t\"id\":115,\n            \"fb_person_id\":729,\n            \"owner\":\"John Doe\",\n            \"number_hidden\":\"1234********456\",\n            \"expire_date_month\":\"12\",\n            \"expire_date_year\":\"2029\",\n            \"is_main\":true\n         },\n    ],\n    \"fb_manual_tags\":[\n\t    \t{\n        \t\t\"id\":31,\n            \"name\":\"Blogger\",\n            \"description\":\"Some helpful multipliers\",\n            \"color\":\"blue\"\n    \t\t}\n    ]\n}","language":"json","status":200}]},"method":"get","params":[{"name":"id","type":"int","default":"","desc":"Person ID","required":true,"in":"path","ref":"","_id":"571f92cbe54f2d0e003ebb3c"}]},"next":{"description":"","pages":[]},"title":"/persons/:id.json","type":"endpoint","slug":"persons-show","excerpt":"Returns a single person.","body":"Shows a single person with a given ID.\n[block:api-header]\n{\n  \"title\": \"Enum values\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Possible values\",\n    \"0-0\": \"**salutation**\",\n    \"0-1\": \"Mr.\\nMrs.\\ndiverse\\ncouple\\nfamily\",\n    \"1-0\": \"**fb_person_address > type**\",\n    \"1-1\": \"home\\nwork\\nother\",\n    \"2-0\": \"**fb_person_phone > type**\",\n    \"2-1\": \"home\\nwork\\nother\\nmobile\\nmobile_work\\nfax\",\n    \"3-0\": \"**fb_person_email_address > type**\",\n    \"3-1\": \"home\\nwork\\nother\",\n    \"4-0\": \"**fb_person_email_website > type**\",\n    \"4-1\": \"home\\nwork\\nother\",\n    \"5-0\": \"**fb_person_email_website > website_type**\",\n    \"5-1\": \"homepage\\nblog\\nfacebook\\ntwitter\\nxing\\nlinked_in\\ngoogle_plus\",\n    \"6-0\": \"**fb_person_instant_messenger > type**\",\n    \"6-1\": \"home\\nwork\\nother\",\n    \"7-0\": \"**fb_person_instant_messenger > messenger**\",\n    \"7-1\": \"skype\\nicq\\ngtalk\\nother\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Custom fields\",\n  \"body\": \"Please find further information about custom fields [at the custom fields section](doc:custom-fields).\"\n}\n[/block]","updates":[],"order":22,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cbf045930bb9a0184a35088","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-23T12:26:01.436Z","__v":20,"parentDoc":null}

get/persons/:id.json

Returns a single person.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Person ID

Result Format


Documentation

Shows a single person with a given ID. [block:api-header] { "title": "Enum values" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Possible values", "0-0": "**salutation**", "0-1": "Mr.\nMrs.\ndiverse\ncouple\nfamily", "1-0": "**fb_person_address > type**", "1-1": "home\nwork\nother", "2-0": "**fb_person_phone > type**", "2-1": "home\nwork\nother\nmobile\nmobile_work\nfax", "3-0": "**fb_person_email_address > type**", "3-1": "home\nwork\nother", "4-0": "**fb_person_email_website > type**", "4-1": "home\nwork\nother", "5-0": "**fb_person_email_website > website_type**", "5-1": "homepage\nblog\nfacebook\ntwitter\nxing\nlinked_in\ngoogle_plus", "6-0": "**fb_person_instant_messenger > type**", "6-1": "home\nwork\nother", "7-0": "**fb_person_instant_messenger > messenger**", "7-1": "skype\nicq\ngtalk\nother" }, "cols": 2, "rows": 8 } [/block] [block:callout] { "type": "info", "title": "Custom fields", "body": "Please find further information about custom fields [at the custom fields section](doc:custom-fields)." } [/block]

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 }}