GET profile/{id}/extended?ProfileId={ProfileId}&IncludePrimaryRelationsOnly={IncludePrimaryRelationsOnly}&IncludeListings={IncludeListings}&IncludeWebContent={IncludeWebContent}
Returns extended Profile information including primary related profiles and affiliation codes. It can optionally include ALL related profiles, listings and/or web content data by setting the appropriate values on the optional parameter;
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
|
| ProfileId | integer |
None. |
|
| IncludePrimaryRelationsOnly | boolean |
None. |
|
| IncludeListings | boolean |
None. |
|
| IncludeWebContent | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
ProfileExtendedDto| Name | Description | Type | Additional information |
|---|---|---|---|
| ProfileId | integer |
None. |
|
| OrgInd | boolean |
None. |
|
| OrgName | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| Mi | string |
None. |
|
| Prefix | string |
None. |
|
| Suffix | string |
None. |
|
| Title | string |
None. |
|
| Address1 | string |
None. |
|
| Address2 | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Zip | string |
None. |
|
| ZipExt | string |
None. |
|
| County | string |
None. |
|
| Country | string |
None. |
|
| WorkPhone | string |
None. |
|
| PhoneDefault | string |
None. |
|
| HomePhone | string |
None. |
|
| CellPhone | string |
None. |
|
| Ext | string |
None. |
|
| Fax | string |
None. |
|
| string |
None. |
||
| Website | string |
None. |
|
| Member | boolean |
None. |
|
| Prospect | boolean |
None. |
|
| Employee | boolean |
None. |
|
| Vendor | boolean |
None. |
|
| ReportName | string |
None. |
|
| ASF | string |
None. |
|
| EmployeesFT | decimal number |
None. |
|
| EmployeesPT | decimal number |
None. |
|
| NAICSCode | string |
None. |
|
| SicCode | string |
None. |
|
| Referredby | string |
None. |
|
| SalFormal | string |
None. |
|
| SalInformal | string |
None. |
|
| SalMailLabel | string |
None. |
|
| Sal4 | string |
None. |
|
| Sal5 | string |
None. |
|
| Sal6 | string |
None. |
|
| Gender | string |
None. |
|
| TaxID | string |
None. |
|
| BirthDate | date |
None. |
|
| DateCreated | date |
None. |
|
| DateChanged | date |
None. |
|
| UserName | string |
None. |
|
| PreferedContact | string |
None. |
|
| Inactive | boolean |
None. |
|
| DateInactive | date |
None. |
|
| CustStatus | string |
None. |
|
| SoldBy | integer |
None. |
|
| AssignedTo | integer |
None. |
|
| BillManually | boolean |
None. |
|
| PreferredPaymentMethod | string |
None. |
|
| CreditRating | string |
None. |
|
| DBA | string |
None. |
|
| NoEmail | boolean |
None. |
|
| ImageURL | string |
None. |
|
| NoFax | boolean |
None. |
|
| InheritAddressFrom | integer |
None. |
|
| PreferredEmailType | string |
None. |
|
| InheritPhoneFrom | integer |
None. |
|
| NextContactDate | date |
None. |
|
| Customers | integer |
None. |
|
| EncryptedProfileID | string |
None. |
|
| ProfileTypeId | integer |
None. |
|
| ActiveUserNum | integer |
None. |
|
| IsTenant | boolean |
None. |
|
| MembershipLevelId | integer |
None. |
|
| MembershipLevelName | string |
None. |
|
| RelatedProfiles | Collection of ProfileExtendedRelatedProfileDto |
None. |
|
| Listings | Collection of ProfileExtendedListingDto |
None. |
|
| Affiliations | Collection of ProfileExtendedAffiliationDto |
None. |
|
| WebContent | Collection of ProfileExtendedWebContentDto |
None. |
|
| ProfileCustomFields | Collection of ProfileExtendedProfileCustomFieldsDto |
None. |
Response Formats
application/json, text/json
Sample:
{
{"Listings": [
{"Affiliations": [
{"WebContent": null, "ProfileCustomFields": [
{
- "ProfileId": 1,
- "OrgInd": true,
- "OrgName": "sample string 3",
- "FirstName": "sample string 4",
- "LastName": "sample string 5",
- "Mi": "sample string 6",
- "Prefix": "sample string 7",
- "Suffix": "sample string 8",
- "Title": "sample string 9",
- "Address1": "sample string 10",
- "Address2": "sample string 11",
- "City": "sample string 12",
- "State": "sample string 13",
- "Zip": "sample string 14",
- "ZipExt": "sample string 15",
- "County": "sample string 16",
- "Country": "sample string 17",
- "WorkPhone": "sample string 18",
- "PhoneDefault": "sample string 19",
- "HomePhone": "sample string 20",
- "CellPhone": "sample string 21",
- "Ext": "sample string 22",
- "Fax": "sample string 23",
- "Email": "sample string 24",
- "Website": "sample string 25",
- "Member": true,
- "Prospect": true,
- "Employee": true,
- "Vendor": true,
- "ReportName": "sample string 30",
- "ASF": "sample string 31",
- "EmployeesFT": 32.0,
- "EmployeesPT": 33.0,
- "NAICSCode": "sample string 34",
- "SicCode": "sample string 35",
- "Referredby": "sample string 36",
- "SalFormal": "sample string 37",
- "SalInformal": "sample string 38",
- "SalMailLabel": "sample string 39",
- "Sal4": "sample string 40",
- "Sal5": "sample string 41",
- "Sal6": "sample string 42",
- "Gender": "sample string 43",
- "TaxID": "sample string 44",
- "BirthDate": "2025-11-01T15:10:31.3734302Z",
- "DateCreated": "2025-11-01T15:10:31.3734302Z",
- "DateChanged": "2025-11-01T15:10:31.3734302Z",
- "UserName": "sample string 48",
- "PreferedContact": "sample string 49",
- "Inactive": true,
- "DateInactive": "2025-11-01T15:10:31.3734302Z",
- "CustStatus": "sample string 52",
- "SoldBy": 53,
- "AssignedTo": 54,
- "BillManually": true,
- "PreferredPaymentMethod": "sample string 56",
- "CreditRating": "sample string 57",
- "DBA": "sample string 58",
- "NoEmail": true,
- "ImageURL": "sample string 60",
- "NoFax": true,
- "InheritAddressFrom": 62,
- "PreferredEmailType": "sample string 63",
- "InheritPhoneFrom": 64,
- "NextContactDate": "2025-11-01T15:10:31.3734302Z",
- "Customers": 66,
- "EncryptedProfileID": "sample string 67",
- "ProfileTypeId": 68,
- "ActiveUserNum": 69,
- "IsTenant": true,
- "MembershipLevelId": 1,
- "MembershipLevelName": "sample string 71",
- "RelatedProfiles": [
- {
- "ProfileId": 1,
- "ReportName": "sample string 2",
- "Member": true,
- "OrgInd": true,
- "Prospect": true,
- "RelationType": "sample string 6",
- "PrimaryRelation": true,
- "MainContact": true,
- "OrgName": "sample string 9",
- "FirstName": "sample string 10",
- "LastName": "sample string 11",
- "Mi": "sample string 12",
- "Prefix": "sample string 13",
- "Suffix": "sample string 14",
- "Title": "sample string 15",
- "Address1": "sample string 16",
- "Address2": "sample string 17",
- "City": "sample string 18",
- "State": "sample string 19",
- "Zip": "sample string 20",
- "ZipExt": "sample string 21",
- "County": "sample string 22",
- "Country": "sample string 23",
- "WorkPhone": "sample string 24",
- "PhoneDefault": "sample string 25",
- "HomePhone": "sample string 26",
- "CellPhone": "sample string 27",
- "Ext": "sample string 28",
- "Fax": "sample string 29",
- "Email": "sample string 30",
- "Website": "sample string 31",
- "Employee": true,
- "Vendor": true,
- "ASF": "sample string 34",
- "EmployeesFT": 35.0,
- "EmployeesPT": 36.0,
- "NAICSCode": "sample string 37",
- "SicCode": "sample string 38",
- "Referredby": "sample string 39",
- "SalFormal": "sample string 40",
- "SalInformal": "sample string 41",
- "SalMailLabel": "sample string 42",
- "Sal4": "sample string 43",
- "Sal5": "sample string 44",
- "Sal6": "sample string 45",
- "Gender": "sample string 46",
- "TaxID": "sample string 47",
- "BirthDate": "2025-11-01T15:10:31.3734302Z",
- "DateCreated": "2025-11-01T15:10:31.3734302Z",
- "DateChanged": "2025-11-01T15:10:31.3734302Z",
- "UserName": "sample string 51",
- "PreferedContact": "sample string 52",
- "Inactive": true,
- "DateInactive": "2025-11-01T15:10:31.3734302Z",
- "CustStatus": "sample string 55",
- "SoldBy": 56,
- "AssignedTo": 57,
- "BillManually": true,
- "PreferredPaymentMethod": "sample string 59",
- "CreditRating": "sample string 60",
- "DBA": "sample string 61",
- "NoEmail": true,
- "ImageURL": "sample string 63",
- "NoFax": true,
- "InheritAddressFrom": 65,
- "PreferredEmailType": "sample string 66",
- "InheritPhoneFrom": 67,
- "NextContactDate": "2025-11-01T15:10:31.3734302Z",
- "Customers": 69,
- "EncryptedProfileID": "sample string 70",
- "ProfileTypeId": 71,
- "MembershipLevelId": 1,
- "MembershipLevelName": "sample string 72",
- "Affiliations": [
- {
- "AffCode": "sample string 1",
- "Descr": "sample string 2",
- "PublicDisplay": true,
- "Icon": "sample string 4",
- "AffCodeTypeId": 5,
- "IconText": "sample string 6",
- "IconUrl": "sample string 7",
- "ListIsAvailableOnWebsite": true,
- "IsEntity": true,
- "AffCodeType": "sample string 10"
- "AffCode": "sample string 1",
- "Descr": "sample string 2",
- "PublicDisplay": true,
- "Icon": "sample string 4",
- "AffCodeTypeId": 5,
- "IconText": "sample string 6",
- "IconUrl": "sample string 7",
- "ListIsAvailableOnWebsite": true,
- "IsEntity": true,
- "AffCodeType": "sample string 10"
{
{
- "ProfileId": 1,
- "ReportName": "sample string 2",
- "Member": true,
- "OrgInd": true,
- "Prospect": true,
- "RelationType": "sample string 6",
- "PrimaryRelation": true,
- "MainContact": true,
- "OrgName": "sample string 9",
- "FirstName": "sample string 10",
- "LastName": "sample string 11",
- "Mi": "sample string 12",
- "Prefix": "sample string 13",
- "Suffix": "sample string 14",
- "Title": "sample string 15",
- "Address1": "sample string 16",
- "Address2": "sample string 17",
- "City": "sample string 18",
- "State": "sample string 19",
- "Zip": "sample string 20",
- "ZipExt": "sample string 21",
- "County": "sample string 22",
- "Country": "sample string 23",
- "WorkPhone": "sample string 24",
- "PhoneDefault": "sample string 25",
- "HomePhone": "sample string 26",
- "CellPhone": "sample string 27",
- "Ext": "sample string 28",
- "Fax": "sample string 29",
- "Email": "sample string 30",
- "Website": "sample string 31",
- "Employee": true,
- "Vendor": true,
- "ASF": "sample string 34",
- "EmployeesFT": 35.0,
- "EmployeesPT": 36.0,
- "NAICSCode": "sample string 37",
- "SicCode": "sample string 38",
- "Referredby": "sample string 39",
- "SalFormal": "sample string 40",
- "SalInformal": "sample string 41",
- "SalMailLabel": "sample string 42",
- "Sal4": "sample string 43",
- "Sal5": "sample string 44",
- "Sal6": "sample string 45",
- "Gender": "sample string 46",
- "TaxID": "sample string 47",
- "BirthDate": "2025-11-01T15:10:31.3734302Z",
- "DateCreated": "2025-11-01T15:10:31.3734302Z",
- "DateChanged": "2025-11-01T15:10:31.3734302Z",
- "UserName": "sample string 51",
- "PreferedContact": "sample string 52",
- "Inactive": true,
- "DateInactive": "2025-11-01T15:10:31.3734302Z",
- "CustStatus": "sample string 55",
- "SoldBy": 56,
- "AssignedTo": 57,
- "BillManually": true,
- "PreferredPaymentMethod": "sample string 59",
- "CreditRating": "sample string 60",
- "DBA": "sample string 61",
- "NoEmail": true,
- "ImageURL": "sample string 63",
- "NoFax": true,
- "InheritAddressFrom": 65,
- "PreferredEmailType": "sample string 66",
- "InheritPhoneFrom": 67,
- "NextContactDate": "2025-11-01T15:10:31.3734302Z",
- "Customers": 69,
- "EncryptedProfileID": "sample string 70",
- "ProfileTypeId": 71,
- "MembershipLevelId": 1,
- "MembershipLevelName": "sample string 72",
- "Affiliations": [
- {
- "AffCode": "sample string 1",
- "Descr": "sample string 2",
- "PublicDisplay": true,
- "Icon": "sample string 4",
- "AffCodeTypeId": 5,
- "IconText": "sample string 6",
- "IconUrl": "sample string 7",
- "ListIsAvailableOnWebsite": true,
- "IsEntity": true,
- "AffCodeType": "sample string 10"
- "AffCode": "sample string 1",
- "Descr": "sample string 2",
- "PublicDisplay": true,
- "Icon": "sample string 4",
- "AffCodeTypeId": 5,
- "IconText": "sample string 6",
- "IconUrl": "sample string 7",
- "ListIsAvailableOnWebsite": true,
- "IsEntity": true,
- "AffCodeType": "sample string 10"
{
- {
- "ListingId": 1,
- "ProfileId": 1,
- "CategoryId": 1,
- "SubCategoryId": 1,
- "DisplayName": "sample string 2",
- "Website": "sample string 3",
- "Email": "sample string 4",
- "Descr": "sample string 5",
- "Expires": true,
- "Keywords": "sample string 6",
- "WebListing": true,
- "PrintListing": true,
- "PrimaryListing": true,
- "Active": true,
- "Directions": "sample string 7",
- "Address1": "sample string 8",
- "Address2": "sample string 9",
- "City": "sample string 10",
- "State": "sample string 11",
- "Zip": "sample string 12",
- "ZipExt": "sample string 13",
- "SoldBy": 1,
- "ChangedBy": "sample string 14",
- "DateCreated": "2025-11-01T15:10:31.3875627Z",
- "DateChanged": "2025-11-01T15:10:31.3875627Z",
- "BusinessLogo": "sample string 15",
- "ListingPrefix": "sample string 16",
- "DefaultAppearance": true,
- "ColorHighLightBox": "sample string 17",
- "ColorFont": "sample string 18",
- "ColorBorder": "sample string 19",
- "BorderSize": 1,
- "FontStyle": "sample string 20",
- "FontSize": 1,
- "ShowMap": true,
- "ShowAddress": true,
- "ShowPhone": true,
- "ShowFax": true,
- "ShowBusDescr": true,
- "ShowWebsite": true,
- "ShowEmail": true,
- "Longitude": "sample string 21",
- "Latitude": "sample string 22",
- "MapUrl": "sample string 23",
- "ListingNotes": "sample string 24",
- "HtmlOverride": "sample string 25",
- "WebsiteRedirect": "sample string 26",
- "DateExpires": "2025-11-01T15:10:31.3875627Z",
- "Phone": "sample string 27",
- "Phone2": "sample string 28",
- "Fax": "sample string 29",
- "Rep": "sample string 30",
- "OverrideProfileSettings": true,
- "OverrideSystemPreferences": true,
- "RotateOrder": 1,
- "EntityId": 1,
- "ListingTypeId": 1,
- "ShortDescr": "sample string 31",
- "ProductsAndServices": "sample string 32",
- "DetailsListingTypeId": 1,
- "Category": "sample string 33",
- "SubCategory": "sample string 34",
- "ListingType": "sample string 35",
- "DetailsListingType": "sample string 36",
- "ObjectState": 0
{
- "ListingId": 1,
- "ProfileId": 1,
- "CategoryId": 1,
- "SubCategoryId": 1,
- "DisplayName": "sample string 2",
- "Website": "sample string 3",
- "Email": "sample string 4",
- "Descr": "sample string 5",
- "Expires": true,
- "Keywords": "sample string 6",
- "WebListing": true,
- "PrintListing": true,
- "PrimaryListing": true,
- "Active": true,
- "Directions": "sample string 7",
- "Address1": "sample string 8",
- "Address2": "sample string 9",
- "City": "sample string 10",
- "State": "sample string 11",
- "Zip": "sample string 12",
- "ZipExt": "sample string 13",
- "SoldBy": 1,
- "ChangedBy": "sample string 14",
- "DateCreated": "2025-11-01T15:10:31.3875627Z",
- "DateChanged": "2025-11-01T15:10:31.3875627Z",
- "BusinessLogo": "sample string 15",
- "ListingPrefix": "sample string 16",
- "DefaultAppearance": true,
- "ColorHighLightBox": "sample string 17",
- "ColorFont": "sample string 18",
- "ColorBorder": "sample string 19",
- "BorderSize": 1,
- "FontStyle": "sample string 20",
- "FontSize": 1,
- "ShowMap": true,
- "ShowAddress": true,
- "ShowPhone": true,
- "ShowFax": true,
- "ShowBusDescr": true,
- "ShowWebsite": true,
- "ShowEmail": true,
- "Longitude": "sample string 21",
- "Latitude": "sample string 22",
- "MapUrl": "sample string 23",
- "ListingNotes": "sample string 24",
- "HtmlOverride": "sample string 25",
- "WebsiteRedirect": "sample string 26",
- "DateExpires": "2025-11-01T15:10:31.3875627Z",
- "Phone": "sample string 27",
- "Phone2": "sample string 28",
- "Fax": "sample string 29",
- "Rep": "sample string 30",
- "OverrideProfileSettings": true,
- "OverrideSystemPreferences": true,
- "RotateOrder": 1,
- "EntityId": 1,
- "ListingTypeId": 1,
- "ShortDescr": "sample string 31",
- "ProductsAndServices": "sample string 32",
- "DetailsListingTypeId": 1,
- "Category": "sample string 33",
- "SubCategory": "sample string 34",
- "ListingType": "sample string 35",
- "DetailsListingType": "sample string 36",
- "ObjectState": 0
- {
- "AffCode": "sample string 1",
- "Descr": "sample string 2",
- "PublicDisplay": true,
- "Icon": "sample string 4",
- "AffCodeTypeId": 5,
- "IconText": "sample string 6",
- "IconUrl": "sample string 7",
- "ListIsAvailableOnWebsite": true,
- "IsEntity": true,
- "AffCodeType": "sample string 10"
{
- "AffCode": "sample string 1",
- "Descr": "sample string 2",
- "PublicDisplay": true,
- "Icon": "sample string 4",
- "AffCodeTypeId": 5,
- "IconText": "sample string 6",
- "IconUrl": "sample string 7",
- "ListIsAvailableOnWebsite": true,
- "IsEntity": true,
- "AffCodeType": "sample string 10"
- {
- "Id": 1,
- "CustomFieldId": 2,
- "FieldName": "sample string 3",
- "ProfileId": 4,
- "FieldValue": "sample string 5"
{
- "Id": 1,
- "CustomFieldId": 2,
- "FieldName": "sample string 3",
- "ProfileId": 4,
- "FieldValue": "sample string 5"