Can I use Greenhouse as a CLI?

Yes. KosmoKrator exposes a Greenhouse CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Greenhouse through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Greenhouse tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Greenhouse credentials stored?

Greenhouse credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Greenhouse MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

productivity

Greenhouse Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Greenhouse KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.greenhouse.*. Use lua_read_doc("integrations.greenhouse") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Greenhouse workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.greenhouse.generate_access_token({body = "example_body"}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("greenhouse"))' --json
kosmo integrations:lua --eval 'print(docs.read("greenhouse.generate_access_token"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local greenhouse = app.integrations.greenhouse
local result = greenhouse.generate_access_token({body = "example_body"})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.greenhouse, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.greenhouse.default.* or app.integrations.greenhouse.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Greenhouse, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Greenhouse Integration

Use the greenhouse integration to call Greenhouse Harvest v3 endpoints for recruiting data: candidates, applications, jobs, interviews, offers, users, approvals, custom fields, departments, offices, scorecards, and partner webhooks.

This package is generated from Greenhouse’s official Harvest v3 OpenAPI registry and exposes 151 operations. Harvest v1/v2 are deprecated; this integration targets v3.

Authentication

Supply access_token to call Harvest v3 with an existing bearer token.
Or supply client_id and client_secret; the integration calls /auth/token and uses the returned access_token for runtime calls.
url defaults to https://harvest.greenhouse.io.

Request Shape

Path, query, and header parameters are exposed as snake_case tool parameters. JSON request bodies are passed through the body object and should match the official Harvest v3 schema for that endpoint.

List filters support Greenhouse’s documented shapes. For date filters such as created_at, pass either a preformatted string like "gte|2024-01-01T00:00:00Z" or an object such as { gte = "2024-01-01T00:00:00Z" }. Array filters such as ids are serialized as comma-separated values.

Return Shape

Responses are returned as decoded JSON from Greenhouse. Empty responses return { success = true, status = 204 } plus the pagination Link header when present. API errors are converted to tool errors using Greenhouse’s message or error response when available.

Examples

local token = app.integrations.greenhouse.post_auth_token({
  body = { sub = 123456 }
})

local candidates = app.integrations.greenhouse.get_v3_candidates({
  per_page = 50,
  created_at = { gte = "2024-01-01T00:00:00Z" },
})

local candidate = app.integrations.greenhouse.post_v3_candidates({
  body = {
    first_name = "Ada",
    last_name = "Lovelace",
    email_addresses = {{ value = "[email protected]", type = "personal" }},
  }
})

Use fake names, email addresses, IDs, and tokens in tests and examples. Never store real Greenhouse candidate, employee, job, offer, interview, webhook, or OAuth credential data in fixtures or Lua examples.

Raw agent markdown

# Greenhouse Integration

Use the `greenhouse` integration to call Greenhouse Harvest v3 endpoints for recruiting data: candidates, applications, jobs, interviews, offers, users, approvals, custom fields, departments, offices, scorecards, and partner webhooks.

This package is generated from Greenhouse's official Harvest v3 OpenAPI registry and exposes 151 operations. Harvest v1/v2 are deprecated; this integration targets v3.

## Authentication

- Supply `access_token` to call Harvest v3 with an existing bearer token.
- Or supply `client_id` and `client_secret`; the integration calls `/auth/token` and uses the returned `access_token` for runtime calls.
- `url` defaults to `https://harvest.greenhouse.io`.

## Request Shape

Path, query, and header parameters are exposed as snake_case tool parameters. JSON request bodies are passed through the `body` object and should match the official Harvest v3 schema for that endpoint.

List filters support Greenhouse's documented shapes. For date filters such as `created_at`, pass either a preformatted string like `"gte|2024-01-01T00:00:00Z"` or an object such as `{ gte = "2024-01-01T00:00:00Z" }`. Array filters such as `ids` are serialized as comma-separated values.

## Return Shape

Responses are returned as decoded JSON from Greenhouse. Empty responses return `{ success = true, status = 204 }` plus the pagination `Link` header when present. API errors are converted to tool errors using Greenhouse's `message` or `error` response when available.

## Examples

```lua
local token = app.integrations.greenhouse.post_auth_token({
  body = { sub = 123456 }
})

local candidates = app.integrations.greenhouse.get_v3_candidates({
  per_page = 50,
  created_at = { gte = "2024-01-01T00:00:00Z" },
})

local candidate = app.integrations.greenhouse.post_v3_candidates({
  body = {
    first_name = "Ada",
    last_name = "Lovelace",
    email_addresses = {{ value = "[email protected]", type = "personal" }},
  }
})
```

Use fake names, email addresses, IDs, and tokens in tests and examples. Never store real Greenhouse candidate, employee, job, offer, interview, webhook, or OAuth credential data in fixtures or Lua examples.

Metadata-derived Lua example

local result = app.integrations.greenhouse.generate_access_token({body = "example_body"})
print(result)

Functions

generate_access_token Read

generate access_token Official Greenhouse Harvest v3 endpoint: POST /auth/token.

Lua path: app.integrations.greenhouse.generate_access_token
Full name: greenhouse.greenhouse_post_auth_token

Parameter	Type	Required	Description
`body`	object	no	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_application_stages Read

List application stages Official Greenhouse Harvest v3 endpoint: GET /v3/application_stages.

Lua path: app.integrations.greenhouse.list_application_stages
Full name: greenhouse.greenhouse_get_v3_application_stages

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`application_ids`	array	no	Comma separated list
`job_interview_stage_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`current`	boolean	no	query parameter `current`.

convert_prospect_candidate Read

Convert a prospect to a candidate Official Greenhouse Harvest v3 endpoint: POST /v3/applications/{id}/convert_to_candidate.

Lua path: app.integrations.greenhouse.convert_prospect_candidate
Full name: greenhouse.greenhouse_post_v3_applications_id_convert_to_candidate

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

create_application Read

Create Application Official Greenhouse Harvest v3 endpoint: POST /v3/applications.

Lua path: app.integrations.greenhouse.create_application
Full name: greenhouse.greenhouse_post_v3_applications

Parameter	Type	Required	Description
`body`	object	no	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_applications Read

List applications Official Greenhouse Harvest v3 endpoint: GET /v3/applications.

Lua path: app.integrations.greenhouse.list_applications
Full name: greenhouse.greenhouse_get_v3_applications

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`candidate_ids`	array	no	Comma separated list
`job_ids`	array	no	Comma separated list
`prospective_job_ids`	array	no	Comma separated list
`job_post_ids`	array	no	Comma separated list
`source_ids`	array	no	Comma separated list
`referrer_ids`	array	no	Comma separated list
`stage_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`status`	string	no	query parameter `status`.
`custom_field_option_id`	integer	no	query parameter `custom_field_option_id`.
`last_activity_at`	object	no	query parameter `last_activity_at`.
`prospect`	boolean	no	query parameter `prospect`.

delete_application Write

Delete Application Official Greenhouse Harvest v3 endpoint: DELETE /v3/applications/{id}.

