GET api/people/{id}
Get a person by its Id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The id of the person to get. Pass 0 to be returned an empty data contract. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The person or null if it does not exist
PersonDataContractName | Description | Type | Additional information |
---|---|---|---|
Gender | EnumDataContract |
None. |
|
Title | string |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
Note | string |
None. |
|
ContactName | string |
None. |
|
PrimaryTelephone | ContactItemDataContract |
None. |
|
PrimaryEmail | ContactItemDataContract |
None. |
|
GroupCount | integer |
None. |
|
GroupMemberships | Collection of GroupMembershipDataContract |
None. |
|
ContactItems | Collection of ContactItemDataContract |
None. |
|
Addresses | Collection of ContactAddressDataContract |
None. |
|
ArchivedAddresses | Collection of ContactAddressDataContract |
None. |
|
AdditionalInformation | AdditionalInformationDataContract |
None. |
|
MarketingPreferences | Collection of MarketingPreferenceDataContract |
None. |
|
GroupIds | Collection of integer |
None. |
|
HasBankAccounts | boolean |
None. |
|
CustomFields | Collection of CustomFieldGroupWithValuesDataContract |
None. |
|
CreatedDate | date |
None. |
|
CreatedBy | CreatedByDataContract |
None. |
|
Id | integer |
None. |
Response Formats
application/json
Sample:
text/json
Sample: