Save your own Greenhouse API credential, then select it in the block. In Greenhouse, open Dev Center > API Credentials, create a Harvest V3 (OAuth) credential, and copy its client ID and client secret. On the credential's settings, enable the Harvest scopes for the operations your workflows use; the scopes listed below cover every operation. Sim obtains access tokens with the client credentials grant and gets a new one when it expires. Requests act as the integration service user Greenhouse creates with the credential. You do not need a redirect URI or a Sim-owned OAuth application, and a legacy Harvest API key cannot authenticate the new block.
Deployments that have Greenhouse partner OAuth credentials can also connect an account through consent. Complete consent with a Site Admin, which Greenhouse requires for list endpoints. A partner connection that has not refreshed within the provider's 14-day refresh-token lifetime must reconnect.
The original API-key block remains as Greenhouse (Legacy) so existing workflows keep their saved configuration. New blocks use Harvest v3. Upgrade an existing block explicitly, select a Greenhouse credential, choose its operation again, and update input and output references before running it. The legacy integration is subject to Greenhouse's v1 availability; preserving a saved block does not extend provider support.
Harvest v3 returns applications, attachments, education, and employment through separate resources. Use their list operations and candidate or application filters to assemble a complete record. Single-record reads use the provider's ids filter. Do not assume the old embedded response structure survives the upgrade.
List operations return one page, its count, nextCursor, and hasMore. Set a page size from 1 to 500 and pass nextCursor into the next call until hasMore is false. A cursor carries the initial query, so other filters and page size are ignored while it is set. Date filters accept a JSON object such as {"gte":"2026-01-01T00:00:00Z"}; use either created_at or updated_at, not both.
For list operations, Job IDs uses comma-separated IDs. For prospect application creation, Job IDs uses a JSON array of integers. Created At takes a JSON date range on list operations, an ISO 8601 timestamp when creating an application, and a YYYY-MM-DD date when updating an application.
Partial reads leave unrequested fields as null, including collections. An explicit empty array means the collection is empty. Date-only filters, such as offer sent_on and starts_on, use YYYY-MM-DD bounds.
When updating candidate contact arrays, tags, or linked users, read the current candidate first and submit the complete desired array: supplied arrays replace their existing values. Unset inputs are omitted; custom-field entries may use null to clear a value. Creating an email note records an email in Greenhouse and does not send one. Application movement may trigger Greenhouse stage automation, and rejection can optionally send a rejection email. Move, hire, reject, and unreject operations return no provider fields on success.
Sim requests these scopes when someone connects a Greenhouse account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
last_activity_at
json
No
Last activity at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}.
custom_field_option_id
number
No
Custom field option ID
private
boolean
No
Candidate or custom-field privacy flag; for candidate listing, false excludes private candidates.
Greenhouse time-zone identifier (for example, eastern time (us & canada)).
company
string
No
Company
title
string
No
Title
can_email
boolean
No
Whether the candidate consents to email communication.
phone_numbers
array
No
Phone numbers JSON array of objects with value, type. type: home, work, mobile, skype, other.
addresses
array
No
Addresses JSON array of objects with value, type. type: home, work, other.
email_addresses
array
No
Email addresses JSON array of objects with value, type. type: personal, work, other.
website_addresses
array
No
Website addresses JSON array of objects with value, type. type: personal, company, portfolio, blog, other.
social_media_addresses
array
No
Social media addresses JSON array of objects with value.
tags
array
No
Tags JSON array of string values.
linked_user_ids
array
No
Linked Greenhouse user IDs as a JSON array of integers.
custom_fields
array
No
JSON array of {name_key or custom_field_id, value}; use exactly one identifier per entry. Values follow the field type; null clears a value. JSON array of objects with name_key, custom_field_id, value.
application
json
No
Optional first application as JSON: {job_id, initial_stage_id?, source_id?, recruiter_id?, coordinator_id?, referrer_id?, created_at?, custom_fields?}, or {prospect:true, job_ids?, prospect_pool_id?, prospect_pool_stage_id?, prospect_owner_id?, prospective_department_id?, prospective_office_id?, source_id?, recruiter_id?, coordinator_id?, referrer_id?, created_at?, custom_fields?}.
Updates selected candidate fields. Read the current candidate first: supplied arrays replace the entire existing collection. Send the complete desired array, or [] to remove all entries.
Greenhouse time-zone identifier (for example, eastern time (us & canada)).
company
string
No
Company
title
string
No
Title
is_private
boolean
No
Restrict candidate visibility to users with private-candidate access.
can_email
boolean
No
Whether the candidate consents to email communication.
phone_numbers
array
No
Phone numbers JSON array of objects with value, type. type: home, work, mobile, skype, other. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it.
addresses
array
No
Addresses JSON array of objects with value, type. type: home, work, other. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it.
email_addresses
array
No
Email addresses JSON array of objects with value, type. type: personal, work, other. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it.
website_addresses
array
No
Website addresses JSON array of objects with value, type. type: personal, company, portfolio, blog, other. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it.
social_media_addresses
array
No
Social media addresses JSON array of objects with value. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it.
tags
array
No
Tags JSON array of string values. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it.
linked_user_ids
array
No
Linked Greenhouse user IDs as a JSON array of integers. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it.
custom_fields
array
No
JSON array of {name_key or custom_field_id, value}; use exactly one identifier per entry. Values follow the field type; null clears a value. JSON array of objects with name_key, custom_field_id, value. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
JSON array of {name_key or custom_field_id, value}; use exactly one identifier per entry. Values follow the field type; null clears a value. JSON array of objects with name_key, custom_field_id, value.
candidate_id
number
Yes
Candidate ID to create the application for.
job_id
number
No
Job ID
initial_stage_id
number
No
Initial stage ID
prospect
boolean
No
Whether this is a prospect application. Set true to use prospect placement fields instead of job_id.
job_ids
array
No
Job IDs for a prospect as a JSON array of integers. Requires prospect=true.
JSON array of {name_key or custom_field_id, value}; use exactly one identifier per entry. Values follow the field type; null clears a value. JSON array of objects with name_key, custom_field_id, value.
Optional JSON object {send_email_at, email_template_id, email_from_user_id}; supplying it sends or schedules a rejection email.
custom_fields
array
No
JSON array of {name_key or custom_field_id, value}; use exactly one identifier per entry. Values follow the field type; null clears a value. JSON array of objects with name_key, custom_field_id, value.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
opened_at
json
No
Opened at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}.
closed_at
json
No
Closed at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
job_ids
string
No
Job IDs Comma-separated values (maximum 50).
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
user_ids
string
No
User IDs Comma-separated values (maximum 50).
job_ids
string
No
Job IDs Comma-separated values (maximum 50).
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
user_ids
string
No
User IDs Comma-separated values (maximum 50).
job_ids
string
No
Job IDs Comma-separated values (maximum 50).
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
candidate_tag_ids
string
No
Candidate tag IDs Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
agency_ids
string
No
Agency IDs Comma-separated values (maximum 50).
office_ids
string
No
Office IDs Comma-separated values (maximum 50).
department_ids
string
No
Department IDs Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
user_ids
string
No
User IDs Comma-separated values (maximum 50).
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
department_ids
string
No
Department IDs Comma-separated values (maximum 50).
office_ids
string
No
Office IDs Comma-separated values (maximum 50).
job_ids
string
No
Job IDs Comma-separated values (maximum 50).
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
prospect_pool_ids
string
No
Prospect pool IDs Comma-separated values (maximum 50).
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
field_type
string
No
Field type Allowed: job, opening, standard, offer, compensation_frequency, candidate, referral_question, application, rejection_question, form, agency_question, user_attribute.
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
custom_field_ids
string
No
Custom field IDs Comma-separated values (maximum 50).
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored.
per_page
number
No
Page size from 1 to 500 (default 100). Each call retrieves one page.
ids
string
No
Ids Comma-separated values (maximum 50).
created_at
json
No
Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at.
updated_at
json
No
Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at.
fields
string
No
Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50).
email_type
string
No
Email type
from_type
string
No
From type Allowed: user_email, organization_email, my_email_address, inviter, organizer, not_applicable.
When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control.
When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control.
When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control.
When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control.
When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control.
When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control.
When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control.
When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control.
