getAllUserDetailsByAdminAPIKey

Retrieves multiple User profiles including some connection-related info given valid query parameters and API Key. By default retrieves ALL connections regardless of invite status (Accepted, Rejected etc). Optionally can return only those profiles since a provided modified date

Request

GET /rest/company/admin/profiles

Headers

Header	Required	Description
x-nextinteract-company-api-key	Yes	Admin-specific API key UUID provided to company

Parameters

modifiedAfterDate - Datetime (optional) to be used to determine which User profiles have been modified since the provided date effectively filtering the total records returned. Should be number of milliseonds sine UNIX epoch date 1 Jan 1970 e.g. 1534379746697. See https://currentmillis.com/

Response

200 OK

[
    {
        "user": {
            "fieldsToNull": [],
            "uTitleId": null,
            "uTitle": null,
            "uGenderCode": null,
            "uGenderName": null,
            "uEmail": "aaron.mcmullen@healthinteract.com.au",
            "uFirstName": "Jane",
            "uLastName": "Doe",
            "uCountryCode": null,
            "uCountryName": null,
            "uPrimaryMobile": null,
            "uDateOfBirth": null,
            "uInterests": null,
            "uDietaryRequirements": null,
            "uPhoto": null,
            "uEnableLocation": "N",
            "uEnableNotifications": "N",
            "uAllowAllEmails": "N",
            "uAllowNewsletterEmail": "N",
            "uProfessionId": null,
            "uProfessionName": null,
            "uSpecialtyId": null,
            "uSpecialtyName": null,
            "uOtherTitle": null,
            "uOtherProfession": null,
            "uOtherSpecialty": null,
            "uFacebookId": null,
            "uTwitterId": null,
            "uLinkedinId": null,
            "uLinkedinUrl": null,
            "uTimezoneId": null,
            "addresses": [],
            "uCreationDate": "2018-08-05",           
            "uIdentifiers": [],
            "uId": 9
        },
        "connectionStatus": {
            "userId": 9,
            "externalId": null,
            "inviteStatusCode": "P",
            "inviteStatusName": "Pending",
            "dInvited": 1533235880000,
            "dExpires": null,
            "dAccepted": null,
            "dRejected": null,
            "dCancelled": null
        }
    },
    {
        "user": {
            "fieldsToNull": [],
            "uTitleId": null,
            "uTitle": null,
            "uGenderCode": null,
            "uGenderName": null,
            "uEmail": "aaron.mcmullen@hypermedia.com.au",
            "uFirstName": "Joe",
            "uLastName": "Bloggs",
            "uCountryCode": null,
            "uCountryName": null,
            "uPrimaryMobile": null,
            "uDateOfBirth": null,
            "uInterests": null,
            "uDietaryRequirements": null,
            "uPhoto": null,
            "uEnableLocation": "N",
            "uEnableNotifications": "N",
            "uAllowAllEmails": "Y",
            "uAllowNewsletterEmail": "Y",
            "uProfessionId": null,
            "uProfessionName": null,
            "uSpecialtyId": null,
            "uSpecialtyName": null,
            "uOtherTitle": null,
            "uOtherProfession": null,
            "uOtherSpecialty": null,
            "uFacebookId": null,
            "uTwitterId": null,
            "uLinkedinId": null,
            "uLinkedinUrl": null,
            "uTimezoneId": null,
            "addresses": [],
            "uCreationDate": "2018-08-05",           
            "uIdentifiers": [],
            "uId": 8
        },
        "connectionStatus": {
            "userId": 8,
            "externalId": "EXTERNAL-ID-1",
            "inviteStatusCode": "A",
            "inviteStatusName": "Accepted",
            "dInvited": 1533235880000,
            "dExpires": null,
            "dAccepted": null,
            "dRejected": null,
            "dCancelled": null
        }
    }
]

Errors

Exception	Description
WSInvalidParameterException	See Error Definitions
WSRecordNotFoundException	See Error Definitions
WSCompanyApiKeyNotActiveException	See Error Definitions
WSCompanyNotActiveException	See Error Definitions
WSUserNotFoundException	See Error Definitions
WSUserNotActiveException	See Error Definitions
WSConnectionStatusNotActiveException	See Error Definitions
WSAdminAPIServiceException	See Error Definitions