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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
KUFU

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

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

Documentation Provider Profile APIs.io OpenAPI GitHub

KUFU カスタム家族項目テンプレート API is one of 2 APIs that KUFU publishes on the 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.

This API exposes 114 operations across 58 paths, and defines 104 schemas. It is described by OpenAPI 3.2.0, at version 0.0.1.

Requests are made against a single base URL, https://app.smarthr.jp/api.

114 operations 58 paths 104 schemas 16 DELETE46 GET19 PATCH20 POST13 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.1
Base URL
https://app.smarthr.jp/api/v1
License
SmartHR, Inc
Resource Areas
1

Paths & Operations 114

Across 58 paths, the API surfaces 114 operations — 16 DELETE, 46 GET, 19 PATCH, 20 POST, 13 PUT. Each is listed below with its method, path, parameters, and response codes.

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

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

GET
/v1/dependent_custom_field_templates
リストの取得
getV1DependentCustomFieldTemplates 2 params → 200
GET
/v1/crew_custom_field_template_groups/{id}
取得
getV1CrewCustomFieldTemplateGroupsId 2 params → 200
PUT
/v1/crew_custom_field_template_groups/{id}
更新
putV1CrewCustomFieldTemplateGroupsId 1 param body → 200
PATCH
/v1/crew_custom_field_template_groups/{id}
部分更新
patchV1CrewCustomFieldTemplateGroupsId 1 param body → 200
DELETE
/v1/crew_custom_field_template_groups/{id}
削除
deleteV1CrewCustomFieldTemplateGroupsId 1 param → 204
GET
/v1/crew_custom_field_template_groups
リスト取得
getV1CrewCustomFieldTemplateGroups 3 params → 200
POST
/v1/crew_custom_field_template_groups
登録
postV1CrewCustomFieldTemplateGroups body → 201
GET
/v1/crew_custom_field_templates
リストの取得
getV1CrewCustomFieldTemplates 3 params → 200
POST
/v1/crew_custom_field_templates
登録
postV1CrewCustomFieldTemplates body → 201
GET
/v1/crew_custom_field_templates/{id}
取得
getV1CrewCustomFieldTemplatesId 2 params → 200
PUT
/v1/crew_custom_field_templates/{id}
更新
putV1CrewCustomFieldTemplatesId 1 param body → 200
PATCH
/v1/crew_custom_field_templates/{id}
部分更新
patchV1CrewCustomFieldTemplatesId 1 param body → 200
DELETE
/v1/crew_custom_field_templates/{id}
削除
deleteV1CrewCustomFieldTemplatesId 1 param → 204
GET
/v1/batch_jobs
リストの取得
getV1BatchJobs 4 params → 200
GET
/v1/batch_jobs/{id}
取得
getV1BatchJobsId 2 params → 200
POST
/v1/batch_jobs/job_types/crew_export
従業員情報ダウンロードの登録
postV1BatchJobsJobTypesCrewExport body → 201
POST
/v1/batch_jobs/job_types/crew_import
従業員一括登録・更新の登録
postV1BatchJobsJobTypesCrewImport body → 201
POST
/v1/batch_jobs/job_types/dependent_import
家族情報一括更新の登録
postV1BatchJobsJobTypesDependentImport body → 201
GET
/v1/batch_job_attachments/{id}/file
ファイル取得
getV1BatchJobAttachmentsIdFile 1 param → 200
GET
/v1/mail_formats
リストの取得
getV1MailFormats 3 params → 200
GET
/v1/mail_formats/{id}
取得
getV1MailFormatsId 2 params → 200
GET
/v1/users
リストの取得
getV1Users 4 params → 200
GET
/v1/users/{id}
取得
getV1UsersId 2 params → 200
GET
/v1/users/{id}/saml_user
SAML SSOアカウントを取得
getV1UsersIdSamlUser 1 param → 200
POST
/v1/users/{id}/saml_user
SAML SSOアカウントの作成
postV1UsersIdSamlUser 1 param body → 201
PATCH
/v1/users/{id}/saml_user
SAML SSOアカウントを更新
patchV1UsersIdSamlUser 1 param body → 200
DELETE
/v1/users/{id}/saml_user
SAML SSOアカウントを削除
deleteV1UsersIdSamlUser 1 param → 204
PATCH
/v1/users/{id}/saml_user/enable
SAML SSOアカウントを有効に変更
patchV1UsersIdSamlUserEnable 1 param → 200
PATCH
/v1/users/{id}/saml_user/disable
SAML SSOアカウントを無効に変更
patchV1UsersIdSamlUserDisable 1 param → 200
GET
/v1/biz_establishments
リストの取得
getV1BizEstablishments 3 params → 200
GET
/v1/companies
リストの取得
getV1Companies 3 params → 200
GET
/v1/bank_account_settings
リストの取得
getV1BankAccountSettings 2 params → 200
GET
/v1/crews/{crew_id}/dependents
リストの取得
getV1CrewsCrewIdDependents 3 params → 200
POST
/v1/crews/{crew_id}/dependents
登録
postV1CrewsCrewIdDependents 1 param body → 201
GET
/v1/crews/{crew_id}/dependents/{id}
取得
getV1CrewsCrewIdDependentsId 2 params → 200
PUT
/v1/crews/{crew_id}/dependents/{id}deprecated
更新
putV1CrewsCrewIdDependentsId 2 params body → 200
PATCH
/v1/crews/{crew_id}/dependents/{id}
部分更新
patchV1CrewsCrewIdDependentsId 2 params body → 200
DELETE
/v1/crews/{crew_id}/dependents/{id}
削除
deleteV1CrewsCrewIdDependentsId 2 params → 204
GET
/v1/job_titles/{id}
取得
getV1JobTitlesId 1 param → 200
PUT
/v1/job_titles/{id}
更新
putV1JobTitlesId 1 param body → 200
PATCH
/v1/job_titles/{id}
部分更新
patchV1JobTitlesId 1 param body → 200
DELETE
/v1/job_titles/{id}
削除
deleteV1JobTitlesId 1 param → 204
GET
/v1/job_titles
リストの取得
getV1JobTitles 3 params → 200
POST
/v1/job_titles
作成
postV1JobTitles body → 201
GET
/v1/crews
リストの取得
getV1Crews 19 params → 200
POST
/v1/crews
登録
postV1Crews body → 201
GET
/v1/crews/{id}
取得
getV1CrewsId 2 params → 200
PUT
/v1/crews/{id}deprecated
更新
putV1CrewsId 1 param body → 200
PATCH
/v1/crews/{id}
部分更新
patchV1CrewsId 1 param body → 200
DELETE
/v1/crews/{id}
削除
deleteV1CrewsId 1 param → 204
PUT
/v1/crews/{id}/invite
招待
putV1CrewsIdInvite 1 param body → 204
DELETE
/v1/crews/{crew_id}/departments
部署情報の削除
deleteV1CrewsCrewIdDepartments 1 param → 204
GET
/v1/crew_input_forms
リストの取得
getV1CrewInputForms 3 params → 200
GET
/v1/crew_input_forms/{id}
取得
getV1CrewInputFormsId 2 params → 200
GET
/v1/recruitment_types/{id}
取得
getV1RecruitmentTypesId 1 param → 200
PUT
/v1/recruitment_types/{id}
更新
putV1RecruitmentTypesId 1 param body → 200
PATCH
/v1/recruitment_types/{id}
部分更新
patchV1RecruitmentTypesId 1 param body → 200
DELETE
/v1/recruitment_types/{id}
削除
deleteV1RecruitmentTypesId 1 param → 204
GET
/v1/recruitment_types
リストの取得
getV1RecruitmentTypes 2 params → 200
POST
/v1/recruitment_types
作成
postV1RecruitmentTypes body → 201
GET
/v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips
リストの取得
getV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlips 4 params → 200
POST
/v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips
登録
postV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlips 1 param body → 201
GET
/v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips/{id}
取得
getV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId 3 params → 200
PUT
/v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips/{id}
更新
putV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId 2 params body → 200
PATCH
/v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips/{id}
部分更新
patchV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId 2 params body → 200
DELETE
/v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips/{id}
削除
deleteV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId 2 params → 204
GET
/v1/tax_withholdings
リストの取得
getV1TaxWithholdings 2 params → 200
POST
/v1/tax_withholdings
登録
postV1TaxWithholdings body → 201
GET
/v1/tax_withholdings/{id}
取得
getV1TaxWithholdingsId 1 param → 200
PUT
/v1/tax_withholdings/{id}
更新
putV1TaxWithholdingsId 1 param body → 200
PATCH
/v1/tax_withholdings/{id}
部分更新
patchV1TaxWithholdingsId 1 param body → 200
DELETE
/v1/tax_withholdings/{id}
削除
deleteV1TaxWithholdingsId 1 param → 204
GET
/v1/crews/{crew_id}/maternity_childcare_leaves
リストの取得
getV1CrewsCrewIdMaternityChildcareLeaves 3 params → 200
GET
/v1/grades/{id}
取得
getV1GradesId 1 param → 200
PUT
/v1/grades/{id}
更新
putV1GradesId 1 param body → 200
PATCH
/v1/grades/{id}
部分更新
patchV1GradesId 1 param body → 200
DELETE
/v1/grades/{id}
削除
deleteV1GradesId 1 param → 204
GET
/v1/grades
リストの取得
getV1Grades 2 params → 200
POST
/v1/grades
作成
postV1Grades body → 201
GET
/v1/payment_periods
リストの取得
getV1PaymentPeriods 3 params → 200
GET
/v1/payment_periods/{id}
取得
getV1PaymentPeriodsId 1 param → 200
GET
/v1/payrolls/{payroll_id}/payslips
リストの取得
getV1PayrollsPayrollIdPayslips 5 params → 200
POST
/v1/payrolls/{payroll_id}/payslips
登録
postV1PayrollsPayrollIdPayslips 1 param body → 201
GET
/v1/payrolls/{payroll_id}/payslips/{id}
取得
getV1PayrollsPayrollIdPayslipsId 3 params → 200
DELETE
/v1/payrolls/{payroll_id}/payslips/{id}
削除
deleteV1PayrollsPayrollIdPayslipsId 2 params → 204
POST
/v1/payrolls/{payroll_id}/payslips/bulk
一括登録
postV1PayrollsPayrollIdPayslipsBulk 1 param body → 201
GET
/v1/payrolls
リストの取得
getV1Payrolls 5 params → 200
POST
/v1/payrolls
登録
postV1Payrolls body → 201
GET
/v1/payrolls/{id}
取得
getV1PayrollsId 1 param → 200
PATCH
/v1/payrolls/{id}
部分更新
patchV1PayrollsId 1 param body → 200
DELETE
/v1/payrolls/{id}
削除
deleteV1PayrollsId 1 param → 204
PATCH
/v1/payrolls/{id}/fix
確定処理
patchV1PayrollsIdFix 1 param → 200
PATCH
/v1/payrolls/{id}/unfix
確定解除処理
patchV1PayrollsIdUnfix 1 param → 200
PATCH
/v1/payrolls/{id}/publish
公開処理
patchV1PayrollsIdPublish 1 param body → 200
GET
/v1/dependent_relations
リストの取得
getV1DependentRelations 3 params → 200
GET
/v1/job_categories/{id}
取得
getV1JobCategoriesId 1 param → 200
PUT
/v1/job_categories/{id}
更新
putV1JobCategoriesId 1 param body → 200
PATCH
/v1/job_categories/{id}
部分更新
patchV1JobCategoriesId 1 param body → 200
DELETE
/v1/job_categories/{id}
削除
deleteV1JobCategoriesId 1 param → 204
GET
/v1/job_categories
リストの取得
getV1JobCategories 2 params → 200
POST
/v1/job_categories
作成
postV1JobCategories body → 201
GET
/v1/departments
リストの取得
getV1Departments 4 params → 200
POST
/v1/departments
登録
postV1Departments body → 201
GET
/v1/departments/{id}
取得
getV1DepartmentsId 1 param → 200
PUT
/v1/departments/{id}
更新
putV1DepartmentsId 1 param body → 200
PATCH
/v1/departments/{id}
部分更新
patchV1DepartmentsId 1 param body → 200
DELETE
/v1/departments/{id}deprecated
削除
deleteV1DepartmentsId 1 param → 204
POST
/v1/departments/{id}/discontinue
廃止
postV1DepartmentsIdDiscontinue 1 param body → 204
GET
/v1/employment_types
リストの取得
getV1EmploymentTypes 2 params → 200
POST
/v1/employment_types
登録
postV1EmploymentTypes body → 201
GET
/v1/employment_types/{id}
取得
getV1EmploymentTypesId 1 param → 200
PUT
/v1/employment_types/{id}
更新
putV1EmploymentTypesId 1 param body → 200
PATCH
/v1/employment_types/{id}
部分更新
patchV1EmploymentTypesId 1 param body → 200
DELETE
/v1/employment_types/{id}
削除
deleteV1EmploymentTypesId 1 param → 204

