Skip to content
Lumen Insight Docs

Get All Appointments

GET /api/dashboard/appointments

Section titled “ /api/dashboard/appointments”

This endpoint retrieves a list of upcoming days and the appointments that take place on those days.

Query Parameters

Section titled “Query Parameters”

startTimestamp Optional Unix Epoch format (millis). This is the start date of the range to filter appointments by.

appId Optional ID of the appointment for which you want to retrieve data.
When this parameter is provided, the endpoint will return data for that specific appointment as well as all other appointments that are scheduled for the same day.

Security

Section titled “Security”

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

Response Body

Section titled “Response Body”
[
    {
        "timestamp": timestamp,
        "isDefaultDisabled": boolean,
        "items": Appointment[],
    },
    {...}
]

timestamp Unix Epoch format (millis). This is the time at the start of the day.

isDefaultDisabled If this day is disabled due to the work-week schedule.
Visitors cannot create appointments on these days.

items Array of appointments on this day.

[
    {
        "typeApp": true,
        "id": string,
        "startTimestamp": timestamp,
        "hoursLength": number,
        "endTimestamp": timestamp,
        "isApproved": boolean,
        "tools": string[],
        "members": Member[],
        "customFields": {
            "{field_id}": "{field_value}",
        },
        "conflictsWithIds": string[],
        "creatorFirstName": string,
        "creatorLastName": string,
        "creatorEmail": string
    },
    {...}
]

id UUID of the appointment.

startTimestamp Unix Epoch format (millis). This is the start time of the appointment.

hoursLength How many hours long this appointment is.

endTimestamp Unix Epoch format (millis). This is the end time of the appointment.

isApproved If this appointment has been approved by a system administrator.

tools Array of tools that are required for this appointment.
The possible values for this are defined in the system config.

members Array of members in this appointment.

[
    {
        "appointmentId": string,
        "email": string,
        "firstName": string | null,
        "lastName": string | null,
        "isCreator": boolean,
        "registrationTimestamp": timestamp | null,
        "isRegistered": boolean
    },
    {...}
]

appointmentId UUID of the appointment.

email Email address of the member.

firstName Nullable First name of the member.
This field may be null if the member does not yet exist in the system and the appointment creator has only added their email address.

lastName Nullable Last name of the member.
This field may be null if the member does not yet exist in the system and the appointment creator has only added their email address.

isCreator If this member is the creator of the appointment.
If this is true, a “firstName”, “lastName”, and “registrationTimestamp” will also exist.

registrationTimestamp Nullable The time at which this member completed their standard registration.
This field may be null if the member has not yet registered.

isRegistered If this member has completed their standard registration.

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

conflictsWithIds Array of appointment IDs that also occur at the same time as this appointment (they overlap).

creatorFirstName First name of the appointment creator.

creatorLastName Last name of the appointment creator.

creatorEmail Email address of the appointment creator.