Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

7shifts Shifts API

Scheduled shifts assigned to users.

7shifts Shifts API is one of 15 APIs that 7shifts publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shifts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, rate-limit docs, and a changelog.

This API exposes 4 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://api.7shifts.com.

4 operations 2 paths 3 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://api.7shifts.com/v2
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

7shifts Shifts API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (oauth2) using the clientCredentials flow.

  • bearerAuth — Access token obtained from /oauth2/token passed as a Bearer token.
  • oauth2 — OAuth 2.0 with clientcredentials, password, authorizationcode, and refreshtoken grant types.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Shifts 4

Scheduled shifts assigned to users.

GET
/v2/company/{company_id}/shifts
List Shifts
listShifts 12 params → 200
POST
/v2/company/{company_id}/shifts
Create Shift
createShift 1 param body → 201400
GET
/v2/company/{company_id}/shifts/{shift_id}
Retrieve Shift
retrieveShift 2 params → 200404
DELETE
/v2/company/{company_id}/shifts/{shift_id}
Delete Shift
deleteShift 2 params → 204404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Shift (15 properties), Break (4 properties), CursorMeta (2 properties). Each schema is shown below with its type and property counts.

Break
object
4 properties
Shift
object
15 properties
CursorMeta
object
Cursor-based pagination metadata.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

7shifts-shifts-api-openapi.yml Raw ↑

Other APIs 7shifts publishes across the network.

7shifts Availability API
7shifts Companies API
7shifts Departments API
7shifts Identity API
7shifts Locations API
7shifts OAuth API
7shifts Reporting API
7shifts Roles API
7shifts Sales API
7shifts Time Off API
7shifts Time Punches API
7shifts Users API