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

SmartHR Custom Field Templates API

Templates defining custom fields attached to crew records.

SmartHR Custom Field Templates API is one of 6 APIs that SmartHR publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Field Templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

5 operations 2 paths 3 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{tenant}.smarthr.jp/api
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

SmartHR Custom Field Templates API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Per-tenant access token issued from the SmartHR admin console (or obtained via OAuth2 for registered apps), passed as Authorization: Bearer ACCESSTOKEN. HTTP B…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Field Templates 5

Templates defining custom fields attached to crew records.

GET
/v1/crew_custom_field_templates
List crew custom field templates
listCrewCustomFieldTemplates 2 params → 200401429
POST
/v1/crew_custom_field_templates
Create a crew custom field template
createCrewCustomFieldTemplate body → 201401422429
GET
/v1/crew_custom_field_templates/{id}
Get a crew custom field template
getCrewCustomFieldTemplate 1 param → 200401404429
PATCH
/v1/crew_custom_field_templates/{id}
Update a crew custom field template
updateCrewCustomFieldTemplate 1 param body → 200401404422429
DELETE
/v1/crew_custom_field_templates/{id}
Delete a crew custom field template
deleteCrewCustomFieldTemplate 1 param → 204401404429

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CrewCustomFieldTemplateInput (4 properties), Error (4 properties). Each schema is shown below with its type and property counts.

CrewCustomFieldTemplate
Error
object
4 properties
CrewCustomFieldTemplateInput
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

smarthr-custom-field-templates-api-openapi.yml Raw ↑

Other APIs SmartHR publishes across the network.

SmartHR Business Establishments API
SmartHR Crews API
SmartHR Departments API
SmartHR Employment Types API
SmartHR Webhooks API
Where this information came from

This is an independent, third-party profile of SmartHR Custom Field Templates 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.