Module airbyte_agent_sdk.connectors.greenhouse.connector

Greenhouse connector.

Classes

ApplicationsQuery(connector: GreenhouseConnector) : Query class for Applications entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: ApplicationsSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.greenhouse.models.AirbyteSearchResult[ApplicationsSearchData] : Search applications records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (ApplicationsSearchFilter):

agency_note_id: Id of the note created when the candidate was submitted by an agency, or null if the application did not come through an agency.
answers: Free-text answers the candidate provided on the job post application form. Each entry pairs the question text with the candidate's answer.
candidate_id: Id of the candidate (person) this application belongs to.
coordinator_id: Id of the user assigned as coordinator on the application's job, or null when unassigned.
created_at: Created at from the Greenhouse v3 applications record.
custom_fields: Org-defined custom fields keyed by the field's name_key. Each value carries the field's display name, its type, and its value.
id: Id from the Greenhouse v3 applications record.
job_id: Id of the job this application is on. null for jobless prospect applications.
job_interview_stage_id: Id of the job interview stage definition (see GET /v3/job_interview_stages) the candidate is currently in for this application. null for prospect applications and applications in a terminal state.
job_post_id: Id of the job post the candidate applied through, or null if the application was created internally rather than from a posted role.
last_activity_at: Timestamp of the most recent activity on this application (notes, emails, stage changes, etc.), in ISO 8601.
location_address: Free-form location string captured on the application (typically from the job post's location question).
needs_decision: true when the application is waiting on a hiring-team decision (scorecard completion, advance/reject, etc.) in its current stage.
prospect: true for prospect applications (sourced candidates not yet attached to a single job), false for candidate applications on a specific job.
prospective_job_ids: For prospect applications, the ids of jobs the prospect is being considered for. Empty for non-prospect applications and for jobless prospects.
recruiter_id: Id of the user assigned as recruiter on the application's job, or null when unassigned.
referrer_id: Id of the referrer who credited this application, or null if there was no referral. References a referrer, not a Greenhouse user.
rejected_at: Timestamp the application was rejected, in ISO 8601. null for applications that have not been rejected.
rejection_reason_id: Id of the rejection reason selected for the application. References a /v3/rejection_reasons row scoped to the organization. null when the application was rejected without a reason, or has not been rejected.
source_id: Id of the source the application is attributed to (e.g. a job board, an event, an employee referral source). null if no source is set.
stage_id: Id of the interview stage the candidate is currently in for this application. null for prospect applications and applications in a terminal state.
stage_name: Display name of the candidate's current interview stage on this application.
status: Lifecycle status of the application. in_process for active candidates, rejected for rejected applications, hired once an offer is closed and the hire endpoint has fired, and converted for prospect applications that have been promoted to a candidate application via convert_to_candidate.
updated_at: Updated at from the Greenhouse v3 applications record.

Args: query: Filter and sort conditions. Supports operators such as eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or. Example: {"filter": {"eq": {"status": "active"}}} limit: Maximum results to return (default 1000) cursor: Pagination cursor from previous response's meta.cursor fields: Field paths to include in results. Each path is a list of keys for nested access. Example: [["id"], ["user", "name"]] returns id and user.name fields.

Returns: ApplicationsSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

context_store_sql_query(self, sql: str, limit: int | None = None) ‑> airbyte_agent_sdk.connectors.greenhouse.models.AirbyteSearchResult[dict[str, Any]] : Run a SQL query against applications records in the Airbyte Context Store.

Only available in hosted execution mode.

Args: sql: SQL query to execute. limit: Maximum results to return.

Returns: AirbyteSearchResult containing the projected rows and query metadata.

Raises: NotImplementedError: If called in local execution mode.

list(self, cursor: str | None = None, per_page: int | None = None, ids: list[int] | None = None, updated_at: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.greenhouse.models.GreenhouseExecuteResultWithMeta[list[Application], ApplicationsListResultMeta] : Returns a cursor-paginated list of applications.

Returns: ApplicationsListResult

AttachmentsQuery(connector: GreenhouseConnector) : Query class for Attachments entity operations.

Initialize query with connector reference.

Methods

download(self, ids: list[int], range_header: str | None = None, **kwargs) ‑> AsyncIterator[bytes] : Looks up an attachment by ID and follows its current time-limited download URL.

Args: ids: The single attachment ID to download. range_header: Optional Range header for partial downloads (e.g., 'bytes=0-99') **kwargs: Additional parameters

Returns: AsyncIterator[bytes]

download_base64(self, ids: list[int], range_header: str | None = None, **kwargs) ‑> dict[str, typing.Any] : Looks up an attachment by ID and follows its current time-limited download URL. and return a JSON-safe base64 chunk.

download_local(self, ids: list[int], path: str, range_header: str | None = None, **kwargs) ‑> Path : Looks up an attachment by ID and follows its current time-limited download URL. and save to file.

Args: ids: The single attachment ID to download. range_header: Optional Range header for partial downloads (e.g., 'bytes=0-99') path: File path to save downloaded content **kwargs: Additional parameters

Returns: str: Path to the downloaded file

download_text(self, ids: list[int], range_header: str | None = None, **kwargs) ‑> dict[str, typing.Any] : Looks up an attachment by ID and follows its current time-limited download URL. and return a JSON-safe UTF-8 text chunk.

list(self, cursor: str | None = None, per_page: int | None = None, ids: list[int] | None = None, updated_at: str | None = None, application_ids: list[int] | None = None, candidate_ids: list[int] | None = None, type: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.greenhouse.models.GreenhouseExecuteResultWithMeta[list[Attachment], AttachmentsListResultMeta] : Returns a cursor-paginated list of attachments.

Args: cursor: Cursor from the previous response Link header. Do not combine with any other parameter. per_page: Number of records to return on the first page. ids: Return only records with these IDs (maximum 50). updated_at: Filter by updated timestamp using the Harvest v3 pipe expression, such as gte|2026-01-01T00:00:00Z. application_ids: Return attachments associated with these application IDs (maximum 50). candidate_ids: Return attachments belonging to these candidate IDs (maximum 50). type: Filter by attachment type. **kwargs: Additional parameters

Returns: AttachmentsListResult

CandidatesQuery(connector: GreenhouseConnector) : Query class for Candidates entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: CandidatesSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.greenhouse.models.AirbyteSearchResult[CandidatesSearchData] : Search candidates records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (CandidatesSearchFilter):

addresses: Postal addresses on the candidate's profile. Each entry pairs the value with a type such as home, work, or other.
can_email: Whether this candidate has consented to receive email communication from your organization.
company: Candidate's current company, as entered on their profile.
created_at: Created at from the Greenhouse v3 candidates record.
custom_fields: Org-defined custom fields keyed by the field's name_key. Each value carries the field's display name, its type, and its value.
email_addresses: Email addresses on the candidate's profile. Each entry pairs the value with a type such as personal, work, or other.
first_name: First name from the Greenhouse v3 candidates record.
id: Id from the Greenhouse v3 candidates record.
last_activity_at: Timestamp of the most recent activity on any of the candidate's applications (notes, emails, stage changes, etc.), in ISO 8601.
last_name: Last name from the Greenhouse v3 candidates record.
linked_user_ids: Ids of Greenhouse users linked to this candidate (employees represented by both a user record and a candidate record).
phone_numbers: Phone numbers on the candidate's profile. Each entry pairs the value with a type such as mobile, home, work, skype, or other.
preferred_name: Preferred or chosen name the candidate goes by, when different from their legal first name.
private: If true, the candidate is restricted to users with View Private Candidates access. Defaults to false.
social_media_addresses: Social media handles or URLs on the candidate's profile. Social entries are untyped — only the value is returned.
tags: Candidate tag names applied to this candidate within your organization.
time_zone: Candidate's time zone as a Rails-style identifier (for example Eastern Time (US & Canada)).
title: Candidate's current job title, as entered on their profile.
updated_at: Updated at from the Greenhouse v3 candidates record.
website_addresses: Personal websites or portfolio URLs on the candidate's profile. Each entry pairs the value with a type such as personal, company, portfolio, blog, or other.

Returns: CandidatesSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

Only available in hosted execution mode.

Args: sql: SQL query to execute. limit: Maximum results to return.

Returns: AirbyteSearchResult containing the projected rows and query metadata.

Raises: NotImplementedError: If called in local execution mode.

list(self, cursor: str | None = None, per_page: int | None = None, ids: list[int] | None = None, updated_at: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.greenhouse.models.GreenhouseExecuteResultWithMeta[list[Candidate], CandidatesListResultMeta] : Returns a cursor-paginated list of candidates.

Returns: CandidatesListResult

DepartmentsQuery(connector: GreenhouseConnector) : Query class for Departments entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: DepartmentsSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.greenhouse.models.AirbyteSearchResult[DepartmentsSearchData] : Search departments records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (DepartmentsSearchFilter):

created_at: Created at from the Greenhouse v3 departments record.
external_id: Partner-supplied identifier for the department, typically the matching id from an HRIS or other external system. Free-form string and null when no external id has been set.
id: Id from the Greenhouse v3 departments record.
name: Display name of the department (e.g. Engineering, Marketing).
parent_id: Id of the parent department in the organization's department tree. null for top-level departments. References another /v3/departments row.
updated_at: Updated at from the Greenhouse v3 departments record.

Returns: DepartmentsSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

Only available in hosted execution mode.

Args: sql: SQL query to execute. limit: Maximum results to return.

Returns: AirbyteSearchResult containing the projected rows and query metadata.

Raises: NotImplementedError: If called in local execution mode.

list(self, cursor: str | None = None, per_page: int | None = None, ids: list[int] | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.greenhouse.models.GreenhouseExecuteResultWithMeta[list[Department], DepartmentsListResultMeta] : Returns a cursor-paginated list of departments.

Returns: DepartmentsListResult

GreenhouseConnector(auth_config: GreenhouseAuthConfig | AirbyteAuthConfig | BaseModel | None = None, on_token_refresh: Any | None = None) : Type-safe Greenhouse API connector.

Auto-generated from OpenAPI specification with full type safety.

Initialize a new greenhouse connector instance.

Supports both local and hosted execution modes:

Local mode: Provide connector-specific auth config (e.g., GreenhouseAuthConfig)
Hosted mode: Provide AirbyteAuthConfig with client credentials and either connector_id or workspace_name

Args: auth_config: Either connector-specific auth config for local mode, or AirbyteAuthConfig for hosted mode on_token_refresh: Optional callback for OAuth2 token refresh persistence. Called with new_tokens dict when tokens are refreshed. Can be sync or async. Example: lambda tokens: save_to_database(tokens) Examples:

Local mode (direct API calls)

connector = GreenhouseConnector(auth_config=GreenhouseAuthConfig(client_id="...", client_secret="...", refresh_token="...", access_token="..."))

Hosted mode with explicit connector_id (no lookup needed)

connector = GreenhouseConnector( auth_config=AirbyteAuthConfig( airbyte_client_id="client_abc123", airbyte_client_secret="secret_xyz789", connector_id="existing-source-uuid" ) )

Hosted mode with lookup by workspace_name

connector = GreenhouseConnector( auth_config=AirbyteAuthConfig( workspace_name="user-123", organization_id="00000000-0000-0000-0000-000000000123", airbyte_client_id="client_abc123", airbyte_client_secret="secret_xyz789" ) )

Class variables

connector_name : The type of the None singleton.

connector_version : The type of the None singleton.

sdk_version : The type of the None singleton.

Static methods

agent_tool(role: AgentToolRole | None = None, *, inspect_tool: str | None = None, docs_tool: str | None = None, max_output_chars: int | None | Unset = UNSET, framework: FrameworkName = 'none', internal_retries: int = 0, should_internal_retry: Callable[[Exception, tuple[Any, ...], dict[str, Any]], bool] | None = None, exhausted_runtime_failure_message: Callable[[Exception, tuple[Any, ...], dict[str, Any]], str | None] | None = None) ‑> Callable[[~_F], ~_F] : Framework-agnostic decorator for user-written connector tool functions.

The progressive-docs sibling of tool_utils: instead of baking the full entity/action reference into the docstring, it instructs the agent to call this connector's inspect and docs tools before executing. Tool failures raise :class:airbyte_agent_sdk.AirbyteToolError by default (framework="none", no auto-detection) — pass framework=... to translate to a supported framework's signal instead.

Decorate three functions per connector — execute, inspect and docs. The role is inferred from each function's signature (extra parameters are allowed); a signature matching more than one role, a generic (*args, **kwargs) wrapper, or a callable whose signature cannot be read must pass the role explicitly:

(entity, action, ...) -> "execute"
(section, ...) -> "read_skill_docs"
() -> "inspect_connector"

Usage: connector = GreenhouseConnector(...)

@GreenhouseConnector.agent_tool() async def execute(entity: str, action: str, params: dict | None = None): return await connector.execute(entity=entity, action=action, params=params or {})

@GreenhouseConnector.agent_tool() async def inspect_connector(): return await connector.inspect_connector()

@GreenhouseConnector.agent_tool() async def read_skill_docs(section: str | None = None): return await connector.read_skill_docs(section)

Args: role: "execute" | "inspect_connector" | "read_skill_docs". None (default) infers the role from the decorated function's signature; an explicit role validates the canonical parameters are present (functions accepting **kwargs, or callables whose signature cannot be read, pass validation). inspect_tool: Exact registered name of the sibling inspect tool, woven into the execute docstring for tighter steering. Defaults to generic phrasing. docs_tool: Exact registered name of the sibling docs tool (see inspect_tool). max_output_chars: Max serialized output size before failing. Defaults per role: execute -> DEFAULT_MAX_OUTPUT_CHARS, docs tools -> None. framework: Translation target for tool failures. Defaults to "none" (raise AirbyteToolError); never auto-detects. internal_retries: How many transient runtime failures (429/5xx, network, timeout) to retry silently before surfacing. Forwarded to :func:airbyte_agent_sdk.translation.translate_exceptions. should_internal_retry: Optional predicate (error, args, kwargs) -> bool further restricting which retryable errors are safe for this specific tool. Forwarded to :func:airbyte_agent_sdk.translation.translate_exceptions. exhausted_runtime_failure_message: Optional callback (error, args, kwargs) -> str | None invoked after internal retries are exhausted or skipped. Forwarded to :func:airbyte_agent_sdk.translation.translate_exceptions.

tool_utils(func: _F | None = None, *, update_docstring: bool = True, max_output_chars: int | None = 100000, framework: FrameworkName | None = None, internal_retries: int = 0, should_internal_retry: Callable[[Exception, tuple[Any, ...], dict[str, Any]], bool] | None = None, exhausted_runtime_failure_message: Callable[[Exception, tuple[Any, ...], dict[str, Any]], str | None] | None = None) ‑> ~_F | Callable[[~_F], ~_F] : Add connector-specific documentation and runtime safeguards to one tool.

For new agents, prefer build_connector_tools. It returns progressive inspect_connector, read_skill_docs, and execute tools so the agent can load only the connector guidance it needs:

from airbyte_agent_sdk import build_connector_tools
from pydantic_ai import Agent

tools = build_connector_tools(connector, framework="pydantic_ai")
agent = Agent("openai:gpt-4o", tools=tools.as_list())

Legacy: one generated-description tool

Existing integrations can keep using tool_utils for one broad execute tool with the connector's full generated catalog in its description:

from fastmcp import FastMCP

connector = GreenhouseConnector()
mcp = FastMCP("Connector Agent")

@mcp.tool()
@GreenhouseConnector.tool_utils
async def execute(entity: str, action: str, params: dict):
    ...

Configure documentation, output limits, framework translation, and retries when needed:

@mcp.tool()
@GreenhouseConnector.tool_utils(update_docstring=False, max_output_chars=None)
async def execute(entity: str, action: str, params: dict):
    ...

@mcp.tool()
@GreenhouseConnector.tool_utils(framework="pydantic_ai", internal_retries=2)
async def execute(entity: str, action: str, params: dict):
    ...

This decorator composes translate_exceptions for runtime wrapping, output-size checks, framework signal translation, and optional internal retries, then adds connector-specific docstring augmentation.

Args: update_docstring: When True, append connector capabilities to __doc__. max_output_chars: Max serialized output size before raising. Use None to disable. framework: One of "pydantic_ai" | "langchain" | "openai_agents" | "mcp". Defaults to None, which auto-detects each framework's canonical import in order. Explicit always wins. internal_retries: How many transient runtime failures (429/5xx, network, timeout) to retry silently before surfacing. Default 0. Forwarded to airbyte_agent_sdk.translation.translate_exceptions. should_internal_retry: Optional predicate (error, args, kwargs) -> bool further restricting which retryable errors are safe for this specific tool. Forwarded to airbyte_agent_sdk.translation.translate_exceptions. exhausted_runtime_failure_message: Optional callback (error, args, kwargs) -> str | None. Invoked after internal retries are exhausted or were skipped because should_internal_retry returned False. Forwarded to airbyte_agent_sdk.translation.translate_exceptions.

Instance variables

connector_id: str | None : Get the connector/source ID (only available in hosted mode).

Returns: The connector ID if in hosted mode, None if in local mode.

Methods

check(self) ‑> airbyte_agent_sdk.connectors.greenhouse.models.GreenhouseCheckResult : Perform a health check to verify connectivity and credentials.

Executes a lightweight list operation (limit=1) to validate that the connector can communicate with the API and credentials are valid.

Returns: GreenhouseCheckResult with status ("healthy" or "unhealthy") and optional error message

Example: result = await connector.check() if result.status == "healthy": print("Connection verified!") else: print(f"Check failed: {result.error}")

close(self) : Close the connector and release resources.

entity_schema(self, entity: str) ‑> dict[str, typing.Any] | None : Get the JSON schema for an entity.

Args: entity: Entity name (e.g., "contacts", "companies")

Returns: JSON schema dict describing the entity structure, or None if not found.

Example: schema = connector.entity_schema("contacts") if schema: print(f"Contact properties: {list(schema.get('properties', {}).keys())}")

execute(self, entity: str, action: "Literal['list', 'download', 'context_store_search', 'context_store_sql_query']", params: Mapping[str, Any] | None = None, *, select_fields: list[str] | None = None, exclude_fields: list[str] | None = None, skip_truncation: bool = True) ‑> Any : Execute an entity operation with full type safety.

This is the recommended interface for blessed connectors as it:

Uses the same signature as non-blessed connectors
Provides full IDE autocomplete for entity/action/params
Makes migration from generic to blessed connectors seamless

Args: entity: Entity name (e.g., "customers") action: Operation action (e.g., "create", "get", "list") params: Operation parameters (typed based on entity+action) select_fields: Optional allowlist of dot-notation fields to include exclude_fields: Optional blocklist of dot-notation fields to remove skip_truncation: Disable long-text truncation for collection actions

Returns: Typed response based on the operation

Example: customer = await connector.execute( entity="customers", action="get", params={"id": "cus_123"} )

inspect_connector(self) ‑> dict[str, typing.Any] : Inspect this connector's hosted metadata/readiness and resolve its docs skill id.

Call this before read_skill_docs in the normal hosted flow. For local/offline connectors this returns a local-mode payload with a warning instead of a hosted inspection.

Example: info = await connector.inspect_connector() print(info["docs_skill_id"])

list_entities(self) ‑> list[dict[str, typing.Any]] : Get structured data about available entities, actions, and parameters.

Returns a list of entity descriptions with:

entity_name: Name of the entity (e.g., "contacts", "deals")
description: Entity description from the first endpoint
available_actions: List of actions (e.g., ["list", "get", "create"])
parameters: Dict mapping action -> list of parameter dicts

Example: entities = connector.list_entities() for entity in entities: print(f"{entity['entity_name']}: {entity['available_actions']}")

read_skill_docs(self, section: str | None = None) ‑> str : Read this connector's usage docs, rendered to text.

Omit section for the outline and general guidance; pass an exact section id from the outline for full details. For local/offline connectors the full generated docs are returned and section is ignored.

Example: outline = await connector.read_skill_docs() details = await connector.read_skill_docs(section="entity:contacts")

InterviewsQuery(connector: GreenhouseConnector) : Query class for Interviews entity operations.

Initialize query with connector reference.

Methods

list(self, cursor: str | None = None, per_page: int | None = None, ids: list[int] | None = None, updated_at: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.greenhouse.models.GreenhouseExecuteResultWithMeta[list[Interview], InterviewsListResultMeta] : Returns a cursor-paginated list of interviews.

Returns: InterviewsListResult

JobPostsQuery(connector: GreenhouseConnector) : Query class for JobPosts entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: JobPostsSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.greenhouse.models.AirbyteSearchResult[JobPostsSearchData] : Search job_posts records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (JobPostsSearchFilter):

active: If true, the post has not been deleted. Deleted posts are excluded by default; pass active=false on the list endpoint to retrieve them.
content: HTML body of the post shown to candidates on the job board. For internal posts this returns the internal_content instead. Sanitized server-side — only a limited element/attribute allowlist (including iframe, video, source) survives. null while the post is still being scaffolded.
created_at: Created at from the Greenhouse v3 job posts record.
demographic_question_set_id: Id of the demographic question set surfaced to candidates on this post for diversity, equity, and inclusion (DE&I) reporting. null when the post does not collect demographic data.
featured: If true, the post is currently featured on the organization's internal job board and surfaces in the weekly internal-jobs email. Only internal posts can be featured, and at most three can be featured at a time.
first_published_at: Timestamp the post first transitioned to live, in ISO 8601. null for posts that have never been published.
id: Id from the Greenhouse v3 job posts record.
internal: If true, the post lives on an internal job board and is visible only to existing employees signed in to the internal board. If false, the post is external and lives on a public-facing job_board. Set by the board the post is associated with at create time.
internal_content: HTML body shown on the internal job board when the post is also configured as internal. null for external-only posts. Same sanitization rules as content.
job_board_id: Id of the job_board this post is published to. Resolves to either an external (careers site, syndicated board) or internal job board depending on internal. Each post belongs to exactly one board at a time.
job_id: Id of the parent job (requisition) this post belongs to. A single job can have multiple posts; the job is the source of truth for the hiring team, openings, and interview plan.
language: ISO 639-1 locale of the post, used to render the candidate-facing application form in the matching language (e.g. en, fr, ja). null when no locale has been chosen.
live: If true, the post is published (job_application_status is live) and its job board is also live. A post on an unpublished board is not live — its public_url returns a 404 until the board is enabled.
public_url: Canonical public URL of the post on its job board, including the gh_jid tracking parameter. null when the post has no associated job board or the board has no public URL configured.
questions: Application form questions presented to candidates on this post, including default questions (resume, cover letter, basic info) and any custom questions configured by the hiring team. Ordered as they appear on the form.
title: Public-facing title shown to candidates on the job board (e.g. Senior Backend Engineer, Remote). Distinct from the internal job.name — a single job can have several posts with different titles, one per board, language, or geography.
updated_at: Updated at from the Greenhouse v3 job posts record.

Returns: JobPostsSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

Only available in hosted execution mode.

Args: sql: SQL query to execute. limit: Maximum results to return.

Returns: AirbyteSearchResult containing the projected rows and query metadata.

Raises: NotImplementedError: If called in local execution mode.

list(self, cursor: str | None = None, per_page: int | None = None, ids: list[int] | None = None, updated_at: str | None = None, active: bool | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.greenhouse.models.GreenhouseExecuteResultWithMeta[list[JobPost], JobPostsListResultMeta] : Returns a cursor-paginated list of job posts.

Returns: JobPostsListResult

JobsQuery(connector: GreenhouseConnector) : Query class for Jobs entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: JobsSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.greenhouse.models.AirbyteSearchResult[JobsSearchData] : Search jobs records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (JobsSearchFilter):

closed_at: Timestamp the job most recently transitioned to closed, in ISO 8601. null for jobs that are still open or draft.
confidential: If true, the job is restricted to users explicitly granted access on the Hiring Team. The legacy Confidential Jobs feature has been sunset — this flag cannot be set on new jobs and is preserved for jobs that already had it enabled.
copied_from_id: Id of the job (typically a template) this job was copied from on creation. null when the job was not created from another job.
created_at: Created at from the Greenhouse v3 jobs record.
custom_fields: Org-defined custom fields keyed by the field's name_key. Each value carries the field's display name, its type, and its value.
department_id: Id of the department this job is assigned to. null when no department is set.
id: Id from the Greenhouse v3 jobs record.
is_template: If true, this job is a template used as the source for new jobs rather than a real requisition. Templates do not accept applications; reference them via template_job_id on POST /v3/jobs.
name: Internal job title shown to the hiring team in Greenhouse (e.g. Senior Backend Engineer). Distinct from the external-facing title on each job_post.
notes: Internal HTML notes about the job, surfaced to the hiring team in the Greenhouse UI. Not exposed on public job posts.
office_ids: Ids of the offices this job is assigned to. A job can span multiple offices; empty array or null when no offices are set.
opened_at: Timestamp the job first transitioned to open, in ISO 8601. null while the job is still in draft.
requisition_id: Partner-supplied external identifier for the requisition (e.g. an HRIS or ATS code). Free-form string, not unique across the organization, and null when no external id has been set.
status: Lifecycle status of the job. draft while it is being scaffolded, open once it has at least one open opening, and closed after every opening is closed. A job moves to closed automatically when its last open opening is closed via PATCH /v3/openings/{id}.
updated_at: Updated at from the Greenhouse v3 jobs record.

Returns: JobsSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

Only available in hosted execution mode.

Args: sql: SQL query to execute. limit: Maximum results to return.

Returns: AirbyteSearchResult containing the projected rows and query metadata.

Raises: NotImplementedError: If called in local execution mode.

list(self, cursor: str | None = None, per_page: int | None = None, ids: list[int] | None = None, updated_at: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.greenhouse.models.GreenhouseExecuteResultWithMeta[list[Job], JobsListResultMeta] : Returns a cursor-paginated list of jobs.

Returns: JobsListResult

OffersQuery(connector: GreenhouseConnector) : Query class for Offers entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: OffersSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.greenhouse.models.AirbyteSearchResult[OffersSearchData] : Search offers records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (OffersSearchFilter):

application_id: Id of the application this offer is extended on. Every offer belongs to exactly one application; the offer is voided if the application is rejected or deleted.
candidate_id: Id of the candidate (person) receiving this offer. Resolved through the offer's application.
created_at: Created at from the Greenhouse v3 offers record.
custom_fields: Org-defined custom fields keyed by the field's name_key. Each value carries the field's display name, its type, and its value.
id: Id from the Greenhouse v3 offers record.
job_id: Id of the job this offer's application is on.
opening_id: Id of the specific opening this offer is being extended for. null when the offer has not yet been linked to an opening.
resolved_at: Timestamp the offer was resolved (Accepted or Rejected), in ISO 8601. Date updates submitted through PATCH /v3/offers/{id} are normalized to noon UTC on the supplied date. null while the offer is still Created or has been superseded as Deprecated without a resolution.
sent_on: Date the offer was sent to the candidate, in ISO 8601 (YYYY-MM-DD). null until the offer has been sent.
starts_on: Candidate's proposed start date, in ISO 8601 (YYYY-MM-DD). null when no start date has been set on the offer.
status: Lifecycle status of the offer. Created for offers still being drafted or pending approval, Accepted once the candidate accepts, Rejected if declined or withdrawn, and Deprecated for superseded prior versions (a new offer version replaces an earlier one with this status).
updated_at: Updated at from the Greenhouse v3 offers record.
version: Revision number of this offer within its application. Greenhouse creates a new offer row (incrementing version) whenever a tracked field on an existing offer changes — typically starts_on, opening_id, or a custom field configured to trigger a new version. Pair with current_only=true to filter the list endpoint down to the latest version per application.

Returns: OffersSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

Only available in hosted execution mode.

Args: sql: SQL query to execute. limit: Maximum results to return.

Returns: AirbyteSearchResult containing the projected rows and query metadata.

Raises: NotImplementedError: If called in local execution mode.

list(self, cursor: str | None = None, per_page: int | None = None, ids: list[int] | None = None, updated_at: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.greenhouse.models.GreenhouseExecuteResultWithMeta[list[Offer], OffersListResultMeta] : Returns a cursor-paginated list of offers.

Returns: OffersListResult

OfficesQuery(connector: GreenhouseConnector) : Query class for Offices entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: OfficesSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.greenhouse.models.AirbyteSearchResult[OfficesSearchData] : Search offices records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (OfficesSearchFilter):

created_at: Created at from the Greenhouse v3 offices record.
external_id: Stable identifier supplied by the customer or HRIS for cross-system reconciliation. null when no external id has been set. Available when the org_structure_external_id product flag is enabled.
id: Id from the Greenhouse v3 offices record.
location: Free-form physical location string for the office (e.g. New York, NY, USA). null for offices that have no location set, including most remote offices.
name: Display name of the office (e.g. San Francisco, Remote (US)). Unique among active offices in the same organization.
parent_id: Id of the parent office when offices are organized hierarchically. null for top-level offices. References another /v3/offices row in the same organization.
primary_in_house_contact_user_id: Id of the Greenhouse user designated as the office's primary internal contact, typically the local recruiting lead. References a /v3/users row. null when no contact has been assigned.
updated_at: Updated at from the Greenhouse v3 offices record.

Returns: OfficesSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

Only available in hosted execution mode.

Args: sql: SQL query to execute. limit: Maximum results to return.

Returns: AirbyteSearchResult containing the projected rows and query metadata.

Raises: NotImplementedError: If called in local execution mode.

list(self, cursor: str | None = None, per_page: int | None = None, ids: list[int] | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.greenhouse.models.GreenhouseExecuteResultWithMeta[list[Office], OfficesListResultMeta] : Returns a cursor-paginated list of offices.

Returns: OfficesListResult

SourcesQuery(connector: GreenhouseConnector) : Query class for Sources entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: SourcesSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.greenhouse.models.AirbyteSearchResult[SourcesSearchData] : Search sources records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (SourcesSearchFilter):

created_at: Created at from the Greenhouse v3 sources record.
id: Id from the Greenhouse v3 sources record.
name: Display name of the source as recruiters see it in Greenhouse (e.g. LinkedIn (Prospecting), Indeed, Referral, Internal Applicant, or a custom agency name). For organization-specific sources this is the label the org configured; for global Greenhouse sources it is the standard public name.
type_: The sourcing strategy this source rolls up to — the broader category used for reporting. Sources are grouped under sourcing strategies such as Agencies, Referral, Third-party boards, Prospecting, Social media, Company marketing, In person event, MyGreenhouse, and Other. Use the strategy when aggregating candidate volume by channel; use the source itself when reporting on a specific channel within that category.
updated_at: Updated at from the Greenhouse v3 sources record.

Returns: SourcesSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

Only available in hosted execution mode.

Args: sql: SQL query to execute. limit: Maximum results to return.

Returns: AirbyteSearchResult containing the projected rows and query metadata.

Raises: NotImplementedError: If called in local execution mode.

list(self, cursor: str | None = None, per_page: int | None = None, ids: list[int] | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.greenhouse.models.GreenhouseExecuteResultWithMeta[list[Source], SourcesListResultMeta] : Returns a cursor-paginated list of sources.

Returns: SourcesListResult

UsersQuery(connector: GreenhouseConnector) : Query class for Users entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: UsersSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.greenhouse.models.AirbyteSearchResult[UsersSearchData] : Search users records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (UsersSearchFilter):

agency_id: Id of the staffing agency this user belongs to, when the user is an external agency recruiter rather than an employee of your organization. null for in-house users.
created_at: Created at from the Greenhouse v3 users record.
custom_fields: Org-defined custom fields keyed by the field's name_key. Each value carries the field's display name, its type, and its value.
deactivated: Whether the user has been deactivated. Deactivated users cannot sign in or be assigned to new jobs, but their historical activity (notes, scorecards, emails) is preserved. Toggle via POST /v3/users/{id}/deactivate and POST /v3/users/{id}/activate.
department_ids: Ids of the departments this user is assigned to. Used to scope future job permissions and to filter the user list by department. Empty when the user is not pinned to any department.
emails: All email addresses on the user's account, including the primary address and any additional verified addresses.
employee_id: Partner-supplied external employee identifier, typically the user's HRIS or payroll id. Free-form string; not unique across organizations and null when no employee id has been set.
first_name: First name from the Greenhouse v3 users record.
id: Id from the Greenhouse v3 users record.
interviewer_tags: Interviewer tags applied to this user — the labeled skill or panel groupings (e.g. Senior Engineer, Bar Raiser) used to suggest qualified interviewers when building an interview plan. Each entry pairs the tag's id with its name.
job_title: Free-form job title set on the user's Greenhouse profile (e.g. Senior Recruiter). Not synchronized with any HRIS title.
last_name: Last name from the Greenhouse v3 users record.
linked_candidate_ids: Ids of candidate records linked to this user. Populated when an employee is represented by both a user record (for Greenhouse access) and a candidate record (for past or internal applications).
name: Concatenation of first_name and last_name rendered as a single display string. Provided for convenience; partners that need either component should read first_name/last_name directly.
office_ids: Ids of the offices this user is assigned to. Used to scope future job permissions and to filter the user list by office. Empty when the user is not pinned to any office.
primary_email: Primary email address on the user's account. Sign-in identifier and the address Greenhouse uses for outbound mail; additional verified addresses are not surfaced here. Service accounts (integration/ISU users) have no email and are excluded from this endpoint by default; when included via show_service_accounts=true, their primary_email is an empty string.
site_admin: Whether the user holds the Site Admin role. Site admins have unrestricted access to every non-confidential job and to organization-level settings. Demote a site admin to a Basic user with POST /v3/users/{id}/revoke_permissions.
updated_at: Updated at from the Greenhouse v3 users record.

Returns: UsersSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

Only available in hosted execution mode.

Args: sql: SQL query to execute. limit: Maximum results to return.

Returns: AirbyteSearchResult containing the projected rows and query metadata.

Raises: NotImplementedError: If called in local execution mode.

list(self, cursor: str | None = None, per_page: int | None = None, ids: list[int] | None = None, updated_at: str | None = None, show_service_accounts: bool | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.greenhouse.models.GreenhouseExecuteResultWithMeta[list[User], UsersListResultMeta] : Returns a cursor-paginated list of users.

Args: cursor: Cursor from the previous response Link header. Do not combine with any other parameter. per_page: Number of records to return on the first page. ids: Return only records with these IDs (maximum 50). updated_at: Filter by updated timestamp using the Harvest v3 pipe expression, such as gte|2026-01-01T00:00:00Z. show_service_accounts: Include Greenhouse service accounts. **kwargs: Additional parameters

Returns: UsersListResult

Classes​

Methods​

Methods​

Methods​

Methods​

Local mode (direct API calls)

Hosted mode with explicit connector_id (no lookup needed)

Hosted mode with lookup by workspace_name

Class variables​

Static methods​

Legacy: one generated-description tool​

Instance variables​

Methods​

Methods​

Methods​

Methods​

Methods​

Methods​

Methods​

Methods​

Classes

Methods

Methods

Methods

Methods

Class variables

Static methods

Legacy: one generated-description tool

Instance variables

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods