Zeal

Zeal Companies API

The Companies API from Zeal — 3 operation(s) for companies.

GitHub OpenAPI

Operations 5

POST /companies Create a company #
GET /companies Get company information #
PUT /companies Update company information #
POST /bankAccount Create a company bank account #

Documentation

📖
Documentation
https://docs.zeal.com/docs/what-is-zeal
📖
APIReference
https://docs.zeal.com/reference/create-company
📖
Documentation
https://docs.zeal.com/docs/employee-onboarding-guide
📖
APIReference
https://docs.zeal.com/reference/create-employee
📖
Documentation
https://docs.zeal.com/docs/contractor-onboarding-guide
📖
APIReference
https://docs.zeal.com/reference/create-contractor
📖
Documentation
https://docs.zeal.com/docs/regular-payroll
📖
APIReference
https://docs.zeal.com/reference/create-employee-check
📖
APIReference
https://docs.zeal.com/reference/create-contractor-payment
📖
Documentation
https://docs.zeal.com/reference/pay-frequency-reporting-periods-and-check-dates
📖
APIReference
https://docs.zeal.com/reference/get-all-reporting-periods
📖
APIReference
https://docs.zeal.com/reference/generate-employee-onboarding-link
📖
Documentation
https://docs.zeal.com/reference/introduction
📖
APIReference
https://docs.zeal.com/reference/get-employee-tax-parameter-definitions
📖
APIReference
https://docs.zeal.com/reference/create-payroll-journal-report
📖
APIReference
https://docs.zeal.com/reference/get-provider-balance
📖
Documentation
https://docs.zeal.com/reference/webhook-events
📖
APIReference
https://docs.zeal.com/reference/webhook-events

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zeal-hq/refs/heads/main/openapi/zeal-hq-companies-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/zeal-hq/refs/heads/main/collections/zeal-hq.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/zeal-hq/refs/heads/main/collections/zeal-hq.opencollection.json
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/zeal-hq/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zeal-hq-companies-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

zeal-hq-companies-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zeal Companies API
  description: 'Zeal is an embedded payroll-as-a-service platform. This representative OpenAPI describes the core surfaces of the Zeal API used to build payroll products: onboarding companies, employees, and contractors; running pay runs (employee checks) and contractor payments; managing pay schedules, tax parameters, reports, funding, and webhooks. All requests are authenticated with a Bearer API key and scoped by a companyID. Use a test API key against Test Mode (no money moves) before switching to a live key.'
  termsOfService: https://www.zeal.com/terms
  contact:
    name: Zeal Support
    url: https://docs.zeal.com
    email: support@zeal.com
  version: '1.0'
servers:
- url: https://api.zeal.com
  description: Zeal API (test or live selected by API key)
security:
- bearerAuth: []
tags:
- name: Companies
paths:
  /companies:
    post:
      operationId: createCompany
      tags:
      - Companies
      summary: Create a company
      description: Create a new employer company on the platform.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCompanyRequest'
      responses:
        '200':
          description: The created company.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
    get:
      operationId: getCompanyInformation
      tags:
      - Companies
      summary: Get company information
      parameters:
      - $ref: '#/components/parameters/companyID'
      responses:
        '200':
          description: The company record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
    put:
      operationId: updateCompanyInformation
      tags:
      - Companies
      summary: Update company information
      description: Update company profile fields such as payroll_firstCheckDate, payroll_schedule, and payroll_firstPayPeriodID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCompanyRequest'
      responses:
        '200':
          description: The updated company.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
  /companies/onboard:
    get:
      operationId: getCompanyOnboardingLink
      tags:
      - Companies
      summary: Get a company onboarding link
      parameters:
      - $ref: '#/components/parameters/companyID'
      responses:
        '200':
          description: A hosted onboarding link for the company.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardLink'
  /bankAccount:
    post:
      operationId: createCompanyBankAccount
      tags:
      - Companies
      summary: Create a company bank account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankAccountRequest'
      responses:
        '200':
          description: The created bank account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankAccount'
components:
  parameters:
    companyID:
      name: companyID
      in: query
      required: true
      description: The Zeal companyID identifying the employer account.
      schema:
        type: string
  schemas:
    UpdateCompanyRequest:
      type: object
      properties:
        companyID:
          type: string
        payroll_firstCheckDate:
          type: string
          format: date
        payroll_schedule:
          type: string
          enum:
          - weekly
          - biweekly
          - semimonthly
          - monthly
        payroll_firstPayPeriodID:
          type: string
    Company:
      type: object
      properties:
        companyID:
          type: string
        business_name:
          type: string
        ein:
          type: string
        status:
          type: string
          enum:
          - needs_onboarding
          - onboarding
          - onboarded
    BankAccountRequest:
      type: object
      properties:
        companyID:
          type: string
        institution_name:
          type: string
        account_number:
          type: string
        routing_number:
          type: string
        account_type:
          type: string
          enum:
          - checking
          - savings
    CreateCompanyRequest:
      type: object
      required:
      - business_name
      - ein
      properties:
        business_name:
          type: string
        ein:
          type: string
        email:
          type: string
    BankAccount:
      type: object
      properties:
        id:
          type: string
        institution_name:
          type: string
        account_type:
          type: string
        status:
          type: string
    OnboardLink:
      type: object
      properties:
        url:
          type: string
          format: uri
        expiration:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Provide your Zeal API key as a Bearer token: `Authorization: Bearer <YOUR_API_KEY>`. Use a test key for Test Mode and a live key for production. Requests are additionally scoped by a companyID passed in the body or query.'