Get Visitor Info

GET /api/dashboard/user

This endpoint retrieves all the information on a specific visitor.

Query Parameters

fName

First name of the visitor.

lName

Last name of the visitor.

Security

This endpoint requires authentication. You must include a valid API key in the request header. Permission(s) Required: VIEW_USER_INFO

Response Body

{
    "email": string,
    "registrationTimestamp": timestmap | null,
    "registeredFirstPrompt": boolean | null,
    "registrationSource": "kiosk" | "website" | null,
    "currentSite": string | "undefined",
    "askedCard": true | null,
    "hasPass": 1 | 0,
    "lastProject": string | "Other",
    "lastSeen": timestamp | undefined,
    "appointmentHistory": Appointment[],
    "customRegData": {
        "{field_id}": "{field_value}",
    }
}

email

Email address of the visitor.

registrationTimestamp Nullable

Unix Epoch format (millis). This is the time when the visitor registered.
This field may be null if the visitor has not registered.

registeredFirstPrompt Nullable

Whether the visitor registered on the kiosk immediately after we asked.
This field may be null if the visitor has not registered.

registrationSource Nullable

Where the visitor registered from. Either “kiosk” or “website”.
This field may be null if the visitor has not registered.

currentSite

ID of the subsite the visitor is physically present (signed in) at.
This field will be “undefined” if the visitor has not signed in today or has since signed out. (not present)

askedCard Nullable

Whether the visitor has been offered a physical access card.
This field may be null.

Note

This feature may not be enabled for your system.

hasPass

Whether the visitor has a physical access card setup.

Note

This feature may not be enabled for your system.

lastProject

Name of the project the visitor selected on their last sign in.
This field will be “Other” if the visitor has never selected a project or if they selected “Other” on their last sign in.

lastSeen

Unix Epoch format (millis). This is the time when the visitor has last signed in or out.

appointmentHistory

List of appointments the visitor has made.
See Get All Appointments to get more appointment details from the id.

[
    {
        "id": string,
        "startTimestamp": timestamp,
        "hoursLength": number,
        "endTimestamp": timestamp,
        "isApproved": boolean,
        "tools": string[]
    },
    {...}
]

id

ID of the appointment.

startTimestamp

Unix Epoch format (millis). This is the time when the appointment starts.

hoursLength

How long the appointment is in hours.

endTimestamp

Unix Epoch format (millis). This is the time when the appointment ends.

isApproved

Whether the appointment is approved.

tools

List of tools the visitor has requested for the appointment.

customRegData

Object of custom fields from registration form and their responses.
The possible values for this are defined in the system config.