SmartHR

SmartHR is a leading Japanese cloud HR, labor, and personnel management SaaS (smarthr.jp). Its per-tenant REST API exposes an organization's employee ("crew") records and the master data around them - departments, employment types, business establishments, and custom field templates - plus webhook subscriptions for change notifications. The API is served from each customer's own tenant subdomain (https://{tenant}.smarthr.jp/api) under a /v1 path, and is authenticated with a per-tenant access token passed as a Bearer token.

SmartHR publishes 7 API contracts indexed on the APIs.io network, including Business Establishments API, Crews API, Custom Field Templates API, and 4 more. Tagged areas include Human Resources, HRIS, Labor Management, Payroll, and Japan.

The SmartHR catalog on APIs.io includes 1 event-driven AsyncAPI specification and 1 Spectral governance ruleset.

SmartHR’s developer surface includes authentication, documentation, and 9 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

41.2/100 developing ▬ flat Agent 27/100 agent aware Front door AI 1/6 silent Heartbeat 91/100 alive saas Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →

AccessFreemiumSelf serve⚡ Free to try

2 published contracts

Human Resources HRISLabor ManagementPayroll Japan EmployeesPersonnelOnboarding Software-as-a-Service

What this lets a business do 2

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Human Capital Management

BC-300

CrewsDepartmentsEmployment Typesカスタム家族項目テンプレート

GET /v1/crew_custom_field_templates PATCH /v1/tax_withholdings/{id}

Developer Platform & API Ecosystem Management

BC-4270

Webhooks

Kin Score

Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0

Composite quality — 41.2/100 · developing

Contract Quality 11.8 / 19

Developer Ergonomics 7.3 / 15

Access Clarity 1.2 / 15

Operational Transparency 3.3 / 10

Contract Governance 1.6 / 9

Discoverability 5.5 / 8

Regulatory Posture 3.7 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 27/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 0 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 6 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 0 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Employment & Payroll regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/smarthr/"><img src="https://apis.io/badge/smarthr/card.svg" alt="SmartHR on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Request/Response Examples +7 pts — share of operations carrying request/response examples; else an Examples / Code Samples link
Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document
Delegated User Identity +6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented)

8 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Access Clarity scores 7.9 — up to +18.4 composite points
Developer Ergonomics scores 48.8 — up to +10.2 composite points
Contract Governance scores 18.2 — up to +9.8 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/smarthr/apis.yml: open an issue on github.com/api-evangelist/smarthr to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Zoom App Marketplace and Partner Ecosystem (builders and partners on Zoom)	builds-on	19.7 (thin)	-	1
Japan ISMAP Cloud Security Assessments (TISAX unreadable)	builds-on	19.7 (thin)	-	1

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 1

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

OpenAPI

measured — observed by APIs.io (published)

APIs 7

Individual APIs this provider publishes, each with its own machine-readable definition.

SmartHR Business Establishments API

Business establishments (jigyosho) registered for the tenant.

SmartHR Crews API

Employee ("crew") records - the core personnel objects in SmartHR.

SmartHR Custom Field Templates API

Templates defining custom fields attached to crew records.

SmartHR Departments API

Organizational departments that crews belong to.

SmartHR Employment Types API

Employment type master data (full-time, part-time, contract, etc.).

SmartHR Webhooks API

Webhook subscriptions that notify external systems of changes.

SmartHR カスタム家族項目テンプレート API

カスタム家族項目テンプレートを操作します

Scroll for all 7

Open Collections 7

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

SmartHR Business Establishments API

OPEN COLLECTION

SmartHR Business Establishments Crews API

OPEN COLLECTION

SmartHR Business Establishments Custom Field Templates API

OPEN COLLECTION

SmartHR Business Establishments Departments API

OPEN COLLECTION

SmartHR Business Establishments Employment Types API

OPEN COLLECTION

SmartHR Business Establishments Webhooks API

OPEN COLLECTION

SmartHR API

OPEN COLLECTION

Scroll for all 7

SmartHR API pricing

Not yet checked against SmartHR's own pricing page. Compiled by API Evangelist on 2026-07-12 from smarthr.jp/pricing/; confirm before you rely on a figure. A free plan or tier is listed.

Plan	Price
¥0 Plan (Free) free	Free
Labor / HR Administration paid	—
Talent Management paid	—
HR Strategy (Combined) enterprise	—

Plan details, limits and sources →

Rate limits

Per Access Token (hourly): 5000 requests
Per Access Token (per second): 10 requests
Per Subdomain: 50000 requests

Compiled by API Evangelist, not yet checked against SmartHR's documentation. All 4 limits →

Pricing Plans 1

Published pricing tiers and plan structures.

Smarthr Plans Pricing

4 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Smarthr Rate Limits

4 limits

RATE LIMITS

Service Levels 1

Uptime the provider promises or reports, as SLA4OAI. Read from its own pages; APIs.io runs no monitors.

SmartHR

SLA

FinOps 1

Cost, billing, and metering signals for API financial operations.

Smarthr Finops

FINOPS

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Kufu Smarthr Webhooks

