Greenhouse

Greenhouse CustomFields API

Org-defined custom fields and their options.

GitHub OpenAPI

Operations 9

GET /custom_fields List Custom Fields #
POST /custom_fields Create Custom Field #
GET /custom_fields/{id} Retrieve Custom Field #
PATCH /custom_fields/{id} Update Custom Field #
DELETE /custom_fields/{id} Delete Custom Field #
GET /custom_fields/{id}/custom_field_options List Custom Field Options #
POST /custom_fields/{id}/custom_field_options Create Custom Field Option #
PATCH /custom_fields/{id}/custom_field_options/{option_id} Update Custom Field Option #
DELETE /custom_fields/{id}/custom_field_options/{option_id} Delete Custom Field Option #

Documentation

📖
Documentation
https://developers.greenhouse.io/harvest.html
📖
Authentication
https://developers.greenhouse.io/harvest.html#authentication
📖
RateLimits
https://developers.greenhouse.io/harvest.html#rate-limits
📖
Documentation
https://developers.greenhouse.io/job-board.html
📖
Authentication
https://developers.greenhouse.io/job-board.html
📖
Documentation
https://developers.greenhouse.io/audit-log.html
📖
Authentication
📖
RateLimits
https://developers.greenhouse.io/audit-log.html
📖
Documentation
https://developers.greenhouse.io/candidate-ingestion.html
📖
Authentication
https://developers.greenhouse.io/candidate-ingestion.html
📖
Documentation
https://developers.greenhouse.io/gho.html
📖
RateLimits
https://developers.greenhouse.io/gho.html
📖
Documentation
https://developers.greenhouse.io/assessment.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/greenhouse-io/refs/heads/main/openapi/greenhouse-io-customfields-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/greenhouse-io/refs/heads/main/json-schema/greenhouse-candidate-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/greenhouse-io/refs/heads/main/json-schema/greenhouse-job-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/greenhouse-io/refs/heads/main/json-ld/greenhouse-io-context.jsonld
🔗
Pagination
https://developers.greenhouse.io/harvest.html#pagination
🔗
Retention
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/greenhouse-io/refs/heads/main/graphql/greenhouse-io-graphql.md

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/greenhouse-io-customfields-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

greenhouse-io-customfields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Greenhouse Harvest Custom Fields API
  description: 'The Harvest API is Greenhouse''s primary REST API for programmatic access to recruiting data:

    candidates, applications, jobs, openings, job posts, departments, offices, users, offers,

    approvals, scheduled interviews, scorecards, sources, tags, custom fields, prospect pools,

    and the activity feed. Harvest uses HTTP Basic authentication with a per-permission API key,

    RFC-5988 Link-header pagination (default 100, max 500 per page), and a per-token rate limit

    of N requests per 10 seconds returned in the X-RateLimit-Limit header.

    '
  version: 1.0.0
  contact:
    name: Greenhouse Software
    url: https://www.greenhouse.com
    email: developers@greenhouse.io
  license:
    name: Greenhouse API Terms
    url: https://www.greenhouse.com/legal
servers:
- url: https://harvest.greenhouse.io/v1
  description: Production Harvest API
security:
- BasicAuth: []
tags:
- name: CustomFields
  description: Org-defined custom fields and their options.
paths:
  /custom_fields:
    get:
      tags:
      - CustomFields
      summary: List Custom Fields
      operationId: listCustomFields
      responses:
        '200':
          description: Custom fields.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomField'
        4XX:
          $ref: '#/components/responses/ErrorResponse'
    post:
      tags:
      - CustomFields
      summary: Create Custom Field
      operationId: createCustomField
      parameters:
      - $ref: '#/components/parameters/OnBehalfOf'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomField'
      responses:
        '201':
          description: Created.
        4XX:
          $ref: '#/components/responses/ErrorResponse'
  /custom_fields/{id}:
    parameters:
    - $ref: '#/components/parameters/Id'
    get:
      tags:
      - CustomFields
      summary: Retrieve Custom Field
      operationId: getCustomField
      responses:
        '200':
          description: Custom field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
        4XX:
          $ref: '#/components/responses/ErrorResponse'
    patch:
      tags:
      - CustomFields
      summary: Update Custom Field
      operationId: updateCustomField
      parameters:
      - $ref: '#/components/parameters/OnBehalfOf'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomField'
      responses:
        '200':
          description: Updated.
        4XX:
          $ref: '#/components/responses/ErrorResponse'
    delete:
      tags:
      - CustomFields
      summary: Delete Custom Field
      operationId: deleteCustomField
      parameters:
      - $ref: '#/components/parameters/OnBehalfOf'
      responses:
        '204':
          description: Deleted.
        4XX:
          $ref: '#/components/responses/ErrorResponse'
  /custom_fields/{id}/custom_field_options:
    parameters:
    - $ref: '#/components/parameters/Id'
    get:
      tags:
      - CustomFields
      summary: List Custom Field Options
      operationId: listCustomFieldOptions
      responses:
        '200':
          description: Options.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomFieldOption'
        4XX:
          $ref: '#/components/responses/ErrorResponse'
    post:
      tags:
      - CustomFields
      summary: Create Custom Field Option
      operationId: createCustomFieldOption
      parameters:
      - $ref: '#/components/parameters/OnBehalfOf'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFieldOption'
      responses:
        '201':
          description: Created.
        4XX:
          $ref: '#/components/responses/ErrorResponse'
  /custom_fields/{id}/custom_field_options/{option_id}:
    parameters:
    - $ref: '#/components/parameters/Id'
    - name: option_id
      in: path
      required: true
      schema:
        type: integer
    patch:
      tags:
      - CustomFields
      summary: Update Custom Field Option
      operationId: updateCustomFieldOption
      parameters:
      - $ref: '#/components/parameters/OnBehalfOf'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFieldOption'
      responses:
        '200':
          description: Updated.
        4XX:
          $ref: '#/components/responses/ErrorResponse'
    delete:
      tags:
      - CustomFields
      summary: Delete Custom Field Option
      operationId: deleteCustomFieldOption
      parameters:
      - $ref: '#/components/parameters/OnBehalfOf'
      responses:
        '204':
          description: Deleted.
        4XX:
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    CustomField:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        field_type:
          type: string
          enum:
          - job
          - candidate
          - application
          - offer
          - opening
          - department
          - office
          - user
          - prospect
        value_type:
          type: string
          enum:
          - short_text
          - long_text
          - currency
          - currency_range
          - date
          - number
          - number_range
          - single_select
          - multi_select
          - url
          - yes_no
        active:
          type: boolean
        required:
          type: boolean
        private:
          type: boolean
        custom_field_options:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldOption'
    Error:
      type: object
      properties:
        message:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
    CustomFieldOption:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        priority:
          type: integer
        external_id:
          type: string
          nullable: true
  responses:
    ErrorResponse:
      description: Error response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    OnBehalfOf:
      name: On-Behalf-Of
      in: header
      required: false
      description: The ID of the Greenhouse user the request is being made on behalf of.
      schema:
        type: integer
    Id:
      name: id
      in: path
      required: true
      schema:
        type: integer
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic with the Harvest API key as the username and an empty password (Base64 encoded).