7shifts

7shifts Users API

Users (employees) scoped to a company.

Documentation GitHub OpenAPI

Operations 4

GET /v2/company/{company_id}/users List Users #

POST /v2/company/{company_id}/users Create User #

GET /v2/company/{company_id}/users/{identifier} Retrieve User #

PUT /v2/company/{company_id}/users/{identifier} Update User #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/7shifts-users-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: 7shifts Users API
  version: '2.0'
  description: 7shifts is a restaurant employee scheduling, time-tracking, and team management platform.
  contact:
    name: 7shifts Developer Portal
    url: https://developers.7shifts.com/reference/introduction
  license:
    name: 7shifts API Terms
    url: https://www.7shifts.com/legal/terms-of-service
servers:
- url: https://api.7shifts.com
  description: 7shifts API production base URL
tags:
- name: Users
  description: Users (employees) scoped to a company.
paths:
  /v2/company/{company_id}/users:
    get:
      tags:
      - Users
      operationId: listUsers
      summary: List Users
      parameters:
      - $ref: '#/components/parameters/CompanyIdPath'
      - name: modified_since
        in: query
        required: false
        description: Filter by modification date (YYYY-MM-DD).
        schema:
          type: string
      - name: location_id
        in: query
        required: false
        description: Filter by location (mutually exclusive with department_id and role_id).
        schema:
          type: integer
          format: int64
      - name: department_id
        in: query
        required: false
        description: Filter by department (mutually exclusive with location_id and role_id).
        schema:
          type: integer
          format: int64
      - name: role_id
        in: query
        required: false
        description: Filter by role (mutually exclusive with location_id and department_id).
        schema:
          type: integer
          format: int64
      - name: status
        in: query
        required: false
        description: User status filter.
        schema:
          type: string
          enum:
          - active
          - inactive
      - name: name
        in: query
        required: false
        description: Partial or full employee name filter.
        schema:
          type: string
      - name: sort_by
        in: query
        required: false
        description: Sort field and direction (e.g. firstname.asc,lastname.desc).
        schema:
          type: string
      - $ref: '#/components/parameters/Cursor'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/ApiVersionHeader'
      - $ref: '#/components/parameters/CompanyGuidHeader'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
                  meta:
                    $ref: '#/components/schemas/CursorMeta'
        '403':
          description: Forbidden
      security:
      - bearerAuth: []
    post:
      tags:
      - Users
      operationId: createUser
      summary: Create User
      parameters:
      - $ref: '#/components/parameters/CompanyIdPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '201':
          description: Created
        '400':
          description: Bad request
      security:
      - bearerAuth: []
  /v2/company/{company_id}/users/{identifier}:
    get:
      tags:
      - Users
      operationId: retrieveUser
      summary: Retrieve User
      parameters:
      - $ref: '#/components/parameters/CompanyIdPath'
      - name: identifier
        in: path
        required: true
        description: User identifier. Accepts either a 7shifts user ID or a punch ID with the prefix "punch:".
        schema:
          type: string
      - name: include_inactive
        in: query
        required: false
        description: Include inactive users in the response.
        schema:
          type: boolean
      - $ref: '#/components/parameters/ApiVersionHeader'
      - $ref: '#/components/parameters/CompanyGuidHeader'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/User'
        '400':
          description: Bad request
        '403':
          description: Forbidden
        '404':
          description: Not found
      security:
      - bearerAuth: []
    put:
      tags:
      - Users
      operationId: updateUser
      summary: Update User
      parameters:
      - $ref: '#/components/parameters/CompanyIdPath'
      - name: identifier
        in: path
        required: true
        description: User identifier.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '200':
          description: Updated
        '400':
          description: Bad request
        '404':
          description: Not found
      security:
      - bearerAuth: []
components:
  schemas:
    CursorMeta:
      title: Cursor Meta
      type: object
      description: Cursor-based pagination metadata.
      properties:
        cursor:
          type: object
          properties:
            current:
              type: string
            next:
              type: string
              nullable: true
            prev:
              type: string
              nullable: true
        count:
          type: integer
    User:
      title: User
      type: object
      properties:
        id:
          type: integer
          format: int64
        first_name:
          type: string
          maxLength: 80
        last_name:
          type: string
          maxLength: 80
        email:
          type: string
          format: email
          maxLength: 155
        mobile_number:
          type: string
          description: Phone number for notifications.
        active:
          type: boolean
          description: Login permission status.
        type:
          type: string
          enum:
          - employee
          - asst_manager
          - manager
          - employer
        invite_status:
          type: string
          enum:
          - accepted
          - pending
          - required
          - missing_contact_info
        employee_id:
          type: string
          description: Company-assigned employee identifier.
        hourly_wage:
          type: integer
          description: Wage in cents.
        skill_level:
          type: integer
        created:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
  parameters:
    ApiVersionHeader:
      name: x-api-version
      in: header
      required: false
      description: 7shifts API version (YYYY-MM-DD).
      schema:
        type: string
    Cursor:
      name: cursor
      in: query
      required: false
      description: Pagination cursor for the next or previous page.
      schema:
        type: string
    Limit:
      name: limit
      in: query
      required: false
      description: Results per page (1-500, default 100; 20 for some collections).
      schema:
        type: integer
        minimum: 1
        maximum: 500
        default: 100
    CompanyIdPath:
      name: company_id
      in: path
      required: true
      description: Company identifier.
      schema:
        type: integer
        format: int64
    CompanyGuidHeader:
      name: x-company-guid
      in: header
      required: false
      description: Company GUID.
      schema:
        type: string
        format: uuid
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token obtained from /oauth2/token passed as a Bearer token.
    oauth2:
      type: oauth2
      description: OAuth 2.0 with client_credentials, password, authorization_code, and refresh_token grant types.
      flows:
        clientCredentials:
          tokenUrl: https://api.7shifts.com/oauth2/token
          scopes: {}