Humaans Companies API

openapi: 3.1.0
info:
  title: Humaans Audit Events Companies 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: Companies
  description: Tenant company record
paths:
  /companies:
    get:
      tags:
      - Companies
      summary: List Companies
      operationId: listCompanies
      responses:
        '200':
          description: Company list
  /companies/{id}:
    parameters:
    - $ref: '#/components/parameters/Id'
    get:
      tags:
      - Companies
      summary: Retrieve Company
      operationId: getCompany
      responses:
        '200':
          description: Company record
    patch:
      tags:
      - Companies
      summary: Update Company
      operationId: updateCompany
      responses:
        '200':
          description: Updated company
components:
  parameters:
    Id:
      name: id
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: Bearer access token issued by Humaans with OAuth-style scopes