Lua path: app.integrations.greenhouse.delete_application
Full name: greenhouse.greenhouse_delete_v3_applications_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

update_applications Read

Update Applications Official Greenhouse Harvest v3 endpoint: PATCH /v3/applications/{id}.

Lua path: app.integrations.greenhouse.update_applications
Full name: greenhouse.greenhouse_patch_v3_applications_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

mark_application_as_hire Read

Mark an application as hire Official Greenhouse Harvest v3 endpoint: POST /v3/applications/{id}/hire.

Lua path: app.integrations.greenhouse.mark_application_as_hire
Full name: greenhouse.greenhouse_post_v3_applications_id_hire

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

move_application_different_stage_within_same_job_or_transfer_another_job Read

Move an application to a different stage within the same job or transfer to another job Official Greenhouse Harvest v3 endpoint: POST /v3/applications/{id}/move.

Lua path: app.integrations.greenhouse.move_application_different_stage_within_same_job_or_transfer_another_job
Full name: greenhouse.greenhouse_post_v3_applications_id_move

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

reject_application Read

Reject Application Official Greenhouse Harvest v3 endpoint: POST /v3/applications/{id}/reject.

Lua path: app.integrations.greenhouse.reject_application
Full name: greenhouse.greenhouse_post_v3_applications_id_reject

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

unreject_application Read

Unreject Application Official Greenhouse Harvest v3 endpoint: POST /v3/applications/{id}/unreject.

Lua path: app.integrations.greenhouse.unreject_application
Full name: greenhouse.greenhouse_post_v3_applications_id_unreject

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	no	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

create_applied_candidate_tag Read

Create Applied Candidate Tag Official Greenhouse Harvest v3 endpoint: POST /v3/applied_candidate_tags.

Lua path: app.integrations.greenhouse.create_applied_candidate_tag
Full name: greenhouse.greenhouse_post_v3_applied_candidate_tags

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_applied_candidate_tags Read

List applied candidate tags Official Greenhouse Harvest v3 endpoint: GET /v3/applied_candidate_tags.

Lua path: app.integrations.greenhouse.list_applied_candidate_tags
Full name: greenhouse.greenhouse_get_v3_applied_candidate_tags

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`candidate_tag_ids`	array	no	Comma separated list
`candidate_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

delete_applied_candidate_tag Write

Delete Applied Candidate Tag Official Greenhouse Harvest v3 endpoint: DELETE /v3/applied_candidate_tags/{id}.

Lua path: app.integrations.greenhouse.delete_applied_candidate_tag
Full name: greenhouse.greenhouse_delete_v3_applied_candidate_tags_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

create_approval_flow Read

Create Approval Flow Official Greenhouse Harvest v3 endpoint: POST /v3/approval_flows.

Lua path: app.integrations.greenhouse.create_approval_flow
Full name: greenhouse.greenhouse_post_v3_approval_flows

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_approval_flows Read

List approval flows Official Greenhouse Harvest v3 endpoint: GET /v3/approval_flows.

Lua path: app.integrations.greenhouse.list_approval_flows
Full name: greenhouse.greenhouse_get_v3_approval_flows

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`job_ids`	array	no	Comma separated list
`offer_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`approval_type`	string	no	query parameter `approval_type`.

replace_approver_groups Read

Replace Approver Groups Official Greenhouse Harvest v3 endpoint: PUT /v3/approval_flows/{id}/replace_approver_groups.

Lua path: app.integrations.greenhouse.replace_approver_groups
Full name: greenhouse.greenhouse_put_v3_approval_flows_id_replace_approver_groups

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

request_approvals Read

Request Approvals Official Greenhouse Harvest v3 endpoint: POST /v3/approval_flows/{id}/request_approvals.

Lua path: app.integrations.greenhouse.request_approvals
Full name: greenhouse.greenhouse_post_v3_approval_flows_id_request_approvals

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	no	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

update_approval_flow Read

Update Approval Flow Official Greenhouse Harvest v3 endpoint: PATCH /v3/approval_flows/{id}.

Lua path: app.integrations.greenhouse.update_approval_flow
Full name: greenhouse.greenhouse_patch_v3_approval_flows_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_approver_groups Read

List approver groups Official Greenhouse Harvest v3 endpoint: GET /v3/approver_groups.

Lua path: app.integrations.greenhouse.list_approver_groups
Full name: greenhouse.greenhouse_get_v3_approver_groups

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`approval_flow_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

replace_approver Read

Replace Approver Official Greenhouse Harvest v3 endpoint: PUT /v3/approver_groups/{id}/replace_approver.

Lua path: app.integrations.greenhouse.replace_approver
Full name: greenhouse.greenhouse_put_v3_approver_groups_id_replace_approver

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_approvers Read

List approvers Official Greenhouse Harvest v3 endpoint: GET /v3/approvers.

Lua path: app.integrations.greenhouse.list_approvers
Full name: greenhouse.greenhouse_get_v3_approvers

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`approver_group_ids`	array	no	Comma separated list
`user_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`status`	string	no	query parameter `status`.

create_attachment Read

Create Attachment Official Greenhouse Harvest v3 endpoint: POST /v3/attachments.

Lua path: app.integrations.greenhouse.create_attachment
Full name: greenhouse.greenhouse_post_v3_attachments

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_attachments Read

List attachments Official Greenhouse Harvest v3 endpoint: GET /v3/attachments.

Lua path: app.integrations.greenhouse.list_attachments
Full name: greenhouse.greenhouse_get_v3_attachments

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`application_ids`	array	no	Comma separated list
`candidate_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`type`	string	no	query parameter `type`.

delete_attachment Write

Delete Attachment Official Greenhouse Harvest v3 endpoint: DELETE /v3/attachments/{id}.

Lua path: app.integrations.greenhouse.delete_attachment
Full name: greenhouse.greenhouse_delete_v3_attachments_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

bulk_requests Read

Bulk requests Official Greenhouse Harvest v3 endpoint: GET /v3/bulk_requests.

Lua path: app.integrations.greenhouse.bulk_requests
Full name: greenhouse.greenhouse_get_v3_bulk_requests

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return
`bulk_action_uuid`	string	no	query parameter `bulk_action_uuid`.
`active`	boolean	no	query parameter `active`.

bulk_requests Read

Bulk requests Official Greenhouse Harvest v3 endpoint: GET /v3/bulk_requests/abc-123-def-456.

Lua path: app.integrations.greenhouse.bulk_requests
Full name: greenhouse.greenhouse_get_v3_bulk_requests_abc_123_def_456

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return
`bulk_action_uuid`	string	no	query parameter `bulk_action_uuid`.

list_candidate_attribute_types Read

List candidate attribute types Official Greenhouse Harvest v3 endpoint: GET /v3/candidate_attribute_types.

Lua path: app.integrations.greenhouse.list_candidate_attribute_types
Full name: greenhouse.greenhouse_get_v3_candidate_attribute_types

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return
`active`	boolean	no	query parameter `active`.
`is_draft`	boolean	no	query parameter `is_draft`.

create_candidate_education Read

Create Candidate Education Official Greenhouse Harvest v3 endpoint: POST /v3/candidate_educations.

Lua path: app.integrations.greenhouse.create_candidate_education
Full name: greenhouse.greenhouse_post_v3_candidate_educations

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_candidate_educations Read

List candidate educations Official Greenhouse Harvest v3 endpoint: GET /v3/candidate_educations.

Lua path: app.integrations.greenhouse.list_candidate_educations
Full name: greenhouse.greenhouse_get_v3_candidate_educations

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`candidate_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`start_at`	object	no	query parameter `start_at`.
`end_at`	object	no	query parameter `end_at`.
`latest`	boolean	no	query parameter `latest`.

