{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:7-shifts/authentication-generate-oauth-token":{"post":{"operationId":"business_7_shifts_authentication_generate_oauth_token","summary":"Create OAuth Token","description":"POST /oauth2/token","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/authentication-get-identity":{"get":{"operationId":"business_7_shifts_authentication_get_identity","summary":"Retrieve Identity","description":"GET /v2/whoami","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/account-create-trial-account":{"post":{"operationId":"business_7_shifts_account_create_trial_account","summary":"Create Trial Account","description":"POST /v2/partner_company_creation","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/companies-list":{"get":{"operationId":"business_7_shifts_companies_list","summary":"List Companies","description":"GET /v2/companies","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"modified_since","in":"query","required":false,"description":"Return companies that have been modified since the specified date. Format YYYY-MM-DD","schema":{"type":"string","description":"Return companies that have been modified since the specified date. Format YYYY-MM-DD"},"example":"2020-01-01"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/companies-get-by-id":{"get":{"operationId":"business_7_shifts_companies_get_by_id","summary":"Retrieve Company","description":"GET /v2/companies/{id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":8655}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/companies-update-company-by-id":{"post":{"operationId":"business_7_shifts_companies_update_company_by_id","summary":"Update Company","description":"PATCH /v2/companies/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/companies-get-labor-settings":{"get":{"operationId":"business_7_shifts_companies_get_labor_settings","summary":"Retrieve Labor Settings","description":"GET /v2/company/{company_id}/labor_settings","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/companies-list-inactive-reasons":{"get":{"operationId":"business_7_shifts_companies_list_inactive_reasons","summary":"List Inactive Reasons","description":"GET /v2/company/{company_id}/inactive_reasons","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/locations-list-get":{"get":{"operationId":"business_7_shifts_locations_list_get","summary":"List Locations","description":"GET /v2/company/{company_id}/locations","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"modified_since","in":"query","required":false,"description":"Return locations that have been modified since the specified date. Format YYYY-MM-DD","schema":{"type":"string","description":"Return locations that have been modified since the specified date. Format YYYY-MM-DD"},"example":"2020-01-01"},{"name":"deleted","in":"query","required":false,"description":"When TRUE the search will return deleted locations","schema":{"type":"boolean","default":false,"description":"When TRUE the search will return deleted locations"}},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","default":100,"description":"The number of results desired per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/locations-create":{"post":{"operationId":"business_7_shifts_locations_create","summary":"Create Location","description":"POST /v2/company/{company_id}/locations","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/locations-get-location":{"get":{"operationId":"business_7_shifts_locations_get_location","summary":"Retrieve Location","description":"GET /v2/company/{company_id}/locations/{location_id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"location_id","in":"query","required":true,"description":"Location ID","schema":{"type":"integer","description":"Location ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/locations-update-location-by-id":{"post":{"operationId":"business_7_shifts_locations_update_location_by_id","summary":"Update Location","description":"PUT /v2/company/{company_id}/locations/{location_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","location_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"location_id":{"type":"integer","description":"Location ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/locations-remove-location-by-id":{"post":{"operationId":"business_7_shifts_locations_remove_location_by_id","summary":"Delete Location","description":"DELETE /v2/company/{company_id}/locations/{location_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","location_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"location_id":{"type":"integer","description":"Location ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/departments-list":{"get":{"operationId":"business_7_shifts_departments_list","summary":"List Departments","description":"GET /v2/company/{company_id}/departments","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"modified_since","in":"query","required":false,"description":"Return departments that have been modified since the specified date. Format YYYY-MM-DD","schema":{"type":"string","description":"Return departments that have been modified since the specified date. Format YYYY-MM-DD"},"example":"2020-01-01"},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","description":"The number of results desired per page."}},{"name":"location_id","in":"query","required":false,"description":"Return departments that match the provided location ID","schema":{"type":"integer","description":"Return departments that match the provided location ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/departments-create-new-department":{"post":{"operationId":"business_7_shifts_departments_create_new_department","summary":"Create Department","description":"POST /v2/company/{company_id}/departments","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/departments-get-department":{"get":{"operationId":"business_7_shifts_departments_get_department","summary":"Retrieve Department","description":"GET /v2/company/{company_id}/departments/{department_id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"department_id","in":"query","required":true,"description":"Department ID","schema":{"type":"integer","description":"Department ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/departments-update-department":{"post":{"operationId":"business_7_shifts_departments_update_department","summary":"Update Department","description":"PUT /v2/company/{company_id}/departments/{department_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","department_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"department_id":{"type":"integer","description":"Department ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/departments-delete-by-id":{"post":{"operationId":"business_7_shifts_departments_delete_by_id","summary":"Delete Department","description":"DELETE /v2/company/{company_id}/departments/{department_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","department_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"department_id":{"type":"integer","description":"Department ID"},"transfer_to":{"type":"integer","description":"Department ID to move roles and shifts to"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/roles-list":{"get":{"operationId":"business_7_shifts_roles_list","summary":"List Roles","description":"GET /v2/company/{company_id}/roles","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"location_id","in":"query","required":false,"description":"Location ID","schema":{"type":"integer","description":"Location ID"}},{"name":"department_id","in":"query","required":false,"description":"Department ID","schema":{"type":"integer","description":"Department ID"}},{"name":"ids","in":"query","required":false,"description":"Role IDs","schema":{"type":"array","description":"Role IDs"},"example":"123,321"},{"name":"modified_since","in":"query","required":false,"description":"Return roles that have been modified since the specified date. Format YYYY-MM-DD","schema":{"type":"string","description":"Return roles that have been modified since the specified date. Format YYYY-MM-DD"}},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","description":"The number of results desired per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/roles-create-role":{"post":{"operationId":"business_7_shifts_roles_create_role","summary":"Create Role","description":"POST /v2/company/{company_id}/roles","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"The company id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/roles-get-role":{"get":{"operationId":"business_7_shifts_roles_get_role","summary":"Retrieve Role","description":"GET /v2/company/{company_id}/roles/{role_id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"role_id","in":"query","required":true,"description":"Role ID","schema":{"type":"integer","description":"Role ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/roles-update-role-by-id":{"post":{"operationId":"business_7_shifts_roles_update_role_by_id","summary":"Update Role","description":"PUT /v2/company/{company_id}/roles/{role_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","role_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"role_id":{"type":"integer","description":"Role ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/roles-delete-role":{"post":{"operationId":"business_7_shifts_roles_delete_role","summary":"Delete Role","description":"DELETE /v2/company/{company_id}/roles/{role_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","role_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"role_id":{"type":"integer","description":"Role ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/users-list":{"get":{"operationId":"business_7_shifts_users_list","summary":"List Users","description":"GET /v2/company/{company_id}/users","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"modified_since","in":"query","required":false,"description":"Return users that have been modified since the specified date. Format YYYY-MM-DD","schema":{"type":"string","description":"Return users that have been modified since the specified date. Format YYYY-MM-DD"},"example":"2020-01-01"},{"name":"location_id","in":"query","required":false,"description":"Location ID (cannot be used in conjunction with Department ID and Role ID)","schema":{"type":"integer","description":"Location ID (cannot be used in conjunction with Department ID and Role ID)"}},{"name":"department_id","in":"query","required":false,"description":"Department ID (cannot be used in conjunction with Location ID and Role ID)","schema":{"type":"integer","description":"Department ID (cannot be used in conjunction with Location ID and Role ID)"}},{"name":"role_id","in":"query","required":false,"description":"Role ID (cannot be used in conjunction with Location ID and Department ID)","schema":{"type":"integer","description":"Role ID (cannot be used in conjunction with Location ID and Department ID)"}},{"name":"status","in":"query","required":false,"description":"The user status","schema":{"type":"string","enum":["active","inactive"],"description":"The user status"}},{"name":"name","in":"query","required":false,"description":"Filter by partial or full employee name","schema":{"type":"string","description":"Filter by partial or full employee name"}},{"name":"sort_by","in":"query","required":false,"description":"Sort the paginated result by the given field and direction.","schema":{"type":"string","description":"Sort the paginated result by the given field and direction."},"example":"firstname.asc,lastname.desc"},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","default":100,"description":"The number of results desired per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/users-create-new-user":{"post":{"operationId":"business_7_shifts_users_create_new_user","summary":"Create User","description":"POST /v2/company/{company_id}/users","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/users-bulk-create":{"post":{"operationId":"business_7_shifts_users_bulk_create","summary":"Create Many Users","description":"POST /v2/company/{company_id}/create_many_users","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/users-get-user-by-identifier":{"get":{"operationId":"business_7_shifts_users_get_user_by_identifier","summary":"Retrieve User","description":"GET /v2/company/{company_id}/users/{identifier}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}},{"name":"identifier","in":"query","required":true,"description":"User ID. Accepted values are 7shifts user id or punch id. Use prefix punch: for punch id","schema":{"type":"string","description":"User ID. Accepted values are 7shifts user id or punch id. Use prefix punch: for punch id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/users-update-user-by-identifier":{"post":{"operationId":"business_7_shifts_users_update_user_by_identifier","summary":"Update User","description":"PUT /v2/company/{company_id}/users/{identifier}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","identifier","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"identifier":{"type":"integer","description":"User ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/users-deactivate":{"post":{"operationId":"business_7_shifts_users_deactivate","summary":"Deactivate User","description":"DELETE /v2/company/{company_id}/users/{identifier}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","identifier"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"identifier":{"type":"integer","description":"User ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/user-wages-list":{"get":{"operationId":"business_7_shifts_user_wages_list","summary":"List User Wages","description":"GET /v2/company/{company_id}/users/{user_id}/wages","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}},{"name":"user_id","in":"query","required":true,"description":"User ID","schema":{"type":"integer","description":"User ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/user-wages-create":{"post":{"operationId":"business_7_shifts_user_wages_create","summary":"Create User Wage","description":"POST /v2/company/{company_id}/users/{user_id}/wages","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","user_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"user_id":{"type":"integer","description":"User ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/user-assignments-list":{"get":{"operationId":"business_7_shifts_user_assignments_list","summary":"List Assignments","description":"GET /v2/company/{company_id}/users/{user_id}/assignments","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"user_id","in":"query","required":true,"description":"User ID","schema":{"type":"integer","description":"User ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/user-assignments-list-location-assignments":{"get":{"operationId":"business_7_shifts_user_assignments_list_location_assignments","summary":"List Location Assignments","description":"GET /v2/company/{company_id}/users/{user_id}/location_assignments","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"user_id","in":"query","required":true,"description":"User ID","schema":{"type":"integer","description":"User ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/user-assignments-create-location-assignment":{"post":{"operationId":"business_7_shifts_user_assignments_create_location_assignment","summary":"Create Location Assignments","description":"POST /v2/company/{company_id}/users/{user_id}/location_assignments","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","user_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"user_id":{"type":"integer","description":"User ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/user-assignments-remove-location-assignment":{"post":{"operationId":"business_7_shifts_user_assignments_remove_location_assignment","summary":"Delete Location Assignment","description":"DELETE /v2/company/{company_id}/users/{user_id}/location_assignments/{location_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","user_id","location_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"user_id":{"type":"integer","description":"User ID"},"location_id":{"type":"integer","description":"Location ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/user-assignments-list-department-assignments":{"get":{"operationId":"business_7_shifts_user_assignments_list_department_assignments","summary":"List Department Assignments","description":"GET /v2/company/{company_id}/users/{user_id}/department_assignments","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"user_id","in":"query","required":true,"description":"User ID","schema":{"type":"integer","description":"User ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/user-assignments-create-department-assignment":{"post":{"operationId":"business_7_shifts_user_assignments_create_department_assignment","summary":"Create Department Assignment","description":"POST /v2/company/{company_id}/users/{user_id}/department_assignments","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","user_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"user_id":{"type":"integer","description":"User ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/user-assignments-remove-department-assignment":{"post":{"operationId":"business_7_shifts_user_assignments_remove_department_assignment","summary":"Delete Department Assignment","description":"DELETE /v2/company/{company_id}/users/{user_id}/department_assignments/{department_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","user_id","department_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"user_id":{"type":"integer","description":"User ID"},"department_id":{"type":"integer","description":"Department ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/user-assignments-list-role-assignments":{"get":{"operationId":"business_7_shifts_user_assignments_list_role_assignments","summary":"List Role Assignments","description":"GET /v2/company/{company_id}/users/{user_id}/role_assignments","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"user_id","in":"query","required":true,"description":"User ID","schema":{"type":"integer","description":"User ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/user-assignments-create-role-assignment":{"post":{"operationId":"business_7_shifts_user_assignments_create_role_assignment","summary":"Create Role Assignment","description":"POST /v2/company/{company_id}/users/{user_id}/role_assignments","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","user_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"user_id":{"type":"integer","description":"User ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/user-assignments-delete-role-assignment":{"post":{"operationId":"business_7_shifts_user_assignments_delete_role_assignment","summary":"Delete Role Assignment","description":"DELETE /v2/company/{company_id}/users/{user_id}/role_assignments/{role_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","user_id","role_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"user_id":{"type":"integer","description":"User ID"},"role_id":{"type":"integer","description":"Role ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/shifts-list":{"get":{"operationId":"business_7_shifts_shifts_list","summary":"List Shifts","description":"GET /v2/company/{company_id}/shifts","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","default":100,"description":"The number of results desired per page."}},{"name":"location_id","in":"query","required":false,"description":"Location ID","schema":{"type":"integer","description":"Location ID"},"example":1234},{"name":"shift_ids","in":"query","required":false,"description":"A comma separated list of Shift IDs","schema":{"type":"array","description":"A comma separated list of Shift IDs"}},{"name":"department_id","in":"query","required":false,"description":"Department ID","schema":{"type":"integer","description":"Department ID"},"example":1234},{"name":"department_ids","in":"query","required":false,"description":"Department IDs","schema":{"type":"array","description":"Department IDs"}},{"name":"role_id","in":"query","required":false,"description":"Role ID","schema":{"type":"integer","description":"Role ID"},"example":1234},{"name":"user_id","in":"query","required":false,"description":"User ID","schema":{"type":"integer","description":"User ID"},"example":1234},{"name":"start[lte]","in":"query","required":false,"description":"Return shifts that start before or on specified date. In ISO8601 Format","schema":{"type":"string","description":"Return shifts that start before or on specified date. In ISO8601 Format"}},{"name":"start[gte]","in":"query","required":false,"description":"Return shifts that start after or on specified date time. In ISO8601 Format","schema":{"type":"string","description":"Return shifts that start after or on specified date time. In ISO8601 Format"}},{"name":"end[lte]","in":"query","required":false,"description":"Return shifts that end before or on specified date time. In ISO8601 Format","schema":{"type":"string","description":"Return shifts that end before or on specified date time. In ISO8601 Format"}},{"name":"end[gte]","in":"query","required":false,"description":"Return shifts that end after or on specified date time. In ISO8601 Format","schema":{"type":"string","description":"Return shifts that end after or on specified date time. In ISO8601 Format"}},{"name":"deleted","in":"query","required":false,"description":"Return shifts that were published and have been deleted. Cannot be combined with draft.","schema":{"type":"boolean","default":false,"description":"Return shifts that were published and have been deleted. Cannot be combined with draft."}},{"name":"draft","in":"query","required":false,"description":"Return shifts that are in draft. Draft shifts have created, edited or deleted but not been published. Overrides deleted flag.","schema":{"type":"boolean","default":false,"description":"Return shifts that are in draft. Draft shifts have created, edited or deleted but not been published. Overrides deleted flag."}},{"name":"include_draft","in":"query","required":false,"description":"Return shifts that are published, and also shifts in draft. Overrides deleted flag and draft flag.","schema":{"type":"boolean","default":false,"description":"Return shifts that are published, and also shifts in draft. Overrides deleted flag and draft flag."}},{"name":"open","in":"query","required":false,"description":"Return shifts that are open. Open shifts means anyone can request to take it and not assigned to any individual.","schema":{"type":"boolean","description":"Return shifts that are open. Open shifts means anyone can request to take it and not assigned to any individual."}},{"name":"modified_since","in":"query","required":false,"description":"Return only shifts that have been modified from specified date time. In ISO8601 Format","schema":{"type":"string","description":"Return only shifts that have been modified from specified date time. In ISO8601 Format"}},{"name":"sort_by","in":"query","required":false,"description":"Sort by either start or end","schema":{"type":"string","description":"Sort by either start or end"}},{"name":"sort_dir","in":"query","required":false,"description":"Sort by direction (asc, desc)","schema":{"type":"string","description":"Sort by direction (asc, desc)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/shifts-create-new-shift":{"post":{"operationId":"business_7_shifts_shifts_create_new_shift","summary":"Create Shift","description":"POST /v2/company/{company_id}/shifts","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/shifts-get-shift-by-id":{"get":{"operationId":"business_7_shifts_shifts_get_shift_by_id","summary":"Retrieve Shift","description":"GET /v2/company/{company_id}/shifts/{shift_id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}},{"name":"shift_id","in":"query","required":true,"description":"Shift ID","schema":{"type":"integer","description":"Shift ID"}},{"name":"include_deleted","in":"query","required":false,"description":"Return the shift even if its deleted","schema":{"type":"boolean","description":"Return the shift even if its deleted"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/shifts-update-shift-by-id":{"post":{"operationId":"business_7_shifts_shifts_update_shift_by_id","summary":"Update Shift","description":"PUT /v2/company/{company_id}/shifts/{shift_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","shift_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"shift_id":{"type":"integer","description":"Shift ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/shifts-delete-shift-by-id":{"post":{"operationId":"business_7_shifts_shifts_delete_shift_by_id","summary":"Delete Shift","description":"DELETE /v2/company/{company_id}/shifts/{shift_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","shift_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"shift_id":{"type":"integer","description":"Shift ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/schedule-enforcement-list-scheduled-shifts":{"get":{"operationId":"business_7_shifts_schedule_enforcement_list_scheduled_shifts","summary":"List Scheduled Shifts","description":"GET /v2/company/{company_id}/shifts_scheduled/{id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"id","in":"query","required":true,"description":"Specified user_id of the user to check if scheduled. If the value begins with punch_id: then this specifies a user punch_id.","schema":{"type":"string","description":"Specified user_id of the user to check if scheduled. If the value begins with punch_id: then this specifies a user punch_id."},"example":"punch_id:003184"},{"name":"location_id","in":"query","required":true,"description":"Location ID.","schema":{"type":"integer","description":"Location ID."},"example":5},{"name":"grace_period","in":"query","required":false,"description":"Grace period in minutes.","schema":{"type":"integer","description":"Grace period in minutes."},"example":5}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-punches-list":{"get":{"operationId":"business_7_shifts_time_punches_list","summary":"List Time Punches","description":"GET /v2/company/{company_id}/time_punches","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"location_id","in":"query","required":false,"description":"Location ID","schema":{"type":"integer","description":"Location ID"}},{"name":"department_id","in":"query","required":false,"description":"Department ID","schema":{"type":"integer","description":"Department ID"}},{"name":"role_id","in":"query","required":false,"description":"Role ID","schema":{"type":"integer","description":"Role ID"}},{"name":"user_id","in":"query","required":false,"description":"User ID","schema":{"type":"integer","description":"User ID"}},{"name":"approved","in":"query","required":false,"description":"Returns time punches that have been approved. Default null, returns both approved and unapproved punches. If true returns only approved…","schema":{"type":"boolean","description":"Returns time punches that have been approved. Default null, returns both approved and unapproved punches. If true returns only approved…"}},{"name":"limit","in":"query","required":false,"description":"The limit of results that will be returned.","schema":{"type":"integer","default":20,"description":"The limit of results that will be returned."}},{"name":"modified_since","in":"query","required":false,"description":"Return time punches that have been modified after the specified date time. UTC in ISO8601 Format","schema":{"type":"string","description":"Return time punches that have been modified after the specified date time. UTC in ISO8601 Format"},"example":"2020-12-30T15:00:00.000Z"},{"name":"clocked_in[lte]","in":"query","required":false,"description":"Return time punches with clocked in before or on the specified date. UTC in ISO8601 format","schema":{"type":"string","description":"Return time punches with clocked in before or on the specified date. UTC in ISO8601 format"}},{"name":"clocked_in[gte]","in":"query","required":false,"description":"Return time punches with clocked in after or on the specified date. UTC in ISO8601 format","schema":{"type":"string","description":"Return time punches with clocked in after or on the specified date. UTC in ISO8601 format"}},{"name":"clocked_out[lte]","in":"query","required":false,"description":"Return time punches with clocked out before or on the specified date. UTC in ISO8601 format","schema":{"type":"string","description":"Return time punches with clocked out before or on the specified date. UTC in ISO8601 format"}},{"name":"clocked_out[gte]","in":"query","required":false,"description":"Return time punches with clocked out after or on the specified date. UTC in ISO8601 format","schema":{"type":"string","description":"Return time punches with clocked out after or on the specified date. UTC in ISO8601 format"}},{"name":"include_deleted","in":"query","required":false,"description":"Deprecated, see 'deleted'","schema":{"type":"boolean","default":false,"description":"Deprecated, see 'deleted'"}},{"name":"deleted","in":"query","required":false,"description":"Returns punches filtered by deleted status. Default false, returns undeleted punches. If true returns only deleted punches. if value is…","schema":{"type":"boolean","default":false,"description":"Returns punches filtered by deleted status. Default false, returns undeleted punches. If true returns only deleted punches. if value is…"}},{"name":"localize_search_time","in":"query","required":false,"description":"If true, convert any date ranges to consider the local timezone of the punches. If false, date ranges will be in UTC","schema":{"type":"boolean","default":false,"description":"If true, convert any date ranges to consider the local timezone of the punches. If false, date ranges will be in UTC"}},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"sort_by","in":"query","required":false,"description":"The name of the field and direction you want the results ordered by.","schema":{"type":"string","description":"The name of the field and direction you want the results ordered by."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-punches-create":{"post":{"operationId":"business_7_shifts_time_punches_create","summary":"Create Time Punch","description":"POST /v2/company/{company_id}/time_punches","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"The company id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-punches-get-time-punch":{"get":{"operationId":"business_7_shifts_time_punches_get_time_punch","summary":"Retrieve Time Punch","description":"GET /v2/company/{company_id}/time_punches/{time_punch_id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"time_punch_id","in":"query","required":true,"description":"Time punch ID","schema":{"type":"integer","description":"Time punch ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-punches-update-by-id":{"post":{"operationId":"business_7_shifts_time_punches_update_by_id","summary":"Update Time Punch","description":"PUT /v2/company/{company_id}/time_punches/{time_punch_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","time_punch_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company id"},"time_punch_id":{"type":"integer","description":"Time punch id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-punches-delete-by-id":{"post":{"operationId":"business_7_shifts_time_punches_delete_by_id","summary":"Delete Time Punch","description":"DELETE /v2/company/{company_id}/time_punches/{time_punch_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","time_punch_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"time_punch_id":{"type":"integer","description":"Time punch ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/receipts-list":{"get":{"operationId":"business_7_shifts_receipts_list","summary":"List Receipts","description":"GET /v2/company/{company_id}/receipts","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"location_id","in":"query","required":true,"description":"Location ID","schema":{"type":"integer","description":"Location ID"},"example":1234},{"name":"receipt_date[gte]","in":"query","required":false,"description":"Return receipts that were created on or after a specific date","schema":{"type":"string","description":"Return receipts that were created on or after a specific date"},"example":"2022-01-01"},{"name":"receipt_date[lte]","in":"query","required":false,"description":"Return receipts that were created on or before a specific date","schema":{"type":"string","description":"Return receipts that were created on or before a specific date"},"example":"2022-01-01"},{"name":"modified_since","in":"query","required":false,"description":"Return receipts that were modified on or after a specific date","schema":{"type":"string","description":"Return receipts that were modified on or after a specific date"},"example":"2022-01-01"},{"name":"status","in":"query","required":false,"description":"Filter receipts by status type","schema":{"type":"string","enum":["open","closed","voided","deleted"],"description":"Filter receipts by status type"},"example":"open"},{"name":"external_user_id","in":"query","required":false,"description":"Filter receipts by external user id","schema":{"type":"string","description":"Filter receipts by external user id"},"example":"ABC123"},{"name":"cursor","in":"query","required":false,"description":"An opaque cursor for the next or previous result set.","schema":{"type":"string","description":"An opaque cursor for the next or previous result set."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","default":100,"description":"The number of results desired per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/receipts-create-receipt":{"post":{"operationId":"business_7_shifts_receipts_create_receipt","summary":"Create Receipt","description":"POST /v2/company/{company_id}/receipts","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/receipts-get-receipt":{"get":{"operationId":"business_7_shifts_receipts_get_receipt","summary":"Retrieve Receipt","description":"GET /v2/company/{company_id}/receipts/{receipt_id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}},{"name":"receipt_id","in":"query","required":true,"description":"Receipt UUID","schema":{"type":"string","description":"Receipt UUID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/receipts-update-receipt":{"post":{"operationId":"business_7_shifts_receipts_update_receipt","summary":"Update Receipt","description":"PUT /v2/company/{company_id}/receipts/{receipt_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","receipt_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"receipt_id":{"type":"string","description":"Receipt ID. Either 7shifts receipt UUID or a combination of the External ID of the sales receipt in your system and a Location ID.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/receipts-get-summary":{"get":{"operationId":"business_7_shifts_receipts_get_summary","summary":"Retrieve Receipts Summary","description":"GET /v2/company/{company_id}/receipts_summary","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"}},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"location_id","in":"query","required":true,"description":"Location ID","schema":{"type":"integer","description":"Location ID"},"example":1234},{"name":"receipt_date[gte]","in":"query","required":false,"description":"Return receipts that were created on or after a specific date. Limit to 31-day range with receipt_date[lte].","schema":{"type":"string","description":"Return receipts that were created on or after a specific date. Limit to 31-day range with receipt_date[lte]."},"example":"2022-01-01"},{"name":"receipt_date[lte]","in":"query","required":false,"description":"Return receipts that were created on or before a specific date. Limit to 31-day range with receipt_date[gte].","schema":{"type":"string","description":"Return receipts that were created on or before a specific date. Limit to 31-day range with receipt_date[gte]."},"example":"2022-01-01"},{"name":"modified_since","in":"query","required":false,"description":"Return receipts that were modified on or after a specific date. Limited to past 30 days.","schema":{"type":"string","description":"Return receipts that were modified on or after a specific date. Limited to past 30 days."},"example":"2022-01-01"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/external-user-mappings-get-mapping-by-id":{"get":{"operationId":"business_7_shifts_external_user_mappings_get_mapping_by_id","summary":"Retrieve User External Mapping","description":"GET /v2/company/{company_id}/external_user_mappings/{identifier}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}},{"name":"identifier","in":"query","required":true,"description":"User ID. Accepted values are 7Shifts user id or external user id. Use prefix ext: for external id","schema":{"type":"string","description":"User ID. Accepted values are 7Shifts user id or external user id. Use prefix ext: for external id"}},{"name":"location_id","in":"query","required":false,"description":"Location ID","schema":{"type":"integer","description":"Location ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/external-user-mappings-update-mapping-by-identifier":{"post":{"operationId":"business_7_shifts_external_user_mappings_update_mapping_by_identifier","summary":"Update External User Mappings","description":"PUT /v2/company/{company_id}/external_user_mappings/{identifier}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","identifier"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"identifier":{"type":"string","description":"User ID. Accepted values are 7Shifts user id or external user id. Use prefix ext: for external id"},"location_id":{"type":"integer","description":"Location ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/external-user-mappings-delete-mapping":{"post":{"operationId":"business_7_shifts_external_user_mappings_delete_mapping","summary":"Delete External User Mapping","description":"DELETE /v2/company/{company_id}/external_user_mappings/{identifier}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","identifier"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"identifier":{"type":"string","description":"User ID. Accepted values are 7Shifts user id, external user id or user email address. Use prefix ext: for external id or email: for email…"},"location_id":{"type":"integer","description":"Location ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/external-user-mappings-list":{"get":{"operationId":"business_7_shifts_external_user_mappings_list","summary":"List External User Mapping","description":"GET /v2/company/{company_id}/external_user_mappings","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}},{"name":"location_id","in":"query","required":false,"description":"Location ID","schema":{"type":"integer","description":"Location ID"}},{"name":"user_id","in":"query","required":false,"description":"The 7shifts user ID","schema":{"type":"integer","description":"The 7shifts user ID"}},{"name":"external_user_id","in":"query","required":false,"description":"The external user ID","schema":{"type":"string","description":"The external user ID"}},{"name":"modified_since","in":"query","required":false,"description":"Return records that have been modified since the specified date. Format YYYY-MM-DD","schema":{"type":"string","description":"Return records that have been modified since the specified date. Format YYYY-MM-DD"}},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","description":"The number of results desired per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/external-user-mappings-create-mapping":{"post":{"operationId":"business_7_shifts_external_user_mappings_create_mapping","summary":"Create External User Mapping","description":"POST /v2/company/{company_id}/external_user_mappings","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"location_id":{"type":"integer","description":"Location ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/external-user-mappings-create-bulk-mappings":{"post":{"operationId":"business_7_shifts_external_user_mappings_create_bulk_mappings","summary":"Create User External Mappings","description":"POST /v2/company/{company_id}/external_user_mappings_bulk","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"location_id":{"type":"integer","description":"Location ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/schedule-events-list-events":{"get":{"operationId":"business_7_shifts_schedule_events_list_events","summary":"List Events","description":"GET /v2/company/{company_id}/events","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"location_id","in":"query","required":false,"description":"Location ID","schema":{"type":"integer","description":"Location ID"},"example":1234},{"name":"start_date","in":"query","required":true,"description":"A date string to request only events within a range. Format YYYY-MM-DD","schema":{"type":"string","description":"A date string to request only events within a range. Format YYYY-MM-DD"},"example":"2020-02-02"},{"name":"end_date","in":"query","required":true,"description":"A date string to request only events within a range. Format YYYY-MM-DD","schema":{"type":"string","description":"A date string to request only events within a range. Format YYYY-MM-DD"},"example":"2020-02-08"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/schedule-events-create-event":{"post":{"operationId":"business_7_shifts_schedule_events_create_event","summary":"Create Event","description":"POST /v2/company/{company_id}/events","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/schedule-events-get-event-by-id":{"get":{"operationId":"business_7_shifts_schedule_events_get_event_by_id","summary":"Retrieve Event","description":"GET /v2/company/{company_id}/events/{event_id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"event_id","in":"query","required":true,"description":"Event ID","schema":{"type":"integer","description":"Event ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/schedule-events-update-event-by-id":{"post":{"operationId":"business_7_shifts_schedule_events_update_event_by_id","summary":"Update Event","description":"PATCH /v2/company/{company_id}/events/{event_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","event_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"event_id":{"type":"integer","description":"Event ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/schedule-events-delete-event":{"post":{"operationId":"business_7_shifts_schedule_events_delete_event","summary":"Delete Event","description":"DELETE /v2/company/{company_id}/events/{event_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","event_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"event_id":{"type":"integer","description":"Event ID"},"recurrence_target":{"type":"string","description":"Recurrence Target"},"start_date":{"type":"string","description":"Start of the targeted range for recurrence. Format YYYY-MM-DD HH:MM:SS"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-get-settings":{"get":{"operationId":"business_7_shifts_task_management_get_settings","summary":"Gets task management settings for a company","description":"GET /v2/company/{company_id}/task_management_settings","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-create-task-tags":{"post":{"operationId":"business_7_shifts_task_management_create_task_tags","summary":"Create Task Tags","description":"POST /v2/company/{company_id}/task_tags","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-delete-task-tags":{"post":{"operationId":"business_7_shifts_task_management_delete_task_tags","summary":"Delete Task Tags","description":"DELETE /v2/company/{company_id}/task_tags","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-get-task-list-templates":{"get":{"operationId":"business_7_shifts_task_management_get_task_list_templates","summary":"Get task list templates","description":"GET /v2/company/{company_id}/task_list_templates","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":8655},{"name":"location_id","in":"query","required":false,"description":"Location ID","schema":{"type":"integer","description":"Location ID"}},{"name":"department_id","in":"query","required":false,"description":"Department ID","schema":{"type":"integer","description":"Department ID"}},{"name":"role_id","in":"query","required":false,"description":"Role ID","schema":{"type":"integer","description":"Role ID"}},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","description":"The number of results desired per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-create-task-list-template":{"post":{"operationId":"business_7_shifts_task_management_create_task_list_template","summary":"Create Task List Template","description":"POST /v2/company/{company_id}/task_list_templates","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-get-task-list-template":{"get":{"operationId":"business_7_shifts_task_management_get_task_list_template","summary":"Retrieve Task List Template","description":"GET /v2/company/{company_id}/task_list_templates/{uuid}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":8655},{"name":"uuid","in":"query","required":true,"description":"Task List Template UUID","schema":{"type":"string","description":"Task List Template UUID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-edit-task-list-template":{"post":{"operationId":"business_7_shifts_task_management_edit_task_list_template","summary":"edit task list template","description":"PUT /v2/company/{company_id}/task_list_templates/{uuid}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","uuid","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"uuid":{"type":"string","description":"Task List Template UUID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-delete-task-list-template":{"post":{"operationId":"business_7_shifts_task_management_delete_task_list_template","summary":"Delete Task List Template","description":"DELETE /v2/company/{company_id}/task_list_templates/{uuid}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","uuid"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"uuid":{"type":"string","description":"Task List Template UUID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-get-task-lists":{"get":{"operationId":"business_7_shifts_task_management_get_task_lists","summary":"List Task Lists","description":"GET /v2/company/{company_id}/task_lists","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":8655},{"name":"user_id","in":"query","required":false,"description":"User ID","schema":{"type":"integer","description":"User ID"},"example":5678},{"name":"location_id","in":"query","required":false,"description":"Location ID","schema":{"type":"integer","description":"Location ID"},"example":8655},{"name":"uuid","in":"query","required":false,"description":"Task List Template UUID","schema":{"type":"string","description":"Task List Template UUID"},"example":"325bf7a2-21a8-4599-a377-2380140b6710"},{"name":"active_on_date","in":"query","required":false,"description":"Show only tasks lists that were active on a date (YYYY-MM-DD)","schema":{"type":"string","description":"Show only tasks lists that were active on a date (YYYY-MM-DD)"},"example":"2019-11-05T00:00:00.000Z"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-get-task-list":{"get":{"operationId":"business_7_shifts_task_management_get_task_list","summary":"Retrieve Task List","description":"GET /v2/company/{company_id}/task_lists/{list_id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"list_id","in":"query","required":true,"description":"List ID","schema":{"type":"integer","description":"List ID"},"example":1234},{"name":"user_id","in":"query","required":false,"description":"User ID","schema":{"type":"integer","description":"User ID"},"example":5678}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-clear-task":{"post":{"operationId":"business_7_shifts_task_management_clear_task","summary":"Clear task","description":"POST /v2/company/{company_id}/task_lists/{list_id}/tasks/{task_id}/clear","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","list_id","task_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"list_id":{"type":"integer","description":"Task List ID"},"task_id":{"type":"integer","description":"Task ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-mark-complete":{"post":{"operationId":"business_7_shifts_task_management_mark_complete","summary":"Complete Task","description":"POST /v2/company/{company_id}/task_lists/{list_id}/tasks/{task_id}/complete","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","list_id","task_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"list_id":{"type":"integer","description":"Task List ID"},"task_id":{"type":"integer","description":"Task ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/task-management-list-task-lists-summary":{"get":{"operationId":"business_7_shifts_task_management_list_task_lists_summary","summary":"List Task Lists Summary","description":"GET /v2/company/{company_id}/task_list_daily_summary","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"location_id","in":"query","required":true,"description":"Location ID","schema":{"type":"integer","description":"Location ID"},"example":5678},{"name":"date","in":"query","required":true,"description":"Date of requested task lists","schema":{"type":"string","description":"Date of requested task lists"},"example":"2019-07-01T00:00:00.000Z"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/log-book-list-categories":{"get":{"operationId":"business_7_shifts_log_book_list_categories","summary":"List Log Book Categories","description":"GET /v2/company/{company_id}/log_book_categories","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/log-book-create-category":{"post":{"operationId":"business_7_shifts_log_book_create_category","summary":"Create Log Book Category","description":"POST /v2/company/{company_id}/log_book_categories","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/log-book-update-category-by-id":{"post":{"operationId":"business_7_shifts_log_book_update_category_by_id","summary":"Update Log Book Category","description":"PATCH /v2/company/{company_id}/log_book_categories/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"id":{"type":"integer","description":"Category ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/log-book-delete-category-by-id":{"post":{"operationId":"business_7_shifts_log_book_delete_category_by_id","summary":"Delete Log Book Category","description":"DELETE /v2/company/{company_id}/log_book_categories/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"id":{"type":"integer","description":"Category ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/log-book-list-posts":{"get":{"operationId":"business_7_shifts_log_book_list_posts","summary":"List Log Book Posts","description":"GET /v2/company/{company_id}/log_book_posts","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}},{"name":"location_id","in":"query","required":false,"description":"Location ID","schema":{"type":"integer","description":"Location ID"}},{"name":"log_book_category_id","in":"query","required":false,"description":"Log Book Category ID","schema":{"type":"integer","description":"Log Book Category ID"}},{"name":"user_id","in":"query","required":false,"description":"Post Author User ID","schema":{"type":"integer","description":"Post Author User ID"}},{"name":"date","in":"query","required":false,"description":"Date of log book creation, format YYYY-MM-DD","schema":{"type":"string","description":"Date of log book creation, format YYYY-MM-DD"}},{"name":"posted_date_gte","in":"query","required":false,"description":"List only log book posts from dates inclusive after, format YYYY-MM-DD","schema":{"type":"string","description":"List only log book posts from dates inclusive after, format YYYY-MM-DD"}},{"name":"posted_date_lte","in":"query","required":false,"description":"List only log book posts from dates inclusive before, format YYYY-MM-DD","schema":{"type":"string","description":"List only log book posts from dates inclusive before, format YYYY-MM-DD"}},{"name":"message","in":"query","required":false,"description":"List only posts containing the message","schema":{"type":"string","description":"List only posts containing the message"}},{"name":"order_field","in":"query","required":false,"description":"Order listed log book posts by a field","schema":{"type":"string","enum":["date","id"],"description":"Order listed log book posts by a field"}},{"name":"order_dir","in":"query","required":false,"description":"Specified direction to order listed log book posts","schema":{"type":"string","enum":["asc","desc"],"description":"Specified direction to order listed log book posts"}},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","description":"The number of results desired per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/log-book-create-post":{"post":{"operationId":"business_7_shifts_log_book_create_post","summary":"Create Log Book Post","description":"POST /v2/company/{company_id}/log_book_posts","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/log-book-get-post":{"get":{"operationId":"business_7_shifts_log_book_get_post","summary":"Retrieve Log Book Post","description":"GET /v2/company/{company_id}/log_book_posts/{id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}},{"name":"id","in":"query","required":true,"description":"Log Book Post ID","schema":{"type":"integer","description":"Log Book Post ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/log-book-delete-post":{"post":{"operationId":"business_7_shifts_log_book_delete_post","summary":"Delete Log Book Post","description":"DELETE /v2/company/{company_id}/log_book_posts/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"id":{"type":"integer","description":"Log Book Post ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/log-book-list-comments":{"get":{"operationId":"business_7_shifts_log_book_list_comments","summary":"List Log Book Comments","description":"GET /v2/company/{company_id}/log_book_comments","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}},{"name":"log_book_ids","in":"query","required":true,"description":"Log book post id associated with log book comments","schema":{"type":"array","description":"Log book post id associated with log book comments"},"example":"123,321"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/log-book-create-comment":{"post":{"operationId":"business_7_shifts_log_book_create_comment","summary":"Create Log Book Comment","description":"POST /v2/company/{company_id}/log_book_comments","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/log-book-get-comment":{"get":{"operationId":"business_7_shifts_log_book_get_comment","summary":"Retrieve Log Book Comment","description":"GET /v2/company/{company_id}/log_book_comments/{id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}},{"name":"id","in":"query","required":true,"description":"Log Book Comment ID","schema":{"type":"integer","description":"Log Book Comment ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/log-book-delete-comment":{"post":{"operationId":"business_7_shifts_log_book_delete_comment","summary":"Delete Log Book Comment","description":"DELETE /v2/company/{company_id}/log_book_comments/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"id":{"type":"integer","description":"Log Book Comment ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/reports-get-worked-hours-wages":{"get":{"operationId":"business_7_shifts_reports_get_worked_hours_wages","summary":"Retrieve Worked Hours & Wages","description":"GET /v2/reports/hours_and_wages","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"punches","in":"query","required":true,"description":"Whether or not to use the punch labour source","schema":{"type":"boolean","description":"Whether or not to use the punch labour source"}},{"name":"company_id","in":"query","required":true,"description":"The company id to pull the report for.","schema":{"type":"integer","description":"The company id to pull the report for."}},{"name":"from","in":"query","required":true,"description":"Starting date for which you want the report to start.","schema":{"type":"string","description":"Starting date for which you want the report to start."},"example":"2019-12-01"},{"name":"to","in":"query","required":true,"description":"Ending date for which you want the report to end.","schema":{"type":"string","description":"Ending date for which you want the report to end."},"example":"2019-12-01"},{"name":"location_id","in":"query","required":false,"description":"The location id for which you want the report for.","schema":{"type":"integer","description":"The location id for which you want the report for."},"example":1234},{"name":"department_id","in":"query","required":false,"description":"The department id for the report.","schema":{"type":"integer","description":"The department id for the report."},"example":1234},{"name":"role_id","in":"query","required":false,"description":"The role id for the report","schema":{"type":"integer","description":"The role id for the report"},"example":1234},{"name":"user_id","in":"query","required":false,"description":"The user id the report should be fetched for - internal use only","schema":{"type":"integer","description":"The user id the report should be fetched for - internal use only"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/reports-get-daily-sales-and-labor":{"get":{"operationId":"business_7_shifts_reports_get_daily_sales_and_labor","summary":"Retrieve Daily Sales & Labor","description":"GET /v2/reports/daily_sales_and_labor","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"start_date","in":"query","required":true,"description":"Starting date for which you want the daily sales and labor data for.","schema":{"type":"string","description":"Starting date for which you want the daily sales and labor data for."},"example":"2019-12-01"},{"name":"end_date","in":"query","required":true,"description":"Ending date for which you want the daily sales and labor data for.","schema":{"type":"string","description":"Ending date for which you want the daily sales and labor data for."},"example":"2019-12-01"},{"name":"location_id","in":"query","required":true,"description":"Location ID","schema":{"type":"integer","description":"Location ID"},"example":1234},{"name":"department_id","in":"query","required":false,"description":"Department ID","schema":{"type":"integer","description":"Department ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/reports-get-daily-stats":{"get":{"operationId":"business_7_shifts_reports_get_daily_stats","summary":"Retrieve Daily Stats","description":"GET /api/v2/company/{company_id}/location/{location_id}/daily_stats","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"location_id","in":"query","required":true,"description":"Location ID","schema":{"type":"integer","description":"Location ID"}},{"name":"department_id","in":"query","required":false,"description":"Department ID","schema":{"type":"integer","description":"Department ID"}},{"name":"date","in":"query","required":true,"description":"Date","schema":{"type":"string","description":"Date"}},{"name":"include_future","in":"query","required":false,"description":"include future","schema":{"type":"boolean","description":"include future"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/forecast-overrides-create-daily-projected-forecast-override":{"post":{"operationId":"business_7_shifts_forecast_overrides_create_daily_projected_forecast_override","summary":"Create Daily Projected Forecast Override","description":"POST /v2/company/{company_id}/location/{location_id}/forecast_override","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","location_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"location_id":{"type":"integer","description":"Location ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/forecast-overrides-sync-projected-forecast-override":{"post":{"operationId":"business_7_shifts_forecast_overrides_sync_projected_forecast_override","summary":"Sync Daily Projected Forecast Override","description":"DELETE /v2/company/{company_id}/location/{location_id}/forecast_override","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","location_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"location_id":{"type":"integer","description":"Location ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/forecast-overrides-bulk-create-projected-forecast-override":{"post":{"operationId":"business_7_shifts_forecast_overrides_bulk_create_projected_forecast_override","summary":"Create Bulk Daily Projected Forecast Overrides","description":"POST /v2/company/{company_id}/location/{location_id}/forecast_overrides","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","location_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"location_id":{"type":"integer","description":"Location ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/forecast-overrides-override-interval":{"post":{"operationId":"business_7_shifts_forecast_overrides_override_interval","summary":"Create Interval Projected Forecast Override","description":"POST /v2/company/{company_id}/locations/{location_id}/forecast_override_interval","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","location_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"location_id":{"type":"integer","description":"Location ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/forecast-overrides-sync-projected-sales-interval":{"post":{"operationId":"business_7_shifts_forecast_overrides_sync_projected_sales_interval","summary":"Sync Interval Projected Forecast Override","description":"DELETE /v2/company/{company_id}/locations/{location_id}/forecast_override_interval","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","location_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"location_id":{"type":"integer","description":"Location ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/forecast-overrides-bulk-create-projected-sales-interval-over":{"post":{"operationId":"business_7_shifts_forecast_overrides_bulk_create_projected_sales_interval_over","summary":"Create Bulk Daily Projected Forecast Overrides","description":"POST /v2/company/{company_id}/locations/{location_id}/forecast_overrides_intervals","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","location_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"location_id":{"type":"integer","description":"Location ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/tip-pool-get-settings":{"get":{"operationId":"business_7_shifts_tip_pool_get_settings","summary":"Gets tip pool settings for a company","description":"GET /v2/company/{company_id}/tip_pool_settings","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/tip-pool-get-manual-entry-tips":{"get":{"operationId":"business_7_shifts_tip_pool_get_manual_entry_tips","summary":"Grabs manual entry tips for a tip pool","description":"GET /v2/company/{company_id}/tip_pool/{tip_pool_settings_uuid}/manual_entry","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"The company ID for the target tip pool settings","schema":{"type":"integer","description":"The company ID for the target tip pool settings"}},{"name":"tip_pool_settings_uuid","in":"query","required":true,"description":"The tip pool settings uuid","schema":{"type":"string","description":"The tip pool settings uuid"}},{"name":"start_date","in":"query","required":true,"description":"The start date of the manual entry query range","schema":{"type":"string","description":"The start date of the manual entry query range"}},{"name":"end_date","in":"query","required":true,"description":"The end date of the manual entry query range","schema":{"type":"string","description":"The end date of the manual entry query range"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/tip-pool-save-manual-entry":{"post":{"operationId":"business_7_shifts_tip_pool_save_manual_entry","summary":"Saves manual entries for a tip pool","description":"PUT /v2/company/{company_id}/tip_pool/{tip_pool_settings_uuid}/manual_entry","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","tip_pool_settings_uuid","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"The company ID for the target tip pool settings"},"tip_pool_settings_uuid":{"type":"string","description":"The tip pool settings uuid"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/tip-pool-get-summary-report":{"get":{"operationId":"business_7_shifts_tip_pool_get_summary_report","summary":"Retreive Tip Pool Summary Report","description":"GET /v2/company/{company_id}/locations/{location_id}/tip_pool_summary_report","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"location_id","in":"query","required":true,"description":"Location ID","schema":{"type":"integer","description":"Location ID"}},{"name":"tip_pool_uuid","in":"query","required":false,"description":"The tip pool UUID, when omitted the report will return all tip pools","schema":{"type":"string","description":"The tip pool UUID, when omitted the report will return all tip pools"}},{"name":"day_part_uuid","in":"query","required":false,"description":"Daypart UUID, when omitted the report will return all dayparts","schema":{"type":"string","description":"Daypart UUID, when omitted the report will return all dayparts"}},{"name":"start_date","in":"query","required":true,"description":"The start date in YYYY-MM-DD format","schema":{"type":"string","description":"The start date in YYYY-MM-DD format"},"example":"2020-12-25"},{"name":"end_date","in":"query","required":true,"description":"The end date in YYYY-MM-DD format","schema":{"type":"string","description":"The end date in YYYY-MM-DD format"},"example":"2020-12-25"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/tip-pool-get-detailed-report":{"get":{"operationId":"business_7_shifts_tip_pool_get_detailed_report","summary":"Retreive Tip Pool Detailed Report","description":"GET /v2/company/{company_id}/locations/{location_id}/tip_pool_detailed_report","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"location_id","in":"query","required":true,"description":"Location ID","schema":{"type":"integer","description":"Location ID"}},{"name":"tip_pool_uuid","in":"query","required":false,"description":"The tip pool UUID, when omitted the report will return all tip pools","schema":{"type":"string","description":"The tip pool UUID, when omitted the report will return all tip pools"}},{"name":"day_part_uuid","in":"query","required":false,"description":"Daypart UUID, when omitted the report will return all dayparts","schema":{"type":"string","description":"Daypart UUID, when omitted the report will return all dayparts"}},{"name":"start_date","in":"query","required":true,"description":"The start date in YYYY-MM-DD format","schema":{"type":"string","description":"The start date in YYYY-MM-DD format"},"example":"2020-12-25"},{"name":"end_date","in":"query","required":true,"description":"The end date in YYYY-MM-DD format","schema":{"type":"string","description":"The end date in YYYY-MM-DD format"},"example":"2020-12-25"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/day-part-get-settings":{"get":{"operationId":"business_7_shifts_day_part_get_settings","summary":"Retrieve day part settings","description":"GET /v2/company/{company_id}/day_part/settings","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"location_id","in":"query","required":false,"description":"Location ID - null will fetch all day parts for company","schema":{"type":"integer","description":"Location ID - null will fetch all day parts for company"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/availability-list-availabilities":{"get":{"operationId":"business_7_shifts_availability_list_availabilities","summary":"List Availabilities","description":"GET /v2/company/{company_id}/availabilities","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number results desired per page.","schema":{"type":"integer","default":100,"description":"The number results desired per page."}},{"name":"location_id","in":"query","required":false,"description":"Location ID","schema":{"type":"integer","description":"Location ID"},"example":1234},{"name":"user_id","in":"query","required":false,"description":"User ID","schema":{"type":"integer","description":"User ID"},"example":1234},{"name":"status","in":"query","required":false,"description":"Return availabilities for a specified status (pending = 0, approved = 1, declined = 2).","schema":{"type":"integer","description":"Return availabilities for a specified status (pending = 0, approved = 1, declined = 2)."}},{"name":"repeating","in":"query","required":false,"description":"Return repeating or weekly availabilities.","schema":{"type":"boolean","description":"Return repeating or weekly availabilities."}},{"name":"week_gte","in":"query","required":false,"description":"Return availabilities for a specific week.","schema":{"type":"string","description":"Return availabilities for a specific week."}},{"name":"week_to_include_repeating_gte","in":"query","required":false,"description":"Return repeating availabilities that end before or on a specified week.","schema":{"type":"string","description":"Return repeating availabilities that end before or on a specified week."}},{"name":"order_field","in":"query","required":false,"description":"The field that availabilities will be sorted by.","schema":{"type":"string","description":"The field that availabilities will be sorted by."}},{"name":"order_dir","in":"query","required":false,"description":"The direction that availabilities will be sorted by.","schema":{"type":"string","description":"The direction that availabilities will be sorted by."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/availability-create-new":{"post":{"operationId":"business_7_shifts_availability_create_new","summary":"Create Availability","description":"POST /v2/company/{company_id}/availabilities","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/availability-get-by-id":{"get":{"operationId":"business_7_shifts_availability_get_by_id","summary":"Retrieve Availability","description":"GET /v2/company/{company_id}/availabilities/{availability_id}","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"availability_id","in":"query","required":true,"description":"Availability ID","schema":{"type":"integer","description":"Availability ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/availability-update-by-id":{"post":{"operationId":"business_7_shifts_availability_update_by_id","summary":"Update Availability","description":"PUT /v2/company/{company_id}/availabilities/{availability_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","availability_id","body"],"properties":{"company_id":{"type":"integer","description":"Company ID"},"availability_id":{"type":"integer","description":"Availability ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/availability-remove-by-id":{"post":{"operationId":"business_7_shifts_availability_remove_by_id","summary":"Delete Availability","description":"DELETE /v2/company/{company_id}/availabilities/{availability_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","availability_id"],"properties":{"company_id":{"type":"integer","description":"Company ID"},"availability_id":{"type":"integer","description":"Availability ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/availability-update-status":{"post":{"operationId":"business_7_shifts_availability_update_status","summary":"Update Availability Status","description":"PUT /v2/company/{company_id}/availabilities/{availability_id}/status","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","availability_id"],"properties":{"company_id":{"type":"integer","description":"Company ID"},"availability_id":{"type":"integer","description":"Availability ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/availability-list-reasons":{"get":{"operationId":"business_7_shifts_availability_list_reasons","summary":"List Availability Reasons","description":"GET /v2/company/{company_id}/availability_reasons","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number results desired per page.","schema":{"type":"integer","default":100,"description":"The number results desired per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/availability-create-reason":{"post":{"operationId":"business_7_shifts_availability_create_reason","summary":"Create Availability Reason","description":"POST /v2/company/{company_id}/availability_reasons","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/availability-update-reason-by-id":{"post":{"operationId":"business_7_shifts_availability_update_reason_by_id","summary":"Update Availability Reason","description":"PUT /v2/company/{company_id}/availability_reasons/{availability_reason_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","availability_reason_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"availability_reason_id":{"type":"integer","description":"Availability Reason ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/availability-delete-reason":{"post":{"operationId":"business_7_shifts_availability_delete_reason","summary":"Delete Availability Reason","description":"DELETE /v2/company/{company_id}/availability_reasons/{availability_reason_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","availability_reason_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"availability_reason_id":{"type":"integer","description":"Availability Reason ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-off-list":{"get":{"operationId":"business_7_shifts_time_off_list","summary":"List Time Off","description":"GET /v2/time_off","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":8655},{"name":"location_id","in":"query","required":false,"description":"Location ID","schema":{"type":"integer","description":"Location ID"},"example":1540},{"name":"user_id","in":"query","required":false,"description":"User ID","schema":{"type":"integer","description":"User ID"},"example":1122554},{"name":"status","in":"query","required":false,"description":"Status","schema":{"type":"integer","description":"Status"},"example":1},{"name":"category","in":"query","required":false,"description":"Category","schema":{"type":"string","enum":["paid","unpaid","paid_sick"],"description":"Category"},"example":"paid"},{"name":"to_date_gte","in":"query","required":false,"description":"Return time offs that end after a specified date.","schema":{"type":"string","description":"Return time offs that end after a specified date."}},{"name":"sort_by","in":"query","required":false,"description":"Sort by column","schema":{"type":"string","enum":["created","from_date"],"description":"Sort by column"},"example":"created"},{"name":"sort_dir","in":"query","required":false,"description":"Sort by direction (asc, desc)","schema":{"type":"string","enum":["asc","desc"],"description":"Sort by direction (asc, desc)"},"example":"asc"},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","description":"The number of results desired per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-off-create-request":{"post":{"operationId":"business_7_shifts_time_off_create_request","summary":"Create time off","description":"POST /v2/time_off","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-off-get-time-off-by-id":{"get":{"operationId":"business_7_shifts_time_off_get_time_off_by_id","summary":"Retrieve Time Off","description":"GET /v2/time_off/{time_off_id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"time_off_id","in":"query","required":true,"description":"Time Off ID","schema":{"type":"integer","description":"Time Off ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-off-update-time-off-by-id":{"post":{"operationId":"business_7_shifts_time_off_update_time_off_by_id","summary":"Update Time Off","description":"PATCH /v2/time_off/{time_off_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["time_off_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"time_off_id":{"type":"integer","description":"Time Off ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-off-remove":{"post":{"operationId":"business_7_shifts_time_off_remove","summary":"Delete Time Off","description":"DELETE /v2/time_off/{time_off_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["time_off_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"time_off_id":{"type":"integer","description":"Time Off ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-off-approve-request":{"post":{"operationId":"business_7_shifts_time_off_approve_request","summary":"Approve Time Off Request","description":"POST /v2/time_off/{time_off_id}/approve","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["time_off_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"time_off_id":{"type":"integer","description":"Time Off ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-off-decline-request":{"post":{"operationId":"business_7_shifts_time_off_decline_request","summary":"Decline Time Off Request","description":"POST /v2/time_off/{time_off_id}/decline","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["time_off_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"time_off_id":{"type":"integer","description":"Time Off ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-off-get-total-hours":{"get":{"operationId":"business_7_shifts_time_off_get_total_hours","summary":"Retrieve Time Off Hours","description":"GET /v2/time_off/total_hours","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":8655},{"name":"employee_id","in":"query","required":true,"description":"Employee IDs","schema":{"type":"array","description":"Employee IDs"},"example":"?employee_id=3&employee_id=4&employee_id=5"},{"name":"date_start","in":"query","required":true,"description":"An ISO 8601 date string","schema":{"type":"string","description":"An ISO 8601 date string"},"example":"2019-11-05T12:32:00-08:00:00"},{"name":"date_end","in":"query","required":true,"description":"An ISO 8601 date string","schema":{"type":"string","description":"An ISO 8601 date string"},"example":"2019-11-05T12:32:00-08:00:00"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-off-get-settings":{"get":{"operationId":"business_7_shifts_time_off_get_settings","summary":"Retrieve Time Off Settings","description":"GET /v2/time_off_settings/{company_id}","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/time-off-set-time-off-settings":{"post":{"operationId":"business_7_shifts_time_off_set_time_off_settings","summary":"Create Time Off Settings","description":"POST /v2/time_off_settings/{company_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id"],"properties":{"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/shift-feedback-list":{"get":{"operationId":"business_7_shifts_shift_feedback_list","summary":"List Shift Feedback","description":"GET /v2/company/{company_id}/shift_feedback","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":384},{"name":"start_date","in":"query","required":true,"description":"The start date of the range you want shift feedback for","schema":{"type":"string","description":"The start date of the range you want shift feedback for"},"example":"2023-01-01"},{"name":"end_date","in":"query","required":true,"description":"The end date of the range you want shift feedback for (inclusive)","schema":{"type":"string","description":"The end date of the range you want shift feedback for (inclusive)"},"example":"2023-01-01"},{"name":"location_id","in":"query","required":false,"description":"Location ID","schema":{"type":"integer","description":"Location ID"},"example":408},{"name":"user_id","in":"query","required":false,"description":"User ID","schema":{"type":"integer","description":"User ID"},"example":1007790},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","description":"The number of results desired per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/engage-overview-by-location-id":{"get":{"operationId":"business_7_shifts_engage_overview_by_location_id","summary":"Retrieve Engagement Overview","description":"GET /v2/company/{company_id}/locations/{location_id}/engage_overview","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":384},{"name":"location_id","in":"query","required":true,"description":"Location ID","schema":{"type":"integer","description":"Location ID"},"example":408},{"name":"date","in":"query","required":true,"description":"A date with YYYY-MM-DD format","schema":{"type":"string","description":"A date with YYYY-MM-DD format"},"example":"2022-11-22"},{"name":"frequency","in":"query","required":false,"description":"Length of the engage data set","schema":{"type":"string","enum":["week","month"],"description":"Length of the engage data set"},"example":"week"},{"name":"user_type","in":"query","required":false,"description":"select user type for engage data","schema":{"type":"string","enum":["employees","managers","assistant_managers"],"description":"select user type for engage data"},"example":"managers"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/webhooks-list":{"get":{"operationId":"business_7_shifts_webhooks_list","summary":"List Webhooks","description":"GET /v2/company/{company_id}/webhooks","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"modified_since","in":"query","required":false,"description":"Return webhooks that have been modified since the specified date. Format YYYY-MM-DD","schema":{"type":"string","description":"Return webhooks that have been modified since the specified date. Format YYYY-MM-DD"},"example":"2020-01-01"},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","description":"The number of results desired per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/webhooks-create":{"post":{"operationId":"business_7_shifts_webhooks_create","summary":"Create Webhook","description":"POST /v2/company/{company_id}/webhooks","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/webhooks-update":{"post":{"operationId":"business_7_shifts_webhooks_update","summary":"Update Webhook","description":"PUT /v2/company/{company_id}/webhooks/{webhook_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","webhook_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"webhook_id":{"type":"integer","description":"Webhook ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/webhooks-delete-webhook-by-id":{"post":{"operationId":"business_7_shifts_webhooks_delete_webhook_by_id","summary":"Delete Webhook","description":"DELETE /v2/company/{company_id}/webhooks/{webhook_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","webhook_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"webhook_id":{"type":"integer","description":"Webhook ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/webhooks-get-webhook":{"get":{"operationId":"business_7_shifts_webhooks_get_webhook","summary":"Test Webhook","description":"GET /v2/company/{company_id}/test_webhook","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"},"example":1234},{"name":"topic","in":"query","required":true,"description":"topic for the sample payload","schema":{"type":"string","description":"topic for the sample payload"},"example":"user.modified"},{"name":"webhook_id","in":"query","required":false,"description":"Webhook ID","schema":{"type":"integer","description":"Webhook ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/integration-mappings-list-sales-category-mappings":{"get":{"operationId":"business_7_shifts_integration_mappings_list_sales_category_mappings","summary":"List Sales Category Mappings","description":"GET /v2/company/{company_id}/location/{location_id}/sales_category_mappings","tags":["business"],"parameters":[{"name":"x-api-version","in":"query","required":false,"description":"7shifts API version","schema":{"type":"string","description":"7shifts API version"}},{"name":"x-company-guid","in":"query","required":false,"description":"Company GUID","schema":{"type":"string","description":"Company GUID"},"example":"1310bfe1-cb3f-4f24-98a2-fde2bc504108"},{"name":"company_id","in":"query","required":true,"description":"Company ID","schema":{"type":"integer","description":"Company ID"}},{"name":"location_id","in":"query","required":true,"description":"Location ID","schema":{"type":"integer","description":"Location ID"}},{"name":"department_id","in":"query","required":true,"description":"Department ID","schema":{"type":"integer","description":"Department ID"}},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next or previous page of results.","schema":{"type":"string","description":"Cursor for the next or previous page of results."}},{"name":"limit","in":"query","required":false,"description":"The number of results desired per page.","schema":{"type":"integer","description":"The number of results desired per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:7-shifts/integration-mappings-create-sales-category-mappings-bulk":{"post":{"operationId":"business_7_shifts_integration_mappings_create_sales_category_mappings_bulk","summary":"Create Sales Category Mappings","description":"POST /v2/company/{company_id}/location/{location_id}/sales_category_mappings_bulk","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","location_id","department_id","body"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"location_id":{"type":"integer","description":"Location ID"},"department_id":{"type":"integer","description":"Department ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:7-shifts/integration-mappings-delete-sales-category-mappings":{"post":{"operationId":"business_7_shifts_integration_mappings_delete_sales_category_mappings","summary":"Delete Sales Category Mappings","description":"DELETE /v2/company/{company_id}/location/{location_id}/sales_category_mappings/{external_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","location_id","external_id","department_id"],"properties":{"x-api-version":{"type":"string","description":"7shifts API version"},"x-company-guid":{"type":"string","description":"Company GUID"},"company_id":{"type":"integer","description":"Company ID"},"location_id":{"type":"integer","description":"Location ID"},"external_id":{"type":"string","description":"External Category ID"},"department_id":{"type":"integer","description":"Department ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}