How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Harri Franchisee Employee API

The Franchisee Employee API from Harri — 6 operation(s) for franchisee employee.

Harri Franchisee Employee API is one of 78 APIs that Harri publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Franchisee Employee. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 6 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://gateway.harri.com/open-api-hub.

6 operations 6 paths 37 schemas 4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://gateway.harri.com/open-api-hub
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Harri Franchisee Employee API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow.

Paths & Operations 6

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

Franchisee Employee 6
GET
/api/v3/franchisees/{franchiseeId}/employees
Get employees API
FranshiseesGetEmployees 9 params → 200
PUT
/api/v3/franchisees/{franchiseeId}/employees/{employeeId}/basic_info
Update employee API
FranshiseesUpdateEmployee 2 params body → 200
GET
/api/v4/franchisees/{franchiseeId}/employees/
Get employees API
FranchiseesListEmployeesV4 9 params → 200
GET
/api/v5/franchisees/{franchiseeId}/employees/{employeeId}/profile
Get employee profile API
FranchiseesGetEmployeeProfileV5 2 params → 200400404
GET
/api/v6/franchisees/{franchiseeId}/employees/{employeeId}
Get employee by id API
FranchiseesGetEmployeeByIdV6 2 params → 200400404
POST
/api/v7/franchisees/{franchiseeId}/employees
Create employee API
FranchiseesCreateEmployeeV7 1 param body → 200

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are EmployeeCustomFieldsPersonalInfoAdditionalInfo (21 properties), EmployeeCustomFieldsFederalWithholdingDetails (17 properties), EmployeeCustomFieldsEmploymentInfoAdditionalInfo (17 properties), EmployeeCustomFieldsEqualOpportunityInformation (14 properties). Each schema is shown below with its type and property counts.

EmployeeProfileV2
TroncPoint
object
3 properties
AnnualRate
object
3 properties
EmploymentPeriod
object
4 properties
EmployeeCustomFieldsFederalWithholdingDetails
object
Section 4 - Federal Withholding Details - FEDERALWITHHOLDINGDETAILS
17 properties
CreatedEmployeeV7
MaxWeeklyHoursV4
object
Max Weekly Hours entry (v4+ shape) exposing a list of workingpatterns and the derived averageweeklyhours.
4 properties
PayType
object
4 properties
EmployeeCustomFieldsPayrollTaxesAdditionalInfo
object
Section 7 - Additional Information - PAYROLLTAXESADDITIONALINFO
7 properties
EmployeeCustomFieldsPayrollTaxesPensionInformation
object
Section 9 - Pension Information - PAYROLLTAXESPENSIONINFORMATION
9 properties
EmployeePosition
CostCenter
object
4 properties
EmployeesListV3
EmployeeJobTitle
object
MaxWeeklyHoursV2
object
4 properties
EmployeeCustomFieldsStateWithholdingDetails
object
Section 5 - State Withholding Details - STATEWITHHOLDINGDETAILS
11 properties
EmployeeCustomFieldsEqualOpportunityInformation
object
Section 8 - Equal Opportunity Information - EQUALOPPORTUNITYINFORMATION
14 properties
EmployeeCustomFieldsEmploymentInfoAdditionalInfo
object
Section 3 - Additional Information - EMPLOYMENTINFOADDITIONALINFO
17 properties
TroncAmount
object
3 properties
EmployeeCustomFieldsCityWithholdingDetails
object
Section 6 - City Withholding Details - CITYWITHHOLDINGDETAILS
4 properties
WorkingPatternDaysV2
object
3 properties
Address
object
6 properties
TippedStatus
object
3 properties
LocationPeriod
object
4 properties
EmployeeCustomFieldsPersonalInfoAdditionalInfo
object
Section 1 - Additional Information - PERSONALINFOADDITIONALINFO
21 properties
WorkingPatternDays
object
3 properties
EmployeesListV2
HourlyRate
object
6 properties
Position
object
3 properties
WorkingPatternV2
object
5 properties
EmployeeCustomFieldsEmergencyContact
object
Section 2 - Emergency Contact - EMERGENCYCONTACT
6 properties
EmployeeBasicInfo
object
11 properties
Location
object
5 properties
JobTitle
object
4 properties
WorkingPatternV4
object
A single working pattern as returned in v4+ Max Weekly Hours responses. Each entry carries its own totalhours and order.
5 properties
EmployeeAggregatedInfoV6
EmployeeCustomFieldsLocalWithholdingDetails
object
Local Withholding Details - LOCALWITHHOLDINGDETAILS
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harri-franchisee-employee-api-openapi.yml Raw ↑

Other APIs Harri publishes across the network.

Harri Absences API
Harri Annual Rates API
Harri Bank Accounts API
Harri Corporate Users API
Harri Cost Centers API
Harri Deprecated AnnualRates API
Harri Deprecated BankAccounts API
Harri Deprecated Employee API
Harri Deprecated EmployeeLocation API
Harri Deprecated EmployeePositions API
Harri Deprecated Employment API
Harri Deprecated Event API
Where this information came from

This is an independent, third-party profile of Harri Franchisee Employee API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.