delete_candidate_education Write

Delete Candidate Education Official Greenhouse Harvest v3 endpoint: DELETE /v3/candidate_educations/{id}.

Lua path: app.integrations.greenhouse.delete_candidate_education
Full name: greenhouse.greenhouse_delete_v3_candidate_educations_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

create_candidate_employment Read

Create Candidate Employment Official Greenhouse Harvest v3 endpoint: POST /v3/candidate_employments.

Lua path: app.integrations.greenhouse.create_candidate_employment
Full name: greenhouse.greenhouse_post_v3_candidate_employments

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_candidate_employments Read

List candidate employments Official Greenhouse Harvest v3 endpoint: GET /v3/candidate_employments.

Lua path: app.integrations.greenhouse.list_candidate_employments
Full name: greenhouse.greenhouse_get_v3_candidate_employments

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`candidate_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`latest`	boolean	no	query parameter `latest`.

delete_candidate_employments Write

Delete Candidate Employments Official Greenhouse Harvest v3 endpoint: DELETE /v3/candidate_employments/{id}.

Lua path: app.integrations.greenhouse.delete_candidate_employments
Full name: greenhouse.greenhouse_delete_v3_candidate_employments_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

create_candidate_tag Read

Create Candidate Tag Official Greenhouse Harvest v3 endpoint: POST /v3/candidate_tags.

Lua path: app.integrations.greenhouse.create_candidate_tag
Full name: greenhouse.greenhouse_post_v3_candidate_tags

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_candidate_tags Read

List candidate tags Official Greenhouse Harvest v3 endpoint: GET /v3/candidate_tags.

Lua path: app.integrations.greenhouse.list_candidate_tags
Full name: greenhouse.greenhouse_get_v3_candidate_tags

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return

delete_candidate_tags Write

Delete Candidate Tags Official Greenhouse Harvest v3 endpoint: DELETE /v3/candidate_tags/{id}.

Lua path: app.integrations.greenhouse.delete_candidate_tags
Full name: greenhouse.greenhouse_delete_v3_candidate_tags_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

anonymize_candidates Read

Anonymize Candidates Official Greenhouse Harvest v3 endpoint: PATCH /v3/candidates/{id}/anonymize.

Lua path: app.integrations.greenhouse.anonymize_candidates
Full name: greenhouse.greenhouse_patch_v3_candidates_id_anonymize

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

create_candidate Read

Create Candidate Official Greenhouse Harvest v3 endpoint: POST /v3/candidates.

Lua path: app.integrations.greenhouse.create_candidate
Full name: greenhouse.greenhouse_post_v3_candidates

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_candidates Read

List candidates Official Greenhouse Harvest v3 endpoint: GET /v3/candidates.

Lua path: app.integrations.greenhouse.list_candidates
Full name: greenhouse.greenhouse_get_v3_candidates

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return
`last_activity_at`	object	no	query parameter `last_activity_at`.
`custom_field_option_id`	integer	no	query parameter `custom_field_option_id`.
`private`	boolean	no	query parameter `private`.
`email`	string	no	query parameter `email`.
`tag`	string	no	query parameter `tag`.

delete_candidate Write

Delete Candidate Official Greenhouse Harvest v3 endpoint: DELETE /v3/candidates/{id}.

Lua path: app.integrations.greenhouse.delete_candidate
Full name: greenhouse.greenhouse_delete_v3_candidates_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

update_candidates Read

Update Candidates Official Greenhouse Harvest v3 endpoint: PATCH /v3/candidates/{id}.

Lua path: app.integrations.greenhouse.update_candidates
Full name: greenhouse.greenhouse_patch_v3_candidates_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

merge_candidates Read

Merge Candidates Official Greenhouse Harvest v3 endpoint: POST /v3/candidates/{id}/merge.

Lua path: app.integrations.greenhouse.merge_candidates
Full name: greenhouse.greenhouse_post_v3_candidates_id_merge

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_close_reasons Read

List close reasons Official Greenhouse Harvest v3 endpoint: GET /v3/close_reasons.

Lua path: app.integrations.greenhouse.list_close_reasons
Full name: greenhouse.greenhouse_get_v3_close_reasons

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return

create_custom_field_department Read

Create Custom Field Department Official Greenhouse Harvest v3 endpoint: POST /v3/custom_field_departments.

Lua path: app.integrations.greenhouse.create_custom_field_department
Full name: greenhouse.greenhouse_post_v3_custom_field_departments

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_custom_field_departments Read

List custom field departments Official Greenhouse Harvest v3 endpoint: GET /v3/custom_field_departments.

Lua path: app.integrations.greenhouse.list_custom_field_departments
Full name: greenhouse.greenhouse_get_v3_custom_field_departments

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`custom_field_ids`	array	no	Comma separated list
`department_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

delete_custom_field_department Write

Delete Custom Field Department Official Greenhouse Harvest v3 endpoint: DELETE /v3/custom_field_departments/{id}.

Lua path: app.integrations.greenhouse.delete_custom_field_department
Full name: greenhouse.greenhouse_delete_v3_custom_field_departments_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

create_custom_field_office Read

Create Custom Field Office Official Greenhouse Harvest v3 endpoint: POST /v3/custom_field_offices.

Lua path: app.integrations.greenhouse.create_custom_field_office
Full name: greenhouse.greenhouse_post_v3_custom_field_offices

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_custom_field_offices Read

List custom field offices Official Greenhouse Harvest v3 endpoint: GET /v3/custom_field_offices.

Lua path: app.integrations.greenhouse.list_custom_field_offices
Full name: greenhouse.greenhouse_get_v3_custom_field_offices

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`custom_field_ids`	array	no	Comma separated list
`office_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

delete_custom_field_office Write

Delete Custom Field Office Official Greenhouse Harvest v3 endpoint: DELETE /v3/custom_field_offices/{id}.

Lua path: app.integrations.greenhouse.delete_custom_field_office
Full name: greenhouse.greenhouse_delete_v3_custom_field_offices_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

create_custom_field_option Read

Create Custom Field Option Official Greenhouse Harvest v3 endpoint: POST /v3/custom_field_options.

Lua path: app.integrations.greenhouse.create_custom_field_option
Full name: greenhouse.greenhouse_post_v3_custom_field_options

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_custom_field_options Read

List custom field options Official Greenhouse Harvest v3 endpoint: GET /v3/custom_field_options.

Lua path: app.integrations.greenhouse.list_custom_field_options
Full name: greenhouse.greenhouse_get_v3_custom_field_options

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`custom_field_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`active`	boolean	no	query parameter `active`.
`custom_field_key`	string	no	query parameter `custom_field_key`.

