V2: User Data (Get)

Description

This endpoint retrieves user information based on the email address.

HTTP Method

get

URL

/api/v2/persons/userdataByEmails

Query Parameters

Response

[
    {
        "ReturnCode": 0,
        "KeyEmail": "string",
        "PersonalData": {
            "ID": integer,
            "FirstName": "string",
            "LastName": "string",
            "NameOnID": "string",
            "Prefix": "string",
            "Suffix": "string",
            "Gender": "string",
            "Email": "string",
            "JobTitle": "string",
            "DateOfBirth": "string",
            "Phone1": "string",
            "Phone2": "string",
            "Address": "string",
            "City": "string",
            "StateProvince": "string",
            "PostalCode": "string",
            "Country": "string",
            "ContactTypeID": integer,
            "BusinessGroup": "string",
            "BusinessUnit": "string",
            "Level1BusinessGroup": "string",
            "Level2BusinessUnit": "string",
            "CompanyName": "string",
            "CorporateID": "string",
            "HomeSiteID": "string",
            "UserRole": "string",
            "Biography": "string",
            "ProfilePicture": "string",
            "ProfilePictureUrl": "string",
            "ProfilePicturePreviewUrl": "string",
            "IsActive": "string",
            "IsUser": "string",
            "IsSpeaker": "string",
            "IsExternal": "string"
        }
    }
]

Example

[
    {
        "ReturnCode": 0,
        "KeyEmail": "janedoe@example.com",
        "PersonalData": {
            "ID": 2266,
            "FirstName": "Jane",
            "LastName": "Doe",
            "NameOnID": "Jane D. Doe",
            "Prefix": "Ms.",
            "Suffix": "Sr.",
            "Gender": null,
            "Email": "janedoe@example.com",
            "JobTitle": "Project Manager",
            "DateOfBirth": "1985-05-15",
            "Phone1": "+19876543210",
            "Phone2": "+10987654321",
            "Address": "5678 Side Ave",
            "City": "Rivertown",
            "StateProvince": "River State",
            "PostalCode": "67890",
            "Country": "Exampleland",
            "ContactTypeID": 4,
            "BusinessGroup": "Business Group Name",
            "BusinessUnit": "Business Unit Name",
            "Level1BusinessGroup": "Level 1 Business Group Name",
            "Level2BusinessUnit": "Level2 Business Unit Name",
            "CompanyName": "Creative Solutions LLC",
            "CorporateID": "CI78901",
            "HomeSiteID": "2",
            "UserRole": null,
            "Biography": "<p>Jane has over 15 years of experience managing high-profile tech projects and leading diverse teams.</p>",
            "ProfilePicture": null,
            "ProfilePictureUrl": "http://example.com/path/to/jane.jpg",
            "ProfilePicturePreviewUrl": "http://example.com/path/to/jane.jpg",
            "IsActive": "true",
            "IsUser": "false",
            "IsSpeaker": "false",
            "IsExternal": "false"
        }
    }
]

Success Response

Code: 200 OK