Call

In this call, you will use a user’s userResourceGuid (user unique identifier) to get all the API-exposed information the system has on them.

A user’s userResourceGuid can be obtained in multiple ways:

• Data reports
• Using APIs
  • Search users
  • Create a new user
• Through UI
  • User’s profile URL: If you go to a user’s profile page (either alumni admin or alumni portal), you will be able to see the userResourceGuid in the browser’s URL. It will be a long alphanumeric value separated by hyphens.
    • In Alumni Portal: https://alumni.example.com/alumni/portal2/profile/id/a18895c4-862f-4a91-a9c1-44a9ecf51a28
    • In Alumni Admin: https://alumni.example.com/alumni/admin/#/crm/a18895c4-862f-4a91-a9c1-44a9ecf51a28

Notes

• It is possible to choose to return all the fields or just a specific field by passing the field key on the query parameter “fields”.

Response

This API will return a specific user’s schema, in JSON, with all their information.

Example

{
  "userResourceGuid": "a18895c4-862f-4a91-a9c1-44a9ecf51a28",
  "firstName": "John",
  "lastName": "Doe",
  "...",
  "connectWithLinkedin": true,
}

API URL: https://gateway.enterprisealumni.com/api/v2/user/userResourceGuid?fields=%2A

*Use gateway-us for the United States region and gateway-uk for the UK region. For the Frankfurt region, simply use gateway.

Expected return

User information on the profile, approval status, signup date, status (active, inactive, deactivated), user type, user ResourceGuid, CRM, and custom fields.