# SmartHR API v1

**Canonical:** https://apis.io/apis/smarthr/kufu-default-api/  
**Provider:** SmartHR — https://apis.io/providers/smarthr/  
**Base URL:** https://app.smarthr.jp/api/v1  
**Documentation:** https://developer.smarthr.jp/api

SmartHR API v1 is one of 7 APIs that [SmartHR](https://apis.io/providers/smarthr/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, API documentation, an API reference, a getting-started guide, and a changelog.

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.

## Operations (60 of 114)

| Method | Path | Summary |
|---|---|---|
| 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` | 作成 |

…and 54 more operations. They are listed in full on the page.

## Machine-readable artifacts (14)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/openapi/kufu-default-api-openapi.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/asyncapi/kufu-smarthr-webhooks.yml
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/smarthr/refs/heads/main/authentication/kufu-authentication.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
- **Documentation** — https://developer.smarthr.jp/api
- **APIReference** — https://developer.smarthr.jp/api
- **GettingStarted** — https://developer.smarthr.jp/api/about_api
- **ChangeLog** — https://support.smarthr.jp/ja/release-notes/api/page/1/

## Other SmartHR APIs (6)

- [SmartHR Business Establishments API](https://apis.io/apis/smarthr/smarthr-business-establishments-api/)
- [SmartHR Crews API](https://apis.io/apis/smarthr/smarthr-crews-api/)
- [SmartHR Custom Field Templates API](https://apis.io/apis/smarthr/smarthr-custom-field-templates-api/)
- [SmartHR Departments API](https://apis.io/apis/smarthr/smarthr-departments-api/)
- [SmartHR Employment Types API](https://apis.io/apis/smarthr/smarthr-employment-types-api/)
- [SmartHR Webhooks API](https://apis.io/apis/smarthr/smarthr-webhooks-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/smarthr/kufu-default-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/smarthr/.