update_custom_field_options Read

Update Custom Field Options Official Greenhouse Harvest v3 endpoint: PATCH /v3/custom_field_options/{id}.

Lua path: app.integrations.greenhouse.update_custom_field_options
Full name: greenhouse.greenhouse_patch_v3_custom_field_options_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

delete_custom_field_option Write

Delete Custom Field Option Official Greenhouse Harvest v3 endpoint: DELETE /v3/custom_field_options/{id}.

Lua path: app.integrations.greenhouse.delete_custom_field_option
Full name: greenhouse.greenhouse_delete_v3_custom_field_options_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

create_custom_field Read

Create Custom Field Official Greenhouse Harvest v3 endpoint: POST /v3/custom_fields.

Lua path: app.integrations.greenhouse.create_custom_field
Full name: greenhouse.greenhouse_post_v3_custom_fields

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_custom_fields Read

List custom fields Official Greenhouse Harvest v3 endpoint: GET /v3/custom_fields.

Lua path: app.integrations.greenhouse.list_custom_fields
Full name: greenhouse.greenhouse_get_v3_custom_fields

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return
`field_type`	string	no	query parameter `field_type`.
`active`	boolean	no	query parameter `active`.
`name`	string	no	query parameter `name`.
`name_key`	string	no	query parameter `name_key`.

delete_custom_field Write

Delete Custom Field Official Greenhouse Harvest v3 endpoint: DELETE /v3/custom_fields/{id}.

Lua path: app.integrations.greenhouse.delete_custom_field
Full name: greenhouse.greenhouse_delete_v3_custom_fields_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

update_custom_fields Read

Update Custom Fields Official Greenhouse Harvest v3 endpoint: PATCH /v3/custom_fields/{id}.

Lua path: app.integrations.greenhouse.update_custom_fields
Full name: greenhouse.greenhouse_patch_v3_custom_fields_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_default_interviewers Read

List default interviewers Official Greenhouse Harvest v3 endpoint: GET /v3/default_interviewers.

Lua path: app.integrations.greenhouse.list_default_interviewers
Full name: greenhouse.greenhouse_get_v3_default_interviewers

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`user_ids`	array	no	Comma separated list
`interview_kit_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

list_demographic_answer_options Read

List demographic answer options Official Greenhouse Harvest v3 endpoint: GET /v3/demographic_answer_options.

Lua path: app.integrations.greenhouse.list_demographic_answer_options
Full name: greenhouse.greenhouse_get_v3_demographic_answer_options

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`demographic_question_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`active`	boolean	no	query parameter `active`.

list_demographic_answers Read

List demographic answers Official Greenhouse Harvest v3 endpoint: GET /v3/demographic_answers.

Lua path: app.integrations.greenhouse.list_demographic_answers
Full name: greenhouse.greenhouse_get_v3_demographic_answers

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`application_ids`	array	no	Comma separated list
`demographic_question_ids`	array	no	Comma separated list
`demographic_answer_option_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

list_demographic_question_sets Read

List demographic question sets Official Greenhouse Harvest v3 endpoint: GET /v3/demographic_question_sets.

Lua path: app.integrations.greenhouse.list_demographic_question_sets
Full name: greenhouse.greenhouse_get_v3_demographic_question_sets

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return
`active`	boolean	no	query parameter `active`.
`enabled`	boolean	no	query parameter `enabled`.

list_demographic_questions Read

List demographic questions Official Greenhouse Harvest v3 endpoint: GET /v3/demographic_questions.

Lua path: app.integrations.greenhouse.list_demographic_questions
Full name: greenhouse.greenhouse_get_v3_demographic_questions

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`demographic_question_set_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`active`	boolean	no	query parameter `active`.
`required`	boolean	no	query parameter `required`.

create_department Read

Create Department Official Greenhouse Harvest v3 endpoint: POST /v3/departments.

Lua path: app.integrations.greenhouse.create_department
Full name: greenhouse.greenhouse_post_v3_departments

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_departments Read

List departments Official Greenhouse Harvest v3 endpoint: GET /v3/departments.

Lua path: app.integrations.greenhouse.list_departments
Full name: greenhouse.greenhouse_get_v3_departments

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return
`parent_id`	integer	no	query parameter `parent_id`.
`external_id`	string	no	query parameter `external_id`.

update_department Read

Update Department Official Greenhouse Harvest v3 endpoint: PATCH /v3/departments/{id}.

Lua path: app.integrations.greenhouse.update_department
Full name: greenhouse.greenhouse_patch_v3_departments_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_eeoc Read

List EEOC Official Greenhouse Harvest v3 endpoint: GET /v3/eeoc.

Lua path: app.integrations.greenhouse.list_eeoc
Full name: greenhouse.greenhouse_get_v3_eeoc

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`application_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`submitted_at`	object	no	query parameter `submitted_at`.

list_email_templates Read

List email templates Official Greenhouse Harvest v3 endpoint: GET /v3/email_templates.

Lua path: app.integrations.greenhouse.list_email_templates
Full name: greenhouse.greenhouse_get_v3_email_templates

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return
`email_type`	string	no	query parameter `email_type`.
`from_type`	string	no	query parameter `from_type`.

list_focus_candidate_attributes Read

List focus candidate attributes Official Greenhouse Harvest v3 endpoint: GET /v3/focus_candidate_attributes.

Lua path: app.integrations.greenhouse.list_focus_candidate_attributes
Full name: greenhouse.greenhouse_get_v3_focus_candidate_attributes

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`interview_kit_ids`	array	no	Comma separated list
`job_candidate_attribute_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

create_future_job_permission Read

Create Future Job Permission Official Greenhouse Harvest v3 endpoint: POST /v3/future_job_permissions.

Lua path: app.integrations.greenhouse.create_future_job_permission
Full name: greenhouse.greenhouse_post_v3_future_job_permissions

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_future_job_permissions Read

List future job permissions Official Greenhouse Harvest v3 endpoint: GET /v3/future_job_permissions.

Lua path: app.integrations.greenhouse.list_future_job_permissions
Full name: greenhouse.greenhouse_get_v3_future_job_permissions

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`department_ids`	array	no	Comma separated list
`office_ids`	array	no	Comma separated list
`user_ids`	array	no	Comma separated list
`role_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`external_department_id`	string	no	query parameter `external_department_id`.
`external_office_id`	string	no	query parameter `external_office_id`.

delete_future_job_permission Write

Delete Future Job Permission Official Greenhouse Harvest v3 endpoint: DELETE /v3/future_job_permissions/{id}.

Lua path: app.integrations.greenhouse.delete_future_job_permission
Full name: greenhouse.greenhouse_delete_v3_future_job_permissions_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

list_interview_kits Read

List interview kits Official Greenhouse Harvest v3 endpoint: GET /v3/interview_kits.

Lua path: app.integrations.greenhouse.list_interview_kits
Full name: greenhouse.greenhouse_get_v3_interview_kits

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`job_ids`	array	no	Comma separated list
`job_interview_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