ASYNCAPI

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

SmartHR API Rules

68 rules · 57 errors 5 warnings 6 info

SPECTRAL

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Kufu Authentication

2 schemes

SECURITY

Smarthr Authentication

http · 1 scheme

SECURITY

Smarthr Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Smarthr Agentic Access

141 operations · 84 acting · 1 human-in-the-loop

141 operations · 84 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

Build 1

SDKs, sample code, and the tooling you integrate with

GitHubOrganization

GitHubOrganization

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity

DomainSecurity

Authentication

Authentication

Operate 1

Status, limits, changes, and where to get help

RateLimits

RateLimits

Commercial 2

Pricing, plans, and the legal terms of use

Plans

Plans

FinOps

FinOps

Company 2

The organization behind the API

LinkedIn

Website

Website

Other 1

Properties that don't map to a standard resource type

CapabilityMap

CapabilityMap

Source (apis.yml)

aid: smarthr
url: https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/apis.yml
name: SmartHR
kind: company
description: SmartHR is a leading Japanese cloud HR, labor, and personnel management SaaS (smarthr.jp). Its per-tenant REST
  API exposes an organization's employee ("crew") records and the master data around them - departments, employment types,
  business establishments, and custom field templates - plus webhook subscriptions for change notifications. The API is served
  from each customer's own tenant subdomain (https://{tenant}.smarthr.jp/api) under a /v1 path, and is authenticated with
  a per-tenant access token passed as a Bearer token.
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  gated: none
  gated_source:
  - onboarding
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  - security
  - sandbox
  generated: '2026-11-06'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/smarthr.png
tags:
- Human Resources
- HRIS
- Labor Management
- Payroll
- Japan
- Employees
- Personnel
- Onboarding
- Software-as-a-Service
tags_raw:
- HR
- Human Resources
- HRIS
- Labor Management
- Payroll
- Japan
- Employees
- Personnel
- Onboarding
- SaaS
created: '2026-07-12'
modified: '2026-07-12'
specificationVersion: '0.23'
apis:
- aid: smarthr:smarthr-business-establishments-api
  name: SmartHR Business Establishments API
  description: Business establishments (jigyosho) registered for the tenant.
  humanURL: https://developer.smarthr.jp/api
  baseURL: https://{tenant}.smarthr.jp/api
  tags:
  - Business Establishments
  properties:
  - type: OpenAPI
    url: openapi/smarthr-business-establishments-api-openapi.yml
  - type: Documentation
    url: https://developer.smarthr.jp/api/about_api
  - type: APIReference
    url: https://developer.smarthr.jp/api
  - type: PostmanCollection
    url: collections/smarthr.postman_collection.json
  - type: OpenCollection
    url: collections/smarthr.opencollection.json
  - type: Documentation
    url: https://developer.smarthr.jp/api/about_webhook
- aid: smarthr:smarthr-crews-api
  name: SmartHR Crews API
  description: Employee ("crew") records - the core personnel objects in SmartHR.
  humanURL: https://developer.smarthr.jp/api
  baseURL: https://{tenant}.smarthr.jp/api
  tags:
  - Crews
  properties:
  - type: OpenAPI
    url: openapi/smarthr-crews-api-openapi.yml
  - type: Documentation
    url: https://developer.smarthr.jp/api/about_api
  - type: APIReference
    url: https://developer.smarthr.jp/api
  - type: PostmanCollection
    url: collections/smarthr.postman_collection.json
  - type: OpenCollection
    url: collections/smarthr.opencollection.json
  - type: Documentation
    url: https://developer.smarthr.jp/api/about_webhook
- aid: smarthr:smarthr-custom-field-templates-api
  name: SmartHR Custom Field Templates API
  description: Templates defining custom fields attached to crew records.
  humanURL: https://developer.smarthr.jp/api
  baseURL: https://{tenant}.smarthr.jp/api
  tags:
  - Custom Field Templates
  properties:
  - type: OpenAPI
    url: openapi/smarthr-custom-field-templates-api-openapi.yml
  - type: Documentation
    url: https://developer.smarthr.jp/api/about_api
  - type: APIReference
    url: https://developer.smarthr.jp/api
  - type: PostmanCollection
    url: collections/smarthr.postman_collection.json
  - type: OpenCollection
    url: collections/smarthr.opencollection.json
  - type: Documentation
    url: https://developer.smarthr.jp/api/about_webhook
- aid: smarthr:smarthr-departments-api
  name: SmartHR Departments API
  description: Organizational departments that crews belong to.
  humanURL: https://developer.smarthr.jp/api
  baseURL: https://{tenant}.smarthr.jp/api
  tags:
  - Departments
  properties:
  - type: OpenAPI
    url: openapi/smarthr-departments-api-openapi.yml
  - type: Documentation
    url: https://developer.smarthr.jp/api/about_api
  - type: APIReference
    url: https://developer.smarthr.jp/api
  - type: PostmanCollection
    url: collections/smarthr.postman_collection.json
  - type: OpenCollection
    url: collections/smarthr.opencollection.json
  - type: Documentation
    url: https://developer.smarthr.jp/api/about_webhook
