DashboardSupportWelcome

👤 USER DOCS

Getting Started

Daily Operations

Shift Workspace & TasksPre-Shift SetupLine-Up CardsShift ReportsForms

Staff & Locations

Staff SchedulingManaging Locations

Oversight

Manager ReportsAnalyticsPre-Shift & Compliance

Incidents & Feedback

Incident ReportingAnonymous FeedbackMessages & Announcements

AI & Settings

AI ChatgearApp Settings

Administration

Dashboard & OnboardingAdmin

⚙️ DEVELOPER DOCS

Getting Started

Getting StartedDevelopmentDeployment Guide

Architecture

Architecture OverviewData FlowArchitecture Decision Records

Core Domain

Core DomainDatabase ReferenceLocations DomainAuth & RBACScheduling DomainReports DomainIncidents DomainNotifications DomainAudit Log & OptimizationDesign Audit Findings

Frontend

Frontend ArchitectureFormsLoading SkeletonsComponentsPWA & NotificationsimageScreenshots

API Reference

API Reference

Endpoints

POS Sales APIOptimization Data APISchedule Shifts APIEmployee Export APIReports APIIncidents APIAI Chat APIPush Notifications APIWebhooks APICron API

Contributing

ContributingcodeCode Examples

Security

Security & Compliance
Danvas IconDanvas
Danvas IconDanvas

Schedule Shifts API

Imported schedule data from external systems

Overview

The Schedule Shifts API allows for the synchronization of shift assignments from external systems (like 7-Shifts) into Danvas. This data is used to populate the visual schedule builder and generate compliance rosters.

Endpoint

GET /api/schedule/{location_slug}

Authentication

Requires an ANALYTICS_API_KEY via the Authorization: Bearer header.

Query Parameters

NameTypeDescription
location_slugstringLocation slug in the path
start_datedateStart date for the range, defaults to yesterday
end_datedateEnd date for the range, defaults to start_date + 6 days
employee_keystringOptional employee filter
departmentstringOptional department filter: FOH, BOH, or Other
daypartstringOptional daypart filter: Lunch, Dinner, or LateNight
include_draftbooleanInclude draft shifts, defaults to false
limitintegerMaximum shifts per page, defaults to 100
offsetintegerPagination offset, defaults to 0

Response


























Optimization Data API

Labor optimization metrics and goals for schedule planning

Employee Export API

Employee data for import and bulk operations

On this page

OverviewEndpointAuthenticationQuery ParametersResponseRelated
{
"location_slug": "cobbsmchenry",
"location_name": "D.C. Cobb's McHenry",
"start_date": "2026-05-18",
"end_date": "2026-05-24",
"shifts": [
{
"shift_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"business_date": "2026-05-18",
"employee_name": "Jane Doe",
"employee_key": "abc123def456",
"role": "Server",
"department": "FOH",
"daypart": "Dinner",
"start_at": "2026-05-18T16:00:00-05:00",
"end_at": "2026-05-18T23:00:00-05:00",
"hours_worked": "7.0",
"hourly_wage": "12.50",
"is_draft": false
}
],
"total_count": 1,
"limit": 100,
"offset": 0,
"generated_at": "2026-05-17T06:15:00Z"
}

Related

Staff Scheduling Guide

Scheduling Domain

API Overview