list_interviewer_tags Read

List interviewer tags Official Greenhouse Harvest v3 endpoint: GET /v3/interviewer_tags.

Lua path: app.integrations.greenhouse.list_interviewer_tags
Full name: greenhouse.greenhouse_get_v3_interviewer_tags

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return

list_interviewers Read

List interviewers Official Greenhouse Harvest v3 endpoint: GET /v3/interviewers.

Lua path: app.integrations.greenhouse.list_interviewers
Full name: greenhouse.greenhouse_get_v3_interviewers

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`interview_ids`	array	no	Comma separated list
`user_ids`	array	no	Comma separated list
`scorecard_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`response_status`	string	no	query parameter `response_status`.

create_interview Read

Create Interview Official Greenhouse Harvest v3 endpoint: POST /v3/interviews.

Lua path: app.integrations.greenhouse.create_interview
Full name: greenhouse.greenhouse_post_v3_interviews

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_interviews Read

List interviews Official Greenhouse Harvest v3 endpoint: GET /v3/interviews.

Lua path: app.integrations.greenhouse.list_interviews
Full name: greenhouse.greenhouse_get_v3_interviews

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`job_ids`	array	no	Comma separated list
`application_ids`	array	no	Comma separated list
`job_interview_ids`	array	no	Comma separated list
`organizer_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`starts_at`	object	no	query parameter `starts_at`.
`ends_at`	object	no	query parameter `ends_at`.
`all_day_start_on`	object	no	query parameter `all_day_start_on`.
`all_day_end_on`	object	no	query parameter `all_day_end_on`.
`external_event_id`	string	no	query parameter `external_event_id`.
`status`	string	no	query parameter `status`.

delete_interview Write

Delete Interview Official Greenhouse Harvest v3 endpoint: DELETE /v3/interviews/{id}.

Lua path: app.integrations.greenhouse.delete_interview
Full name: greenhouse.greenhouse_delete_v3_interviews_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

update_interviews Read

Update Interviews Official Greenhouse Harvest v3 endpoint: PATCH /v3/interviews/{id}.

Lua path: app.integrations.greenhouse.update_interviews
Full name: greenhouse.greenhouse_patch_v3_interviews_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_job_board_custom_locations Read

List job board custom locations Official Greenhouse Harvest v3 endpoint: GET /v3/job_board_custom_locations.

Lua path: app.integrations.greenhouse.list_job_board_custom_locations
Full name: greenhouse.greenhouse_get_v3_job_board_custom_locations

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`greenhouse_job_board_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`active`	boolean	no	query parameter `active`.

list_job_candidate_attributes Read

List job candidate attributes Official Greenhouse Harvest v3 endpoint: GET /v3/job_candidate_attributes.

Lua path: app.integrations.greenhouse.list_job_candidate_attributes
Full name: greenhouse.greenhouse_get_v3_job_candidate_attributes

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`job_ids`	array	no	Comma separated list
`candidate_attribute_type_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

create_job_hiring_manager Read

Create Job Hiring Manager Official Greenhouse Harvest v3 endpoint: POST /v3/job_hiring_managers.

Lua path: app.integrations.greenhouse.create_job_hiring_manager
Full name: greenhouse.greenhouse_post_v3_job_hiring_managers

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_job_hiring_managers Read

List job hiring managers Official Greenhouse Harvest v3 endpoint: GET /v3/job_hiring_managers.

Lua path: app.integrations.greenhouse.list_job_hiring_managers
Full name: greenhouse.greenhouse_get_v3_job_hiring_managers

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`user_ids`	array	no	Comma separated list
`job_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

delete_job_hiring_manager Write

Delete Job Hiring Manager Official Greenhouse Harvest v3 endpoint: DELETE /v3/job_hiring_managers/{id}.

Lua path: app.integrations.greenhouse.delete_job_hiring_manager
Full name: greenhouse.greenhouse_delete_v3_job_hiring_managers_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

list_job_interview_stages Read

List job interview stages Official Greenhouse Harvest v3 endpoint: GET /v3/job_interview_stages.

Lua path: app.integrations.greenhouse.list_job_interview_stages
Full name: greenhouse.greenhouse_get_v3_job_interview_stages

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`job_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`active`	boolean	no	query parameter `active`.

list_job_interviews Read

List job interviews Official Greenhouse Harvest v3 endpoint: GET /v3/job_interviews.

Lua path: app.integrations.greenhouse.list_job_interviews
Full name: greenhouse.greenhouse_get_v3_job_interviews

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`job_interview_stage_ids`	array	no	Comma separated list
`job_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`active`	boolean	no	query parameter `active`.
`scheduling_type`	string	no	query parameter `scheduling_type`.

create_job_note Read

Create Job Note Official Greenhouse Harvest v3 endpoint: POST /v3/job_notes.

Lua path: app.integrations.greenhouse.create_job_note
Full name: greenhouse.greenhouse_post_v3_job_notes

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_job_notes Read

List job notes Official Greenhouse Harvest v3 endpoint: GET /v3/job_notes.

Lua path: app.integrations.greenhouse.list_job_notes
Full name: greenhouse.greenhouse_get_v3_job_notes

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`job_ids`	array	no	Comma separated list
`user_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`visibility`	string	no	query parameter `visibility`.

delete_job_note Write

Delete Job Note Official Greenhouse Harvest v3 endpoint: DELETE /v3/job_notes/{id}.

Lua path: app.integrations.greenhouse.delete_job_note
Full name: greenhouse.greenhouse_delete_v3_job_notes_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

update_job_notes Read

Update Job Notes Official Greenhouse Harvest v3 endpoint: PATCH /v3/job_notes/{id}.

Lua path: app.integrations.greenhouse.update_job_notes
Full name: greenhouse.greenhouse_patch_v3_job_notes_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

create_job_owner Read

Create Job Owner Official Greenhouse Harvest v3 endpoint: POST /v3/job_owners.

Lua path: app.integrations.greenhouse.create_job_owner
Full name: greenhouse.greenhouse_post_v3_job_owners

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_job_owners Read

List job owners Official Greenhouse Harvest v3 endpoint: GET /v3/job_owners.

