SmartHR

SmartHR API v1

The full SmartHR REST API v1 reference (58 paths, 114 operations) covering crews, departments, employment types, custom field templates, dependents, payrolls, tax withholdings, batch jobs and users.

GitHub OpenAPI

Operations 114

GET /v1/dependent_custom_field_templates リストの取得 #
GET /v1/crew_custom_field_template_groups/{id} 取得 #
PUT /v1/crew_custom_field_template_groups/{id} 更新 #
PATCH /v1/crew_custom_field_template_groups/{id} 部分更新 #
DELETE /v1/crew_custom_field_template_groups/{id} 削除 #
GET /v1/crew_custom_field_template_groups リスト取得 #
POST /v1/crew_custom_field_template_groups 登録 #
GET /v1/crew_custom_field_templates リストの取得 #
POST /v1/crew_custom_field_templates 登録 #
GET /v1/crew_custom_field_templates/{id} 取得 #
PUT /v1/crew_custom_field_templates/{id} 更新 #
PATCH /v1/crew_custom_field_templates/{id} 部分更新 #
DELETE /v1/crew_custom_field_templates/{id} 削除 #
GET /v1/batch_jobs リストの取得 #
GET /v1/batch_jobs/{id} 取得 #
POST /v1/batch_jobs/job_types/crew_export 従業員情報ダウンロードの登録 #
POST /v1/batch_jobs/job_types/crew_import 従業員一括登録・更新の登録 #
POST /v1/batch_jobs/job_types/dependent_import 家族情報一括更新の登録 #
GET /v1/batch_job_attachments/{id}/file ファイル取得 #
GET /v1/mail_formats リストの取得 #
GET /v1/mail_formats/{id} 取得 #
GET /v1/users リストの取得 #
GET /v1/users/{id} 取得 #
GET /v1/users/{id}/saml_user SAML SSOアカウントを取得 #
POST /v1/users/{id}/saml_user SAML SSOアカウントの作成 #
PATCH /v1/users/{id}/saml_user SAML SSOアカウントを更新 #
DELETE /v1/users/{id}/saml_user SAML SSOアカウントを削除 #
PATCH /v1/users/{id}/saml_user/enable SAML SSOアカウントを有効に変更 #
PATCH /v1/users/{id}/saml_user/disable SAML SSOアカウントを無効に変更 #
GET /v1/biz_establishments リストの取得 #
GET /v1/companies リストの取得 #
GET /v1/bank_account_settings リストの取得 #
GET /v1/crews/{crew_id}/dependents リストの取得 #
POST /v1/crews/{crew_id}/dependents 登録 #
GET /v1/crews/{crew_id}/dependents/{id} 取得 #
PUT /v1/crews/{crew_id}/dependents/{id} 更新 #
PATCH /v1/crews/{crew_id}/dependents/{id} 部分更新 #
DELETE /v1/crews/{crew_id}/dependents/{id} 削除 #
GET /v1/job_titles/{id} 取得 #
PUT /v1/job_titles/{id} 更新 #
PATCH /v1/job_titles/{id} 部分更新 #
DELETE /v1/job_titles/{id} 削除 #
GET /v1/job_titles リストの取得 #
POST /v1/job_titles 作成 #
GET /v1/crews リストの取得 #
POST /v1/crews 登録 #
GET /v1/crews/{id} 取得 #
PUT /v1/crews/{id} 更新 #
PATCH /v1/crews/{id} 部分更新 #
DELETE /v1/crews/{id} 削除 #
PUT /v1/crews/{id}/invite 招待 #
DELETE /v1/crews/{crew_id}/departments 部署情報の削除 #
GET /v1/crew_input_forms リストの取得 #
GET /v1/crew_input_forms/{id} 取得 #
GET /v1/recruitment_types/{id} 取得 #
PUT /v1/recruitment_types/{id} 更新 #
PATCH /v1/recruitment_types/{id} 部分更新 #
DELETE /v1/recruitment_types/{id} 削除 #
GET /v1/recruitment_types リストの取得 #
POST /v1/recruitment_types 作成 #
GET /v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips リストの取得 #
POST /v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips 登録 #
GET /v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips/{id} 取得 #
PUT /v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips/{id} 更新 #
PATCH /v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips/{id} 部分更新 #
DELETE /v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips/{id} 削除 #
GET /v1/tax_withholdings リストの取得 #
POST /v1/tax_withholdings 登録 #
GET /v1/tax_withholdings/{id} 取得 #
PUT /v1/tax_withholdings/{id} 更新 #
PATCH /v1/tax_withholdings/{id} 部分更新 #
DELETE /v1/tax_withholdings/{id} 削除 #
GET /v1/crews/{crew_id}/maternity_childcare_leaves リストの取得 #
GET /v1/grades/{id} 取得 #
PUT /v1/grades/{id} 更新 #
PATCH /v1/grades/{id} 部分更新 #
DELETE /v1/grades/{id} 削除 #
GET /v1/grades リストの取得 #
POST /v1/grades 作成 #
GET /v1/payment_periods リストの取得 #
GET /v1/payment_periods/{id} 取得 #
GET /v1/payrolls/{payroll_id}/payslips リストの取得 #
POST /v1/payrolls/{payroll_id}/payslips 登録 #
GET /v1/payrolls/{payroll_id}/payslips/{id} 取得 #
DELETE /v1/payrolls/{payroll_id}/payslips/{id} 削除 #
POST /v1/payrolls/{payroll_id}/payslips/bulk 一括登録 #
GET /v1/payrolls リストの取得 #
POST /v1/payrolls 登録 #
GET /v1/payrolls/{id} 取得 #
PATCH /v1/payrolls/{id} 部分更新 #
DELETE /v1/payrolls/{id} 削除 #
PATCH /v1/payrolls/{id}/fix 確定処理 #
PATCH /v1/payrolls/{id}/unfix 確定解除処理 #
PATCH /v1/payrolls/{id}/publish 公開処理 #
GET /v1/dependent_relations リストの取得 #
GET /v1/job_categories/{id} 取得 #
PUT /v1/job_categories/{id} 更新 #
PATCH /v1/job_categories/{id} 部分更新 #
DELETE /v1/job_categories/{id} 削除 #
GET /v1/job_categories リストの取得 #
POST /v1/job_categories 作成 #
GET /v1/departments リストの取得 #
POST /v1/departments 登録 #
GET /v1/departments/{id} 取得 #
PUT /v1/departments/{id} 更新 #
PATCH /v1/departments/{id} 部分更新 #
DELETE /v1/departments/{id} 削除 #
POST /v1/departments/{id}/discontinue 廃止 #
GET /v1/employment_types リストの取得 #
POST /v1/employment_types 登録 #
GET /v1/employment_types/{id} 取得 #
PUT /v1/employment_types/{id} 更新 #
PATCH /v1/employment_types/{id} 部分更新 #
DELETE /v1/employment_types/{id} 削除 #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/authentication/kufu-authentication.yml
📖
Documentation
https://developer.smarthr.jp/api
📖
APIReference
https://developer.smarthr.jp/api
📖
GettingStarted
https://developer.smarthr.jp/api/about_api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/openapi/kufu-default-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/asyncapi/kufu-smarthr-webhooks.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/conventions/kufu-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/errors/kufu-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/data-model/kufu-data-model.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/sandbox/kufu-sandbox.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/lifecycle/kufu-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/conformance/kufu-conformance.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/llms/kufu-llms.txt
🔗
ChangeLog
https://support.smarthr.jp/ja/release-notes/api/page/1/

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/kufu-default-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

OpenAPI Specification

kufu-default-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SmartHR カスタム家族項目テンプレート API
  description: SmartHR の各種データを操作する API です
  license:
    name: SmartHR, Inc
  version: 0.0.1
servers:
- url: https://app.smarthr.jp/api
tags:


# --- truncated at 32 KB (336 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/openapi/kufu-default-api-openapi.yml