Humaans Custom Fields API

Tenant-defined custom field definitions and values

OpenAPI Specification

humaans-io-custom-fields-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Humaans Audit Events Custom Fields API
  version: '1.0'
  description: 'The Humaans HRIS API exposes the People, Compensations, Time Away, Documents,

    Locations, Job Roles, Custom Fields, Performance, Timesheet, Webhooks, and

    related resources of the Humaans system of record. The API is REST-based,

    accepts and returns JSON, and uses Bearer token authentication scoped via

    OAuth scopes (public:read, private:read, private:write, compensations:read,

    compensations:write, documents:read, documents:write, webhooks:manage).

    '
  contact:
    name: Humaans
    url: https://docs.humaans.io/api/
  termsOfService: https://humaans.io/terms
servers:
- url: https://app.humaans.io/api
  description: Humaans API production endpoint
security:
- bearerAuth: []
tags:
- name: Custom Fields
  description: Tenant-defined custom field definitions and values
paths:
  /custom-fields:
    get:
      tags:
      - Custom Fields
      summary: List Custom Fields
      operationId: listCustomFields
      responses:
        '200':
          description: List
    post:
      tags:
      - Custom Fields
      summary: Create Custom Field
      operationId: createCustomField
      responses:
        '201':
          description: Created
  /custom-values:
    get:
      tags:
      - Custom Fields
      summary: List Custom Values
      operationId: listCustomValues
      responses:
        '200':
          description: List
    post:
      tags:
      - Custom Fields
      summary: Create Custom Value
      operationId: createCustomValue
      responses:
        '201':
          description: Created
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: Bearer access token issued by Humaans with OAuth-style scopes