YM REST Services

<back to all web services

PeopleProfileFindID

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/PeopleProfileFindIDFinds and returns a member or non-member ID using Import ID, Constituent ID or Website/Profile ID as criteria.
PeopleProfileFindID Parameters:
NameParameterData TypeRequiredDescription
ImportIDquerystringNo
ConstituentIDquerystringNo
ProfileIDqueryintNo
UsernamequerystringNo
EmailquerystringNo
PageNumberqueryintNo
PageSizequeryintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
PeopleProfileFindIDResponse Parameters:
NameParameterData TypeRequiredDescription
IDformList<string>NoThis key has been deprecated and will be removed in a future update. Please use the “ProfileIDs” key.
ProfileIDsformList<int>No

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}/PeopleProfileFindID HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ID":["String"],"ProfileIDs":[0],"ImportID":"String","ConstituentID":"String","ProfileID":0,"Username":"String","Email":"String","PageNumber":0,"PageSize":0,"UsingRedis":true,"AppInitTime":"2024-05-03T09:25:23.9339333-04:00","ServerID":"WS-6-183-431","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":"2024-05-03T10:08:22.3046231-04:00","Device":"Desktop"}