Lua path: app.integrations.greenhouse.list_job_owners
Full name: greenhouse.greenhouse_get_v3_job_owners

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`user_ids`	array	no	Comma separated list
`job_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`type`	string	no	query parameter `type`.

delete_job_owner Write

Delete Job Owner Official Greenhouse Harvest v3 endpoint: DELETE /v3/job_owners/{id}.

Lua path: app.integrations.greenhouse.delete_job_owner
Full name: greenhouse.greenhouse_delete_v3_job_owners_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

create_job_post_location Read

Create Job Post Location Official Greenhouse Harvest v3 endpoint: POST /v3/job_post_locations.

Lua path: app.integrations.greenhouse.create_job_post_location
Full name: greenhouse.greenhouse_post_v3_job_post_locations

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_job_post_locations Read

List job post locations Official Greenhouse Harvest v3 endpoint: GET /v3/job_post_locations.

Lua path: app.integrations.greenhouse.list_job_post_locations
Full name: greenhouse.greenhouse_get_v3_job_post_locations

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`office_ids`	array	no	Comma separated list
`job_post_ids`	array	no	Comma separated list
`custom_location_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`type`	string	no	query parameter `type`.
`plain_text_location`	string	no	query parameter `plain_text_location`.

delete_job_post_location Write

Delete Job Post Location Official Greenhouse Harvest v3 endpoint: DELETE /v3/job_post_locations/{id}.

Lua path: app.integrations.greenhouse.delete_job_post_location
Full name: greenhouse.greenhouse_delete_v3_job_post_locations_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

list_job_posts Read

List job posts Official Greenhouse Harvest v3 endpoint: GET /v3/job_posts.

Lua path: app.integrations.greenhouse.list_job_posts
Full name: greenhouse.greenhouse_get_v3_job_posts

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`job_ids`	array	no	Comma separated list
`job_board_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`active`	boolean	no	query parameter `active`.
`featured`	boolean	no	query parameter `featured`.
`live`	boolean	no	query parameter `live`.
`internal`	boolean	no	query parameter `internal`.

update_job_posts Read

Update Job Posts Official Greenhouse Harvest v3 endpoint: PATCH /v3/job_posts/{id}.

Lua path: app.integrations.greenhouse.update_job_posts
Full name: greenhouse.greenhouse_patch_v3_job_posts_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

create_job Read

Create job Official Greenhouse Harvest v3 endpoint: POST /v3/jobs.

Lua path: app.integrations.greenhouse.create_job
Full name: greenhouse.greenhouse_post_v3_jobs

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_jobs Read

List jobs Official Greenhouse Harvest v3 endpoint: GET /v3/jobs.

Lua path: app.integrations.greenhouse.list_jobs
Full name: greenhouse.greenhouse_get_v3_jobs

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return
`opened_at`	object	no	query parameter `opened_at`.
`closed_at`	object	no	query parameter `closed_at`.
`requisition_id`	string	no	query parameter `requisition_id`.
`department_id`	integer	no	query parameter `department_id`.
`office_id`	integer	no	query parameter `office_id`.
`custom_field_option_id`	integer	no	query parameter `custom_field_option_id`.
`confidential`	boolean	no	query parameter `confidential`.
`status`	string	no	query parameter `status`.

update_job Read

Update Job Official Greenhouse Harvest v3 endpoint: PATCH /v3/jobs/{id}.

Lua path: app.integrations.greenhouse.update_job
Full name: greenhouse.greenhouse_patch_v3_jobs_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

create_note Read

Create Note Official Greenhouse Harvest v3 endpoint: POST /v3/notes.

Lua path: app.integrations.greenhouse.create_note
Full name: greenhouse.greenhouse_post_v3_notes

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

create_offer Read

Create Offer Official Greenhouse Harvest v3 endpoint: POST /v3/offers.

Lua path: app.integrations.greenhouse.create_offer
Full name: greenhouse.greenhouse_post_v3_offers

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_offers Read

List offers Official Greenhouse Harvest v3 endpoint: GET /v3/offers.

Lua path: app.integrations.greenhouse.list_offers
Full name: greenhouse.greenhouse_get_v3_offers

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`application_ids`	array	no	Comma separated list
`job_ids`	array	no	Comma separated list
`candidate_ids`	array	no	Comma separated list
`opening_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`current_only`	boolean	no	query parameter `current_only`.
`custom_field_option_id`	integer	no	query parameter `custom_field_option_id`.
`status`	string	no	query parameter `status`.
`resolved_at`	object	no	query parameter `resolved_at`.
`sent_on`	object	no	query parameter `sent_on`.
`starts_on`	object	no	query parameter `starts_on`.

update_offers Read

Update Offers Official Greenhouse Harvest v3 endpoint: PATCH /v3/offers/{id}.

Lua path: app.integrations.greenhouse.update_offers
Full name: greenhouse.greenhouse_patch_v3_offers_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

create_office Read

Create Office Official Greenhouse Harvest v3 endpoint: POST /v3/offices.

Lua path: app.integrations.greenhouse.create_office
Full name: greenhouse.greenhouse_post_v3_offices

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_offices Read

List offices Official Greenhouse Harvest v3 endpoint: GET /v3/offices.

Lua path: app.integrations.greenhouse.list_offices
Full name: greenhouse.greenhouse_get_v3_offices

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return
`parent_id`	integer	no	query parameter `parent_id`.
`external_id`	string	no	query parameter `external_id`.

update_office Read

Update Office Official Greenhouse Harvest v3 endpoint: PATCH /v3/offices/{id}.

Lua path: app.integrations.greenhouse.update_office
Full name: greenhouse.greenhouse_patch_v3_offices_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

create_opening Read

Create Opening Official Greenhouse Harvest v3 endpoint: POST /v3/openings.

Lua path: app.integrations.greenhouse.create_opening
Full name: greenhouse.greenhouse_post_v3_openings

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_openings Read

List openings Official Greenhouse Harvest v3 endpoint: GET /v3/openings.

Lua path: app.integrations.greenhouse.list_openings
Full name: greenhouse.greenhouse_get_v3_openings

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`job_ids`	array	no	Comma separated list
`application_ids`	array	no	Comma separated list
`close_reason_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`opened_at`	object	no	query parameter `opened_at`.
`closed_at`	object	no	query parameter `closed_at`.
`custom_field_option_id`	integer	no	query parameter `custom_field_option_id`.
`open`	boolean	no	query parameter `open`.
`opening_id`	string	no	query parameter `opening_id`.

delete_openings Write

Delete Openings Official Greenhouse Harvest v3 endpoint: DELETE /v3/openings/{id}.

Lua path: app.integrations.greenhouse.delete_openings
Full name: greenhouse.greenhouse_delete_v3_openings_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

update_openings Read

Update Openings Official Greenhouse Harvest v3 endpoint: PATCH /v3/openings/{id}.

Lua path: app.integrations.greenhouse.update_openings
Full name: greenhouse.greenhouse_patch_v3_openings_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_prospect_details Read

List prospect details Official Greenhouse Harvest v3 endpoint: GET /v3/prospect_details.

Lua path: app.integrations.greenhouse.list_prospect_details
Full name: greenhouse.greenhouse_get_v3_prospect_details

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`application_ids`	array	no	Comma separated list
`pool_ids`	array	no	Comma separated list
`pool_stage_ids`	array	no	Comma separated list
`prospect_owner_ids`	array	no	Comma separated list
`department_ids`	array	no	Comma separated list
`office_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

list_prospect_pool_stages Read

List prospect pool stages Official Greenhouse Harvest v3 endpoint: GET /v3/prospect_pool_stages.

