Guides
Signup For Free

7shifts API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for 7shifts API as part of the HRIS category

Delete Availability for a Company

  • ID: delete_availability_for_a_company
  • Operation: write
  • Entities: company, availability
  • Summary: The Delete Availability for a Company API endpoint allows you to delete a specific availability record for a given company. The endpoint requires two path parameters: 'company_id' and 'availability_id', both of which are integers and are required. The request does not require a body or query parameters. The response can be a 204 No Content on successful deletion, or various error responses such as 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Server Error, each providing a detailed problem type in JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Availability Reason

  • ID: delete_availability_reason
  • Operation: write
  • Entities: availability reason, company
  • Summary: The Delete Availability Reason API allows you to delete a specific availability reason for a company. It requires the company ID and the availability reason ID as path parameters. The request headers can optionally include the API version and company GUID. The response will be a 204 No Content on success. If there is an error, the response will include details about the error, such as the type, title, status, detail, code, and the parameter related to the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Department from Company

  • ID: delete_department_from_company
  • Operation: write
  • Entities: company, department, role
  • Summary: The Delete Department from Company API allows users to delete a specific department from a company using the DELETE method. The API requires the company_id and department_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. An optional query parameter transfer_to can be used to specify a department ID to transfer roles and shifts to. The API returns a 204 No Content response on success. Error responses include 403 Forbidden, 404 Not Found, and 500 Server Error, each providing detailed error information in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Event from Company

  • ID: delete_event_from_company
  • Operation: write
  • Entities: company, location, event
  • Summary: The Delete Event from Company API allows users to delete a specific event from a company using the DELETE method. The endpoint requires the company_id and event_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. Optional query parameters include recurrence_target and start_date for targeting specific recurrences. The API returns a 200 OK response with details of the deleted event, including event type, location IDs, start and end times, and recurrence rules. Error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Unexpected Error, each providing details about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete External User Mapping

  • ID: delete_external_user_mapping
  • Operation: write
  • Entities: company, user mapping, identifier
  • Summary: The Delete External User Mapping API allows you to remove a mapping between a company and an external user in the 7shifts system. The API requires the company ID and the user identifier, which can be a 7shifts user ID, an external user ID prefixed with 'ext:', or an email address prefixed with 'email:'. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The API returns a 204 status code for successful deletion, and various error codes for issues such as bad requests, unauthorized access, forbidden actions, not found errors, unprocessable entities, and unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Forecast Override for a Location

  • ID: delete_forecast_override_for_a_location
  • Operation: write
  • Entities: company, forecast override, location
  • Summary: This API endpoint allows you to delete forecast override data for a specific location within a company. The DELETE method is used to remove override data for a specified date range. The request requires the company_id and location_id as path parameters. The request body must include the start_date and report_type, with an optional end_date. The API supports headers for API version and company GUID. The response will be a 204 No Content on success, or an error message with details in case of failure.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Forecast Override Interval

  • ID: delete_forecast_override_interval
  • Operation: write
  • Entities: company, forecast override interval, location
  • Summary: The Delete Forecast Override Interval API endpoint allows you to delete the overridden project sales interval of 15 minutes or 1 hour for a specific company and location. The request requires the company_id and location_id as path parameters. Optional headers include x-api-version and x-company-guid. The request body must include the start and end date/time of the interval in UTC format, and optionally the report_type, which defaults to 'sales'. The API returns a 204 No Content response on success. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 422 Unprocessable Entity, and 500 Server Error, each providing detailed error information in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Location from Company

  • ID: delete_location_from_company
  • Operation: write
  • Entities: company, location
  • Summary: This API endpoint allows the deletion of a specific location from a company in the 7shifts system. It requires the company ID and location ID as path parameters. The request must include the 'accept' header with the value 'application/problem+json'. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The API returns a 204 status code for successful deletion, and error responses with detailed problem descriptions for 403 (Forbidden), 404 (Not Found), and 500 (Server Error) status codes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Log Book Category

  • ID: delete_log_book_category
  • Operation: write
  • Entities: company, log book category
  • Summary: The Delete Log Book Category API allows users to delete a specific log book category for a given company. It requires the company ID and category ID as path parameters. The API supports optional headers for specifying the API version and company GUID. The response includes various status codes: 204 for successful deletion, 401 for unauthorized access, 403 for forbidden access, 404 if the category is not found, and 500 for server errors. The response body for error cases includes detailed information about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Log Book Comment

  • ID: delete_log_book_comment
  • Operation: write
  • Entities: company, log book comment
  • Summary: The Delete Log Book Comment API allows users to delete a specific log book comment for a given company. The API requires the company ID and the log book comment ID as path parameters. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The request must include the 'accept' header with the value 'application/problem+json'. The API returns a 204 No Content response on successful deletion. Possible error responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Server Error, each providing detailed error information in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Log Book Post

  • ID: delete_log_book_post
  • Operation: write
  • Entities: company, log book post
  • Summary: The Delete Log Book Post API allows users to delete a specific log book post for a given company. The API requires the 'company_id' and 'id' as path parameters to identify the company and the log book post to be deleted. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The 'accept' header is required and should be set to 'application/problem+json'. The API returns a 204 No Content response on successful deletion. Error responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Server Error, each providing a detailed problem description in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Role Assignment for a User in a Company

  • ID: delete_role_assignment_for_a_user_in_a_company
  • Operation: write
  • Entities: company, role assignment, user
  • Summary: This API endpoint allows the deletion of a role assignment for a specific user within a company. The DELETE method is used to remove the role assignment identified by the role_id for the user identified by user_id in the company identified by company_id. The request requires the 'accept' header to be set to 'application/problem+json'. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The path parameters company_id, user_id, and role_id are required. The API returns a 204 No Content response on success. In case of errors, it may return 403 Forbidden, 404 Not Found, or 500 Server Error with detailed error information in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Role from Company

  • ID: delete_role_from_company
  • Operation: write
  • Entities: company, role
  • Summary: The Delete Role from Company API allows you to remove a specific role from a company in the 7shifts system. This API requires the 'Entrée' plan. The endpoint requires the company_id and role_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The request must include an 'accept' header with the value 'application/problem+json'. The API returns a 204 status code for successful deletion. Error responses include 400 (Bad Request), 403 (Forbidden), 404 (Not Found), and 500 (Server Error), each providing detailed error information in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Sales Category Mapping

  • ID: delete_sales_category_mapping
  • Operation: write
  • Entities: company, sales category mapping, location
  • Summary: The Delete Sales Category Mapping API allows the user to delete a sales category mapping for a specific company and location using the external category ID. The API requires the company_id, location_id, and external_id as path parameters, and department_id as a query parameter. Optional headers include x-api-version and x-company-guid. The API returns a 204 status code for successful deletion, and various error codes (400, 401, 403, 404, 422, 500) with detailed error information in case of failure.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Shift for a Company

  • ID: delete_shift_for_a_company
  • Operation: write
  • Entities: company, shift
  • Summary: This API endpoint allows you to delete a specific shift for a company using the DELETE method. The endpoint requires the company_id and shift_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The request must include the 'accept' header with the value 'application/problem+json'. The response will return a 204 status code for successful deletion, or an error object with details in case of failure, such as 401 Unauthorized, 403 Forbidden, 404 Not Found, or 500 Unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Task List Template

  • ID: delete_task_list_template
  • Operation: write
  • Entities: company, task list template, error
  • Summary: The Delete Task List Template API allows you to delete a specific task list template for a given company. The API requires the company ID and the UUID of the task list template to be specified in the path parameters. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The 'accept' header is required and should be set to 'application/problem+json'. The API returns a 204 No Content response on successful deletion. Error responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Server Error, each providing detailed information about the error in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Task Tags for a Company

  • ID: delete_task_tags_for_a_company
  • Operation: write
  • Entities: company, task tag
  • Summary: This API endpoint allows the deletion of task tags for a specified company. The DELETE request requires the company_id as a path parameter and a JSON body containing the company_id and a list of task tag UUIDs to be deleted. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The response can be a 204 No Content on success or various error responses such as 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Server Error, each providing detailed error information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Time Off Request

  • ID: delete_time_off_request
  • Operation: write
  • Entities: company, time off
  • Summary: The Delete Time Off Request API allows users to delete a specific time off request identified by the 'time_off_id' path parameter. The request requires the 'accept' header to specify the media type for the response, and optionally includes 'x-api-version' and 'x-company-guid' headers for API versioning and company identification. The response can be a 204 No Content on success, or various error responses such as 400 Bad Request or 403 Forbidden, each providing detailed error information in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Time Punch

  • ID: delete_time_punch
  • Operation: write
  • Entities: company, time punch, problem
  • Summary: The Delete Time Punch API allows you to delete a specific time punch record for a company using the DELETE method. The endpoint requires the company_id and time_punch_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The request must include the 'accept' header with the value 'application/problem+json'. The API returns a 204 No Content response on success. Error responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Server Error, each providing a detailed problem type object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete User Department Assignment

  • ID: delete_user_department_assignment
  • Operation: write
  • Entities: company, user, department assignment
  • Summary: The Delete User Department Assignment API allows you to remove a department assignment for a specific user within a company. The API requires the company_id, user_id, and department_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The response will be a 204 No Content on success, or an error object with details in case of failure, such as 400 Bad Request, 403 Forbidden, 404 Not Found, or 500 Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete User from Company

  • ID: delete_user_from_company
  • Operation: write
  • Entities: company, user, response
  • Summary: The Delete User from Company API allows you to remove a user from a specified company in the 7shifts system. This API requires the company ID and user ID as path parameters. Optional headers include the API version and company GUID. The Authorization header with a Bearer token is required. The request body must include an inactive reason and can optionally include comments related to the user deletion. The API returns a 204 No Content response on success. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Server Error, each providing detailed error information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete User Location Assignment

  • ID: delete_user_location_assignment
  • Operation: write
  • Entities: company, location assignment, user
  • Summary: This API endpoint allows the deletion of a user's location assignment in a specified company. The DELETE method is used to remove the assignment. The request requires path parameters including company_id, user_id, and location_id, all of which are integers. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The response can be a 204 No Content for a successful deletion, or various error responses such as 400 Bad Request, 403 Forbidden, 404 Not Found, and 500 Server Error, each providing detailed error information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Webhook for a Company

  • ID: delete_webhook_for_a_company
  • Operation: write
  • Entities: company, webhook
  • Summary: This API endpoint allows the deletion of a specific webhook for a company using the DELETE method. The request requires the company_id and webhook_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The response will be a 204 No Content on success, or an error object with details in case of failure, such as 401 Unauthorized, 403 Forbidden, 404 Not Found, or 500 Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Availability Details for a Company

  • ID: get_availability_details_for_a_company
  • Operation: read
  • Entities: company, availability, user
  • Summary: This API endpoint retrieves the availability details for a specific company and availability ID. It requires the 'company_id' and 'availability_id' as path parameters, both of which are integers. The request must include an 'accept' header with the value 'application/json'. The response includes detailed availability information for each day of the week, including start and end times, comments, and reasons. The response also includes metadata such as the creation and modification dates, and the status of the availability. If the availability is repeating, this is indicated by a boolean value. The API returns a 200 status code with the availability data if successful, or error codes such as 401, 403, 404, or 500 for various failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Availability Reasons for a Company

  • ID: get_availability_reasons_for_a_company
  • Operation: read
  • Entities: availability reason, company
  • Summary: This API endpoint retrieves the availability reasons for a specified company. It requires the company_id as a path parameter. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. Query parameters include cursor for pagination and limit for the number of results per page. The response includes an object type of 'availability_reasons', an array of data with details about each availability reason, and meta information for pagination.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Availabilities

  • ID: get_company_availabilities
  • Operation: read
  • Entities: company, availability, user
  • Summary: The Get Company Availabilities API endpoint retrieves the availability data for a specified company. The endpoint requires the company_id as a path parameter. Optional query parameters include cursor for pagination, limit for the number of results per page, location_id, user_id, status, repeating, week_gte, week_to_include_repeating_gte, order_field, and order_dir. The response includes availability data with details such as availability ID, user ID, company ID, week, repeat status, daily availability status, and timestamps for creation and modification. The response also includes pagination metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Departments

  • ID: get_company_departments
  • Operation: read
  • Entities: company, department, location
  • Summary: The Get Company Departments API retrieves a list of departments for a specified company. The request requires the company_id as a path parameter. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. Optional query parameters include modified_since to filter departments modified after a certain date, cursor for pagination, limit to specify the number of results per page, and location_id to filter departments by location. The response includes a list of department objects with details such as id, company_id, location_id, name, default status, and timestamps for creation and modification. The meta object contains pagination information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Details

  • ID: get_company_details
  • Operation: read
  • Entities: company, meta, plan
  • Summary: The Get Company Details API retrieves detailed information about a specific company using its ID. The request requires the company ID as a path parameter and optionally accepts headers for API version and company GUID. The response includes company details such as name, country, plan ID, status, and metadata. The response status can be active, trial, cancelled, delinquent, expired, or unknown.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Events

  • ID: get_company_events
  • Operation: read
  • Entities: company, location, event
  • Summary: The Get Company Events API retrieves a list of events for a specified company. The API requires a company ID as a path parameter and accepts optional headers for API version and company GUID. It also accepts query parameters for location ID, start date, and end date to filter events within a specific date range. The response includes an array of event objects, each containing details such as event ID, location IDs, color, start and end dates and times, title, description, whether it is a multi-day event, event type, and recurrence rules.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Labor Settings

  • ID: get_company_labor_settings
  • Operation: read
  • Entities: company, labor setting, overtime
  • Summary: The Get Company Labor Settings API retrieves the labor settings for a specified company. The endpoint requires the company_id as a path parameter. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The response includes detailed labor settings such as overtime thresholds, multipliers, break settings, and jurisdiction information. The response is structured with an 'object' field indicating 'labor_settings' and a 'data' field containing all the labor settings details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Locations

  • ID: get_company_locations
  • Operation: read
  • Entities: company, department, location
  • Summary: The Get Company Locations API retrieves a list of locations for a specified company. The request requires the company_id as a path parameter. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. Query parameters such as modified_since, deleted, cursor, and limit can be used to filter and paginate the results. The response includes an array of location objects, each containing details such as id, name, country, state, city, formatted address, latitude, longitude, timezone, and operational hours. The meta object provides pagination information with cursor details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Receipts

  • ID: get_company_receipts
  • Operation: read
  • Entities: company, location, receipt
  • Summary: The Get Company Receipts API endpoint allows users to retrieve receipts for a specific company. The endpoint requires the company_id as a path parameter and location_id as a query parameter. Optional query parameters include receipt_date[gte], receipt_date[lte], modified_since, status, external_user_id, cursor, and limit. The API returns a list of receipts with details such as receipt_id, net_total, gross_total, tips, and more. The response includes pagination information in the meta object. Receipts with a receipt_date greater than 90 days in the past will not be included in the result set.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Roles

  • ID: get_company_roles
  • Operation: read
  • Entities: company, role, station
  • Summary: The Get Company Roles API endpoint retrieves a list of roles for a specified company. The endpoint requires the company_id as a path parameter. Optional query parameters include location_id, department_id, ids, modified_since, cursor, and limit. The API supports optional headers for specifying the API version and company GUID. The response includes a list of roles with details such as role ID, company ID, location ID, department ID, color, number of stations, role name, job code, sort order, stations, creation date, and modification date. The response also includes metadata for pagination.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Shifts

  • ID: get_company_shifts
  • Operation: read
  • Entities: company, department, shift
  • Summary: The Get Company Shifts API endpoint retrieves a list of shifts for a specified company. It requires the company_id as a path parameter. Optional query parameters include cursor for pagination, limit for the number of results per page, and various filters such as location_id, shift_ids, department_ids, role_id, user_id, and date range filters for start and end times. The response includes a list of shifts with details such as shift ID, user ID, start and end times, location, role, and other shift attributes. The response also includes pagination metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Time Punches

  • ID: get_company_time_punches
  • Operation: read
  • Entities: company, user, time punch
  • Summary: The Get Company Time Punches API endpoint retrieves time punch records for a specified company. It requires the company_id as a path parameter. Optional query parameters include location_id, department_id, role_id, user_id, approved, limit, modified_since, clocked_in and clocked_out date ranges, deleted status, and sorting options. The response includes an array of time punch records with details such as shift_id, user_id, role_id, location_id, department_id, hourly_wage, approval status, clocked in/out times, notes, and more. The response also includes metadata for pagination.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Webhooks

  • ID: get_company_webhooks
  • Operation: read
  • Entities: company, webhook
  • Summary: The Get Company Webhooks API retrieves a list of webhooks for a specified company. It requires the company_id as a path parameter. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. Optional query parameters include modified_since to filter webhooks modified after a certain date, cursor for pagination, and limit to specify the number of results per page. The response includes a list of webhooks with details such as id, company_id, url, method, event, created, and modified timestamps, along with pagination metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Daily Sales and Labor Report

  • ID: get_daily_sales_and_labor_report
  • Operation: read
  • Entities: labor, sales, report
  • Summary: The Get Daily Sales and Labor Report API provides detailed daily sales and labor data for a specified date range and location. It requires the 'start_date', 'end_date', and 'location_id' as query parameters, with optional 'department_id'. The API returns a list of daily reports, each containing information such as actual and projected sales, labor costs, items sold, and labor hours. The response includes detailed metrics like sales per labor hour and labor percent, allowing businesses to analyze their performance effectively.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Daily Statistics for a Company Location

  • ID: get_daily_statistics_for_a_company_location
  • Operation: read
  • Entities: company, department, location
  • Summary: This API endpoint retrieves daily statistics for a specific company location. It requires the company_id and location_id as path parameters. The API supports optional headers for specifying the API version and company GUID. The query parameters include department_id (optional), date (required), and include_future (optional). The response includes detailed sales and labor statistics, both current and past, in cents, along with labor ratios and sales per man hour. The response is structured with a summary and intervals of data, providing a comprehensive view of daily statistics.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Day Part Settings for a Company

  • ID: get_day_part_settings_for_a_company
  • Operation: read
  • Entities: company, location, day part
  • Summary: This API endpoint retrieves the day part settings for a specified company. It requires the 'company_id' as a path parameter and optionally accepts 'location_id' as a query parameter to filter results by location. The request headers can include 'x-api-version' to specify the API version and 'x-company-guid' for the company GUID. The response includes an array of day part settings, each containing details such as UUID, location ID, name, segments, and timestamps for creation and modification. The API returns various HTTP status codes, including 200 for success, 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, and 500 for server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Department Details

  • ID: get_department_details
  • Operation: read
  • Entities: company, department, location
  • Summary: This API endpoint retrieves the details of a specific department within a company. It requires the company ID and department ID as path parameters. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response includes details such as department ID, company ID, location ID, department name, whether it is the default department, and timestamps for creation and modification. The response also handles error cases with appropriate status codes and messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Engage Overview for a Location

  • ID: get_engage_overview_for_a_location
  • Operation: read
  • Entities: company, location, engage overview
  • Summary: The Get Engage Overview for a Location API provides an overview of engagement statistics for a specific location within a company. It requires the company_id and location_id as path parameters, and the date as a query parameter. Optional query parameters include frequency and user_type. The API returns detailed statistics on location and employee engagement, including metrics such as lates, no-shows, sick shifts, shift bids, and shift drops. It also provides employee stats for the most reliable, eager, sick, late, and those with the most drops, along with engagement scores for the most and least engaged employees. The response includes shift feedback and average tenure data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Event Details

  • ID: get_event_details
  • Operation: read
  • Entities: company, location, event
  • Summary: The Get Event Details API retrieves detailed information about a specific event for a given company. It requires the company_id and event_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The response includes details such as event type, location IDs, start and end times, title, description, color, and recurrence rules. The API returns a 200 status code with event details on success, and appropriate error messages for unauthorized, forbidden, not found, or server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get External User Mappings

  • ID: get_external_user_mappings
  • Operation: read
  • Entities: company, external user mapping, user
  • Summary: The Get External User Mappings API retrieves the mapping details of a user in the 7Shifts system or an external system. The API requires the company_id and identifier as path parameters, where the identifier can be a 7Shifts user ID or an external user ID prefixed with 'ext:'. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. An optional query parameter location_id can be provided. The response includes details such as mapping ID, user IDs, company ID, location ID, application name, creation and modification timestamps, and user active status. The API returns various HTTP status codes for different outcomes, including 200 for success, 400 for bad request, 401 for unauthorized access, 403 for forbidden access, 404 for not found, and 500 for unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get External User Mappings for a Company

  • ID: get_external_user_mappings_for_a_company
  • Operation: read
  • Entities: company, external user mapping, user
  • Summary: This API endpoint retrieves external user mappings for a specified company. It requires the company_id as a path parameter. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. Query parameters can be used to filter results by location_id, user_id, external_user_id, modified_since, cursor, and limit. The response includes a list of external user mappings with details such as mapping ID, user IDs, company and location IDs, application name, creation and modification timestamps, and user activity status. The response also includes pagination metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Hours and Wages Report

  • ID: get_hours_and_wages_report
  • Operation: read
  • Entities: employee, wage, report
  • Summary: The Get Hours and Wages Report API endpoint retrieves detailed reports on hours worked and wages earned by employees within a specified date range. The API requires a minimum plan of 'The Works' and may experience performance limitations, potentially resulting in 500 errors due to timeouts. It is recommended to include a location_id to minimize the number of locations in the report and to shorten the report period to a single week if errors persist. The API accepts headers for API version and company GUID, and query parameters including punches, company_id, from and to dates, and optional location_id, department_id, role_id, and user_id. The response includes detailed employee data, shifts, roles, and total hours and pay information, with options to show exception costs and tips.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Inactive Reasons for a Company

  • ID: get_inactive_reasons_for_a_company
  • Operation: read
  • Entities: company, inactive reason
  • Summary: This API endpoint retrieves a list of inactive reasons for a specified company. The request requires the company_id as a path parameter. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The response returns an object with the type 'inactive_reason_enum' and a data array containing various reasons for inactivity such as 'rude_to_customers', 'no_show_late', 'quit', etc. The API requires a minimum plan of 'Comp'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Location Details

  • ID: get_location_details
  • Operation: read
  • Entities: company, department, location
  • Summary: This API endpoint retrieves the details of a specific location for a given company. It requires the company ID and location ID as path parameters. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response includes detailed information about the location such as its name, address, operating hours, and other attributes. The response is structured with an 'object' field indicating the type of object returned ('location') and a 'data' field containing the location details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Log Book Categories for a Company

  • ID: get_log_book_categories_for_a_company
  • Operation: read
  • Entities: company, log book category
  • Summary: This API endpoint retrieves the log book categories for a specified company. It requires the company ID as a path parameter. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response includes a list of log book categories with details such as ID, name, and creation date. Possible error responses include 401 Unauthorized, 403 Forbidden, and 500 Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Log Book Comment Details

  • ID: get_log_book_comment_details
  • Operation: read
  • Entities: company, log book comment, user
  • Summary: This API endpoint retrieves the details of a specific log book comment for a given company. It requires the company ID and the log book comment ID as path parameters. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response includes the log book comment details such as ID, UUID, log book ID, user ID, message, and creation timestamp. The API returns various HTTP status codes including 200 for success, 401 for unauthorized access, 403 for forbidden access, 404 if the comment is not found, and 500 for server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Log Book Comments

  • ID: get_log_book_comments
  • Operation: read
  • Entities: company, log book comment, user
  • Summary: The Get Log Book Comments API allows users to retrieve comments associated with log book posts for a specific company. The API requires a valid company ID as a path parameter and log book IDs as a query parameter. Optional headers include the API version and company GUID. The response includes a list of comments with details such as comment ID, UUID, log book ID, user ID, message, and creation timestamp. The API returns various HTTP status codes, including 200 for success, 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, and 500 for server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Log Book Post Details

  • ID: get_log_book_post_details
  • Operation: read
  • Entities: company, log book post, attachment
  • Summary: This API endpoint retrieves the details of a specific log book post for a given company. It requires the company ID and the log book post ID as path parameters. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response includes detailed information about the log book post, such as its ID, UUID, location ID, user ID, category ID, date, message, attachments, comment count, and creation timestamp. The API returns various HTTP status codes, including 200 for success, 401 for unauthorized access, 403 for forbidden access, 404 for not found, and 500 for server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Log Book Posts for a Company

  • ID: get_log_book_posts_for_a_company
  • Operation: read
  • Entities: company, location, log book post
  • Summary: This API endpoint retrieves log book posts for a specified company. It requires the company ID as a path parameter and supports various optional query parameters such as location ID, log book category ID, user ID, date, and message to filter the results. The response includes an array of log book posts with details such as ID, UUID, location ID, user ID, log book category ID, date, message, attachments, log book comment count, and creation date. The response also includes metadata for pagination with cursor information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Manual Tip Entry Data

  • ID: get_manual_tip_entry_data
  • Operation: read
  • Entities: company, tip pool, manual entry
  • Summary: This API endpoint retrieves manual tip entry data for a specified company and tip pool settings within a given date range. The request requires the company ID and tip pool settings UUID as path parameters, and the start and end dates as query parameters. Optional headers include the API version and company GUID. The response includes an object type of 'manual_tip_pooling' and an array of data objects, each containing details such as UUIDs, entry date, tip amount, and timestamps for creation and modification.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Receipt Details

  • ID: get_receipt_details
  • Operation: read
  • Entities: company, location, receipt
  • Summary: This API endpoint retrieves the details of a specific receipt for a given company. It requires the company ID and receipt ID as path parameters. Optional headers include the API version and company GUID. The response includes detailed information about the receipt, such as the company and location IDs, POS ID, receipt date, net and gross totals, tips, discounts, and status. The response also includes arrays for receipt lines and tip details, which provide further breakdowns of the receipt's contents.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Receipts Summary for a Company

  • ID: get_receipts_summary_for_a_company
  • Operation: read
  • Entities: company, location, receipt
  • Summary: This API endpoint retrieves a summary of receipts for a specified company. The request requires the company ID as a path parameter and the location ID as a query parameter. Optional query parameters include receipt_date[gte], receipt_date[lte], and modified_since, all of which must be in ISO8601 date-time format. The response includes an array of receipt data, each containing the date and closed receipt details such as receipts count, net total, gross total, tips total, and receipt discounts. The API requires a minimum plan of 'Comp' and has restrictions on the date range for receipt_date and modified_since parameters.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Role Details for a Company

  • ID: get_role_details_for_a_company
  • Operation: read
  • Entities: company, role, station
  • Summary: This API endpoint retrieves the details of a specific role within a company using the company ID and role ID as path parameters. The request requires optional headers for API version and company GUID. The response includes detailed information about the role, such as its ID, company ID, location ID, department ID, color, number of stations, name, job code, sort order, stations, and timestamps for creation and modification.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Sales Category Mappings for a Location

  • ID: get_sales_category_mappings_for_a_location
  • Operation: read
  • Entities: company, sales category mapping, location
  • Summary: This API endpoint retrieves sales category mappings for a specific location within a company. It requires the company ID and location ID as path parameters, and the department ID as a query parameter. Optional query parameters include a cursor for pagination and a limit for the number of results per page. The response includes the sales category mappings data, which contains location ID, department ID, and external category ID, along with pagination metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Scheduled Shift Details

  • ID: get_scheduled_shift_details
  • Operation: read
  • Entities: company, department, shift
  • Summary: This API endpoint retrieves the details of a scheduled shift for a specified company and user. It requires the 'company_id' and 'id' as path parameters, where 'id' can be a user_id or a punch_id. The 'location_id' is a required query parameter, while 'grace_period' is optional. The API can accept optional headers for 'x-api-version' and 'x-company-guid'. The response includes details such as shift start and end times, location, user, department, role, and attendance status, among others.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Shift Details

  • ID: get_shift_details
  • Operation: read
  • Entities: company, department, shift
  • Summary: The Get Shift Details API retrieves detailed information about a specific shift for a given company. It requires the company_id and shift_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. An optional query parameter include_deleted can be used to include deleted shifts in the response. The response includes detailed shift information such as start and end times, user and location IDs, wage, notes, and more. The response also includes information about breaks associated with the shift.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Shift Feedback for a Company

  • ID: get_shift_feedback_for_a_company
  • Operation: read
  • Entities: company, department, shift feedback
  • Summary: This API endpoint retrieves shift feedback for a specified company within a given date range. It requires the company ID as a path parameter and the start and end dates as query parameters. Optional query parameters include location ID, user ID, cursor for pagination, and limit for the number of results per page. The response includes an array of shift feedback data, each containing details such as shift ID, user ID, rating, comments, and more. The response also includes pagination metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Shifts for a Company

  • ID: get_shifts_for_a_company
  • Operation: read
  • Entities: company, department, shift
  • Summary: The Get Shifts for a Company API endpoint retrieves a list of shifts for a specified company. It requires the company_id as a path parameter. Optional query parameters include cursor for pagination, limit for the number of results per page, and various filters such as location_id, shift_ids, department_ids, role_id, user_id, and date range filters (start[lte], start[gte], end[lte], end[gte]). The API also supports filtering by shift status (deleted, draft, include_draft, open) and sorting options (sort_by, sort_dir). The response includes a list of shifts with details such as shift ID, user ID, start and end times, location, role, and other attributes. The response also includes pagination metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Task List Daily Summary

  • ID: get_task_list_daily_summary
  • Operation: read
  • Entities: company, location, task list
  • Summary: The Get Task List Daily Summary API retrieves a summary of task lists for a specific company and location on a given date. The API requires the company_id as a path parameter and location_id and date as query parameters. The response includes the total percentage of tasks completed, in progress, and incomplete, along with the report time, date, and a list of task lists with their details. The API returns a 200 status code with the task list summary on success, and various error codes (400, 401, 403, 404) with detailed error messages on failure.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Task List Details

  • ID: get_task_list_details
  • Operation: read
  • Entities: company, task, task list
  • Summary: The Get Task List Details API retrieves detailed information about a specific task list for a given company. The API requires the company_id and list_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. An optional query parameter user_id can be provided. The response includes detailed information about the task list, including its ID, title, description, start and due dates, tasks, recurrence, assignments, and time frame. The response is returned in JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Task List Template Details

  • ID: get_task_list_template_details
  • Operation: read
  • Entities: task list template, assignment, task template
  • Summary: This API endpoint retrieves the details of a specific task list template for a given company. It requires the company ID and the UUID of the task list template as path parameters. The API version can be specified in the header, but it is optional. The response includes detailed information about the task list template, such as its ID, title, description, status, due date, creation date, activation date, task templates, assignments, recurrence rules, and time frame. The response is returned in JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Task List Templates for a Company

  • ID: get_task_list_templates_for_a_company
  • Operation: read
  • Entities: task list template, assignment, task template
  • Summary: This API endpoint retrieves task list templates for a specified company. The request requires the company_id as a path parameter. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. Query parameters such as location_id, department_id, role_id, cursor, and limit can be used to filter and paginate the results. The response includes a list of task list templates with details such as id, company_id, uuid, title, description, status, due date, creation and activation timestamps, task templates, assignments, recurrence rules, and time frames. The response also includes metadata for pagination.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Task Lists for a Company

  • ID: get_task_lists_for_a_company
  • Operation: read
  • Entities: company, task, task list
  • Summary: This API endpoint retrieves task lists for a specified company. The request requires the company_id as a path parameter. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. Optional query parameters include user_id, location_id, uuid for the task list template, and active_on_date to filter task lists active on a specific date. The response includes a list of task lists with details such as id, title, description, start and due dates, tasks, recurrence, assignments, and time frames. The response is returned in JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Task Management Settings for a Company

  • ID: get_task_management_settings_for_a_company
  • Operation: read
  • Entities: company, employee, task management setting
  • Summary: This API endpoint retrieves the task management settings for a specified company. It requires the 'company_id' as a path parameter and optionally accepts the 'x-api-version' header to specify the API version. The response includes the task management settings such as whether task management is enabled, if auto-assign IDs are prompted, and other related settings. The API returns a 200 status code with the settings data if successful, or error codes 403, 404, or 500 for forbidden access, not found, or server errors, respectively.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Test Webhook for a Company

  • ID: get_test_webhook_for_a_company
  • Operation: read
  • Entities: company, topic, webhook
  • Summary: This API endpoint is used to test a webhook for a specific company. It requires a minimum plan of Gourmet. The request is made using the GET method to the URL https://api.7shifts.com/v2/company/{company_id}/test_webhook. The request requires the 'company_id' as a path parameter and 'topic' as a query parameter. Optionally, 'webhook_id' can be provided as a query parameter. Headers can include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response can be a 200 OK with an empty JSON object or various error responses (401 Unauthorized, 403 Forbidden, 404 Not Found, 500 Server Error) with detailed error information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Time Off Details

  • ID: get_time_off_details
  • Operation: read
  • Entities: company, time off, user
  • Summary: The Get Time Off Details API endpoint allows users to retrieve time off details for a specified company. The API requires the 'company_id' as a mandatory query parameter. Optional query parameters include 'location_id', 'user_id', 'status', 'category', 'to_date_gte', 'sort_by', 'sort_dir', 'cursor', and 'limit'. The API also accepts optional headers 'x-api-version' and 'x-company-guid', and requires an 'Authorization' header with a Bearer token. The response includes an array of time off details with fields such as 'id', 'user_id', 'company_id', 'from_date', 'to_date', 'partial', 'comments', 'status', 'category', 'created', 'amount_of_hours', and 'hours'. The response also contains metadata for pagination.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Time Off Settings for a Company

  • ID: get_time_off_settings_for_a_company
  • Operation: read
  • Entities: company, time off setting, time off category
  • Summary:
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Time Punch Details

  • ID: get_time_punch_details
  • Operation: read
  • Entities: company, shift, time punch
  • Summary: The Get Time Punch Details API retrieves detailed information about a specific time punch for a given company. It requires the company_id and time_punch_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The response includes detailed information about the time punch, such as the shift ID, user ID, role ID, location ID, department ID, hourly wage, approval status, clock-in and clock-out times, notes, and more. The response also includes information about any breaks taken during the shift.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Tip Pool Detailed Report

  • ID: get_tip_pool_detailed_report
  • Operation: read
  • Entities: employee, location, tip pool
  • Summary: The Get Tip Pool Detailed Report API endpoint retrieves a detailed report of tip pools for a specified company and location. The request requires the company_id and location_id as path parameters, and the start_date and end_date as query parameters. Optional query parameters include tip_pool_uuid and day_part_uuid to filter the report. The response includes detailed information about the tip pools, including unassigned and assigned tips, with various financial metrics and employee details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Tip Pool Settings for a Company

  • ID: get_tip_pool_settings_for_a_company
  • Operation: read
  • Entities: company, tip pool setting, stakeholder
  • Summary: This API endpoint retrieves the tip pool settings for a specified company. It requires the company ID as a path parameter. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response includes detailed information about the tip pool settings, such as contribution and distribution types, sales tip percentage, stakeholders, contributions, and cadence settings. The response also includes metadata like creation and modification timestamps. If the request is unauthorized or the company ID is not found, appropriate error messages are returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Tip Pool Summary Report

  • ID: get_tip_pool_summary_report
  • Operation: read
  • Entities: company, tip pool, location
  • Summary: The Get Tip Pool Summary Report API endpoint retrieves a summary report of tip pools for a specified company and location. It requires the company_id and location_id as path parameters, and the start_date and end_date as query parameters. Optional query parameters include tip_pool_uuid and day_part_uuid. The API returns a detailed report including unassigned and assigned tips, hours worked, and total tips in and out. The response includes a list of tip pools with detailed information about each pool, including employee details and tip amounts.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Total Time Off Hours

  • ID: get_total_time_off_hours
  • Operation: read
  • Entities: employee, time off, hour
  • Summary: The Get Total Time Off Hours API endpoint retrieves the total hours of time off for specified employees within a given date range. It requires the company ID, employee IDs, and the start and end dates as query parameters. The API returns a list of objects containing user ID, category, and hours of time off. Optional headers include the API version and company GUID. The response is in JSON format, and the endpoint supports error handling for unexpected issues.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get User Assignments in a Company

  • ID: get_user_assignments_in_a_company
  • Operation: read
  • Entities: role, department, location
  • Summary: This API endpoint retrieves the assignments of a user within a specified company. It requires the company ID and user ID as path parameters. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response includes details about the user's locations, departments, and roles within the company. The response body contains an 'object' field with the value 'assignments' and a 'data' field with arrays of 'locations', 'departments', and 'roles', each containing relevant details such as IDs and names.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get User Department Assignments

  • ID: get_user_department_assignments
  • Operation: read
  • Entities: company, department, user
  • Summary: This API endpoint retrieves the department assignments for a specific user within a company. It requires the company ID and user ID as path parameters. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response includes a list of department assignments, each containing the department ID, location ID, department name, and a boolean indicating if the employee appears on the schedule for that department.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get User Details from 7shifts

  • ID: get_user_details_from_7shifts
  • Operation: read
  • Entities: company, manager, user
  • Summary: This API endpoint retrieves user details from 7shifts for a specified company and user identifier. The request requires the company ID and user identifier as path parameters. The user identifier can be either a 7shifts user ID or a punch ID prefixed with 'punch:'. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response returns a JSON object containing user details such as name, email, phone numbers, address, employment status, and more. The response also includes metadata about the user's account and settings within 7shifts.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get User Identity and Details

  • ID: get_user_identity_and_details
  • Operation: read
  • Entities: company, identity, user
  • Summary: The 'Get User Identity and Details' API endpoint allows you to retrieve the identity and user details of the authenticated user. It requires a GET request to the URL 'https://api.7shifts.com/v2/whoami'. The request can include optional headers such as 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response includes the identity ID and an array of user details, such as user ID, company ID, first and last names, email, mobile number, invite status, and more. The response also indicates whether the user is active, their role type, and other personal and employment details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get User Location Assignments

  • ID: get_user_location_assignments
  • Operation: read
  • Entities: company, location assignment, user
  • Summary: This API endpoint retrieves the location assignments for a specific user within a company. It requires the company ID and user ID as path parameters. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response includes an object type 'location_assignments' and a data array containing location IDs and names. The minimum plan required to access this endpoint is 'Entrée'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get User Role Assignments

  • ID: get_user_role_assignments
  • Operation: read
  • Entities: company, role assignment, user
  • Summary: This API endpoint retrieves the role assignments for a specific user within a company. It requires the company ID and user ID as path parameters. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response includes an array of role assignments, each containing details such as role ID, location ID, department ID, role name, whether it is the primary role, skill level, and sort order. The minimum plan required to access this endpoint is 'Entrée'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get User Wages

  • ID: get_user_wages
  • Operation: read
  • Entities: company, wage, user
  • Summary: The Get User Wages API endpoint retrieves the current and upcoming wage details for a specific user within a company. The request requires the company_id and user_id as path parameters. Required headers include Authorization with a Bearer token. Optional headers include x-api-version for specifying the API version, x-company-guid for the company GUID, Accept for the response format, and Content-Type for the request format. The response includes the current and upcoming wages, each with details such as wage ID, effective date, role ID, wage type, wage value in cents, and timestamps for creation and modification. The response is structured with an object type of 'user_wages'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Users of a Company

  • ID: get_users_of_a_company
  • Operation: read
  • Entities: company, employee, user
  • Summary: This API endpoint retrieves a list of users for a specified company. The request requires the company_id as a path parameter. Optional headers include x-api-version and x-company-guid. The API supports various query parameters such as modified_since, location_id, department_id, role_id, status, name, sort_by, cursor, and limit to filter and paginate the results. The response includes user details such as id, first_name, last_name, email, and more, along with metadata for pagination.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Company Details

  • ID: patch_update_company_details
  • Operation: write
  • Entities: company, meta, plan
  • Summary: The Update Company Details API allows you to update the details of a company in the 7shifts system. It requires a PATCH request to the endpoint https://api.7shifts.com/v2/companies/{id}, where {id} is the path parameter representing the Company ID. The request headers can optionally include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The request body must include the company details to be updated, such as 'name', 'country', 'photo', and 'pos'. The response will return the updated company details, including fields like 'id', 'name', 'country', 'plan_id', 'created', 'modified', 'status', and 'meta' information. If the request is unauthorized, a 403 error response will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Event Details

  • ID: patch_update_event_details
  • Operation: write
  • Entities: company, location, event
  • Summary: This API endpoint allows updating the details of an event for a specific company in the 7shifts platform. The PATCH method is used to modify the event identified by the event_id within the company identified by the company_id. The request requires headers for API version and company GUID, path parameters for company and event IDs, and a request body containing event details such as location IDs, start and end dates and times, title, description, color, and recurrence rules. The response returns the updated event details, including location-specific start and end times, and other event attributes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Log Book Category

  • ID: patch_update_log_book_category
  • Operation: write
  • Entities: company, log book category
  • Summary: The Update Log Book Category API allows users to update the details of a specific log book category within a company. The API requires the company ID and category ID as path parameters. Optional headers include the API version and company GUID. The request body must contain at least one property to update, such as the category name, column, sort order, field type, notification setting, or required status. The response includes the updated category details if successful, or an error message if the request fails. The API is in beta and requires a minimum plan of 'The Works'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Time Off Request

  • ID: patch_update_time_off_request
  • Operation: write
  • Entities: company, time off, user
  • Summary: The Update Time Off Request API allows users to modify an existing time off request by providing the time_off_id in the path. The request requires headers such as 'accept' and 'content-type' set to 'application/json', and an 'Authorization' header with a Bearer token. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The request body must include details such as user_id, from_date, to_date, partial, comments, status, category, and hours. The response returns the updated time off details including id, user_id, company_id, from_date, to_date, partial, comments, status, category, created date, and amount of hours. In case of an error, a detailed error message is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Acquire OAuth Token

  • ID: post_acquire_oauth_token
  • Operation: write
  • Entities: token, scope, authorization
  • Summary: This API endpoint is used to acquire an OAuth token from the 7shifts API. It requires a POST request to the URL 'https://api.7shifts.com/oauth2/token' with headers specifying 'Content-Type' as 'application/x-www-form-urlencoded' and 'accept' as 'application/json'. The request body must include 'grant_type', 'client_id', 'client_secret', and 'scope'. The 'grant_type' should be 'client_credentials' for Partner OAuth tokens. The response includes a 'token_type' which is 'Bearer', 'expires_in' indicating the number of seconds until the token expires, and an 'access_token' which is the authorization token. Optionally, a 'refresh_token' may also be provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Approve Time Off Request

  • ID: post_approve_time_off_request
  • Operation: write
  • Entities: company, time off, user
  • Summary: The Approve Time Off Request API allows users to approve a time off request by providing the time_off_id in the path parameters. The request can include optional headers such as x-api-version and x-company-guid. The request body can optionally include a status_action_message. The response returns details of the approved time off request, including the id, user_id, company_id, from_date, to_date, and other related information. In case of an error, a detailed error message is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Assign Role to User in Company

  • ID: post_assign_role_to_user_in_company
  • Operation: write
  • Entities: company, role assignment, user
  • Summary: This API endpoint allows you to assign a role to a user within a specified company. The request requires the company ID and user ID as path parameters. The request body must include the role ID and optionally a boolean indicating if the role is primary. The API supports optional headers for API version and company GUID. On success, it returns the role assignment details including role ID, location ID, department ID, role name, primary status, skill level, and sort order. Possible error responses include 400 Bad Request, 403 Forbidden, 404 Not Found, and 500 Server Error, each providing detailed error information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Bulk External User Mappings for a Company

  • ID: post_bulk_external_user_mappings_for_a_company
  • Operation: write
  • Entities: company, external user mapping, user
  • Summary: This API endpoint allows for bulk mapping of external user IDs to 7shifts user IDs for a specified company. The request requires a company ID as a path parameter and accepts optional headers for API version and company GUID. The request body must include an array of user mapping data, with each entry containing an external user ID and optionally a 7shifts user ID, first name, last name, email, and phone number. The response includes a list of successfully mapped users and any exceptions encountered during processing. The API supports various error responses, including 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 422 Unprocessable Entity, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Bulk Sales Category Mappings for a Location

  • ID: post_bulk_sales_category_mappings_for_a_location
  • Operation: write
  • Entities: company, sales category mapping, location
  • Summary: This API endpoint allows for the bulk creation of sales category mappings for a specific location within a company. The request requires the company ID and location ID as path parameters, and the department ID as a query parameter. The request body must contain an array of objects, each with an 'external_category_id'. The response will return the created sales category mappings, including the location ID, department ID, and external category ID. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, and 500 Internal Server Error, each providing details about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Clear a Task in a Task List for a Company

  • ID: post_clear_task_in_task_list
  • Operation: write
  • Entities: company, task, task list
  • Summary: This API endpoint is used to clear a specific task within a task list for a given company. The request requires the company ID, task list ID, and task ID as path parameters. The request body must include the user ID of the person clearing the task. Optional headers include the API version and company GUID. The response will return the cleared task details if successful, or an error message if the request fails.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Complete a Task in a Task List for a Company

  • ID: post_complete_task_in_task_list
  • Operation: write
  • Entities: company, task, user
  • Summary: This API endpoint is used to mark a specific task as complete within a task list for a given company. The request requires the company ID, task list ID, and task ID as path parameters. The request body must include the user ID of the person completing the task and can optionally include a completion value. The API supports optional headers for specifying the API version and company GUID. On success, it returns details of the completed task, including its ID, title, description, and completion details. Error responses provide detailed information about the issue encountered.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Availability Reasons for a Company

  • ID: post_create_availability_reasons
  • Operation: write
  • Entities: availability reason, company
  • Summary: This API endpoint allows the creation of availability reasons for a specific company identified by the company_id path parameter. The request requires a JSON body containing the 'reason' for availability and an optional 'comments_required' boolean. Headers may include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The response returns a 201 status code with the created availability reason details, including 'id', 'company_id', 'reason', 'comments_required', 'sort', 'created', and 'modified' timestamps. Error responses include 401 Unauthorized, 403 Forbidden, 422 Unprocessable Entity, and 500 Server Error, each with detailed error information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Company Availability

  • ID: post_create_company_availability
  • Operation: write
  • Entities: company, availability, user
  • Summary: This API endpoint allows the creation of availability schedules for a company. The endpoint requires a POST request to the URL https://api.7shifts.com/v2/company/{company_id}/availabilities with the company_id as a path parameter. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body must contain details about the user's availability for each day of the week, including start and end times, comments, and reasons for availability. The response will include the created availability object with its ID and status. Possible error responses include 400 Bad Request, 403 Forbidden, 404 Not Found, 409 Conflict, and 422 Unprocessable Entity, each providing details about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Company Receipt

  • ID: post_create_company_receipt
  • Operation: write
  • Entities: company, tip, receipt
  • Summary: The Create Company Receipt API allows you to create a new receipt for a specified company. The API requires a POST request to the endpoint with the company ID as a path parameter. The request headers can include optional parameters such as the API version and company GUID. The request body must include details about the receipt, such as location ID, receipt date, net total, receipt lines, tip details, and status. The response will return a UUID for the created receipt if successful, or an error message with details if the request fails.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Department Assignment for User

  • ID: post_create_department_assignment_for_user
  • Operation: write
  • Entities: company, department, user
  • Summary: This API endpoint allows you to create a department assignment for a user within a company. It requires the company ID and user ID as path parameters. The request body must include the department ID and optionally whether the user should appear on the schedule for this department. The API supports optional headers for specifying the API version and company GUID. On success, it returns the created department assignment details. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Event for a Company

  • ID: post_create_event_for_company
  • Operation: write
  • Entities: company, event
  • Summary: This API endpoint allows the creation of events for a specific company identified by the company_id path parameter. The request requires a JSON body with details about the event, including location_ids, start_date, start_time, end_date, end_time, title, and is_multi_day. Optional fields include description, color, and recurrence. The response returns the event details including its ID and type. The API supports various error responses for bad requests, unauthorized access, forbidden actions, not found errors, unprocessable entities, and unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Forecast Override for a Location

  • ID: post_create_forecast_override
  • Operation: write
  • Entities: company, department, location
  • Summary: This API endpoint allows the creation of a forecast override for a specific location within a company. The request requires the company ID and location ID as path parameters. The request body must include the date, value, and report type, with an optional department ID. The response returns the created forecast override details, including location ID, department ID, date, value, and report type. Error responses include details about the problem encountered.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Forecast Override for a Location

  • ID: post_create_forecast_override_for_a_location
  • Operation: write
  • Entities: company, forecast override, location
  • Summary: This API endpoint allows you to create a forecast override for a specific location within a company. The request requires the company_id and location_id as path parameters. The request body must include the date, value, and report_type fields, with the report_type defaulting to 'sales'. Optional fields include department_id. The API supports versioning through the x-api-version header and requires the content-type and accept headers to be set to application/json. Upon successful creation, the API returns a 201 status code with the details of the override. Possible error responses include 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 422 (Unprocessable Entity), and 500 (Server Error), each providing a detailed explanation of the issue.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Location Assignment for User

  • ID: post_create_location_assignment_for_user
  • Operation: write
  • Entities: company, location assignment, user
  • Summary: This API endpoint allows the creation of a location assignment for a specific user within a company. It requires the company ID and user ID as path parameters. The request body must include the location ID for the assignment. Optional headers include the API version and company GUID. The response will return a 201 status code with the location assignment details if successful. Possible error responses include 400 (Bad Request), 403 (Forbidden), 404 (Not Found), and 500 (Server Error), each providing details about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Log Book Category for a Company

  • ID: post_create_log_book_category
  • Operation: write
  • Entities: company, log book category
  • Summary: This API endpoint allows the creation of a new log book category for a specified company. The request requires the company ID as a path parameter and accepts headers for API version and company GUID. The request body must include the name of the category and can optionally include column number, sort order, field type, notification flag, and required flag. The response returns the details of the created log book category, including its ID, company ID, name, column, sort order, field type, notification flag, required flag, creation timestamp, and UUID. The API requires a minimum plan of 'The Works'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Log Book Comment

  • ID: post_create_log_book_comment
  • Operation: write
  • Entities: company, log book, log book comment
  • Summary: This API endpoint allows users to create a comment on a log book for a specific company in the 7shifts platform. The request requires the company ID as a path parameter and a JSON body containing the log book ID and the message to be posted as a comment. Optional headers include the API version and company GUID. The response returns a JSON object with details of the created comment, including its ID, UUID, log book ID, user ID, message, and creation timestamp. Error responses include unauthorized access, forbidden access, unprocessable entity, and server errors, each with detailed problem descriptions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Log Book Post

  • ID: post_create_log_book_post
  • Operation: write
  • Entities: company, location, log book post
  • Summary: This API endpoint allows the creation of a log book post for a specified company. It requires a POST request to the URL https://api.7shifts.com/v2/company/{company_id}/log_book_posts with the company_id as a path parameter. The request headers can optionally include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The request body must include 'location_id', 'log_book_category_id', 'date', and 'message', with optional 'attachments'. The response will return a 201 status code with details of the created log book post, including its ID, UUID, location ID, user ID, category ID, date, message, attachments, comment count, and creation timestamp. Error responses include 401 Unauthorized, 403 Forbidden, 422 Unprocessable Entity, and 500 Server Error, each providing details about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Multiple Users in a Company

  • ID: post_create_multiple_users_in_company
  • Operation: write
  • Entities: company, department, user
  • Summary: This API endpoint allows the creation of multiple users within a specified company in the 7shifts system. The request is made via a POST method to the URL https://api.7shifts.com/v2/company/{company_id}/create_many_users, where {company_id} is a required path parameter representing the ID of the company. The request headers can optionally include 'x-api-version' to specify the API version and 'x-company-guid' for the company GUID. The request body must be a JSON array of user objects, each containing required fields such as 'first_name', 'last_name', 'location_ids', 'department_ids', and 'type'. Optional fields include 'email', 'mobile_number', 'address', and more. The response returns a JSON object with the created users' details, including 'id', 'first_name', 'last_name', 'email', and other user attributes. The API also handles various error responses, including 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Department for a Company

  • ID: post_create_new_department
  • Operation: write
  • Entities: company, department, location
  • Summary: This API endpoint allows the creation of a new department for a specified company. The request requires the company ID as a path parameter and a JSON body containing the location ID, department name, and a boolean indicating if the department is the default for the location. Optional headers include the API version and company GUID. The response will return a 201 status with the department details if successful, or an error message with status codes 403, 422, or 500 for forbidden access, unprocessable entity, or server error, respectively.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Location for a Company

  • ID: post_create_new_location
  • Operation: write
  • Entities: company, department, location
  • Summary: This API endpoint allows the creation of a new location for a specified company. The request requires the company ID as a path parameter and accepts various details about the location in the request body, such as the name, country, address, timezone, and operating hours. The response returns the details of the newly created location, including its ID, name, and other attributes. The API supports optional headers for specifying the API version and company GUID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Role for a Company

  • ID: post_create_new_role_for_company
  • Operation: write
  • Entities: company, role, station
  • Summary: This API endpoint allows the creation of a new role for a specified company. The request is made to the URL https://api.7shifts.com/v2/company/{company_id}/roles using the POST method. The request headers can include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID, both of which are optional. The 'accept' and 'content-type' headers are required and should be set to 'application/json'. The path parameter 'company_id' is required to specify the company for which the role is being created. The request body must include 'name', 'color', 'location_id', and 'department_id' as required fields, with optional fields 'sort', 'job_code', and 'stations'. The response will return a 201 status code with details of the created role, including its ID, company ID, location ID, department ID, color, number of stations, name, job code, sort order, stations, and timestamps for creation and modification. Error responses may include status codes 400, 403, 422, and 500, each providing details about the error encountered.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New User in a Company

  • ID: post_create_new_user_in_company
  • Operation: write
  • Entities: company, department, user
  • Summary: This API endpoint allows the creation of a new user within a specified company on the 7shifts platform. The request requires the company ID as a path parameter and includes various user details in the request body, such as first name, last name, location IDs, department IDs, and user type. Optional fields include email, phone numbers, address, and more. The response returns the created user's details, including their ID, name, contact information, and status. The API supports different user types like employee, assistant manager, and manager, and allows setting roles, wages, and permissions for the user.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Shift for a Company

  • ID: post_create_shift_for_company
  • Operation: write
  • Entities: company, department, shift
  • Summary: This API endpoint allows the creation of a shift for a specified company using the 7shifts platform. The endpoint requires a POST request to the URL https://api.7shifts.com/v2/company/{company_id}/shifts, where {company_id} is a path parameter representing the unique identifier of the company. The request headers may include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The request body must include 'location_id', 'start', and 'end' as required fields, along with optional fields such as 'user_id', 'department_id', 'role_id', and others to define the shift details. The response returns a JSON object containing the shift details, including 'id', 'user_id', 'start', 'end', and other attributes. The API also handles error responses for bad requests, forbidden access, and unprocessable entities.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Task List Template

  • ID: post_create_task_list_template
  • Operation: write
  • Entities: company, task, template
  • Summary: This API endpoint allows the creation of a new task list template for a specified company. The request requires the company ID as a path parameter. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The request body must include the title, recurrence rules, and assignments for the task list. Additional optional fields include description, due date, time frame, task templates, and status. The response returns a JSON object containing the details of the created task list template, including its ID, company ID, UUID, title, description, status, due date, creation time, activation time, task templates, assignments, and recurrence rules. Error responses include various HTTP status codes with detailed error messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Task Tags for a Company

  • ID: post_create_task_tags_for_company
  • Operation: write
  • Entities: company, task, tag
  • Summary: This API endpoint allows the creation of task tags for a specific company identified by the company_id. The request requires headers specifying the content type and optionally the API version. The path parameter company_id is mandatory. The request body must include the company_id and an array of tags, each containing a user_id and a task_id. The response will return a 204 status code for success with no content, or an error object with details in case of failure, including status codes 401, 403, 404, 422, and 500.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Time Off Request

  • ID: post_create_time_off_request
  • Operation: write
  • Entities: company, time off, user
  • Summary: The Create Time Off Request API allows users to submit a request for time off. The request requires headers including 'accept', 'content-type', 'x-api-version', 'x-company-guid', and 'Authorization' with a Bearer token. The body of the request must include 'user_id', 'company_id', 'from_date', 'to_date', 'partial', 'status', and 'category'. Optional fields include 'partial_from', 'partial_to', 'comments', 'hours', 'status_action_user_id', and 'status_action_message'. The response returns the details of the time off request including 'id', 'user_id', 'company_id', 'from_date', 'to_date', 'partial', 'partial_from', 'partial_to', 'comments', 'status', 'status_action_user_id', 'status_action_message', 'category', 'created', 'amount_of_hours', and 'hours'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Time Punch for a Company

  • ID: post_create_time_punch_for_a_company
  • Operation: write
  • Entities: shift, time punch, break
  • Summary: This API endpoint allows the creation of a time punch for a specified company. It requires the company ID as a path parameter and accepts various headers such as 'x-api-version', 'x-company-guid', 'Authorization', 'Accept', and 'Content-Type'. The request body must include 'location_id', 'user_id', and 'clocked_in' as required fields, with optional fields like 'department_id', 'role_id', 'clocked_out', 'notes', 'tips', and 'breaks'. The response returns a detailed object containing the time punch information, including IDs, timestamps, and other relevant data. The API supports various response codes, including 201 for successful creation and error codes like 400, 401, 403, 404, 422, and 500 for different failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Trial Company

  • ID: post_create_trial_company
  • Operation: write
  • Entities: company, administrator, location
  • Summary: The Create Trial Company API endpoint allows partners with OAuth clients to create a trial company with The Works plan, a single location, and one administrator. The administrator will receive an invitation email from 7shifts to complete the company setup. The request requires a JSON body with fields such as email, firstname, lastname, company_name, country, and utm_source. Optional fields include mobile_phone, utm_campaign, utm_content, utm_medium, and utm_term. The response includes a 201 status code with company, location, and user IDs if successful, or various error codes and messages if the request fails.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create User Wage

  • ID: post_create_user_wage
  • Operation: write
  • Entities: company, wage, user
  • Summary: The Create User Wage API allows you to create a wage entry for a specific user within a company. It requires the company ID and user ID as path parameters. The request body must include the effective date, wage type, and wage value in cents. Optionally, a role ID can be provided. The API supports versioning and requires specific headers for content type and acceptance. Upon successful creation, it returns the wage details including the ID, effective date, role ID, wage type, wage value, and timestamps for creation and modification. Error responses include forbidden access, conflict, unprocessable entity, and server errors, each with detailed information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Webhook for a Company

  • ID: post_create_webhook_for_company
  • Operation: write
  • Entities: company, webhook, event
  • Summary: This API endpoint allows the creation of a webhook for a specified company. The request requires the company ID as a path parameter and accepts headers for API version and company GUID. The request body must include the webhook URL, method (which must be 'post'), and the event type. The API responds with a 201 status code upon successful creation, returning the webhook details including ID, company ID, URL, method, event, and timestamps for creation and modification. Error responses include status codes 400, 401, 403, 409, 422, and 500, each providing a detailed explanation of the issue.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Decline Time Off Request

  • ID: post_decline_time_off_request
  • Operation: write
  • Entities: company, time off, user
  • Summary: The Decline Time Off Request API allows users to decline a time off request by specifying the time_off_id in the path parameters. The request can include optional headers such as x-api-version and x-company-guid. The request body can optionally include a status_action_message to provide a reason for declining the request. The response includes details of the time off request, such as id, user_id, company_id, from_date, to_date, partial status, comments, status, category, created date, amount of hours, and detailed hours information. In case of an error, a problem+json object is returned with details about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create External User Mappings for a Company

  • ID: post_external_user_mappings_for_company
  • Operation: write
  • Entities: company, external user mapping, user
  • Summary: This API endpoint allows the creation of external user mappings for a specified company in 7shifts. It requires the company ID as a path parameter and accepts optional headers for API version and company GUID. The request body must include the user ID in 7shifts and the external user ID. The response returns a 201 status code with details of the created mapping, including mapping ID, user IDs, company ID, location ID, application name, creation and modification timestamps, and user active status. Error responses include status codes 401, 403, 409, 422, and 500 with detailed error information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Override Project Sales Interval

  • ID: post_override_project_sales_interval
  • Operation: write
  • Entities: company, forecast override interval, location
  • Summary: This API endpoint allows users to override the projected sales interval for a specific company and location. The interval can be set for either 15 minutes or 1 hour. The request requires the company_id and location_id as path parameters. The request body must include the start and end times of the interval, the override value in cents, and optionally the department_id and report_type. The API supports versioning and requires specific headers for content type and acceptance. The response will return a 204 status for success, or detailed error information for various failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Override Project Sales Intervals

  • ID: post_override_project_sales_intervals
  • Operation: write
  • Entities: company, sales interval, location
  • Summary: This API endpoint allows users to override many project sales intervals of 15 minutes or 1 hour for a specific company and location. The request requires the company_id and location_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The request body must be an array of objects, each containing the start and end times of the interval, the override value in cents, and optionally the department_id and report_type. The response will return a 204 status for success, or error details in case of failure.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Set Time Off Settings for a Company

  • ID: post_set_time_off_settings_for_a_company
  • Operation: write
  • Entities: company, time off setting, category
  • Summary: This API endpoint allows setting the time off settings for a specific company identified by the company_id. The request is made using the POST method to the URL https://api.7shifts.com/v2/time_off_settings/{company_id}. The request requires headers specifying 'accept' and 'content-type' as 'application/json'. The company_id is a required path parameter. The request body can optionally include settings for paid time off, sick time off, time off request comments, and notice period. The response returns the updated settings for the company, including categories of time off. If the user does not have permission, a 403 error is returned. Unexpected errors are also handled with a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Availability for a Company

  • ID: put_update_availability_for_a_company
  • Operation: write
  • Entities: company, availability, day
  • Summary: This API endpoint allows updating the availability details for a specific company and availability ID. The request requires path parameters 'company_id' and 'availability_id', both of which are integers. The request body must include availability details for each day of the week, such as status, start and end times, comments, and reason IDs. The response will return a 201 status code with the updated availability details if successful. Error responses may include 400 (Bad Request), 403 (Forbidden), 404 (Not Found), 409 (Conflict), and 422 (Unprocessable Entity), each providing a detailed explanation of the issue.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Availability Reason for a Company

  • ID: put_update_availability_reason
  • Operation: write
  • Entities: availability reason, company
  • Summary: This API endpoint allows updating an availability reason for a specific company in the 7shifts system. The request requires the company ID and availability reason ID as path parameters. The request body must include the 'reason' field, and optionally, 'comments_required'. The headers must include 'accept' and 'content-type' as 'application/json'. The response returns the updated availability reason details if successful, or an error message with details if the request fails.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Availability Status

  • ID: put_update_availability_status
  • Operation: write
  • Entities: company, availability, status
  • Summary: This API endpoint is used to update the status of an availability for a specific company and availability ID. The request requires the company_id and availability_id as path parameters. The request body must include the status, which can be either 'approved' or 'declined'. An optional message can also be included. The response will return a 204 status code for a successful update, or an error response with details if the request fails.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Department Details

  • ID: put_update_department_details
  • Operation: write
  • Entities: company, department, location
  • Summary: The Update Department Details API allows users to update the details of a specific department within a company. The API requires the company_id and department_id as path parameters. The request headers can include optional parameters such as x-api-version and x-company-guid. The request body must include the department name and a boolean indicating if the department is the default for the location. The API returns a 200 OK response with the updated department details if successful. Error responses include 403 Forbidden, 404 Not Found, and 500 Server Error, each providing details about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update External User Mappings

  • ID: put_update_external_user_mappings
  • Operation: write
  • Entities: company, external user mapping, user
  • Summary: This API endpoint allows updating external user mappings for a specified company in 7shifts. The request requires the company ID and user identifier as path parameters. The user identifier can be a 7Shifts user ID or an external user ID prefixed with 'ext:'. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The request body should contain the 'user_id' and 'external_user_id'. The response returns the updated mapping details, including mapping ID, user IDs, company ID, location ID, application name, creation and modification timestamps, and user active status. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 422 Unprocessable Entity, and 500 Unexpected Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Location Details

  • ID: put_update_location_details
  • Operation: write
  • Entities: company, location, time
  • Summary: The Update Location Details API allows updating the details of a specific location within a company. It requires the company_id and location_id as path parameters. The request body must include details such as location name, city, country, state, shift feedback settings, formatted address, latitude, longitude, place ID, timezone, and opening and closing hours for each day of the week. The API returns the updated location details including the location ID, company ID, name, country, state, city, formatted address, latitude, longitude, place ID, timezone, and other settings. The response also includes timestamps for creation and modification of the location details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Manual Entry for Tip Pool

  • ID: put_update_manual_entry_for_tip_pool
  • Operation: write
  • Entities: company, tip pool, manual entry
  • Summary: This API endpoint allows updating a manual entry for a tip pool in a specified company. The request requires the company ID and the tip pool settings UUID as path parameters. The request body must include the object type 'manual_tip_pooling' and an array of data objects, each containing the tip pool settings UUID, entry date, and tip amount. Optional fields include the manual entry UUID, day part UUID, created, and modified timestamps. The response returns the updated manual entry details. The API supports various error responses, including 400 Bad Request, 401 Unauthorized, 403 Forbidden, 422 Unprocessable Entity, and 500 Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Receipt Details

  • ID: put_update_receipt_details
  • Operation: write
  • Entities: company, receipt, receipt line
  • Summary: This API endpoint allows updating the details of a receipt for a specific company in the 7shifts system. The request requires the company ID and receipt ID as path parameters. The receipt ID can be a 7shifts receipt UUID or a combination of an external ID and location ID. The request body must include the net total of the receipt, and optionally other details such as receipt date, gross total, discounts, tips, and line items. The response indicates whether the update was queued for processing or if there were errors such as bad request, forbidden access, or server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Role Details in a Company

  • ID: put_update_role_details
  • Operation: write
  • Entities: company, department, role
  • Summary: This API endpoint allows updating the details of a specific role within a company. It requires the company ID and role ID as path parameters. The request body must include details such as department ID, sort order, color, name, job code, and stations associated with the role. The response returns the updated role details, including role ID, company ID, location ID, department ID, color, number of stations, name, job code, sort order, and timestamps for creation and modification. The API supports various error responses, including 400 Bad Request, 403 Forbidden, 404 Not Found, 422 Unprocessable Entity, and 500 Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Shift Details

  • ID: put_update_shift_details
  • Operation: write
  • Entities: company, department, shift
  • Summary: The Update Shift Details API allows users to update the details of a specific shift for a company. The API requires the company_id and shift_id as path parameters. The request headers include optional x-api-version and x-company-guid, and mandatory accept and content-type headers. The request body contains various optional fields such as location_id, user_id, department_id, role_id, station_id, start, end, close, business_decline, notes, draft, open, open_offer_type, unassigned, unassigned_skill_level, status, late_minutes, and breaks. The response returns the updated shift details, including fields like id, user_id, start, end, close, business_decline, hourly_wage, department_id, location_id, role_id, notes, draft, notified, open, unassigned, unassigned_skill_level, open_offer_type, attendance_status, publish_status, late_minutes, created, modified, deleted, soft_deleted, station, station_name, station_id, and breaks.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Task List Template

  • ID: put_update_task_list_template
  • Operation: write
  • Entities: company, task list template, assignment
  • Summary: This API endpoint allows updating a task list template for a specific company in the 7shifts system. The request requires the company ID and the UUID of the task list template to be updated. The request headers can optionally include the API version and company GUID. The request body must include details such as the title, description, status, task templates, recurrence rules, assignments, due date, and time frame. The response returns the updated task list template details, including its ID, company ID, UUID, title, description, status, due date, creation and activation timestamps, task templates, assignments, recurrence rules, and time frame. The API can return various error responses, including 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 422 Unprocessable Entity, and 500 Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Time Punch Details

  • ID: put_update_time_punch_details
  • Operation: write
  • Entities: company, shift, time punch
  • Summary: This API endpoint allows updating the details of a specific time punch for a company. It requires the company_id and time_punch_id as path parameters. The request headers must include 'accept' and 'content-type' set to 'application/json'. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The request body must include details such as department_id, role_id, clocked_in and clocked_out times, notes, tips, and breaks. The response returns the updated time punch details, including the time punch ID, shift ID, user ID, role ID, company ID, location ID, department ID, hourly wage, approval status, clocked in and out times, notes, and break details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update User Details in 7shifts

  • ID: put_update_user_details
  • Operation: write
  • Entities: company, user
  • Summary: This API endpoint allows updating user details in the 7shifts system. It requires a PUT request to the URL https://api.7shifts.com/v2/company/{company_id}/users/{identifier} with the company_id and identifier as path parameters. The request headers must include 'Authorization' with a Bearer token, 'accept', and 'content-type' as 'application/json'. Optional headers include 'x-api-version' and 'x-company-guid'. The request body should contain user details such as first name, last name, email, phone numbers, address, hire date, user type, and other optional fields. The response returns the updated user details including user ID, company ID, name, contact information, status, and other attributes. The API supports error responses for various HTTP status codes including 400, 401, 403, 404, 422, and 500.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Webhook Details

  • ID: put_update_webhook_details
  • Operation: write
  • Entities: company, webhook
  • Summary: The Update Webhook Details API allows users to update the details of a specific webhook for a company. The API requires the company ID and webhook ID as path parameters. The request headers can include optional parameters such as 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The request body must include the 'url' of the webhook to be updated. The response will return the updated webhook details if successful, or an error message if there is an issue with the request. The API requires a minimum plan of Gourmet to access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 7 days ago