Schemas 104

The contract defines 104 schemas that model the data the API accepts and returns. The most detailed are Crew (145 properties), postV1Crews (137 properties), patchV1CrewsId (137 properties), putV1CrewsId (137 properties). Each schema is shown below with its type and property counts.

postV1BatchJobsJobTypesCrewImport
object
従業員一括登録・更新の登録
2 properties 2 required
TaxWithholding
object
TaxWithholding model
4 properties 4 required
Payroll
object
Payroll model
12 properties 11 required
Company
object
Company model
10 properties 2 required
BatchJob
object
BatchJob model
10 properties 9 required
postV1PayrollsPayrollIdPayslips
object
登録
4 properties 2 required
putV1GradesId
object
更新
2 properties
putV1CrewsId
object
更新
137 properties 6 required
BizEstablishmentForCrew
object
23 properties 5 required
postV1Grades
object
作成
2 properties
postV1RecruitmentTypes
object
作成
1 property 1 required
putV1CrewsIdInvite
object
招待
2 properties 1 required
putV1CrewCustomFieldTemplatesId
object
更新
8 properties 4 required
postV1JobCategories
object
作成
1 property
CrewInputForm
object
CrewInputForm model
28 properties 5 required
Crew
object
Crew model
145 properties 8 required
Payslip
object
Payslip model
12 properties 3 required
PayrollAggregate
object
4 properties 2 required
putV1TaxWithholdingsId
object
更新
3 properties 3 required
patchV1RecruitmentTypesId
object
部分更新
1 property 1 required
Attachment
object
2 properties
postV1PayrollsPayrollIdPayslipsBulk
object
一括登録
1 property 1 required
patchV1GradesId
object
部分更新
2 properties
postV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlips
object
登録
3 properties 2 required
patchV1UsersIdSamlUser
object
SAML SSOアカウントを更新
2 properties 2 required
JobCategory
object
JobCategory model
4 properties
Allowance
object
2 properties 2 required
SuppressedEmailLog
object
6 properties 1 required
postV1Crews
object
登録
137 properties 6 required
putV1EmploymentTypesId
object
更新
1 property 1 required
postV1BatchJobsJobTypesDependentImport
object
家族情報一括更新の登録
1 property 1 required
putV1DepartmentsId
object
更新
5 properties 1 required
putV1CrewsCrewIdDependentsId
object
更新
48 properties 6 required
postV1TaxWithholdings
object
登録
2 properties 2 required
BankAccount
object
10 properties 5 required
BizEstablishment
object
BizEstablishment model
25 properties 5 required
Address
object
7 properties 1 required
DependentCustomFieldParam
object
3 properties 1 required
postV1CrewCustomFieldTemplates
object
登録
8 properties 4 required
postV1CrewCustomFieldTemplateGroups
object
登録
3 properties 1 required
Dependent
object
Dependent model
53 properties 7 required
patchV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId
object
部分更新
2 properties 2 required
postV1BatchJobsJobTypesCrewExport
object
従業員情報ダウンロードの登録
1 property 1 required
putV1JobTitlesId
object
更新
2 properties
CrewInputFormField
object
4 properties
patchV1PayrollsIdPublish
object
公開処理
2 properties
Image
object
4 properties
patchV1CrewsId
object
部分更新
137 properties 6 required
PaymentPeriodForCrew
object
3 properties 1 required
putV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId
object
更新
2 properties 2 required
CrewCustomFieldTemplateNested
object
11 properties 7 required
CrewInputFormFieldGroup
object
6 properties
Department
object
Department model
11 properties 5 required
CrewCustomEnumFieldTemplateElement
object
4 properties 3 required
patchV1EmploymentTypesId
object
部分更新
2 properties 1 required
DepartmentNested
object
7 properties 3 required
Grade
object
Grade model
5 properties
postV1JobTitles
object
作成
3 properties
CrewCustomField
object
2 properties
putV1RecruitmentTypesId
object
更新
1 property 1 required
patchV1CrewsCrewIdDependentsId
object
部分更新
48 properties 6 required
SamlUser
object
SamlUser model
6 properties 4 required
TaxWithholdingSlip
object
TaxWithholdingSlip model
113 properties 11 required
CrewCustomFieldTemplate
object
CrewCustomFieldTemplate model
12 properties 7 required
postV1DepartmentsIdDiscontinue
object
廃止
1 property 1 required
API_V1_Entity_PayslipParams_Value
object
2 properties 2 required
postV1Payrolls
object
登録
7 properties 7 required
DependentCustomField
object
4 properties
patchV1TaxWithholdingsId
object
部分更新
3 properties 3 required
EmploymentType
object
EmploymentType model
6 properties 3 required
CrewCustomFieldTemplateGroupNested
object
6 properties 3 required
Attendance
object
5 properties 3 required
patchV1CrewCustomFieldTemplatesId
object
部分更新
8 properties 4 required
CrewCustomFieldParam
object
3 properties 1 required
postV1CrewsCrewIdDependents
object
登録
48 properties 6 required
Role
object
7 properties 3 required
MaternityChildcareLeave
object
MaternityChildcareLeave model
35 properties 2 required
putV1CrewCustomFieldTemplateGroupsId
object
更新
3 properties 1 required
patchV1DepartmentsId
object
部分更新
5 properties 1 required
PaymentPeriod
object
PaymentPeriod model
5 properties 3 required
AddonEnabled
object
2 properties
EmploymentTypeForCrew
object
4 properties 1 required
Position
object
5 properties 1 required
postV1UsersIdSamlUser
object
SAML SSOアカウントの作成
3 properties 3 required
CrewCustomFieldTemplateGroup
object
CrewCustomFieldTemplateGroup model
7 properties 3 required
DependentCustomEnumFieldTemplateElement
object
4 properties 3 required
patchV1CrewCustomFieldTemplateGroupsId
object
部分更新
3 properties 1 required
MailFormat
object
MailFormat model
6 properties 3 required
User
object
User model
17 properties 4 required
JobTitle
object
JobTitle model
6 properties 2 required
Deduction
object
2 properties 2 required
patchV1JobTitlesId
object
部分更新
3 properties
postV1Departments
object
登録
5 properties 1 required
postV1EmploymentTypes
object
登録
2 properties 1 required
DependentCustomFieldTemplate
object
DependentCustomFieldTemplate model
10 properties 3 required
BankAccountSetting
object
BankAccountSetting model
7 properties 5 required
putV1JobCategoriesId
object
更新
1 property
patchV1JobCategoriesId
object
部分更新
1 property
RecruitmentType
object
RecruitmentType model
5 properties 1 required
patchV1PayrollsId
object
部分更新
2 properties 2 required
LaborAndSocialSecurityAttorney
object
10 properties
AttachmentParams
object
2 properties
DependentRelation
object
DependentRelation model
7 properties
BatchJobAttachment
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kufu-default-api-openapi.yml Raw ↑

Other APIs KUFU publishes across the network.

KUFU Webhook API
AE Profile APIs.io
← Back to K APIs
API Details
ID
kufu:kufu-default-api
Base URL
https://app.smarthr.jp/api/v1
Docs
https://developer.smarthr.jp/api
Provider
KUFU
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=kufu-default-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/kufu-default-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of KUFU カスタム家族項目テンプレート 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.