Lua path: app.integrations.greenhouse.list_prospect_pool_stages
Full name: greenhouse.greenhouse_get_v3_prospect_pool_stages

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`prospect_pool_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

list_prospect_pools Read

List prospect pools Official Greenhouse Harvest v3 endpoint: GET /v3/prospect_pools.

Lua path: app.integrations.greenhouse.list_prospect_pools
Full name: greenhouse.greenhouse_get_v3_prospect_pools

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`department_ids`	array	no	Comma separated list
`office_ids`	array	no	Comma separated list
`job_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`active`	boolean	no	query parameter `active`.

list_referrers Read

List referrers Official Greenhouse Harvest v3 endpoint: GET /v3/referrers.

Lua path: app.integrations.greenhouse.list_referrers
Full name: greenhouse.greenhouse_get_v3_referrers

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`user_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

list_rejection_details Read

List rejection details Official Greenhouse Harvest v3 endpoint: GET /v3/rejection_details.

Lua path: app.integrations.greenhouse.list_rejection_details
Full name: greenhouse.greenhouse_get_v3_rejection_details

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`application_ids`	array	no	Comma separated list
`rejection_reason_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`custom_field_option_id`	integer	no	query parameter `custom_field_option_id`.

update_rejection_details Read

Update Rejection Details Official Greenhouse Harvest v3 endpoint: PATCH /v3/rejection_details/{id}.

Lua path: app.integrations.greenhouse.update_rejection_details
Full name: greenhouse.greenhouse_patch_v3_rejection_details_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_rejection_reasons Read

List rejection reasons Official Greenhouse Harvest v3 endpoint: GET /v3/rejection_reasons.

Lua path: app.integrations.greenhouse.list_rejection_reasons
Full name: greenhouse.greenhouse_get_v3_rejection_reasons

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return
`include_defaults`	boolean	no	query parameter `include_defaults`.

list_scorecard_candidate_attributes Read

List scorecard candidate attributes Official Greenhouse Harvest v3 endpoint: GET /v3/scorecard_candidate_attributes.

Lua path: app.integrations.greenhouse.list_scorecard_candidate_attributes
Full name: greenhouse.greenhouse_get_v3_scorecard_candidate_attributes

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`scorecard_ids`	array	no	Comma separated list
`job_candidate_attribute_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

create_scorecard_candidate_attributes_restricted Read

Create scorecard candidate attributes - **restricted** Official Greenhouse Harvest v3 endpoint: POST /v3/scorecard_candidate_attributes.

Lua path: app.integrations.greenhouse.create_scorecard_candidate_attributes_restricted
Full name: greenhouse.greenhouse_post_v3_scorecard_candidate_attributes

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

updates_scorecard_candidate_attributes_restricted Read

Updates scorecard candidate attributes - **restricted** Official Greenhouse Harvest v3 endpoint: PATCH /v3/scorecard_candidate_attributes/{id}.

Lua path: app.integrations.greenhouse.updates_scorecard_candidate_attributes_restricted
Full name: greenhouse.greenhouse_patch_v3_scorecard_candidate_attributes_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_scorecard_question_answer_options Read

List scorecard question answer options Official Greenhouse Harvest v3 endpoint: GET /v3/scorecard_question_answer_options.

Lua path: app.integrations.greenhouse.list_scorecard_question_answer_options
Full name: greenhouse.greenhouse_get_v3_scorecard_question_answer_options

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`scorecard_question_option_ids`	array	no	Comma separated list
`scorecard_question_answer_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

create_scorecard_question_answer_options Read

Create scorecard question answer options Official Greenhouse Harvest v3 endpoint: POST /v3/scorecard_question_answer_options.

Lua path: app.integrations.greenhouse.create_scorecard_question_answer_options
Full name: greenhouse.greenhouse_post_v3_scorecard_question_answer_options

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_scorecard_question_answers Read

List scorecard question answers Official Greenhouse Harvest v3 endpoint: GET /v3/scorecard_question_answers.

Lua path: app.integrations.greenhouse.list_scorecard_question_answers
Full name: greenhouse.greenhouse_get_v3_scorecard_question_answers

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`scorecard_ids`	array	no	Comma separated list
`scorecard_question_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

create_scorecard_question_answers_restricted Read

Create scorecard question answers - **restricted** Official Greenhouse Harvest v3 endpoint: POST /v3/scorecard_question_answers.

Lua path: app.integrations.greenhouse.create_scorecard_question_answers_restricted
Full name: greenhouse.greenhouse_post_v3_scorecard_question_answers

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

update_scorecard_question_answers_restricted Read

Update scorecard question answers - **restricted** Official Greenhouse Harvest v3 endpoint: PATCH /v3/scorecard_question_answers/{id}.

Lua path: app.integrations.greenhouse.update_scorecard_question_answers_restricted
Full name: greenhouse.greenhouse_patch_v3_scorecard_question_answers_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_scorecard_question_candidate_attributes Read

List scorecard question candidate attributes Official Greenhouse Harvest v3 endpoint: GET /v3/scorecard_question_candidate_attributes.

Lua path: app.integrations.greenhouse.list_scorecard_question_candidate_attributes
Full name: greenhouse.greenhouse_get_v3_scorecard_question_candidate_attributes

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`scorecard_question_ids`	array	no	Comma separated list
`focus_candidate_attribute_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

list_scorecard_question_options Read

List scorecard question options Official Greenhouse Harvest v3 endpoint: GET /v3/scorecard_question_options.

Lua path: app.integrations.greenhouse.list_scorecard_question_options
Full name: greenhouse.greenhouse_get_v3_scorecard_question_options

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`scorecard_question_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`active`	boolean	no	query parameter `active`.

list_scorecard_questions Read

List scorecard questions Official Greenhouse Harvest v3 endpoint: GET /v3/scorecard_questions.

Lua path: app.integrations.greenhouse.list_scorecard_questions
Full name: greenhouse.greenhouse_get_v3_scorecard_questions

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`interview_kit_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

create_scorecard_restricted Read

Create Scorecard - **restricted** Official Greenhouse Harvest v3 endpoint: POST /v3/scorecards.

Lua path: app.integrations.greenhouse.create_scorecard_restricted
Full name: greenhouse.greenhouse_post_v3_scorecards

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_scorecards Read

List scorecards Official Greenhouse Harvest v3 endpoint: GET /v3/scorecards.

