bamboohr.com
    Preparing search index...

    Interface TimeOffRequestsOptions

    interface TimeOffRequestsOptions {
        action?: "view" | "approve" | "myRequests";
        employeeId?: number;
        end: string;
        excludeNote?: boolean;
        id?: number;
        start: string;
        status?: string;
        type?: string;
    }
    Index

    Properties

    action? employeeId? end excludeNote? id? start status? type?

    Properties

    action?: "view" | "approve" | "myRequests"

    Limit to requests the user can view, approve, or to their own requests. Defaults to "view".

    employeeId?: number

    A particular employee ID to limit the response to.

    end: string

    YYYY-MM-DD. Only show time off that occurs on/before the specified end date.

    excludeNote?: boolean

    When true, omits the notes object from each request in the response.

    id?: number

    A particular request ID to limit the response to.

    start: string

    YYYY-MM-DD. Only show time off that occurs on/after the specified start date.

    status?: string

    A comma separated list of request status values to include. If omitted, requests of all status values are included. Legal values are "approved", "denied", "superceded", "requested", "canceled".

    type?: string

    A comma separated list of time off types IDs to include limit the response to. If omitted, requests of all types are included.

    Settings

    Member Visibility

    On This Page

    Properties