Sign in

v1

latestOpenAPI 3.0.4MIT2026-08-0417157271.9 KB
Member

Get a single member by MemberKey

Both methods are valid and return the same result: a single Member entity identified by its unique MemberKey. The path-style is more intuitive and commonly used in RESTful APIs. The function-style follows OData conventions and may be required in certain query contexts (e.g., when the key contains special characters or is not a simple numeric ID).

<b>Path-style access: </b>/odata/v1/Member/{MemberKey}

<b>Example: </b>/odata/v1/Member/14090

<b>Function-style access: </b>/odata/v1/Member('{MemberKey}')

<b>Example: </b>/odata/v1/Member('14090')

get/odata/v1/Member/{MemberKey}

Path parameters

MemberKeystring required

A unique identifier for this record from the immediate source

Query parameters

$selectstring

Selects which properties to include in the response.

Response

OK (DDF.Core.Entities.Member object)

@odata.contextstring nullable
MemberKeystring nullable

A unique identifier for this record.

MemberMlsIdstring nullable

The local, well-known identifier. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system.

OfficeKeystring nullable

The unique identifier of the member's office.

OfficeNationalAssociationIdstring nullable

The national association ID of the office. i.e. In Canada, this is the Organization ID of the Office.

JobTitlestring nullable

The title or position of the member within their organization.

MemberAORKeystring nullable

A system unique identifier. This is the Board ID of the Member's Primary Board or Association of REALTORS.

MemberAddress1string nullable

The street number, direction, name and suffix of the member.

MemberAddress2string nullable

The unit/suite number of the member.

MemberFaxstring nullable

North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard. International numbers should be preceded by a plus symbol.

MemberFirstNamestring nullable

The first name of the Member.

MemberLastNamestring nullable

The last name of the Member.

MemberMiddleNamestring nullable

The middle name of the Member.

MemberNamePrefixstring nullable

Prefix to the name (e.g. Dr. Mr. Ms. etc.)

MemberNameSuffixstring nullable

Suffix to the surname (e.g. Esq., Jr., III etc.)

MemberNationalAssociationIdstring nullable

The national association ID of the member. i.e. In Canada this is the CREA ID of the member.

MemberNicknamestring nullable

An alternate name used by the Member, usually as a substitute for the first name.

MemberOfficePhonestring nullable

North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard. International numbers should be preceded by a plus symbol.

MemberOfficePhoneExtstring nullable

The extension of the given phone number (if applicable).

MemberPostalCodestring nullable

The postal code of the member.

MemberPagerstring nullable

North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard. International numbers should be preceded by a plus symbol.

MemberTollFreePhonestring nullable

North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard. International numbers should be preceded by a plus symbol.

ModificationTimestampstring Enum: DateTime nullable

Date/time the roster (member or office) record was last modified (in Zulu time (UTC)).

OriginalEntryTimestampstring Enum: DateTime nullable

Date/time the roster (member or office) record was originally input into the source system (in Zulu time (UTC)).

MemberCitystring nullable

The city of the member.

MemberAORstring Enum: AOR nullable

The Member's Primary Board Name or Association's Name of REALTORS.

MemberCountrystring Enum: Country nullable

The country in a postal address.

MemberDesignationinteger[] nullable

Designations and certifications acknowledging experience and expertise in various real estate sectors are awarded by CREA and each affiliated group upon completion of required courses

MemberLanguagesinteger[] nullable

The languages the member speaks.

MemberStateOrProvincestring Enum: StateOrProvince nullable

The state or province in which the member is addressed.

MemberStatusstring Enum: MemberStatus nullable

The current status of the member.

MemberTypestring Enum: MemberType nullable

The type of member. i.e. Agent, Broker, Office Manager, Appraiser, Assistants, MLO, Realtor, Association Staff, MLS Staff, etc.

MemberEmailYNboolean nullable

This flag signifies the availability of a REALTOR®’s email address. It is intended for clients who use the Lead API endpoint to communicate with Realtors. If the flag is false, these clients should turn off the email REALTOR® function for the respective REALTOR®. Clients not using Lead API endpoint can disregard this field.

Example response

{
  "@odata.context": "https://localhost:7051/odata/v1/$metadata#DDF.Core.Entities.Member",
  "MemberKey": "MemberKey",
  "MemberMlsId": "MemberMlsId",
  "OfficeKey": "OfficeKey",
  "OfficeNationalAssociationId": "111111",
  "JobTitle": "JobTitle",
  "MemberAORKey": "MemberAORKey",
  "MemberAddress1": "MemberAddress1",
  "MemberAddress2": "MemberAddress2",
  "MemberFax": "MemberFax",
  "MemberFirstName": "MemberFirstName",
  "MemberLastName": "MemberLastName",
  "MemberMiddleName": "MemberMiddleName",
  "MemberNamePrefix": "MemberNamePrefix",
  "MemberNameSuffix": "MemberNameSuffix",
  "MemberNationalAssociationId": "MemberNationalAssociationId",
  "MemberNickname": "MemberNickname",
  "MemberOfficePhone": "MemberOfficePhone",
  "MemberOfficePhoneExt": "MemberOfficePhoneExt",
  "MemberPostalCode": "MemberPostalCode",
  "MemberPager": "MemberPager",
  "MemberTollFreePhone": "MemberTollFreePhone",
  "ModificationTimestamp": "\"2021-01-01T12:00:00.000Z\"",
  "OriginalEntryTimestamp": "\"2021-01-01T12:00:00.000Z\"",
  "MemberCity": "MemberCity",
  "MemberAOR": "Affiliate",
  "MemberCountry": "Canada",
  "MemberSocialMedia": [
    {
      "SocialMediaKey": "SocialMediaKey",
      "ResourceRecordKey": "12345",
      "SocialMediaType": "FaceBook",
      "ModificationTimestamp": "\"2021-01-01T00:00:00.000Z\"",
      "SocialMediaUrlOrId": "\"SocialMediaUrlOrId\""
    }
  ],
  "Media": [
    {
      "MediaKey": "MediaKey",
      "LongDescription": "REALTOR.ca Logo",
      "MediaURL": "https:///ddfcdn.realtor.ca/realtorlogo.png",
      "ModificationTimestamp": "2019-08-24T14:15:22Z",
      "Order": 1,
      "PreferredPhotoYN": true,
      "ResourceRecordId": "RealtorLogo.png",
      "ResourceRecordKey": "1234",
      "ResourceName": "Member",
      "MediaCategory": "Photo"
    }
  ],
  "MemberStateOrProvince": "Ontario",
  "MemberStatus": "Active",
  "MemberType": "GlobalAffiliate"
}