Lua path: app.integrations.greenhouse.list_scorecards
Full name: greenhouse.greenhouse_get_v3_scorecards

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`interview_kit_ids`	array	no	Comma separated list
`interviewer_ids`	array	no	Comma separated list
`submitter_ids`	array	no	Comma separated list
`application_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`interviewed_at`	object	no	query parameter `interviewed_at`.
`submitted_at`	object	no	query parameter `submitted_at`.
`status`	string	no	query parameter `status`.

update_scorecard Read

Update Scorecard Official Greenhouse Harvest v3 endpoint: PATCH /v3/scorecards/{id}.

Lua path: app.integrations.greenhouse.update_scorecard
Full name: greenhouse.greenhouse_patch_v3_scorecards_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_sources Read

List sources Official Greenhouse Harvest v3 endpoint: GET /v3/sources.

Lua path: app.integrations.greenhouse.list_sources
Full name: greenhouse.greenhouse_get_v3_sources

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return

list_tracking_links Read

List tracking links Official Greenhouse Harvest v3 endpoint: GET /v3/tracking_links.

Lua path: app.integrations.greenhouse.list_tracking_links
Full name: greenhouse.greenhouse_get_v3_tracking_links

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`job_ids`	array	no	Comma separated list
`source_ids`	array	no	Comma separated list
`referrer_ids`	array	no	Comma separated list
`job_board_ids`	array	no	Comma separated list
`job_post_ids`	array	no	Comma separated list
`related_post_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`token`	string	no	query parameter `token`.
`related_post_type`	string	no	query parameter `related_post_type`.

create_user_email Read

Create User Email Official Greenhouse Harvest v3 endpoint: POST /v3/user_emails.

Lua path: app.integrations.greenhouse.create_user_email
Full name: greenhouse.greenhouse_post_v3_user_emails

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_user_emails Read

List user emails Official Greenhouse Harvest v3 endpoint: GET /v3/user_emails.

Lua path: app.integrations.greenhouse.list_user_emails
Full name: greenhouse.greenhouse_get_v3_user_emails

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`user_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`email`	array	no	Comma separated list
`verified`	boolean	no	query parameter `verified`.
`verification_token_sent_at`	object	no	query parameter `verification_token_sent_at`.

create_user_job_permission Read

Create User Job Permission Official Greenhouse Harvest v3 endpoint: POST /v3/user_job_permissions.

Lua path: app.integrations.greenhouse.create_user_job_permission
Full name: greenhouse.greenhouse_post_v3_user_job_permissions

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_user_job_permissions Read

List user job permissions Official Greenhouse Harvest v3 endpoint: GET /v3/user_job_permissions.

Lua path: app.integrations.greenhouse.list_user_job_permissions
Full name: greenhouse.greenhouse_get_v3_user_job_permissions

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`job_ids`	array	no	Comma separated list
`user_ids`	array	no	Comma separated list
`role_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return

delete_user_job_permission Write

Delete User Job Permission Official Greenhouse Harvest v3 endpoint: DELETE /v3/user_job_permissions/{id}.

Lua path: app.integrations.greenhouse.delete_user_job_permission
Full name: greenhouse.greenhouse_delete_v3_user_job_permissions_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

list_user_roles Read

List user roles Official Greenhouse Harvest v3 endpoint: GET /v3/user_roles.

Lua path: app.integrations.greenhouse.list_user_roles
Full name: greenhouse.greenhouse_get_v3_user_roles

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return

activate_user Read

Activate a user Official Greenhouse Harvest v3 endpoint: POST /v3/users/{id}/activate.

Lua path: app.integrations.greenhouse.activate_user
Full name: greenhouse.greenhouse_post_v3_users_id_activate

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	no	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

deactivate_user Read

Deactivate a user Official Greenhouse Harvest v3 endpoint: POST /v3/users/{id}/deactivate.

Lua path: app.integrations.greenhouse.deactivate_user
Full name: greenhouse.greenhouse_post_v3_users_id_deactivate

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	no	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_users Read

List users Official Greenhouse Harvest v3 endpoint: GET /v3/users.

Lua path: app.integrations.greenhouse.list_users
Full name: greenhouse.greenhouse_get_v3_users

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`agency_ids`	array	no	Comma separated list
`office_ids`	array	no	Comma separated list
`department_ids`	array	no	Comma separated list
`linked_candidate_ids`	array	no	Comma separated list
`interviewer_tag_ids`	array	no	Comma separated list
`fields`	array	no	Comma separated list of fields to return
`employee_ids`	array	no	Comma separated list
`custom_field_option_id`	integer	no	query parameter `custom_field_option_id`.
`deactivated`	boolean	no	query parameter `deactivated`.
`primary_email`	string	no	query parameter `primary_email`.
`external_office_id`	string	no	query parameter `external_office_id`.
`external_department_id`	string	no	query parameter `external_department_id`.

create_user Read

Create user Official Greenhouse Harvest v3 endpoint: POST /v3/users.

Lua path: app.integrations.greenhouse.create_user
Full name: greenhouse.greenhouse_post_v3_users

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

revoke_user_permissions Read

Revoke user permissions Official Greenhouse Harvest v3 endpoint: POST /v3/users/{id}/revoke_permissions.

Lua path: app.integrations.greenhouse.revoke_user_permissions
Full name: greenhouse.greenhouse_post_v3_users_id_revoke_permissions

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	no	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

update_users Read

Update Users Official Greenhouse Harvest v3 endpoint: PATCH /v3/users/{id}.

Lua path: app.integrations.greenhouse.update_users
Full name: greenhouse.greenhouse_patch_v3_users_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

create_webhook_partners_exclusive Read

Create Webhook - **Greenhouse Partners Exclusive** Official Greenhouse Harvest v3 endpoint: POST /v3/webhooks.

Lua path: app.integrations.greenhouse.create_webhook_partners_exclusive
Full name: greenhouse.greenhouse_post_v3_webhooks

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.

list_webhooks_partners_exclusive Read

List Webhooks **Greenhouse Partners Exclusive** Official Greenhouse Harvest v3 endpoint: GET /v3/webhooks.

Lua path: app.integrations.greenhouse.list_webhooks_partners_exclusive
Full name: greenhouse.greenhouse_get_v3_webhooks

Parameter	Type	Required	Description
`cursor`	string	no	Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
`per_page`	integer	no	Number of results per page
`ids`	array	no	Comma separated list
`created_at`	object	no	query parameter `created_at`.
`updated_at`	object	no	query parameter `updated_at`.
`fields`	array	no	Comma separated list of fields to return
`last_delivered`	object	no	query parameter `last_delivered`.
`event_action_type`	string	no	query parameter `event_action_type`.
`deactivated`	boolean	no	query parameter `deactivated`.

delete_webhook_partners_exclusive Write

Delete Webhook - **Greenhouse Partners Exclusive** Official Greenhouse Harvest v3 endpoint: DELETE /v3/webhooks/{id}.

Lua path: app.integrations.greenhouse.delete_webhook_partners_exclusive
Full name: greenhouse.greenhouse_delete_v3_webhooks_id

Parameter	Type	Required	Description
`id`	string	yes	path parameter `id`.

update_webhook_partners_exclusive Read

Update Webhook - **Greenhouse Partners Exclusive** Official Greenhouse Harvest v3 endpoint: PATCH /v3/webhooks/{id}.

Lua path: app.integrations.greenhouse.update_webhook_partners_exclusive
Full name: greenhouse.greenhouse_patch_v3_webhooks_id

Parameter	Type	Required	Description
`id`	integer	yes	path parameter `id`.
`body`	object	yes	JSON request body matching the official Greenhouse Harvest v3 schema for this operation.