7shifts

# 7shifts

7shifts is a scheduling and labor management platform designed for restaurants. It helps restaurant managers schedule staff, track time and attendance, and manage labor costs. Restaurant owners, general managers, and shift supervisors are the primary users.

Official docs: https://developers.7shifts.com/

## 7shifts Overview

- **Shift**
  - **Shift Swaps**
- **Time Punch**
- **User**
- **Account**
- **Company**
- **Role**
- **Location**
- **Availability**
- **Schedule**
- **Announcement**
- **Tip Pool**
- **Wage**
- **Task List**
- **Labor Cost**
- **Sales Forecast**
- **Integration**
- **Report**
- **Drawer**
- **Break**
- **Checklist**
- **Event**
- **Form Template**
- **Form**
- **Training Module**
- **Training Progress**
- **Learning Management System (LMS)**
- **File**
- **Folder**
- **Shared Link**

Use action names and parameters as needed.

## Working with 7shifts

This skill uses the Membrane CLI to interact with 7shifts. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.

### Install the CLI

Install the Membrane CLI so you can run `membrane` from the terminal:

```bash
npm install -g @membranehq/cli@latest
```

### Authentication

```bash
membrane login --tenant --clientName=<agentType>
```

This will either open a browser for authentication or print an authorization URL to the console, depending on whether interactive mode is available.

**Headless environments:** The command will print an authorization URL. Ask the user to open it in a browser. When they see a code after completing login, finish with:

```bash
membrane login complete <code>
```

Add `--json` to any command for machine-readable JSON output.

**Agent Types** : claude, openclaw, codex, warp, windsurf, etc. Those will be used to adjust tooling to be used best with your harness

### Connecting to 7shifts

Use `membrane connection ensure` to find or create a connection by app URL or domain:

```bash
membrane connection ensure "https://7shifts.com" --json
```
The user completes authentication in the browser. The output contains the new connection id.

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has `state: "READY"`, skip to **Step 2**.

#### 1b. Wait for the connection to be ready

If the connection is in `BUILDING` state, poll until it's ready:

```bash
npx @membranehq/cli connection get <id> --wait --json
```

The `--wait` flag long-polls (up to `--timeout` seconds, default 30) until the state changes. Keep polling until `state` is no longer `BUILDING`.

The resulting state tells you what to do next:

- **`READY`** — connection is fully set up. Skip to **Step 2**.
- **`CLIENT_ACTION_REQUIRED`** — the user or agent needs to do something. The `clientAction` object describes the required action:
  - `clientAction.type` — the kind of action needed:
    - `"connect"` — user needs to authenticate (OAuth, API key, etc.). This covers initial authentication and re-authentication for disconnected connections.
    - `"provide-input"` — more information is needed (e.g. which app to connect to).
  - `clientAction.description` — human-readable explanation of what's needed.
  - `clientAction.uiUrl` (optional) — URL to a pre-built UI where the user can complete the action. Show this to the user when present.
  - `clientAction.agentInstructions` (optional) — instructions for the AI agent on how to proceed programmatically.

  After the user completes the action (e.g. authenticates in the browser), poll again with `membrane connection get <id> --json` to check if the state moved to `READY`.

- **`CONFIGURATION_ERROR`** or **`SETUP_FAILED`** — something went wrong. Check the `error` field for details.

### Searching for actions

Search using a natural language description of what you want to do:

```bash
membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json
```

You should always search for actions in the context of a specific connection.

Each result includes `id`, `name`, `description`, `inputSchema` (what parameters the action accepts), and `outputSchema` (what it returns).

## Popular actions

| Name | Key | Description |
| --- | --- | --- |
| List Time Off | list-time-off | List time off requests |
| List Roles | list-roles | List all roles for a company |
| List Departments | list-departments | List all departments for a company |
| Create Time Punch | create-time-punch | Create a new time punch (clock in/out record) |
| List Time Punches | list-time-punches | List time punches for a company with filtering options |
| Delete Shift | delete-shift | Delete a shift |
| Update Shift | update-shift | Update an existing shift |
| Create Shift | create-shift | Create a new shift |
| Get Shift | get-shift | Retrieve a specific shift by ID |
| List Shifts | list-shifts | List shifts for a company with filtering options |
| Deactivate User | deactivate-user | Deactivate (soft delete) a user |
| Update User | update-user | Update an existing user's information |
| Create User | create-user | Create a new user (employee) in 7shifts |
| Get User | get-user | Retrieve a specific user by ID |
| List Users | list-users | List all users (employees) for a company |
| Get Location | get-location | Retrieve a specific location by ID |
| Create Location | create-location | Create a new location for a company |
| List Locations | list-locations | List all locations for a company |
| Get Company | get-company | Retrieve a specific company by ID |
| List Companies | list-companies | List all companies accessible to the authenticated user |

### Running actions

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --json
```

To pass JSON parameters:

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "v