Employee Export API

Employee data for import and bulk operations

Returns employee data for import operations, bulk invitations, and employee directory features.

The live API returns flat rows suitable for bulk provisioning and supports an optional location filter plus an include_all flag for inactive employees.

Endpoint

GET /api/analytics/employees/export

Query Parameters

Parameter	Type	Required	Description
`location_slug`	string	❌	Filter by location
`include_all`	boolean	❌	Include inactive employees as well (default: `false`)
`limit`	integer	❌	Maximum results (default: `500`, max: `2000`)

Response Schema

Schedule Shifts API

Imported schedule data from external systems

Reports API

Endpoints for submitting and retrieving shift and manager reports

Field	Type	Nullable	Default	Description
`employee_key`	string	No	-	Unique employee identifier
`full_name`	string	No	-	Employee full name
`employee_type`	string	No	-	Employee type (e.g., "Server")
`first_name`	string	Yes	null	First name
`last_name`	string	Yes	null	Last name
`active`	boolean	No	true	Employment status
`email`	string	Yes	null	Email address
`phone`	string	Yes	null	Phone number
`primary_location_slug`	string	Yes	null	Primary location
`all_locations`	string	Yes	null	Comma-separated locations
`primary_job`	string	Yes	null	Primary job role
`primary_reporting_role`	string	Yes	null	Reporting role (e.g., "FOH")
`all_jobs`	string	Yes	null	Comma-separated job roles

[
  {
    "employee_key": "emp-123",
    "full_name": "John Doe",
    "employee_type": "Server",
    "first_name": "John",
    "last_name": "Doe",
    "active": true,
    "email": "john@example.com",
    "phone": "555-1234"

import { getEmployeeExport } from '@repo/analytics/employee-client';

// Get all employees
const allEmployees = await getEmployeeExport();

// Get employees for specific location
const downtownEmployees = await getEmployeeExport({
  locationSlug: 'downtown'

File	Purpose
`packages/analytics/employee-client.ts`	Client implementation with Zod schema
`packages/database/src/schema/`	Employee-related database tables

Employee Export API

Endpoint

Query Parameters

Response Schema

On this page

Employee Fields

Example Request

Example Response

Client Usage

Error Responses