KUFU カスタム家族項目テンプレート API
カスタム家族項目テンプレートを操作します
KUFU カスタム家族項目テンプレート API is one of 2 APIs that KUFU publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include カスタム家族項目テンプレート. 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 2.0, at version 0.0.1.
Requests are made against the base URL https://app.smarthr.jp/api/v1.
114 operations
58 paths
104 schemas
16 DELETE46 GET19 PATCH20 POST13 PUT
Metadata
The identity and technical contract details declared by the specification.
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
リストの取得
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}deprecated
更新
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}deprecated
更新
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}deprecated
削除
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}
削除
Schemas 104
The contract defines 104 schemas that model the data the API accepts and returns. The most detailed are Crew (145 properties), putV1CrewsId (137 properties), postV1Crews (137 properties), patchV1CrewsId (137 properties). Each schema is shown below with its type and property counts.
Crew
object
Crew model
145 properties
8 required
LaborAndSocialSecurityAttorney
object
10 properties
Payroll
object
Payroll model
12 properties
11 required
SuppressedEmailLog
object
6 properties
1 required
Deduction
object
2 properties
2 required
DependentCustomFieldParam
object
3 properties
1 required
putV1CrewCustomFieldTemplatesId
object
更新
8 properties
4 required
BatchJob
object
BatchJob model
10 properties
9 required
postV1EmploymentTypes
object
登録
2 properties
1 required
patchV1UsersIdSamlUser
object
SAML SSOアカウントを更新
2 properties
2 required
JobCategory
object
JobCategory model
4 properties
BatchJobAttachment
object
4 properties
3 required
patchV1TaxWithholdingsId
object
部分更新
3 properties
3 required
TaxWithholdingSlip
object
TaxWithholdingSlip model
113 properties
11 required
postV1UsersIdSamlUser
object
SAML SSOアカウントの作成
3 properties
3 required
putV1CrewsIdInvite
object
招待
2 properties
1 required
postV1Payrolls
object
登録
7 properties
7 required
patchV1JobTitlesId
object
部分更新
3 properties
BizEstablishmentForCrew
object
23 properties
5 required
Payslip
object
Payslip model
12 properties
3 required
TaxWithholding
object
TaxWithholding model
4 properties
4 required
putV1JobTitlesId
object
更新
2 properties
DependentCustomFieldTemplate
object
DependentCustomFieldTemplate model
10 properties
3 required
patchV1PayrollsId
object
部分更新
2 properties
2 required
API_V1_Entity_PayslipParams_Value
object
2 properties
2 required
patchV1EmploymentTypesId
object
部分更新
2 properties
1 required
Position
object
5 properties
1 required
MailFormat
object
MailFormat model
6 properties
3 required
CrewInputFormFieldGroup
object
6 properties
patchV1DepartmentsId
object
部分更新
5 properties
1 required
BizEstablishment
object
BizEstablishment model
25 properties
5 required
DependentCustomEnumFieldTemplateElement
object
4 properties
3 required
PaymentPeriod
object
PaymentPeriod model
5 properties
3 required
patchV1CrewsId
object
部分更新
137 properties
6 required
postV1CrewCustomFieldTemplateGroups
object
登録
3 properties
1 required
CrewCustomFieldTemplateGroup
object
CrewCustomFieldTemplateGroup model
7 properties
3 required
postV1RecruitmentTypes
object
作成
1 property
1 required
CrewCustomFieldParam
object
3 properties
1 required
Attachment
object
2 properties
patchV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId
object
部分更新
2 properties
2 required
postV1PayrollsPayrollIdPayslips
object
登録
4 properties
2 required
postV1Crews
object
登録
137 properties
6 required
putV1CrewCustomFieldTemplateGroupsId
object
更新
3 properties
1 required
postV1Departments
object
登録
5 properties
1 required
patchV1CrewCustomFieldTemplatesId
object
部分更新
8 properties
4 required
patchV1GradesId
object
部分更新
2 properties
postV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlips
object
登録
3 properties
2 required
patchV1CrewsCrewIdDependentsId
object
部分更新
48 properties
6 required
putV1CrewsCrewIdDependentsId
object
更新
48 properties
6 required
CrewCustomFieldTemplate
object
CrewCustomFieldTemplate model
12 properties
7 required
RecruitmentType
object
RecruitmentType model
5 properties
1 required
Dependent
object
Dependent model
53 properties
7 required
AttachmentParams
object
2 properties
Attendance
object
5 properties
3 required
AddonEnabled
object
2 properties
BankAccount
object
10 properties
5 required
SamlUser
object
SamlUser model
6 properties
4 required
putV1DepartmentsId
object
更新
5 properties
1 required
putV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId
object
更新
2 properties
2 required
PaymentPeriodForCrew
object
3 properties
1 required
postV1CrewCustomFieldTemplates
object
登録
8 properties
4 required
putV1CrewsId
object
更新
137 properties
6 required
Grade
object
Grade model
5 properties
putV1JobCategoriesId
object
更新
1 property
patchV1JobCategoriesId
object
部分更新
1 property
putV1RecruitmentTypesId
object
更新
1 property
1 required
Role
object
7 properties
3 required
CrewInputFormField
object
4 properties
putV1TaxWithholdingsId
object
更新
3 properties
3 required
postV1DepartmentsIdDiscontinue
object
廃止
1 property
1 required
CrewCustomFieldTemplateGroupNested
object
6 properties
3 required
EmploymentType
object
EmploymentType model
6 properties
3 required
putV1EmploymentTypesId
object
更新
1 property
1 required
postV1BatchJobsJobTypesCrewExport
object
従業員情報ダウンロードの登録
1 property
1 required
CrewCustomFieldTemplateNested
object
11 properties
7 required
BankAccountSetting
object
BankAccountSetting model
7 properties
5 required
DependentRelation
object
DependentRelation model
7 properties
DependentCustomField
object
4 properties
EmploymentTypeForCrew
object
4 properties
1 required
MaternityChildcareLeave
object
MaternityChildcareLeave model
35 properties
2 required
Company
object
Company model
10 properties
2 required
User
object
User model
17 properties
4 required
CrewCustomField
object
2 properties
JobTitle
object
JobTitle model
6 properties
2 required
postV1TaxWithholdings
object
登録
2 properties
2 required
PayrollAggregate
object
4 properties
2 required
postV1Grades
object
作成
2 properties
patchV1PayrollsIdPublish
object
公開処理
2 properties
Allowance
object
2 properties
2 required
CrewInputForm
object
CrewInputForm model
28 properties
5 required
Image
object
4 properties
patchV1CrewCustomFieldTemplateGroupsId
object
部分更新
3 properties
1 required
postV1CrewsCrewIdDependents
object
登録
48 properties
6 required
Address
object
7 properties
1 required
CrewCustomEnumFieldTemplateElement
object
4 properties
3 required
putV1GradesId
object
更新
2 properties
patchV1RecruitmentTypesId
object
部分更新
1 property
1 required
postV1BatchJobsJobTypesCrewImport
object
従業員一括登録・更新の登録
2 properties
2 required
postV1JobTitles
object
作成
3 properties
postV1JobCategories
object
作成
1 property
Department
object
Department model
11 properties
5 required
DepartmentNested
object
7 properties
3 required
postV1PayrollsPayrollIdPayslipsBulk
object
一括登録
1 property
1 required
postV1BatchJobsJobTypesDependentImport
object
家族情報一括更新の登録
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from KUFU 1
Other APIs KUFU publishes across the network.
KUFU Webhook API
#カスタム家族項目テンプレート