Function getScheduleById

getScheduleById<ThrowOnError extends boolean = true>(
    options: Options<GetScheduleByIdData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                default: boolean;
                hours: {
                    "0": null
                    | string;
                    "1": number[][];
                    "2": number[][];
                    "3": number[][];
                    "4": number[][];
                    "5": number[][];
                    "6": null | string;
                };
                modifiedAt: string;
                name: string;
                timezone: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                modifiedBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
        included: {
            attributes: {
                createdAt: string;
                description: string;
                enabled: boolean;
                endDate: string;
                modifiedAt: string;
                name: string;
                startDate: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                modifiedBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
                schedule: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
            };
            type: string;
        }[];
    },
    unknown,
    ThrowOnError,
>
Get business schedule by ID Retrieves a business schedule by the schedule ID.

Any one of the following roles is required for this endpoint:

Legacy Role Equivalent Permission Set Role

org.user.schedule.read org.permission.schedule.read

org.admin.schedule.read
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetScheduleByIdData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                default: boolean;
                hours: {
                    "0": null
                    | string;
                    "1": number[][];
                    "2": number[][];
                    "3": number[][];
                    "4": number[][];
                    "5": number[][];
                    "6": null | string;
                };
                modifiedAt: string;
                name: string;
                timezone: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                modifiedBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
        included: {
            attributes: {
                createdAt: string;
                description: string;
                enabled: boolean;
                endDate: string;
                modifiedAt: string;
                name: string;
                startDate: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                modifiedBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
                schedule: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
            };
            type: string;
        }[];
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:673

Legacy Role	Equivalent Permission Set Role
org.user.schedule.read	org.permission.schedule.read
org.admin.schedule.read

Function getScheduleById

Type Parameters

Parameters

Settings