API documentation

Contact Class Reference

Description

Renders a contact.

Protected Member Functions

 _render ($contact)
 Renders a contact. More...
 

Member Function Documentation

_render (   $contact)
protected

Renders a contact.

Example output:

{
"id": 42,
"entityType": "Contacts",
"rev": "6",
"name": {
"givenName": "Tad",
"familyName": "Mueller",
"salutation": null,
"displayName": "Tad Mueller"
},
"htmlUrl": "https://app01.nutshell.com/contact/1234", // a url to open with a web browser for this entity
"description": "Works late call anytime",
"tags": ["Some tag", "Some other tag"],
"creator": {
"stub": true,
"id": 3,
"entityType": "Users",
"rev": "1",
"name": "Chris Dzombak"
},
"leads": [ Lead, ... ],
"accounts": [ Account, ... ],
"contactedCount": 0,
"address": {
"4": {
"name": null,
"location": { "longitude": -120.4796456, "latitude": 37.3037134 },
"locationAccuracy": "8",
"address_1": "349 W 20th St",
"address_2": "",
"address_3": "",
"city": "Merced",
"state": "CA",
"postalCode": "95340",
"country": "US",
"timezone": null
},
"--primary": {
"name": null,
"location": { "longitude": -120.4796456, "latitude": 37.3037134 },
"locationAccuracy": "8",
"address_1": "349 W 20th St",
"address_2": "",
"address_3": "",
"city": "Merced",
"state": "CA",
"postalCode": "95340",
"country": "US",
"timezone": null
},
},
"phone": {
"7": {
"countryCode": "1",
"number": "209-230-4682",
"extension": null
},
"--primary": {
"countryCode": "1",
"number": "209-230-4682",
"extension": null
}
},
"url": {
"0": "http: //example.com",
"mail": "https: //mail.example.com"
},
"email": {
"0": "jhalpert@nutshell.com",
"assistant": "dschrute@dunder-mifflin.com"
},
"notes": [ Note, ... ]
"avatar": {
"url": "\/image\/2008\/default\/default\/contact-avatar-4.png"
},
"territory": {
"id": 1,
"name": "Michigan"
},
"lastContactedDate": null, // ATOM/rfc3339 format. Returns null if the value is empty.
"deletedTime": "2010-09-28T13:30:00+0000", // ATOM/rfc3339 format. Only present when deleted.
"modifiedTime": "2010-04-26T15:25:10+0000" // ATOM/rfc3339 format. If modified_time is blank the created_time value is returned in its place.
"createdTime": "2010-04-26T15:25:10+0000" // ATOM/rfc3339 format.
}
See Also
Lead::_renderStub for output for lead stubs
Returns
array