- aid: smarthr:smarthr-employment-types-api
  name: SmartHR Employment Types API
  description: Employment type master data (full-time, part-time, contract, etc.).
  humanURL: https://developer.smarthr.jp/api
  baseURL: https://{tenant}.smarthr.jp/api
  tags:
  - Employment Types
  properties:
  - type: OpenAPI
    url: openapi/smarthr-employment-types-api-openapi.yml
  - type: Documentation
    url: https://developer.smarthr.jp/api/about_api
  - type: APIReference
    url: https://developer.smarthr.jp/api
  - type: PostmanCollection
    url: collections/smarthr.postman_collection.json
  - type: OpenCollection
    url: collections/smarthr.opencollection.json
  - type: Documentation
    url: https://developer.smarthr.jp/api/about_webhook
- aid: smarthr:smarthr-webhooks-api
  name: SmartHR Webhooks API
  description: Webhook subscriptions that notify external systems of changes.
  humanURL: https://developer.smarthr.jp/api
  baseURL: https://{tenant}.smarthr.jp/api
  tags:
  - Webhook
  tags_raw:
  - Webhooks
  properties:
  - type: OpenAPI
    url: openapi/smarthr-webhooks-api-openapi.yml
  - type: Documentation
    url: https://developer.smarthr.jp/api/about_api
  - type: APIReference
    url: https://developer.smarthr.jp/api
  - type: PostmanCollection
    url: collections/smarthr.postman_collection.json
  - type: OpenCollection
    url: collections/smarthr.opencollection.json
  - type: Documentation
    url: https://developer.smarthr.jp/api/about_webhook
- aid: smarthr:smarthr-default-api
  name: SmartHR カスタム家族項目テンプレート API
  description: カスタム家族項目テンプレートを操作します
  humanURL: https://developer.smarthr.jp/api
  baseURL: https://{tenant}.smarthr.jp/api
  tags: []
  tags_raw:
  - カスタム家族項目テンプレート
  properties:
  - type: OpenAPI
    url: openapi/smarthr-default-api-openapi.yml
  - type: Webhooks
    url: asyncapi/kufu-smarthr-webhooks.yml
  - type: Authentication
    url: authentication/kufu-authentication.yml
  - type: Conventions
    url: conventions/kufu-conventions.yml
  - type: ErrorCatalog
    url: errors/kufu-problem-types.yml
  - type: DataModel
    url: data-model/kufu-data-model.yml
  - type: Sandbox
    url: sandbox/kufu-sandbox.yml
  - type: Lifecycle
    url: lifecycle/kufu-lifecycle.yml
  - type: Conformance
    url: conformance/kufu-conformance.yml
  - type: LLMsTxt
    url: llms/kufu-llms.txt
  - type: Documentation
    url: https://developer.smarthr.jp/api
  - type: APIReference
    url: https://developer.smarthr.jp/api
  - type: GettingStarted
    url: https://developer.smarthr.jp/api/about_api
  - type: ChangeLog
    url: https://support.smarthr.jp/ja/release-notes/api/page/1/
common:
- type: CapabilityMap
  url: capabilities/smarthr-capability-edges.yml
  name: SmartHR Business Capability Map
- type: AgenticAccess
  url: agentic-access/smarthr-agentic-access.yml
- type: DomainSecurity
  url: security/smarthr-domain-security.yml
- type: Authentication
  url: authentication/smarthr-authentication.yml
- type: GitHubOrganization
  url: https://github.com/kufu
- type: LinkedIn
  url: https://www.linkedin.com/company/smarthr
- type: Website
  url: https://smarthr.jp/
- type: Documentation
  url: https://developer.smarthr.jp/
- type: Plans
  url: plans/smarthr-plans-pricing.yml
- type: RateLimits
  url: rate-limits/smarthr-rate-limits.yml
- type: FinOps
  url: finops/smarthr-finops.yml
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
x-former-name: KUFU, Inc.

SmartHR API — frequently asked questions

Does SmartHR have an API?

Yes. APIs.io lists 7 APIs from SmartHR, including SmartHR Business Establishments API, SmartHR Crews API and SmartHR Custom Field Templates API, and 4 more.

Is there an OpenAPI specification for the SmartHR API?

Yes. APIs.io indexes 7 OpenAPI specifications for SmartHR, each linked for download from this page.

How do I authenticate with the SmartHR API?

SmartHR uses bearer-token authentication (2 schemes). The details are profiled on APIs.io as Kufu Authentication.

How much does the SmartHR API cost?

APIs.io lists 4 pricing plans for SmartHR, with each plan's price, limits and inclusions under Pricing on this page.

Is the SmartHR API ready for AI agents?

SmartHR has a Kin Score of 41.2 out of 100 (developing) and an Agent Readiness score of 27.1 (agent-aware), scored by API Evangelist on 2026-11-06.

Work with this as data

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

MCP server

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

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/smarthr"

All providers

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

Every operation they expose

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

How their score was established

curl "https://apis.io/api/v1/providers/smarthr/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

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

GitHub Google LinkedIn

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