YM REST Services

<back to all web services

MembersProfiles

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/MembersProfilesReturn all members' profiles.
MembersProfiles Parameters:
NameParameterData TypeRequiredDescription
IncludeCustomFieldsqueryboolNo
FilterByDateTimequeryDateTime?No
PageNumberqueryintNo
PageSizequeryintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MembersProfilesResponse Parameters:
NameParameterData TypeRequiredDescription
MembersProfilesListformList<MemberProfileData>No
MembersProfilesCountformintNo
MemberProfileData Parameters:
NameParameterData TypeRequiredDescription
WebSiteMemberIDformintNo
MasterMemberIDformint?No
ConstituentIDformstringNo
RegistrationDateformDateTime?No
ApprovedSiteMemberformboolNo
DateApprovedformDateTime?No
DateLastLoginformDateTime?No
MemberSuspendedformboolNo
LastUpdatedformDateTime?No
DateMembershipExpiresformDateTime?No
MembershipformstringNo
HasDonatedOnlineformboolNo
DateLastDonatedformDateTime?No
HasPurchasedOnlineformboolNo
DateLastPurchasedformDateTime?No
HasRegisteredEventOnlineformboolNo
DateLastEventRegformDateTime?No
UsernameformstringNo
PasswordformstringNo
MemberTypeCodeformstringNo
PrimaryGroupCodeformstringNo
GenderformstringNo
FirstNameformstringNo
MiddleNameformstringNo
LastNameformstringNo
NicknameformstringNo
MemberNameSuffixformstringNo
MemberNameTitleformstringNo
BirthdateformDateTime?No
MarriageStatusformstringNo
MaidenNameformstringNo
AnniversaryDateformDateTime?No
SpouseNameformstringNo
EmailAddressformstringNo
EmailAddressAlternateformstringNo
EmailBouncedformboolNo
MessengerTypeformstringNo
MessengerHandleformstringNo
HomeAddressLine1formstringNo
HomeAddressLine2formstringNo
HomeCityformstringNo
HomeLocationformstringNo
HomeStateAbbrevformstringNo
HomePostalCodeformstringNo
HomeCountryformstringNo
PersonalWebsiteformstringNo
HomePhoneAreaCodeformstringNo
HomePhoneformstringNo
MobileAreaCodeformstringNo
MobilePhoneformstringNo
EmployerNameformstringNo
ProfessionalTitleformstringNo
ProfessionformstringNo
EmployerAddressLine1formstringNo
EmployerAddressLine2formstringNo
EmployerCityformstringNo
EmployerLocationformstringNo
EmployerStateAbbrevformstringNo
EmployerPostalCodeformstringNo
EmployerCountryformstringNo
EmployerWebsiteformstringNo
EmployerPhoneAreaCodeformstringNo
EmployerPhoneformstringNo
EmployerFaxAreaCodeformstringNo
EmployerFaxformstringNo
ResumeExistsformboolNo
ResumeHeadlineformstringNo
SocialOrganizationsformstringNo
EducationAndExperienceformstringNo
MorePersonalInfoformstringNo
InternalCommentsformstringNo
HomeAddressValidatedformboolNo
EmployerAddressValidatedformboolNo
DateLastRenewedformDateTime?No
DateEffectiveMembershipExpiresformDateTime?No
ImportBatchIDformint?No
CareerOpeningsAllowedformint?No
MembersPagesAllowedformint?No
AdditionalSeatsAllowedformint?No
NameFormatNormalformint?No
MemberHasConsentedformbool?No
DateConsentedformDateTime?No
ConsentIPAddressformstringNo
MemberHasRevokedConsentformbool?No
DateConsentRevokedformDateTime?No
CustomFieldsformList<CustomFld>No
CustomFld Parameters:
NameParameterData TypeRequiredDescription
ExportLabelformstringNo
CustomFieldValueformCustomFieldResponseNo
CustomFieldResponse Parameters:
NameParameterData TypeRequiredDescription
FieldCodeformstringNo
FieldsformCustomFieldsNo
VisibilityformstringNo
VisibilityIntformintNo
ValuesformList<CustomFieldResponseValue>No
ValuesProxyformArrayListNo
MetaValueformCustomFieldResponseValueNo
ClientIDformintNo
CustomField Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
FieldTypeformCustomFieldTypeNo
GroupCodeformstringNo
GroupCodeFriendlyformstringNo
RequiredformboolNo
VisibleformintNo
MemberCanOverrideformboolNo
EditableformintNo
SearchableformboolNo
OrdinalformintNo
MaxLengthformintNo
IsMultiSelectformboolNo
IsFIBformboolNo
IsFileUploadformboolNo
LabelformstringNo
CodeformstringNo
ExportLabelformstringNo
SearchLabelformstringNo
SearchInfoformstringNo
DescriptionformstringNo
ValidationExpressionformstringNo
MemberTypesformList<CustomFieldMemberType>No
DonationFundsformList<CustomFieldDonationFund>No
MemberTypesProxyformArrayListNo
ValuesformList<CustomFieldValue>No
ValuesProxyformArrayListNo
HelpTopicformCustomHelpNo
FieldDataTypeformFieldTypesNo
CustomFieldMemberType Parameters:
NameParameterData TypeRequiredDescription
MemberTypeIDformstringNo
CustomFieldDonationFund Parameters:
NameParameterData TypeRequiredDescription
DonationFundIDformstringNo
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
OrdinalformintNo
TextformstringNo
ValueformstringNo
CustomHelp Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
ClientIDformintNo
LabelformstringNo
ContentformstringNo
WidthformintNo
HeightformintNo
CustomFieldResponseValue Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo
TextformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/MembersProfiles HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"MembersProfilesList":[{"WebSiteMemberID":0,"MasterMemberID":0,"ConstituentID":"String","RegistrationDate":"0001-01-01T00:00:00.0000000","ApprovedSiteMember":false,"DateApproved":"0001-01-01T00:00:00.0000000","DateLastLogin":"0001-01-01T00:00:00.0000000","MemberSuspended":false,"LastUpdated":"0001-01-01T00:00:00.0000000","DateMembershipExpires":"0001-01-01T00:00:00.0000000","Membership":"String","HasDonatedOnline":false,"DateLastDonated":"0001-01-01T00:00:00.0000000","HasPurchasedOnline":false,"DateLastPurchased":"0001-01-01T00:00:00.0000000","HasRegisteredEventOnline":false,"DateLastEventReg":"0001-01-01T00:00:00.0000000","Username":"String","Password":"String","MemberTypeCode":"String","PrimaryGroupCode":"String","Gender":"String","FirstName":"String","MiddleName":"String","LastName":"String","Nickname":"String","MemberNameSuffix":"String","MemberNameTitle":"String","Birthdate":"0001-01-01T00:00:00.0000000","MarriageStatus":"String","MaidenName":"String","AnniversaryDate":"0001-01-01T00:00:00.0000000","SpouseName":"String","EmailAddress":"String","EmailAddressAlternate":"String","EmailBounced":false,"MessengerType":"String","MessengerHandle":"String","HomeAddressLine1":"String","HomeAddressLine2":"String","HomeCity":"String","HomeLocation":"String","HomeStateAbbrev":"String","HomePostalCode":"String","HomeCountry":"String","PersonalWebsite":"String","HomePhoneAreaCode":"String","HomePhone":"String","MobileAreaCode":"String","MobilePhone":"String","EmployerName":"String","ProfessionalTitle":"String","Profession":"String","EmployerAddressLine1":"String","EmployerAddressLine2":"String","EmployerCity":"String","EmployerLocation":"String","EmployerStateAbbrev":"String","EmployerPostalCode":"String","EmployerCountry":"String","EmployerWebsite":"String","EmployerPhoneAreaCode":"String","EmployerPhone":"String","EmployerFaxAreaCode":"String","EmployerFax":"String","ResumeExists":false,"ResumeHeadline":"String","SocialOrganizations":"String","EducationAndExperience":"String","MorePersonalInfo":"String","InternalComments":"String","HomeAddressValidated":false,"EmployerAddressValidated":false,"DateLastRenewed":"0001-01-01T00:00:00.0000000","DateEffectiveMembershipExpires":"0001-01-01T00:00:00.0000000","ImportBatchID":0,"CareerOpeningsAllowed":0,"MembersPagesAllowed":0,"AdditionalSeatsAllowed":0,"NameFormatNormal":0,"MemberHasConsented":false,"DateConsented":"0001-01-01T00:00:00.0000000","ConsentIPAddress":"String","MemberHasRevokedConsent":false,"DateConsentRevoked":"0001-01-01T00:00:00.0000000","CustomFields":[{"ExportLabel":"String","CustomFieldValue":{"FieldCode":"String","Fields":[{"ClientID":0,"FieldType":"Textbox","GroupCode":"String","GroupCodeFriendly":"String","Required":false,"Visible":0,"MemberCanOverride":false,"Editable":0,"Searchable":false,"Ordinal":0,"MaxLength":0,"IsMultiSelect":false,"IsFIB":true,"IsFileUpload":false,"Label":"String","Code":"String","ExportLabel":"String","SearchLabel":"String","SearchInfo":"String","Description":"String","ValidationExpression":"String","MemberTypes":[{"MemberTypeID":"String"}],"DonationFunds":[{"DonationFundID":"String"}],"MemberTypesProxy":[{"MemberTypeID":"String"}],"Values":[{"Ordinal":0,"Text":"String","Value":"String"}],"ValuesProxy":[{"Ordinal":0,"Text":"String","Value":"String"}],"HelpTopic":{"ID":0,"ClientID":0,"Label":"String","Content":"String","Width":0,"Height":0},"FieldDataType":"String"}],"Visibility":"String","VisibilityInt":2,"Values":[{"Value":"String","Text":"String"}],"ValuesProxy":[{"Value":"String","Text":"String"}],"MetaValue":{"Value":"String","Text":"String"},"ClientID":0}}]}],"MembersProfilesCount":0,"IncludeCustomFields":false,"FilterByDateTime":"0001-01-01T00:00:00.0000000","PageNumber":0,"PageSize":0,"MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-01-15T08:44:38.1593100-05:00","Device":"Desktop"}