KosmoKrator

productivity

SmartRecruiters Lua API for KosmoKrator Agents

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

Lua Namespace

Agents call this integration through app.integrations.smartrecruiters.*. Use lua_read_doc("integrations.smartrecruiters") 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 SmartRecruiters workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.smartrecruiters.create_new_candidate_application({uuid = "example_uuid", body = "example_body"}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("smartrecruiters"))' --json
kosmo integrations:lua --eval 'print(docs.read("smartrecruiters.create_new_candidate_application"))' --json

Workflow file

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

workflow.lua 
local smartrecruiters = app.integrations.smartrecruiters
local result = smartrecruiters.create_new_candidate_application({uuid = "example_uuid", 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.smartrecruiters, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.smartrecruiters.default.* or app.integrations.smartrecruiters.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need SmartRecruiters, 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.

SmartRecruiters

Namespace: smartrecruiters

SmartRecruiters tools map one-to-one to the official OpenAPI specs listed in the SmartRecruiters Developer Hub API Reference. The package combines the public registry specs for jobs, candidates, applications, configuration, interviews, reporting, users, webhooks, assessments, approvals, offers, and marketplace/partner APIs.

Authentication depends on the endpoint family. Customer APIs generally accept x-smarttoken; marketplace and partner flows may require OAuth bearer tokens. Configure either api_key, access_token, or client credentials. When only client credentials are configured, the service requests an OAuth token from token_url.

Request Shape

  • Path and query parameters use snake_case tool keys while preserving SmartRecruiters’ official HTTP parameter names internally.
  • JSON, JSON Patch, form, and multipart endpoints accept a body object. Multipart file-like values should be supplied as scalar or JSON-serializable body fields; hosts that need binary upload streams can extend the service layer without changing tool names.
  • Array query parameters follow the OpenAPI serialization hints from the official spec.
  • Returned data is the decoded JSON response when JSON is returned. Empty successful responses return { success, status }; CSV or other text responses return { body, status, content_type }.

Common Tools

  • smartrecruiters_apply_create_candidate: Create a New Candidate Application (POST /postings/{uuid}/candidates from apply-api.json)
  • smartrecruiters_apply_get_apply_configuration_for_posting: Get application configuration for posting (GET /postings/{uuid}/configuration from apply-api.json)
  • smartrecruiters_apply_get_application_status: Get candidate status (GET /postings/{uuid}/candidates/{candidateId}/status from apply-api.json)
  • smartrecruiters_approvals_approvals_get_by_id: Get approval request by id (GET /approvals/{approvalRequestId} from approvals-api.json)
  • smartrecruiters_approvals_approvals_comments_get: Get comments for given approval request (GET /approvals/{approvalRequestId}/comments from approvals-api.json)
  • smartrecruiters_approvals_approvals_comments_create: Add comment to given approval request (POST /approvals/{approvalRequestId}/comments from approvals-api.json)
  • smartrecruiters_approvals_approvals_get: Get pending approvals requests where you are an approver. (GET /approvals from approvals-api.json)
  • smartrecruiters_approvals_approvals_create: Create approval request (POST /approvals from approvals-api.json)
  • smartrecruiters_approvals_approvals_approve: Approve the approval request by id (POST /approvals/{approvalRequestId}/approve-decisions from approvals-api.json)
  • smartrecruiters_approvals_approvals_reject: Reject the approval request by id (POST /approvals/{approvalRequestId}/reject-decisions from approvals-api.json)
  • smartrecruiters_assessments_orders_get_list: Retrieves all assessment orders for specified application (GET /assessment-orders from assessments-api.json)
  • smartrecruiters_audit_audit_get: List audit events (GET /audit-events from audit-api.json)
  • smartrecruiters_configuration_configuration_access_group_create: Create access group (POST /configuration/access-groups from configuration-api.json)
  • smartrecruiters_configuration_configuration_access_group_list: List access groups (GET /configuration/access-groups from configuration-api.json)
  • smartrecruiters_configuration_configuration_access_group_get: Get access group (GET /configuration/access-groups/{accessGroupId} from configuration-api.json)
  • smartrecruiters_configuration_configuration_access_group_update: Update access group (PUT /configuration/access-groups/{accessGroupId} from configuration-api.json)
  • smartrecruiters_configuration_configuration_access_group_delete: Delete access group (DELETE /configuration/access-groups/{accessGroupId} from configuration-api.json)
  • smartrecruiters_configuration_configuration_company_my: Get company information (GET /configuration/company from configuration-api.json)

Examples

local jobs = smartrecruiters.smartrecruiters_jobs_search_jobs({ limit = 10 })

local candidate = smartrecruiters.smartrecruiters_candidates_get_candidate({
  candidate_id = "candidate-123"
})

local webhook = smartrecruiters.smartrecruiters_webhooks_create_webhook_subscription({
  body = {
    callbackUrl = "https://example.test/webhooks/smartrecruiters",
    events = { "candidate.created" }
  }
})

Some operations are partner-only, deprecated, or scope-gated by SmartRecruiters. Prefer least-privilege OAuth scopes or a dedicated API key for automation accounts.

Raw agent markdown 
# SmartRecruiters

Namespace: `smartrecruiters`

SmartRecruiters tools map one-to-one to the official OpenAPI specs listed in the SmartRecruiters Developer Hub API Reference. The package combines the public registry specs for jobs, candidates, applications, configuration, interviews, reporting, users, webhooks, assessments, approvals, offers, and marketplace/partner APIs.

Authentication depends on the endpoint family. Customer APIs generally accept `x-smarttoken`; marketplace and partner flows may require OAuth bearer tokens. Configure either `api_key`, `access_token`, or client credentials. When only client credentials are configured, the service requests an OAuth token from `token_url`.

## Request Shape

- Path and query parameters use snake_case tool keys while preserving SmartRecruiters' official HTTP parameter names internally.
- JSON, JSON Patch, form, and multipart endpoints accept a `body` object. Multipart file-like values should be supplied as scalar or JSON-serializable body fields; hosts that need binary upload streams can extend the service layer without changing tool names.
- Array query parameters follow the OpenAPI serialization hints from the official spec.
- Returned data is the decoded JSON response when JSON is returned. Empty successful responses return `{ success, status }`; CSV or other text responses return `{ body, status, content_type }`.

## Common Tools

- `smartrecruiters_apply_create_candidate`: Create a New Candidate Application (`POST /postings/{uuid}/candidates` from `apply-api.json`)
- `smartrecruiters_apply_get_apply_configuration_for_posting`: Get application configuration for posting (`GET /postings/{uuid}/configuration` from `apply-api.json`)
- `smartrecruiters_apply_get_application_status`: Get candidate status (`GET /postings/{uuid}/candidates/{candidateId}/status` from `apply-api.json`)
- `smartrecruiters_approvals_approvals_get_by_id`: Get approval request by id (`GET /approvals/{approvalRequestId}` from `approvals-api.json`)
- `smartrecruiters_approvals_approvals_comments_get`: Get comments for given approval request (`GET /approvals/{approvalRequestId}/comments` from `approvals-api.json`)
- `smartrecruiters_approvals_approvals_comments_create`: Add comment to given approval request (`POST /approvals/{approvalRequestId}/comments` from `approvals-api.json`)
- `smartrecruiters_approvals_approvals_get`: Get pending approvals requests where you are an approver. (`GET /approvals` from `approvals-api.json`)
- `smartrecruiters_approvals_approvals_create`: Create approval request (`POST /approvals` from `approvals-api.json`)
- `smartrecruiters_approvals_approvals_approve`: Approve the approval request by id (`POST /approvals/{approvalRequestId}/approve-decisions` from `approvals-api.json`)
- `smartrecruiters_approvals_approvals_reject`: Reject the approval request by id (`POST /approvals/{approvalRequestId}/reject-decisions` from `approvals-api.json`)
- `smartrecruiters_assessments_orders_get_list`: Retrieves all assessment orders for specified application (`GET /assessment-orders` from `assessments-api.json`)
- `smartrecruiters_audit_audit_get`: List audit events (`GET /audit-events` from `audit-api.json`)
- `smartrecruiters_configuration_configuration_access_group_create`: Create access group (`POST /configuration/access-groups` from `configuration-api.json`)
- `smartrecruiters_configuration_configuration_access_group_list`: List access groups (`GET /configuration/access-groups` from `configuration-api.json`)
- `smartrecruiters_configuration_configuration_access_group_get`: Get access group (`GET /configuration/access-groups/{accessGroupId}` from `configuration-api.json`)
- `smartrecruiters_configuration_configuration_access_group_update`: Update access group (`PUT /configuration/access-groups/{accessGroupId}` from `configuration-api.json`)
- `smartrecruiters_configuration_configuration_access_group_delete`: Delete access group (`DELETE /configuration/access-groups/{accessGroupId}` from `configuration-api.json`)
- `smartrecruiters_configuration_configuration_company_my`: Get company information (`GET /configuration/company` from `configuration-api.json`)

## Examples

```lua
local jobs = smartrecruiters.smartrecruiters_jobs_search_jobs({ limit = 10 })

local candidate = smartrecruiters.smartrecruiters_candidates_get_candidate({
  candidate_id = "candidate-123"
})

local webhook = smartrecruiters.smartrecruiters_webhooks_create_webhook_subscription({
  body = {
    callbackUrl = "https://example.test/webhooks/smartrecruiters",
    events = { "candidate.created" }
  }
})
```

Some operations are partner-only, deprecated, or scope-gated by SmartRecruiters. Prefer least-privilege OAuth scopes or a dedicated API key for automation accounts.
Metadata-derived Lua example 
local result = app.integrations.smartrecruiters.create_new_candidate_application({uuid = "example_uuid", body = "example_body"})
print(result)

Functions

create_new_candidate_application Write

Create a New Candidate Application Official SmartRecruiters endpoint: POST /postings/{uuid}/candidates from apply-api.json.

Lua path
app.integrations.smartrecruiters.create_new_candidate_application
Full name
smartrecruiters.smartrecruiters_apply_create_candidate
ParameterTypeRequiredDescription
uuid string yes Posting UUID
body object yes Request body matching the official SmartRecruiters apply-api.json schema for Create a New Candidate Application.
get_application_configuration_posting Read

Get application configuration for posting Official SmartRecruiters endpoint: GET /postings/{uuid}/configuration from apply-api.json.

Lua path
app.integrations.smartrecruiters.get_application_configuration_posting
Full name
smartrecruiters.smartrecruiters_apply_get_apply_configuration_for_posting
ParameterTypeRequiredDescription
accept_language string no Language for screening questions. By default 'en'.
uuid string yes Posting UUID
conditionals_included boolean no Specifies whether conditional questions should be returned in the response. 'false' if not specified
get_candidate_status Read

Get candidate status Official SmartRecruiters endpoint: GET /postings/{uuid}/candidates/{candidateId}/status from apply-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_status
Full name
smartrecruiters.smartrecruiters_apply_get_application_status
ParameterTypeRequiredDescription
uuid string yes Posting UUID
candidate_id string yes path parameter `candidateId`.
get_approval_request_by_id Read

Get approval request by id Official SmartRecruiters endpoint: GET /approvals/{approvalRequestId} from approvals-api.json.

Lua path
app.integrations.smartrecruiters.get_approval_request_by_id
Full name
smartrecruiters.smartrecruiters_approvals_approvals_get_by_id
ParameterTypeRequiredDescription
approval_request_id string yes Approval request identifier
get_comments_given_approval_request Read

Get comments for given approval request Official SmartRecruiters endpoint: GET /approvals/{approvalRequestId}/comments from approvals-api.json.

Lua path
app.integrations.smartrecruiters.get_comments_given_approval_request
Full name
smartrecruiters.smartrecruiters_approvals_approvals_comments_get
ParameterTypeRequiredDescription
approval_request_id string yes Approval request identifier
add_comment_given_approval_request Read

Add comment to given approval request Official SmartRecruiters endpoint: POST /approvals/{approvalRequestId}/comments from approvals-api.json.

Lua path
app.integrations.smartrecruiters.add_comment_given_approval_request
Full name
smartrecruiters.smartrecruiters_approvals_approvals_comments_create
ParameterTypeRequiredDescription
approval_request_id string yes Approval request identifier
body object no Request body matching the official SmartRecruiters approvals-api.json schema for Add comment to given approval request.
get_pending_approvals_requests_where_you_are_approver Read

Get pending approvals requests where you are an approver. Official SmartRecruiters endpoint: GET /approvals from approvals-api.json.

Lua path
app.integrations.smartrecruiters.get_pending_approvals_requests_where_you_are_approver
Full name
smartrecruiters.smartrecruiters_approvals_approvals_get
ParameterTypeRequiredDescription
page_id string no Identifier for the paged list of approval requests. To get the first page of approval request, leave it blank.
create_approval_request Read

Create approval request Official SmartRecruiters endpoint: POST /approvals from approvals-api.json.

Lua path
app.integrations.smartrecruiters.create_approval_request
Full name
smartrecruiters.smartrecruiters_approvals_approvals_create
ParameterTypeRequiredDescription
body object no Request body matching the official SmartRecruiters approvals-api.json schema for Create approval request.
approve_approval_request_by_id Read

Approve the approval request by id Official SmartRecruiters endpoint: POST /approvals/{approvalRequestId}/approve-decisions from approvals-api.json.

Lua path
app.integrations.smartrecruiters.approve_approval_request_by_id
Full name
smartrecruiters.smartrecruiters_approvals_approvals_approve
ParameterTypeRequiredDescription
approval_request_id string yes Approval request identifier
body object no Request body matching the official SmartRecruiters approvals-api.json schema for Approve the approval request by id.
reject_approval_request_by_id Read

Reject the approval request by id Official SmartRecruiters endpoint: POST /approvals/{approvalRequestId}/reject-decisions from approvals-api.json.

Lua path
app.integrations.smartrecruiters.reject_approval_request_by_id
Full name
smartrecruiters.smartrecruiters_approvals_approvals_reject
ParameterTypeRequiredDescription
approval_request_id string yes Approval request identifier
body object no Request body matching the official SmartRecruiters approvals-api.json schema for Reject the approval request by id.
retrieves_all_assessment_orders_specified_application Read

Retrieves all assessment orders for specified application Official SmartRecruiters endpoint: GET /assessment-orders from assessments-api.json.

Lua path
app.integrations.smartrecruiters.retrieves_all_assessment_orders_specified_application
Full name
smartrecruiters.smartrecruiters_assessments_orders_get_list
ParameterTypeRequiredDescription
application_id string yes ID of the application
list_audit_events Read

List audit events Official SmartRecruiters endpoint: GET /audit-events from audit-api.json.

Lua path
app.integrations.smartrecruiters.list_audit_events
Full name
smartrecruiters.smartrecruiters_audit_audit_get
ParameterTypeRequiredDescription
event_date_after string no ISO8601-formatted time boundaries for the event time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ (example: 2023-01-21T12:50:02.594Z)
event_date_before string no ISO8601-formatted time boundaries for the event time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ (example: 2023-01-21T12:50:02.594Z)
event_name array no Name of the event
author_type array no Type of the author who generated the event
author_id string no Unique identifier of the author
entity_type array no Type of the entity that the event is related to
entity_id string no Unique identifier of the entity that the event is related to
next_page_id string no Unique identifier for the next page of events
limit integer no Number of audit events to return. Maximum value is 100.
create_access_group Read

Create access group Official SmartRecruiters endpoint: POST /configuration/access-groups from configuration-api.json.

Lua path
app.integrations.smartrecruiters.create_access_group
Full name
smartrecruiters.smartrecruiters_configuration_configuration_access_group_create
ParameterTypeRequiredDescription
body object no ## Access Group Request This request is used to **create/update an access group** by specifying its **name, description, and inclusion criteria**. ### Fields - **name (string, required)** The name of the access group. - **description (string, required)** A brief description of the access group. - **criteria (object, required)** Defines the conditions under which entities are included in the access group. - The **criteria** object **must contain exactly one include object**. - The **include** object contains multiple properties, where each property represents an active **job property** with category set to the **organization**. #### Each **job property** is referenced by its **ID** and includes the following attributes: - **all (boolean)** true Includes **all** values. false Includes **only** specified values. - **values (array)** A list of specific values to include (if all is set to false) or exclude (if all is set to true) ### Usage Examples - **Match all countries** all: true and an empty values array. - **Match specific countries** all: false and a list of country codes in values. - **Match all countries except certain ones** all: true with values specifying the excluded countries. To obtain a list of available **job properties** under the **organization** category, use the ****. The **job property ID** should be used as the key in the include object.
list_access_groups Read

List access groups Official SmartRecruiters endpoint: GET /configuration/access-groups from configuration-api.json.

Lua path
app.integrations.smartrecruiters.list_access_groups
Full name
smartrecruiters.smartrecruiters_configuration_configuration_access_group_list
ParameterTypeRequiredDescription
page_id string no pageId
page_size integer no pageSize
get_access_group Read

Get access group Official SmartRecruiters endpoint: GET /configuration/access-groups/{accessGroupId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_access_group
Full name
smartrecruiters.smartrecruiters_configuration_configuration_access_group_get
ParameterTypeRequiredDescription
access_group_id string yes Access group identifier
update_access_group Read

Update access group Official SmartRecruiters endpoint: PUT /configuration/access-groups/{accessGroupId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.update_access_group
Full name
smartrecruiters.smartrecruiters_configuration_configuration_access_group_update
ParameterTypeRequiredDescription
access_group_id string yes Access group identifier
body object no ## Access Group Request This request is used to **create/update an access group** by specifying its **name, description, and inclusion criteria**. ### Fields - **name (string, required)** The name of the access group. - **description (string, required)** A brief description of the access group. - **criteria (object, required)** Defines the conditions under which entities are included in the access group. - The **criteria** object **must contain exactly one include object**. - The **include** object contains multiple properties, where each property represents an active **job property** with category set to the **organization**. #### Each **job property** is referenced by its **ID** and includes the following attributes: - **all (boolean)** true Includes **all** values. false Includes **only** specified values. - **values (array)** A list of specific values to include (if all is set to false) or exclude (if all is set to true) ### Usage Examples - **Match all countries** all: true and an empty values array. - **Match specific countries** all: false and a list of country codes in values. - **Match all countries except certain ones** all: true with values specifying the excluded countries. To obtain a list of available **job properties** under the **organization** category, use the ****. The **job property ID** should be used as the key in the include object.
delete_access_group Read

Delete access group Official SmartRecruiters endpoint: DELETE /configuration/access-groups/{accessGroupId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.delete_access_group
Full name
smartrecruiters.smartrecruiters_configuration_configuration_access_group_delete
ParameterTypeRequiredDescription
access_group_id string yes Access group identifier
get_company_information Read

Get company information Official SmartRecruiters endpoint: GET /configuration/company from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_company_information
Full name
smartrecruiters.smartrecruiters_configuration_configuration_company_my
ParameterTypeRequiredDescription
No parameters.
get_list_available_job_properties Read

Get a list of available job properties Official SmartRecruiters endpoint: GET /configuration/job-properties from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_list_available_job_properties
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_all
ParameterTypeRequiredDescription
accept_language string no language of returned content
create_job_property Read

Create a job property Official SmartRecruiters endpoint: POST /configuration/job-properties from configuration-api.json.

Lua path
app.integrations.smartrecruiters.create_job_property
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_create
ParameterTypeRequiredDescription
body object no job property to be created
get_job_property_by_id Read

Get job property by id Official SmartRecruiters endpoint: GET /configuration/job-properties/{id} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_job_property_by_id
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_get
ParameterTypeRequiredDescription
id string yes job property identifier
accept_language string no language of returned content
update_job_property Read

Update a job property Official SmartRecruiters endpoint: PATCH /configuration/job-properties/{id} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.update_job_property
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_update
ParameterTypeRequiredDescription
id string yes job property identifier
body object no patch request
add_job_property_translations Read

Add a job property's translations Official SmartRecruiters endpoint: PATCH /configuration/job-properties/{id}/translations from configuration-api.json.

Lua path
app.integrations.smartrecruiters.add_job_property_translations
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_translations_patch
ParameterTypeRequiredDescription
id string yes job property identifier
body object yes Request body matching the official SmartRecruiters configuration-api.json schema for Add a job property's translations.
get_available_job_property_values Read

Get available job property values Official SmartRecruiters endpoint: GET /configuration/job-properties/{id}/values from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_available_job_property_values
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_values_get
ParameterTypeRequiredDescription
id string yes job property identifier
accept_language string no language of returned content
page_id string no pageId
page_size integer no pageSize
create_job_property_value Read

Create a job property value Official SmartRecruiters endpoint: POST /configuration/job-properties/{id}/values from configuration-api.json.

Lua path
app.integrations.smartrecruiters.create_job_property_value
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_values_create
ParameterTypeRequiredDescription
id string yes job property identifier
body object no job property object to be created
archive_job_property_value Read

Archive a job property value Official SmartRecruiters endpoint: DELETE /configuration/job-properties/{id}/values/{valueId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.archive_job_property_value
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_values_deprecated_archive
ParameterTypeRequiredDescription
id string yes job property identifier
value_id string yes job property's value identifier
unarchive_job_property_value Read

Unarchive a job property value Official SmartRecruiters endpoint: PUT /configuration/job-properties/{id}/values/{valueId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.unarchive_job_property_value
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_values_deprecated_unarchive
ParameterTypeRequiredDescription
id string yes job property identifier
value_id string yes job property's value identifier
update_job_property_value Read

Update a job property value Official SmartRecruiters endpoint: PATCH /configuration/job-properties/{id}/values/{valueId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.update_job_property_value
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_values_update
ParameterTypeRequiredDescription
id string yes job property identifier
value_id string yes job property's value identifier
body object no patch request
add_job_property_value_translations Read

Add a job property value's translations Official SmartRecruiters endpoint: PATCH /configuration/job-properties/{id}/values/{valueId}/translations from configuration-api.json.

Lua path
app.integrations.smartrecruiters.add_job_property_value_translations
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_values_translations_patch
ParameterTypeRequiredDescription
id string yes job property identifier
value_id string yes job property's value identifier
body object yes Request body matching the official SmartRecruiters configuration-api.json schema for Add a job property value's translations.
archive_job_property_value Read

Archive a job property value Official SmartRecruiters endpoint: PUT /configuration/job-properties/{id}/archive-values/{valueId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.archive_job_property_value
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_values_archive
ParameterTypeRequiredDescription
id string yes job property identifier
value_id string yes job property's value identifier
unarchive_job_property_value Read

Unarchive a job property value Official SmartRecruiters endpoint: DELETE /configuration/job-properties/{id}/archive-values/{valueId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.unarchive_job_property_value
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_values_unarchive
ParameterTypeRequiredDescription
id string yes job property identifier
value_id string yes job property's value identifier
activate_job_property Read

Activate a job property Official SmartRecruiters endpoint: PUT /configuration/job-properties/{id}/activation from configuration-api.json.

Lua path
app.integrations.smartrecruiters.activate_job_property
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_activate
ParameterTypeRequiredDescription
id string yes job property identifier
deactivate_job_property Read

Deactivate a job property Official SmartRecruiters endpoint: DELETE /configuration/job-properties/{id}/activation from configuration-api.json.

Lua path
app.integrations.smartrecruiters.deactivate_job_property
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_deactivate
ParameterTypeRequiredDescription
id string yes job property identifier
get_job_property_dependents Read

Get job property's dependents Official SmartRecruiters endpoint: GET /configuration/job-properties/{id}/dependents from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_job_property_dependents
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_dependents_all
ParameterTypeRequiredDescription
id string yes job property identifier
accept_language string no language of returned content
create_job_property_dependents Read

Create job property dependents Official SmartRecruiters endpoint: POST /configuration/job-properties/{id}/dependents from configuration-api.json.

Lua path
app.integrations.smartrecruiters.create_job_property_dependents
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_dependents_create
ParameterTypeRequiredDescription
id string yes job property identifier
body object yes Job properties' id
remove_job_property_dependent Read

Remove job property's dependent Official SmartRecruiters endpoint: DELETE /configuration/job-properties/{id}/dependents/{dependentId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.remove_job_property_dependent
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_dependents_remove
ParameterTypeRequiredDescription
id string yes job property identifier
dependent_id string yes job property's dependent identifier
get_dependent_job_property_values Read

Get dependent job property's values Official SmartRecruiters endpoint: GET /configuration/job-properties/{id}/dependents/{dependentId}/values from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_dependent_job_property_values
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_dependents_values_all
ParameterTypeRequiredDescription
id string yes job property identifier
dependent_id string yes job property's dependent identifier
accept_language string no language of returned content
get_job_property_dependent_values Read

Get job property's dependent values Official SmartRecruiters endpoint: GET /configuration/job-properties/{id}/values/{valueId}/dependents/{dependentId}/values from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_job_property_dependent_values
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_dependents_values_get
ParameterTypeRequiredDescription
id string yes job property identifier
value_id string yes job property's value identifier
dependent_id string yes job property's dependent identifier
accept_language string no language of returned content
page_id string no pageId
page_size integer no pageSize
add_job_property_dependent_value Read

Add job property's dependent value Official SmartRecruiters endpoint: POST /configuration/job-properties/{id}/values/{valueId}/dependents/{dependentId}/values from configuration-api.json.

Lua path
app.integrations.smartrecruiters.add_job_property_dependent_value
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_dependents_values_add
ParameterTypeRequiredDescription
id string yes job property identifier
value_id string yes job property's value identifier
dependent_id string yes job property's dependent identifier
body object yes Identifier of job property's dependent value
remove_job_property_dependent_values_relationship Read

Remove job property's dependent values relationship Official SmartRecruiters endpoint: DELETE /configuration/job-properties/{id}/values/{valueId}/dependents/{dependentId}/values/{dependentValueId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.remove_job_property_dependent_values_relationship
Full name
smartrecruiters.smartrecruiters_configuration_configuration_job_properties_dependents_values_remove
ParameterTypeRequiredDescription
id string yes job property identifier
value_id string yes job property's value identifier
dependent_id string yes job property's dependent identifier
dependent_value_id string yes job property's dependent value identifier
creates_department Read

Creates department Official SmartRecruiters endpoint: POST /configuration/departments from configuration-api.json.

Lua path
app.integrations.smartrecruiters.creates_department
Full name
smartrecruiters.smartrecruiters_configuration_configuration_department_create
ParameterTypeRequiredDescription
body object yes department to be created
get_departments Read

Get departments Official SmartRecruiters endpoint: GET /configuration/departments from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_departments
Full name
smartrecruiters.smartrecruiters_configuration_configuration_department_all
ParameterTypeRequiredDescription
accept_language string no language of returned content
get_department Read

Get department Official SmartRecruiters endpoint: GET /configuration/departments/{id} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_department
Full name
smartrecruiters.smartrecruiters_configuration_configuration_department_get
ParameterTypeRequiredDescription
id string yes Identifier of a department
get_list_hiring_process Read

Get list of hiring process Official SmartRecruiters endpoint: GET /configuration/hiring-processes from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_list_hiring_process
Full name
smartrecruiters.smartrecruiters_configuration_configuration_hiring_process_all
ParameterTypeRequiredDescription
No parameters.
get_hiring_process Read

Get hiring process Official SmartRecruiters endpoint: GET /configuration/hiring-processes/{id} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_hiring_process
Full name
smartrecruiters.smartrecruiters_configuration_configuration_hiring_process_get
ParameterTypeRequiredDescription
id string yes Identifier of a hiring process
get_list_available_offer_properties Read

Get a list of available offer properties Official SmartRecruiters endpoint: GET /configuration/offer-properties from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_list_available_offer_properties
Full name
smartrecruiters.smartrecruiters_configuration_configuration_offer_properties_all
ParameterTypeRequiredDescription
No parameters.
get_list_available_candidate_properties Read

Get a list of available candidate properties Official SmartRecruiters endpoint: GET /configuration/candidate-properties from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_list_available_candidate_properties
Full name
smartrecruiters.smartrecruiters_configuration_configuration_candidate_properties_all
ParameterTypeRequiredDescription
No parameters.
get_candidate_property_by_id Read

Get candidate property by id Official SmartRecruiters endpoint: GET /configuration/candidate-properties/{id} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_property_by_id
Full name
smartrecruiters.smartrecruiters_configuration_configuration_candidate_properties_get
ParameterTypeRequiredDescription
id string yes Candidate property id (uuid or key)
get_candidate_property_values Read

Get Candidate Property values Official SmartRecruiters endpoint: GET /configuration/candidate-properties/{id}/values from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_property_values
Full name
smartrecruiters.smartrecruiters_configuration_configuration_candidate_properties_values_all
ParameterTypeRequiredDescription
id string yes Candidate property id (uuid or key)
create_candidate_property_value Read

Create candidate property value Official SmartRecruiters endpoint: POST /configuration/candidate-properties/{id}/values from configuration-api.json.

Lua path
app.integrations.smartrecruiters.create_candidate_property_value
Full name
smartrecruiters.smartrecruiters_configuration_configuration_candidate_properties_values_create
ParameterTypeRequiredDescription
id string yes Candidate property id (uuid or key)
body object yes Candidate property value.
get_candidate_property_value_by_id Read

Get Candidate Property value by id Official SmartRecruiters endpoint: GET /configuration/candidate-properties/{id}/values/{valueId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_property_value_by_id
Full name
smartrecruiters.smartrecruiters_configuration_configuration_candidate_properties_values_get
ParameterTypeRequiredDescription
id string yes Candidate property id (uuid or key)
value_id string yes candidate property's value identifier
update_candidate_property_value_label Read

Update candidate property value label Official SmartRecruiters endpoint: PUT /configuration/candidate-properties/{id}/values/{valueId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.update_candidate_property_value_label
Full name
smartrecruiters.smartrecruiters_configuration_configuration_candidate_properties_values_update
ParameterTypeRequiredDescription
id string yes Candidate property id (uuid or key)
value_id string yes candidate property's value identifier
body object yes Candidate property value label.
remove_candidate_property_value Read

Remove candidate property value Official SmartRecruiters endpoint: DELETE /configuration/candidate-properties/{id}/values/{valueId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.remove_candidate_property_value
Full name
smartrecruiters.smartrecruiters_configuration_configuration_candidate_properties_values_delete
ParameterTypeRequiredDescription
id string yes Candidate property id (uuid or key)
value_id string yes candidate property's value identifier
list_candidate_source_types_with_subtypes Read

List candidate source types with subtypes Official SmartRecruiters endpoint: GET /configuration/sources from configuration-api.json.

Lua path
app.integrations.smartrecruiters.list_candidate_source_types_with_subtypes
Full name
smartrecruiters.smartrecruiters_configuration_configuration_source_types
ParameterTypeRequiredDescription
No parameters.
list_candidate_sources Read

List candidate sources Official SmartRecruiters endpoint: GET /configuration/sources/{sourceType}/values from configuration-api.json.

Lua path
app.integrations.smartrecruiters.list_candidate_sources
Full name
smartrecruiters.smartrecruiters_configuration_configuration_source_values_all
ParameterTypeRequiredDescription
source_type string yes Source type from /configuration/sources
source_sub_type string no Source SubType from /configuration/sources
limit integer no number of elements to return. max value is 100
offset integer no number of elements to skip while processing result
get_candidate_source Read

Get a candidate source Official SmartRecruiters endpoint: GET /configuration/sources/{sourceType}/values/{sourceValueId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_source
Full name
smartrecruiters.smartrecruiters_configuration_configuration_source_values_single
ParameterTypeRequiredDescription
source_type string yes Source type from /configuration/sources
source_value_id string yes Source id
source_sub_type string no Source SubType from /configuration/sources
get_candidate_source_by_identifier Read

Get a candidate source by identifier. Official SmartRecruiters endpoint: GET /configuration/sources/{sourceIdentifier} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_source_by_identifier
Full name
smartrecruiters.smartrecruiters_configuration_configuration_source_values_single_by_identifier
ParameterTypeRequiredDescription
source_identifier string yes Source identifier
get_source_by_name Read

Get recruiter source by name Official SmartRecruiters endpoint: PUT /configuration/sources/recruiters/resolve from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_source_by_name
Full name
smartrecruiters.smartrecruiters_configuration_configuration_source_values_recruiter_source_by_name
ParameterTypeRequiredDescription
source_name string yes Name of the source
get_rejection_reasons Read

Get rejection reasons Official SmartRecruiters endpoint: GET /configuration/rejection-reasons from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_rejection_reasons
Full name
smartrecruiters.smartrecruiters_configuration_configuration_reasons_rejection_all
ParameterTypeRequiredDescription
No parameters.
get_withdrawal_reasons Read

Get withdrawal reasons Official SmartRecruiters endpoint: GET /configuration/withdrawal-reasons from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_withdrawal_reasons
Full name
smartrecruiters.smartrecruiters_configuration_configuration_reasons_withdrawal_all
ParameterTypeRequiredDescription
No parameters.
list_career_sites_configurations Read

List career sites configurations Official SmartRecruiters endpoint: GET /configuration/career-sites from configuration-api.json.

Lua path
app.integrations.smartrecruiters.list_career_sites_configurations
Full name
smartrecruiters.smartrecruiters_configuration_configuration_careersites_list
ParameterTypeRequiredDescription
page_id string no pageId
page_size integer no pageSize
get_details_career_site_configuration Read

Get details of career site configuration Official SmartRecruiters endpoint: GET /configuration/career-sites/{careerSiteId} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_details_career_site_configuration
Full name
smartrecruiters.smartrecruiters_configuration_configuration_careersites_get
ParameterTypeRequiredDescription
career_site_id string yes Id of a career site configuration
get_list_predefined_locations Read

Get list of predefined locations Official SmartRecruiters endpoint: GET /configuration/predefined-locations from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_list_predefined_locations
Full name
smartrecruiters.smartrecruiters_configuration_configuration_predefined_locations_get_many
ParameterTypeRequiredDescription
page_id string no pageId
page_size integer no pageSize
identifiers array no Comma-separated list of identifiers to filter by
create_predefined_location Write

Create predefined location Official SmartRecruiters endpoint: POST /configuration/predefined-locations from configuration-api.json.

Lua path
app.integrations.smartrecruiters.create_predefined_location
Full name
smartrecruiters.smartrecruiters_configuration_configuration_predefined_locations_create_one
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters configuration-api.json schema for Create predefined location.
remove_multiple_predefined_locations Write

Remove multiple predefined locations Official SmartRecruiters endpoint: DELETE /configuration/predefined-locations from configuration-api.json.

Lua path
app.integrations.smartrecruiters.remove_multiple_predefined_locations
Full name
smartrecruiters.smartrecruiters_configuration_configuration_predefined_locations_delete_many
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters configuration-api.json schema for Remove multiple predefined locations.
get_predefined_location_by_id Read

Get predefined location by id Official SmartRecruiters endpoint: GET /configuration/predefined-locations/{id} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.get_predefined_location_by_id
Full name
smartrecruiters.smartrecruiters_configuration_configuration_predefined_locations_get_one
ParameterTypeRequiredDescription
id string yes path parameter `id`.
update_predefined_location Write

Update predefined location Official SmartRecruiters endpoint: PUT /configuration/predefined-locations/{id} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.update_predefined_location
Full name
smartrecruiters.smartrecruiters_configuration_configuration_predefined_locations_update_one
ParameterTypeRequiredDescription
id string yes path parameter `id`.
body object yes Request body matching the official SmartRecruiters configuration-api.json schema for Update predefined location.
remove_predefined_location Write

Remove predefined location Official SmartRecruiters endpoint: DELETE /configuration/predefined-locations/{id} from configuration-api.json.

Lua path
app.integrations.smartrecruiters.remove_predefined_location
Full name
smartrecruiters.smartrecruiters_configuration_configuration_predefined_locations_delete_one
ParameterTypeRequiredDescription
id string yes path parameter `id`.
retrieves_interview_types Read

Retrieves interview types Official SmartRecruiters endpoint: GET /interview-types from interviews.json.

Lua path
app.integrations.smartrecruiters.retrieves_interview_types
Full name
smartrecruiters.smartrecruiters_interviews_types_get
ParameterTypeRequiredDescription
No parameters.
adds_interview_types_already_existing_ones Read

Adds interview types to already existing ones Official SmartRecruiters endpoint: PATCH /interview-types from interviews.json.

Lua path
app.integrations.smartrecruiters.adds_interview_types_already_existing_ones
Full name
smartrecruiters.smartrecruiters_interviews_types_update
ParameterTypeRequiredDescription
body object yes Interview types to be added
removes_interview_type_with_given_name Read

Removes interview type with given name Official SmartRecruiters endpoint: DELETE /interview-types/{interviewType} from interviews.json.

Lua path
app.integrations.smartrecruiters.removes_interview_type_with_given_name
Full name
smartrecruiters.smartrecruiters_interviews_types_delete
ParameterTypeRequiredDescription
interview_type string yes Interview type name
retrieves_list_interviews Read

Retrieves a list of interviews Official SmartRecruiters endpoint: GET /interviews from interviews.json.

Lua path
app.integrations.smartrecruiters.retrieves_list_interviews
Full name
smartrecruiters.smartrecruiters_interviews_interviews_get_list
ParameterTypeRequiredDescription
application_id string yes ID of the application
creates_interview Read

Creates an interview Official SmartRecruiters endpoint: POST /interviews from interviews.json.

Lua path
app.integrations.smartrecruiters.creates_interview
Full name
smartrecruiters.smartrecruiters_interviews_interviews_create
ParameterTypeRequiredDescription
body object yes Interview to be added
retrieves_interview Read

Retrieves an interview Official SmartRecruiters endpoint: GET /interviews/{interviewId} from interviews.json.

Lua path
app.integrations.smartrecruiters.retrieves_interview
Full name
smartrecruiters.smartrecruiters_interviews_interviews_get
ParameterTypeRequiredDescription
interview_id string yes ID of the interview
modifies_interview Read

Modifies an interview Official SmartRecruiters endpoint: PATCH /interviews/{interviewId} from interviews.json.

Lua path
app.integrations.smartrecruiters.modifies_interview
Full name
smartrecruiters.smartrecruiters_interviews_interviews_update
ParameterTypeRequiredDescription
interview_id string yes ID of the interview
body object yes Interview to be updated
deletes_interview Read

Deletes an interview Official SmartRecruiters endpoint: DELETE /interviews/{interviewId} from interviews.json.

Lua path
app.integrations.smartrecruiters.deletes_interview
Full name
smartrecruiters.smartrecruiters_interviews_interviews_delete
ParameterTypeRequiredDescription
interview_id string yes ID of the interview
creates_timeslot Read

Creates a timeslot Official SmartRecruiters endpoint: POST /interviews/{interviewId}/timeslots from interviews.json.

Lua path
app.integrations.smartrecruiters.creates_timeslot
Full name
smartrecruiters.smartrecruiters_interviews_timeslots_create
ParameterTypeRequiredDescription
interview_id string yes ID of the interview
body object yes Timeslot to be added
retrieves_timeslot Read

Retrieves a timeslot Official SmartRecruiters endpoint: GET /interviews/{interviewId}/timeslots/{timeslotId} from interviews.json.

Lua path
app.integrations.smartrecruiters.retrieves_timeslot
Full name
smartrecruiters.smartrecruiters_interviews_timeslots_get
ParameterTypeRequiredDescription
interview_id string yes ID of the interview
timeslot_id string yes ID of the timeslot
modifies_timeslot Read

Modifies a timeslot Official SmartRecruiters endpoint: PATCH /interviews/{interviewId}/timeslots/{timeslotId} from interviews.json.

Lua path
app.integrations.smartrecruiters.modifies_timeslot
Full name
smartrecruiters.smartrecruiters_interviews_timeslots_update
ParameterTypeRequiredDescription
interview_id string yes ID of the interview
timeslot_id string yes ID of the timeslot
body object yes Timeslot to be updated
deletes_timeslot Read

Deletes a timeslot Official SmartRecruiters endpoint: DELETE /interviews/{interviewId}/timeslots/{timeslotId} from interviews.json.

Lua path
app.integrations.smartrecruiters.deletes_timeslot
Full name
smartrecruiters.smartrecruiters_interviews_timeslots_delete
ParameterTypeRequiredDescription
interview_id string yes ID of the interview
timeslot_id string yes ID of the timeslot
changes_candidate_status Read

Changes a candidate's status. Official SmartRecruiters endpoint: PUT /interviews/{interviewId}/candidate/status from interviews.json.

Lua path
app.integrations.smartrecruiters.changes_candidate_status
Full name
smartrecruiters.smartrecruiters_interviews_statuses_candidate_put
ParameterTypeRequiredDescription
interview_id string yes ID of the interview
body object yes New candidate's status
changes_interviewer_status_given_timeslot Read

Changes a interviewer's status in given timeslot Official SmartRecruiters endpoint: PUT /interviews/{interviewId}/timeslots/{timeslotId}/interviewers/{userId}/status from interviews.json.

Lua path
app.integrations.smartrecruiters.changes_interviewer_status_given_timeslot
Full name
smartrecruiters.smartrecruiters_interviews_statuses_interviewer_put
ParameterTypeRequiredDescription
interview_id string yes ID of the interview
timeslot_id string yes ID of the timeslot
user_id string yes ID of the user
body object yes New interviewer's status
changes_no_show_value_timeslot Read

Changes no-show value in a timeslot Official SmartRecruiters endpoint: PATCH /interviews/{interviewId}/timeslots/{timeslotId}/noshow from interviews.json.

Lua path
app.integrations.smartrecruiters.changes_no_show_value_timeslot
Full name
smartrecruiters.smartrecruiters_interviews_timeslots_patch_noshow
ParameterTypeRequiredDescription
interview_id string yes ID of the interview
timeslot_id string yes ID of the timeslot
value boolean yes New no-show value
changes_candidate_status_given_timeslot Read

Changes a candidate's status in given timeslot Official SmartRecruiters endpoint: PUT /interviews/{interviewId}/timeslots/{timeslotId}/candidateStatus from interviews.json.

Lua path
app.integrations.smartrecruiters.changes_candidate_status_given_timeslot
Full name
smartrecruiters.smartrecruiters_interviews_statuses_timeslot_candidate_put
ParameterTypeRequiredDescription
interview_id string yes ID of the interview
timeslot_id string yes ID of the timeslot
body object yes New candidate's status
positions_job Read

Positions for a job Official SmartRecruiters endpoint: GET /jobs/{jobId}/positions from jobs-api.json.

Lua path
app.integrations.smartrecruiters.positions_job
Full name
smartrecruiters.smartrecruiters_jobs_jobs_positions_all
ParameterTypeRequiredDescription
job_id string yes job identifier
accept_language string no language of returned content
create_new_position_job Read

Create a new position for a job Official SmartRecruiters endpoint: POST /jobs/{jobId}/positions from jobs-api.json.

Lua path
app.integrations.smartrecruiters.create_new_position_job
Full name
smartrecruiters.smartrecruiters_jobs_jobs_positions_create
ParameterTypeRequiredDescription
job_id string yes job identifier
body object yes Position body object
get_single_position Read

Get a single position Official SmartRecruiters endpoint: GET /jobs/{jobId}/positions/{positionId} from jobs-api.json.

Lua path
app.integrations.smartrecruiters.get_single_position
Full name
smartrecruiters.smartrecruiters_jobs_jobs_positions_get
ParameterTypeRequiredDescription
job_id string yes job identifier
position_id string yes position identifier
accept_language string no language of returned content
update_position Read

Update position Official SmartRecruiters endpoint: PUT /jobs/{jobId}/positions/{positionId} from jobs-api.json.

Lua path
app.integrations.smartrecruiters.update_position
Full name
smartrecruiters.smartrecruiters_jobs_jobs_positions_update
ParameterTypeRequiredDescription
job_id string yes job identifier
position_id string yes position identifier
body object yes Position body object
delete_position Read

Delete position Official SmartRecruiters endpoint: DELETE /jobs/{jobId}/positions/{positionId} from jobs-api.json.

Lua path
app.integrations.smartrecruiters.delete_position
Full name
smartrecruiters.smartrecruiters_jobs_jobs_positions_remove
ParameterTypeRequiredDescription
job_id string yes job identifier
position_id string yes position identifier
find_and_list_job_ads_given_job Read

Find and list job ads for a given job Official SmartRecruiters endpoint: GET /jobs/{jobId}/jobads from jobs-api.json.

Lua path
app.integrations.smartrecruiters.find_and_list_job_ads_given_job
Full name
smartrecruiters.smartrecruiters_jobs_jobs_jobads_all
ParameterTypeRequiredDescription
job_id string yes job identifier
accept_language string no language of returned content
create_new_job_ad Read

Create a new job ad Official SmartRecruiters endpoint: POST /jobs/{jobId}/jobads from jobs-api.json.

Lua path
app.integrations.smartrecruiters.create_new_job_ad
Full name
smartrecruiters.smartrecruiters_jobs_jobs_jobads_create
ParameterTypeRequiredDescription
job_id string yes job identifier
body object yes job ad
get_job_ad Read

Get a job ad Official SmartRecruiters endpoint: GET /jobs/{jobId}/jobads/{jobAdId} from jobs-api.json.

Lua path
app.integrations.smartrecruiters.get_job_ad
Full name
smartrecruiters.smartrecruiters_jobs_jobs_jobads_get
ParameterTypeRequiredDescription
job_id string yes job identifier
job_ad_id string yes job ad identifier
accept_language string no language of returned content
update_job_ad Read

Update a job ad Official SmartRecruiters endpoint: PUT /jobs/{jobId}/jobads/{jobAdId} from jobs-api.json.

Lua path
app.integrations.smartrecruiters.update_job_ad
Full name
smartrecruiters.smartrecruiters_jobs_jobs_jobads_update
ParameterTypeRequiredDescription
job_id string yes job identifier
job_ad_id string yes job ad identifier
body object yes job ad
publishes_job_ad Read

Publishes a job ad Official SmartRecruiters endpoint: POST /jobs/{jobId}/jobads/{jobAdId}/postings from jobs-api.json.

Lua path
app.integrations.smartrecruiters.publishes_job_ad
Full name
smartrecruiters.smartrecruiters_jobs_jobs_jobads_postings_create
ParameterTypeRequiredDescription
job_id string yes job identifier
job_ad_id string yes job ad identifier
body object no Publication object
list_publications_job_ad Read

List publications for a job ad Official SmartRecruiters endpoint: GET /jobs/{jobId}/jobads/{jobAdId}/postings from jobs-api.json.

Lua path
app.integrations.smartrecruiters.list_publications_job_ad
Full name
smartrecruiters.smartrecruiters_jobs_jobs_jobads_postings_all
ParameterTypeRequiredDescription
job_id string yes job identifier
job_ad_id string yes job ad identifier
accept_language string no language of returned content
active_only boolean no publication status filter; when omitted, defaults to 'true' (only active publications are returned); 'false' returns active and inactive publications
unpublish_job_ad Read

Unpublish a job ad Official SmartRecruiters endpoint: DELETE /jobs/{jobId}/jobads/{jobAdId}/postings from jobs-api.json.

Lua path
app.integrations.smartrecruiters.unpublish_job_ad
Full name
smartrecruiters.smartrecruiters_jobs_jobs_jobads_postings_unpublish
ParameterTypeRequiredDescription
job_id string yes job identifier
job_ad_id string yes job ad identifier
publishes_default_job_ad Read

Publishes a default job ad Official SmartRecruiters endpoint: POST /jobs/{jobId}/publication from jobs-api.json.

Lua path
app.integrations.smartrecruiters.publishes_default_job_ad
Full name
smartrecruiters.smartrecruiters_jobs_jobs_publication_create
ParameterTypeRequiredDescription
job_id string yes job identifier
body object no Publication object
unpublishes_job_from_all_sources Read

Unpublishes a job from all sources Official SmartRecruiters endpoint: DELETE /jobs/{jobId}/publication from jobs-api.json.

Lua path
app.integrations.smartrecruiters.unpublishes_job_from_all_sources
Full name
smartrecruiters.smartrecruiters_jobs_jobs_publication_unpublish
ParameterTypeRequiredDescription
job_id string yes job identifier
find_and_list_publications_job Read

Find and list publications for a job Official SmartRecruiters endpoint: GET /jobs/{jobId}/publication from jobs-api.json.

Lua path
app.integrations.smartrecruiters.find_and_list_publications_job
Full name
smartrecruiters.smartrecruiters_jobs_jobs_publication_all
ParameterTypeRequiredDescription
job_id string yes job identifier
accept_language string no language of returned content
active_only boolean no publication status filter; defaults to 'true' (only active publications are returned); 'false' returns active and inactive publications
get_hiring_team_job_with_given_id Read

Get hiring team of a job with a given id. Official SmartRecruiters endpoint: GET /jobs/{jobId}/hiring-team from jobs-api.json.

Lua path
app.integrations.smartrecruiters.get_hiring_team_job_with_given_id
Full name
smartrecruiters.smartrecruiters_jobs_jobs_hiring_team_get
ParameterTypeRequiredDescription
job_id string yes job identifier
accept_language string no language of returned content
add_hiring_team_member_job_with_given_id Read

Add hiring team member of a job with a given id. Official SmartRecruiters endpoint: POST /jobs/{jobId}/hiring-team from jobs-api.json.

Lua path
app.integrations.smartrecruiters.add_hiring_team_member_job_with_given_id
Full name
smartrecruiters.smartrecruiters_jobs_jobs_hiring_team_add
ParameterTypeRequiredDescription
job_id string yes job identifier
body object no HiringTeamMember object
removes_hiring_team_member_job_with_given_id Read

Removes hiring team member of a job with a given id. Official SmartRecruiters endpoint: DELETE /jobs/{jobId}/hiring-team/{userId} from jobs-api.json.

Lua path
app.integrations.smartrecruiters.removes_hiring_team_member_job_with_given_id
Full name
smartrecruiters.smartrecruiters_jobs_jobs_hiring_team_remove
ParameterTypeRequiredDescription
job_id string yes job identifier
user_id string yes user identifier
get_note_job Read

Get note of a job. Official SmartRecruiters endpoint: GET /jobs/{jobId}/note from jobs-api.json.

Lua path
app.integrations.smartrecruiters.get_note_job
Full name
smartrecruiters.smartrecruiters_jobs_jobs_notes_get
ParameterTypeRequiredDescription
job_id string yes job identifier
accept_language string no language of returned content
update_note_job Read

Update note of a job. Official SmartRecruiters endpoint: PUT /jobs/{jobId}/note from jobs-api.json.

Lua path
app.integrations.smartrecruiters.update_note_job
Full name
smartrecruiters.smartrecruiters_jobs_jobs_notes_update
ParameterTypeRequiredDescription
job_id string yes job identifier
body object yes Request body matching the official SmartRecruiters jobs-api.json schema for Update note of a job..
update_job_headcount Read

Update job headcount. Official SmartRecruiters endpoint: PATCH /jobs/{jobId}/headcount from jobs-api.json.

Lua path
app.integrations.smartrecruiters.update_job_headcount
Full name
smartrecruiters.smartrecruiters_jobs_jobs_headcount_update
ParameterTypeRequiredDescription
job_id string yes job identifier
body object yes Request body matching the official SmartRecruiters jobs-api.json schema for Update job headcount..
search_jobs Read

Search jobs Official SmartRecruiters endpoint: GET /jobs from jobs-api.json.

Lua path
app.integrations.smartrecruiters.search_jobs
Full name
smartrecruiters.smartrecruiters_jobs_jobs_all
ParameterTypeRequiredDescription
accept_language string no language of returned content
q string no full-text search query based on a job title; case insensitive; e.g. java developer
limit integer no number of elements to return. max value is 100
offset integer no number of elements to skip while processing result; this method of paging is very slow and is deprecated, please use pageId instead
page_id string no unique identifier for next page of jobs - returned as nextPageId in previous page result. You must set job_id value for sort parameter if you use pageId.
sort string no Order in which results are returned. - default - sorts results by creation date or by match score and creation date if query (q) is set. Can't be used with pageId parameter (request might not return all results) - job_id - sorts results by job id. The only supported sorting order when using pageId based pagination.
city array no city filter (part of the location object); can be used repeatedly; case sensitive; e.g. San Francisco
department array no department filter (by department label); can be used repeatedly; case sensitive; e.g. Marketing
updated_after string no ISO8601-formatted time boundaries for the job update time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ
last_activity_after string no ISO8601-formatted time boundaries for the job lastActivityOn time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ. lastActivityOn is updated when job is edited, new candidates apply or job is published.
language string no Exceptions to the language code ISO format: * "en-GB" - "English - English (UK)" * "es-MX" - "Spanish - espaol (Mxico)" * "fr-CA" - "French - franais (Canada)" * "pt-BR" - "Portugal - portugus (Brasil)" * "zh-TW" - "Chinese (Traditional) - ()" * "zh-CN" - "Chinese (Simplified) - ()" Value "pt-PT" is deprecated and will not work, use "pt" instead.
status string no Status of a job. Deprecated - cannot be used repeatedly. To filter by multiple status, use "statuses".
statuses array no Job status filter, can be used repeatedly. When present, overrides "status".
posting_status string no Posting status of a job
hiring_team_member_id array no Filter jobs to those where any of the given users is a member of the job's hiring team. Values are user identifiers.
create_new_job Read

Create a new job Official SmartRecruiters endpoint: POST /jobs from jobs-api.json.

Lua path
app.integrations.smartrecruiters.create_new_job
Full name
smartrecruiters.smartrecruiters_jobs_jobs_create
ParameterTypeRequiredDescription
body object no Job object that needs to be created
get_content_job_with_given_id Read

Get content of a job with a given id. Official SmartRecruiters endpoint: GET /jobs/{jobId} from jobs-api.json.

Lua path
app.integrations.smartrecruiters.get_content_job_with_given_id
Full name
smartrecruiters.smartrecruiters_jobs_jobs_get
ParameterTypeRequiredDescription
job_id string yes job identifier
accept_language string no language of returned content
update_job Read

Update a job Official SmartRecruiters endpoint: PATCH /jobs/{jobId} from jobs-api.json.

Lua path
app.integrations.smartrecruiters.update_job
Full name
smartrecruiters.smartrecruiters_jobs_jobs_patch
ParameterTypeRequiredDescription
job_id string yes job identifier
body object no Request body matching the official SmartRecruiters jobs-api.json schema for Update a job.
updates_job Read

Updates job Official SmartRecruiters endpoint: PUT /jobs/{jobId} from jobs-api.json.

Lua path
app.integrations.smartrecruiters.updates_job
Full name
smartrecruiters.smartrecruiters_jobs_jobs_update
ParameterTypeRequiredDescription
job_id string yes job identifier
body object no Job that needs to be updated
updates_job_status Read

Updates job status Official SmartRecruiters endpoint: PUT /jobs/{jobId}/status from jobs-api.json.

Lua path
app.integrations.smartrecruiters.updates_job_status
Full name
smartrecruiters.smartrecruiters_jobs_jobs_status_update
ParameterTypeRequiredDescription
job_id string yes job identifier
body object yes Request body matching the official SmartRecruiters jobs-api.json schema for Updates job status.
job_status_history Read

Job status history Official SmartRecruiters endpoint: GET /jobs/{jobId}/status/history from jobs-api.json.

Lua path
app.integrations.smartrecruiters.job_status_history
Full name
smartrecruiters.smartrecruiters_jobs_jobs_status_history_get
ParameterTypeRequiredDescription
job_id string yes job identifier
accept_language string no language of returned content
get_latest_approval_request_given_job Read

Get latest approval request for given job Official SmartRecruiters endpoint: GET /jobs/{jobId}/approvals/latest from jobs-api.json.

Lua path
app.integrations.smartrecruiters.get_latest_approval_request_given_job
Full name
smartrecruiters.smartrecruiters_jobs_jobs_approvals_latest
ParameterTypeRequiredDescription
job_id string yes job identifier
accept_language string no language of returned content
add_tags_candidate Read

Add tags to a candidate Official SmartRecruiters endpoint: POST /candidates/{id}/tags from candidates-api.json.

Lua path
app.integrations.smartrecruiters.add_tags_candidate
Full name
smartrecruiters.smartrecruiters_candidates_candidates_tags_add
ParameterTypeRequiredDescription
id string yes candidate identifier
body object yes Tags to be added.
get_tags_candidate Read

Get tags for a candidate Official SmartRecruiters endpoint: GET /candidates/{id}/tags from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_tags_candidate
Full name
smartrecruiters.smartrecruiters_candidates_candidates_tags_get
ParameterTypeRequiredDescription
id string yes candidate identifier
update_tags_candidate Read

Update tags for a candidate Official SmartRecruiters endpoint: PUT /candidates/{id}/tags from candidates-api.json.

Lua path
app.integrations.smartrecruiters.update_tags_candidate
Full name
smartrecruiters.smartrecruiters_candidates_candidates_tags_replace
ParameterTypeRequiredDescription
id string yes candidate identifier
body object yes Tags to be set.
delete_tags_candidate Read

Delete tags for a candidate Official SmartRecruiters endpoint: DELETE /candidates/{id}/tags from candidates-api.json.

Lua path
app.integrations.smartrecruiters.delete_tags_candidate
Full name
smartrecruiters.smartrecruiters_candidates_candidates_tags_delete
ParameterTypeRequiredDescription
id string yes candidate identifier
get_onboarding_status_candidate Read

Get Onboarding Status for a candidate Official SmartRecruiters endpoint: GET /candidates/{id}/onboardingStatus from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_onboarding_status_candidate
Full name
smartrecruiters.smartrecruiters_candidates_candidates_onboarding_get
ParameterTypeRequiredDescription
id string yes candidate identifier
set_onboarding_status_candidate Read

Set Onboarding Status for a candidate Official SmartRecruiters endpoint: PUT /candidates/{id}/onboardingStatus from candidates-api.json.

Lua path
app.integrations.smartrecruiters.set_onboarding_status_candidate
Full name
smartrecruiters.smartrecruiters_candidates_candidates_onboarding_update
ParameterTypeRequiredDescription
id string yes candidate identifier
body object yes Onboarding status.
get_onboarding_status_candidate_associated_with_given_job Read

Get Onboarding Status for a candidate associated with given job Official SmartRecruiters endpoint: GET /candidates/{id}/jobs/{jobId}/onboardingStatus from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_onboarding_status_candidate_associated_with_given_job
Full name
smartrecruiters.smartrecruiters_candidates_candidates_onboarding_get_for_job
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
sets_onboarding_status_candidate_associated_with_given_job Write

Sets Onboarding Status for a candidate associated with given job Official SmartRecruiters endpoint: PUT /candidates/{id}/jobs/{jobId}/onboardingStatus from candidates-api.json.

Lua path
app.integrations.smartrecruiters.sets_onboarding_status_candidate_associated_with_given_job
Full name
smartrecruiters.smartrecruiters_candidates_candidates_onboarding_update_for_job
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
body object yes Onboarding status.
search_candidates Read

Search candidates Official SmartRecruiters endpoint: GET /candidates from candidates-api.json.

Lua path
app.integrations.smartrecruiters.search_candidates
Full name
smartrecruiters.smartrecruiters_candidates_candidates_all
ParameterTypeRequiredDescription
q string no keyword search, for more information see
limit integer no number of elements to return. max value is 100
page_id string no page identifier of elements to return The pageId param can be used to fetch multiple page response, in case the number of results is higher than max number of elements to return (specified in the limit parameter). The pageId should not be present when requesting the first page of results. The pageId of the following page is returned either in the nextPageId property, or is available in the HTTP header Link value of relation type next. Example of the Link header: ; rel="next"
job_id array no job filter to display candidates who applied for a job [id]; can be used repeatedly;
location array no location keyword search which looks up a string in a candidates location data; can be used repeatedly; case insensitive; e.g. Krakow
average_rating array no average rating filter to display candidates with a specific average rating (integer); can be used repeatedly; e.g. 4
status array no candidates status filter in a context of a job; can be used repeatedly
consent_status array no candidates consent status filter; can be used repeatedly
sub_status string no candidates sub-status filter in a context of a job. Works only in a correlation with a set value for the "status" field.
tag array no tag assigned to a candidate; can be used repeatedly; case insensitive; e.g. fluent english
updated_after string no ISO8601-formatted time boundaries for the candidate update time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ
onboarding_status string no candidate's onboarding status
property_id array no candidate's property id (1-N). Currently it is only possible to filter by single-select application fields. Other application field type filtering is not possible.
property_value_id array no candidate's property value id (1-N)
source_type array no candidate's source type (1-N)
source_sub_type array no candidate's source subtype (1-N)
source_value_id array no candidate's source value id (1-N)
question_category array no screening question category (1-N)
question_field_id array no screening question field id (1-N)
question_field_value_id array no screening question field value id (1-N)
create_new_candidate_and_assign_talent_pool Read

Create a new candidate and assign to a Talent Pool Official SmartRecruiters endpoint: POST /candidates from candidates-api.json.

Lua path
app.integrations.smartrecruiters.create_new_candidate_and_assign_talent_pool
Full name
smartrecruiters.smartrecruiters_candidates_candidates_add
ParameterTypeRequiredDescription
body object yes Candidate object that needs to be created.
parse_resume_create_candidate_and_assign_talent_pool Write

Parse a resume, create a candidate and assign to a Talent Pool. Official SmartRecruiters endpoint: POST /candidates/cv from candidates-api.json.

Lua path
app.integrations.smartrecruiters.parse_resume_create_candidate_and_assign_talent_pool
Full name
smartrecruiters.smartrecruiters_candidates_candidates_resume_add
ParameterTypeRequiredDescription
body object no Request body matching the official SmartRecruiters candidates-api.json schema for Parse a resume, create a candidate and assign to a Talent Pool..
parse_resume Write

Parse a resume Official SmartRecruiters endpoint: POST /candidates/cv/parse from candidates-api.json.

Lua path
app.integrations.smartrecruiters.parse_resume
Full name
smartrecruiters.smartrecruiters_candidates_candidates_resume_parse
ParameterTypeRequiredDescription
body object no Request body matching the official SmartRecruiters candidates-api.json schema for Parse a resume.
get_details_candidate Read

Get details of a candidate Official SmartRecruiters endpoint: GET /candidates/{id} from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_details_candidate
Full name
smartrecruiters.smartrecruiters_candidates_candidates_get
ParameterTypeRequiredDescription
id string yes candidate identifier
delete_candidate Read

Delete Candidate Official SmartRecruiters endpoint: DELETE /candidates/{id} from candidates-api.json.

Lua path
app.integrations.smartrecruiters.delete_candidate
Full name
smartrecruiters.smartrecruiters_candidates_candidates_delete
ParameterTypeRequiredDescription
id string yes candidate identifier
update_candidate_personal_information Read

Update candidate personal information Official SmartRecruiters endpoint: PATCH /candidates/{id} from candidates-api.json.

Lua path
app.integrations.smartrecruiters.update_candidate_personal_information
Full name
smartrecruiters.smartrecruiters_candidates_candidates_update
ParameterTypeRequiredDescription
id string yes candidate identifier
body object no Candidate personal information
get_list_candidate_attachments Read

Get list candidate's attachments. Official SmartRecruiters endpoint: GET /candidates/{id}/attachments from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_list_candidate_attachments
Full name
smartrecruiters.smartrecruiters_candidates_candidates_attachments_list
ParameterTypeRequiredDescription
id string yes candidate identifier
attach_files_candidate Read

Attach files to a candidate. Official SmartRecruiters endpoint: POST /candidates/{id}/attachments from candidates-api.json.

Lua path
app.integrations.smartrecruiters.attach_files_candidate
Full name
smartrecruiters.smartrecruiters_candidates_candidates_attachments_add
ParameterTypeRequiredDescription
id string yes candidate identifier
body object no Request body matching the official SmartRecruiters candidates-api.json schema for Attach files to a candidate..
get_candidate_attachment Read

Get a candidate's attachment. Official SmartRecruiters endpoint: GET /candidates/{id}/attachments/{attachmentId} from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_attachment
Full name
smartrecruiters.smartrecruiters_candidates_candidates_attachments_get
ParameterTypeRequiredDescription
id string yes candidate identifier
attachment_id string yes Identifier of an attachment
get_list_candidate_attachments_context_given_job Read

Get list of candidate's attachments in context of given job. Official SmartRecruiters endpoint: GET /candidates/{id}/jobs/{jobId}/attachments from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_list_candidate_attachments_context_given_job
Full name
smartrecruiters.smartrecruiters_candidates_candidates_attachments_list_for_job
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
attach_file_candidate_context_given_job Write

Attach file to candidate in context of given job. Official SmartRecruiters endpoint: POST /candidates/{id}/jobs/{jobId}/attachments from candidates-api.json.

Lua path
app.integrations.smartrecruiters.attach_file_candidate_context_given_job
Full name
smartrecruiters.smartrecruiters_candidates_candidates_attachments_add_for_job
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
body object no Request body matching the official SmartRecruiters candidates-api.json schema for Attach file to candidate in context of given job..
get_candidate_attachment Read

Get candidate's attachment. Official SmartRecruiters endpoint: GET /candidates/attachments/{attachmentId} from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_attachment
Full name
smartrecruiters.smartrecruiters_candidates_candidates_attachments_get_for_job
ParameterTypeRequiredDescription
attachment_id string yes attachment identifier
delete_attachment Write

Delete attachment. Official SmartRecruiters endpoint: DELETE /candidates/attachments/{attachmentId} from candidates-api.json.

Lua path
app.integrations.smartrecruiters.delete_attachment
Full name
smartrecruiters.smartrecruiters_candidates_candidates_attachments_delete_for_job
ParameterTypeRequiredDescription
attachment_id string yes attachment identifier
update_candidate_status Read

Update a candidate's status Official SmartRecruiters endpoint: PUT /candidates/{id}/jobs/{jobId}/status from candidates-api.json.

Lua path
app.integrations.smartrecruiters.update_candidate_status
Full name
smartrecruiters.smartrecruiters_candidates_candidates_status_update
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
body object no Candidate Status to be set
update_candidate_status_primary_assignment Write

Update a candidate's status on primary assignment Official SmartRecruiters endpoint: PUT /candidates/{id}/status from candidates-api.json.

Lua path
app.integrations.smartrecruiters.update_candidate_status_primary_assignment
Full name
smartrecruiters.smartrecruiters_candidates_candidates_status_update_primary
ParameterTypeRequiredDescription
id string yes candidate identifier
body object no Candidate Status to be set
get_candidate_status_history Read

Get candidate's status history Official SmartRecruiters endpoint: GET /candidates/{id}/status/history from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_status_history
Full name
smartrecruiters.smartrecruiters_candidates_candidates_status_history_get
ParameterTypeRequiredDescription
id string yes candidate identifier
get_candidate_status_history_candidate_job Read

Get candidate's status history for a candidate's job Official SmartRecruiters endpoint: GET /candidates/{id}/jobs/{jobId}/status/history from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_status_history_candidate_job
Full name
smartrecruiters.smartrecruiters_candidates_candidates_status_history_get_for_job
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
update_candidate_source Read

Update a candidate's source Official SmartRecruiters endpoint: PUT /candidates/{id}/jobs/{jobId}/source from candidates-api.json.

Lua path
app.integrations.smartrecruiters.update_candidate_source
Full name
smartrecruiters.smartrecruiters_candidates_candidates_source_update
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
body object yes Candidate source to be set
get_candidate_property_values_candidate Read

Get candidate property values for a candidate Official SmartRecruiters endpoint: GET /candidates/{id}/properties from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_property_values_candidate
Full name
smartrecruiters.smartrecruiters_candidates_candidates_properties_get
ParameterTypeRequiredDescription
id string yes candidate identifier
context string no context for candidate properties to display
get_candidate_property_values_candidate_job Read

Get candidate property values for a candidate's job Official SmartRecruiters endpoint: GET /candidates/{id}/jobs/{jobId}/properties from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_property_values_candidate_job
Full name
smartrecruiters.smartrecruiters_candidates_candidates_properties_get_for_job
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
context string no context for candidate properties to display
add_update_candidate_properties_values Write

Add/update candidate properties values Official SmartRecruiters endpoint: PUT /candidates/{id}/jobs/{jobId}/properties from candidates-api.json.

Lua path
app.integrations.smartrecruiters.add_update_candidate_properties_values
Full name
smartrecruiters.smartrecruiters_candidates_candidates_properties_values_batch_update_for_job
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
body object no Request body matching the official SmartRecruiters candidates-api.json schema for Add/update candidate properties values.
add_update_candidate_property_value Read

Add/update candidate property value Official SmartRecruiters endpoint: PUT /candidates/{id}/properties/{propertyId} from candidates-api.json.

Lua path
app.integrations.smartrecruiters.add_update_candidate_property_value
Full name
smartrecruiters.smartrecruiters_candidates_candidates_properties_values_update
ParameterTypeRequiredDescription
id string yes candidate identifier
property_id string yes Candidate property id (uuid or key)
body object no Input value of the candidate property.
add_update_candidate_property_value Write

Add/update candidate property value Official SmartRecruiters endpoint: PUT /candidates/{id}/jobs/{jobId}/properties/{propertyId} from candidates-api.json.

Lua path
app.integrations.smartrecruiters.add_update_candidate_property_value
Full name
smartrecruiters.smartrecruiters_candidates_candidates_properties_values_update_for_job
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
property_id string yes Candidate property id (uuid or key)
body object no Input value of the candidate property.
get_candidate_screening_answers_candidate_job Read

Get candidate screening answers for a candidate's job Official SmartRecruiters endpoint: GET /candidates/{id}/jobs/{jobId}/screening-answers from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_screening_answers_candidate_job
Full name
smartrecruiters.smartrecruiters_candidates_candidates_screening_answers_get
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
create_new_candidate_and_assign_job Write

Create a new candidate and assign to a job Official SmartRecruiters endpoint: POST /jobs/{jobId}/candidates from candidates-api.json.

Lua path
app.integrations.smartrecruiters.create_new_candidate_and_assign_job
Full name
smartrecruiters.smartrecruiters_candidates_candidates_add_to_job
ParameterTypeRequiredDescription
job_id string yes job identifier
body object yes Candidate object that needs to be created.
parse_resume_create_candidate_and_assign_job Write

Parse a resume, create a candidate and assign to a job. Official SmartRecruiters endpoint: POST /jobs/{jobId}/candidates/cv from candidates-api.json.

Lua path
app.integrations.smartrecruiters.parse_resume_create_candidate_and_assign_job
Full name
smartrecruiters.smartrecruiters_candidates_candidates_resume_add_to_job
ParameterTypeRequiredDescription
job_id string yes job identifier
body object no Request body matching the official SmartRecruiters candidates-api.json schema for Parse a resume, create a candidate and assign to a job..
get_details_candidate_application_job Read

Get details of a candidate's application to a job Official SmartRecruiters endpoint: GET /candidates/{id}/jobs/{jobId} from candidates-api.json.

Lua path
app.integrations.smartrecruiters.get_details_candidate_application_job
Full name
smartrecruiters.smartrecruiters_candidates_candidates_get_application
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
delete_candidate_application_job Write

Delete candidate's application to a job Official SmartRecruiters endpoint: DELETE /candidates/{id}/jobs/{jobId} from candidates-api.json.

Lua path
app.integrations.smartrecruiters.delete_candidate_application_job
Full name
smartrecruiters.smartrecruiters_candidates_candidates_delete_application
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
get_job_application Read

Get a job application Official SmartRecruiters endpoint: GET /job-applications/{jobApplicationId} from job-applications-api.json.

Lua path
app.integrations.smartrecruiters.get_job_application
Full name
smartrecruiters.smartrecruiters_job_applications_job_applications_get_by_id
ParameterTypeRequiredDescription
job_application_id string yes ID of job application
delete_job_application Write

Delete a job application Official SmartRecruiters endpoint: DELETE /job-applications/{jobApplicationId} from job-applications-api.json.

Lua path
app.integrations.smartrecruiters.delete_job_application
Full name
smartrecruiters.smartrecruiters_job_applications_job_applications_delete_by_id
ParameterTypeRequiredDescription
job_application_id string yes ID of job application
shares_new_messages_hireloop_with_users_hiring_teams_or_everyone_and_sends_emails Read

Shares new messages on Hireloop with Users, Hiring Teams or Everyone and sends emails. Official SmartRecruiters endpoint: POST /messages/shares from messages-api.json.

Lua path
app.integrations.smartrecruiters.shares_new_messages_hireloop_with_users_hiring_teams_or_everyone_and_sends_emails
Full name
smartrecruiters.smartrecruiters_messages_messages_shares_create
ParameterTypeRequiredDescription
body object no Message to post
delete_message Read

Delete a message Official SmartRecruiters endpoint: DELETE /messages/shares/{id} from messages-api.json.

Lua path
app.integrations.smartrecruiters.delete_message
Full name
smartrecruiters.smartrecruiters_messages_messages_shares_delete
ParameterTypeRequiredDescription
id string yes identifier of a message
fetch_messages Read

Fetch messages Official SmartRecruiters endpoint: GET /messages from messages-api.json.

Lua path
app.integrations.smartrecruiters.fetch_messages
Full name
smartrecruiters.smartrecruiters_messages_messages_fetch
ParameterTypeRequiredDescription
candidate_id string yes identifier of a candidate
job_id string no identifier of a job
page_id string no identifier of next page
limit integer no limit
retrieves_all_criteria_specified_job Read

Retrieves all criteria for specified job Official SmartRecruiters endpoint: GET /jobs/{jobId}/criteria from reviews.json.

Lua path
app.integrations.smartrecruiters.retrieves_all_criteria_specified_job
Full name
smartrecruiters.smartrecruiters_reviews_scorecards_criteria_get_by_job_id
ParameterTypeRequiredDescription
job_id string yes ID of the job
retrieves_all_reviews_specified_candidate_and_job Read

Retrieves all reviews for specified candidate and job Official SmartRecruiters endpoint: GET /reviews from reviews.json.

Lua path
app.integrations.smartrecruiters.retrieves_all_reviews_specified_candidate_and_job
Full name
smartrecruiters.smartrecruiters_reviews_reviews_get_list
ParameterTypeRequiredDescription
candidate_id string yes ID of the candidate
job_id string yes ID of the job
creates_review Read

Creates a review Official SmartRecruiters endpoint: POST /reviews from reviews.json.

Lua path
app.integrations.smartrecruiters.creates_review
Full name
smartrecruiters.smartrecruiters_reviews_reviews_create
ParameterTypeRequiredDescription
body object yes Review to be created
retrieves_review Read

Retrieves a review Official SmartRecruiters endpoint: GET /reviews/{reviewId} from reviews.json.

Lua path
app.integrations.smartrecruiters.retrieves_review
Full name
smartrecruiters.smartrecruiters_reviews_reviews_get
ParameterTypeRequiredDescription
review_id string yes ID of the review
updates_review Read

Updates a review Official SmartRecruiters endpoint: PATCH /reviews/{reviewId} from reviews.json.

Lua path
app.integrations.smartrecruiters.updates_review
Full name
smartrecruiters.smartrecruiters_reviews_reviews_update
ParameterTypeRequiredDescription
review_id string yes ID of the review
body object yes Review to be updated
deletes_review Read

Deletes a review Official SmartRecruiters endpoint: DELETE /reviews/{reviewId} from reviews.json.

Lua path
app.integrations.smartrecruiters.deletes_review
Full name
smartrecruiters.smartrecruiters_reviews_reviews_delete
ParameterTypeRequiredDescription
review_id string yes ID of the review
reviewer_id string yes ID of the reviewer
get_report_files Read

Get report files Official SmartRecruiters endpoint: GET /reports/{reportId}/files from reporting-api.json.

Lua path
app.integrations.smartrecruiters.get_report_files
Full name
smartrecruiters.smartrecruiters_reporting_get_report_files
ParameterTypeRequiredDescription
page string no Opaque page identifier to be returned.
limit integer no Number of entities that should be returned per page.
report_id string yes Report identifier
generate_ad_hoc_report Read

Generate ad-hoc report Official SmartRecruiters endpoint: POST /reports/{reportId}/files from reporting-api.json.

Lua path
app.integrations.smartrecruiters.generate_ad_hoc_report
Full name
smartrecruiters.smartrecruiters_reporting_generate_ad_hoc_report
ParameterTypeRequiredDescription
report_id string yes Report identifier
get_reports Read

Get reports Official SmartRecruiters endpoint: GET /reports from reporting-api.json.

Lua path
app.integrations.smartrecruiters.get_reports
Full name
smartrecruiters.smartrecruiters_reporting_get_reports
ParameterTypeRequiredDescription
page string no Opaque page identifier to be returned.
limit integer no Number of entities that should be returned per page.
get_report Read

Get report Official SmartRecruiters endpoint: GET /reports/{reportId} from reporting-api.json.

Lua path
app.integrations.smartrecruiters.get_report
Full name
smartrecruiters.smartrecruiters_reporting_get_report
ParameterTypeRequiredDescription
report_id string yes Report identifier
get_most_recent_report_file Read

Get most recent report file Official SmartRecruiters endpoint: GET /reports/{reportId}/files/recent from reporting-api.json.

Lua path
app.integrations.smartrecruiters.get_most_recent_report_file
Full name
smartrecruiters.smartrecruiters_reporting_get_most_recent_report_file
ParameterTypeRequiredDescription
report_id string yes Report identifier
if_none_match string no Report file ETag to be compared with the most recent report file
download_most_recent_report_file Read

Download most recent report file Official SmartRecruiters endpoint: GET /reports/{reportId}/files/recent/data from reporting-api.json.

Lua path
app.integrations.smartrecruiters.download_most_recent_report_file
Full name
smartrecruiters.smartrecruiters_reporting_download_most_recent_report_file
ParameterTypeRequiredDescription
report_id string yes Report identifier
if_none_match string no Report file ETag to be compared with the most recent report file
get_report_file Read

Get report file Official SmartRecruiters endpoint: GET /files/{reportFileId} from reporting-api.json.

Lua path
app.integrations.smartrecruiters.get_report_file
Full name
smartrecruiters.smartrecruiters_reporting_get_report_file
ParameterTypeRequiredDescription
report_file_id string yes Report file identifier
download_report_file Read

Download report file Official SmartRecruiters endpoint: GET /files/{reportFileId}/data from reporting-api.json.

Lua path
app.integrations.smartrecruiters.download_report_file
Full name
smartrecruiters.smartrecruiters_reporting_download_report_file
ParameterTypeRequiredDescription
report_file_id string yes Report file identifier
list_users_your_company Read

List users of your company Official SmartRecruiters endpoint: GET /users from users-api-deprecated.json.

Lua path
app.integrations.smartrecruiters.list_users_your_company
Full name
smartrecruiters.smartrecruiters_users_api_deprecated_users_all
ParameterTypeRequiredDescription
q string no full-text search query based on firstName, lastName, email
limit integer no number of elements to return. max value is 100
offset integer no number of elements to skip while processing result
updated_after string no ISO8601-formatted time boundaries for the user update time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ
create_new_user Read

Create a new user Official SmartRecruiters endpoint: POST /users from users-api-deprecated.json.

Lua path
app.integrations.smartrecruiters.create_new_user
Full name
smartrecruiters.smartrecruiters_users_api_deprecated_users_create
ParameterTypeRequiredDescription
body object no User object to be created
get_details_my_user Read

Get details of my user Official SmartRecruiters endpoint: GET /users/me from users-api-deprecated.json.

Lua path
app.integrations.smartrecruiters.get_details_my_user
Full name
smartrecruiters.smartrecruiters_users_api_deprecated_users_me
ParameterTypeRequiredDescription
No parameters.
get_details_user_with_given_id Read

Get details of a user with given id Official SmartRecruiters endpoint: GET /users/{id} from users-api-deprecated.json.

Lua path
app.integrations.smartrecruiters.get_details_user_with_given_id
Full name
smartrecruiters.smartrecruiters_users_api_deprecated_users_get
ParameterTypeRequiredDescription
id string yes user identifier
deactivate_user Read

Deactivate a user Official SmartRecruiters endpoint: DELETE /users/{id} from users-api-deprecated.json.

Lua path
app.integrations.smartrecruiters.deactivate_user
Full name
smartrecruiters.smartrecruiters_users_api_deprecated_users_activation_delete
ParameterTypeRequiredDescription
id string yes user identifier
update_user Read

Update a user Official SmartRecruiters endpoint: PATCH /users/{id} from users-api-deprecated.json.

Lua path
app.integrations.smartrecruiters.update_user
Full name
smartrecruiters.smartrecruiters_users_api_deprecated_users_update
ParameterTypeRequiredDescription
id string yes user identifier
body object no patch request
send_activation_email_user Read

Send an activation email to a user Official SmartRecruiters endpoint: POST /users/{id}/activation-email from users-api-deprecated.json.

Lua path
app.integrations.smartrecruiters.send_activation_email_user
Full name
smartrecruiters.smartrecruiters_users_api_deprecated_users_activation_email_send
ParameterTypeRequiredDescription
id string yes user identifier
activate_user Read

Activate a user Official SmartRecruiters endpoint: PUT /users/{id}/activation from users-api-deprecated.json.

Lua path
app.integrations.smartrecruiters.activate_user
Full name
smartrecruiters.smartrecruiters_users_api_deprecated_users_activation_activate
ParameterTypeRequiredDescription
id string yes user identifier
deactivate_user Read

Deactivate a user Official SmartRecruiters endpoint: DELETE /users/{id}/activation from users-api-deprecated.json.

Lua path
app.integrations.smartrecruiters.deactivate_user
Full name
smartrecruiters.smartrecruiters_users_api_deprecated_users_activation_deactivate
ParameterTypeRequiredDescription
id string yes user identifier
update_user_avatar Read

Update user avatar Official SmartRecruiters endpoint: PUT /users/{id}/avatar from users-api-deprecated.json.

Lua path
app.integrations.smartrecruiters.update_user_avatar
Full name
smartrecruiters.smartrecruiters_users_api_deprecated_users_avatar_update
ParameterTypeRequiredDescription
id string yes user identifier
body object no Request body matching the official SmartRecruiters users-api-deprecated.json schema for Update user avatar.
returns_details_single_new_hire Read

Returns details for a single New Hire Official SmartRecruiters endpoint: GET /new-hires/{newHireId} from smartonboard.json.

Lua path
app.integrations.smartrecruiters.returns_details_single_new_hire
Full name
smartrecruiters.smartrecruiters_smartonboard_new_hires_get
ParameterTypeRequiredDescription
new_hire_id string yes ID of the New Hire
returns_details_single_onboarding_process Read

Returns details of a single Onboarding Process Official SmartRecruiters endpoint: GET /onboarding-processes/{onboardingProcessId} from smartonboard.json.

Lua path
app.integrations.smartrecruiters.returns_details_single_onboarding_process
Full name
smartrecruiters.smartrecruiters_smartonboard_onboarding_processes_get
ParameterTypeRequiredDescription
onboarding_process_id string yes ID of the Onboarding Process
returns_answers_submitted_single_web_form_assignment Read

Returns answers submitted for a single Web Form Assignment Official SmartRecruiters endpoint: GET /web-form-assignments/{webFormAssignmentId}/form-answers from smartonboard.json.

Lua path
app.integrations.smartrecruiters.returns_answers_submitted_single_web_form_assignment
Full name
smartrecruiters.smartrecruiters_smartonboard_web_form_assignments_form_answers_get
ParameterTypeRequiredDescription
web_form_assignment_id string yes ID of the Web Form Assignment
returns_metadata_fields_that_belong_single_web_form_assignment Read

Returns metadata for the fields that belong to a single Web Form Assignment Official SmartRecruiters endpoint: GET /web-form-assignments/{webFormAssignmentId}/fields-metadata from smartonboard.json.

Lua path
app.integrations.smartrecruiters.returns_metadata_fields_that_belong_single_web_form_assignment
Full name
smartrecruiters.smartrecruiters_smartonboard_web_form_assignments_fields_metadata_get
ParameterTypeRequiredDescription
web_form_assignment_id string yes ID of the Web Form Assignment
returns_answers_submitted_single_fillable_pdf_form_assignment Read

Returns answers submitted for a single Fillable PDF Form Assignment Official SmartRecruiters endpoint: GET /fillable-pdf-form-assignments/{fillablePdfFormAssignmentId}/form-answers from smartonboard.json.

Lua path
app.integrations.smartrecruiters.returns_answers_submitted_single_fillable_pdf_form_assignment
Full name
smartrecruiters.smartrecruiters_smartonboard_fillable_pdf_form_assignments_form_answers_get
ParameterTypeRequiredDescription
fillable_pdf_form_assignment_id string yes ID of the Fillable PDF Form Assignment
returns_assignments_associated_with_single_onboarding_process Read

Returns Assignments associated with a single Onboarding Process Official SmartRecruiters endpoint: GET /onboarding-processes/{onboardingProcessId}/assignments from smartonboard.json.

Lua path
app.integrations.smartrecruiters.returns_assignments_associated_with_single_onboarding_process
Full name
smartrecruiters.smartrecruiters_smartonboard_onboarding_processes_assignments_get
ParameterTypeRequiredDescription
onboarding_process_id string yes ID of the Onboarding Process
integration_relevant boolean no Indicate if only assignments that have integration key defined should be fetched. By default set to false
returns_specific_assignment_associated_with_single_onboarding_process Read

Returns specific Assignment associated with a single Onboarding Process Official SmartRecruiters endpoint: GET /onboarding-processes/{onboardingProcessId}/assignments/{assignmentId} from smartonboard.json.

Lua path
app.integrations.smartrecruiters.returns_specific_assignment_associated_with_single_onboarding_process
Full name
smartrecruiters.smartrecruiters_smartonboard_onboarding_processes_assignment_get
ParameterTypeRequiredDescription
onboarding_process_id string yes ID of the Onboarding Process
assignment_id string yes ID of the Assignment
returns_list_attachments_submitted_single_activity_assignment Read

Returns list of Attachments submitted for a single Activity Assignment Official SmartRecruiters endpoint: GET /activity-assignments/{activityAssignmentId}/attachments from smartonboard.json.

Lua path
app.integrations.smartrecruiters.returns_list_attachments_submitted_single_activity_assignment
Full name
smartrecruiters.smartrecruiters_smartonboard_activity_assignments_attachments_get
ParameterTypeRequiredDescription
activity_assignment_id string yes ID of the Activity Assignment
returns_single_attachment_specific_activity_assignment Read

Returns single Attachment for specific Activity Assignment Official SmartRecruiters endpoint: GET /activity-assignments/{activityAssignmentId}/attachments/{attachmentId} from smartonboard.json.

Lua path
app.integrations.smartrecruiters.returns_single_attachment_specific_activity_assignment
Full name
smartrecruiters.smartrecruiters_smartonboard_activity_assignments_attachments_get_by_id
ParameterTypeRequiredDescription
activity_assignment_id string yes ID of the Activity Assignment
attachment_id string yes ID of the Attachment
list_users_your_company Read

List users of your company Official SmartRecruiters endpoint: GET /users from users-api.json.

Lua path
app.integrations.smartrecruiters.list_users_your_company
Full name
smartrecruiters.smartrecruiters_users_users_all
ParameterTypeRequiredDescription
q string no full-text search query based on firstName, lastName, email, externalData
limit integer no number of elements to return. max value is 100
page_id string no Unique identifier for the next page of users
updated_after string no ISO8601-formatted time boundaries for the user update time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ
create_new_user Read

Create a new user. Official SmartRecruiters endpoint: POST /users from users-api.json.

Lua path
app.integrations.smartrecruiters.create_new_user
Full name
smartrecruiters.smartrecruiters_users_users_create
ParameterTypeRequiredDescription
body object no User object to be created
get_details_my_user Read

Get details of my user Official SmartRecruiters endpoint: GET /users/me from users-api.json.

Lua path
app.integrations.smartrecruiters.get_details_my_user
Full name
smartrecruiters.smartrecruiters_users_users_me
ParameterTypeRequiredDescription
No parameters.
get_details_user_with_given_id Read

Get details of a user with given id Official SmartRecruiters endpoint: GET /users/{id} from users-api.json.

Lua path
app.integrations.smartrecruiters.get_details_user_with_given_id
Full name
smartrecruiters.smartrecruiters_users_users_get
ParameterTypeRequiredDescription
id string yes user identifier
update_user Read

Update a user Official SmartRecruiters endpoint: PATCH /users/{id} from users-api.json.

Lua path
app.integrations.smartrecruiters.update_user
Full name
smartrecruiters.smartrecruiters_users_users_update
ParameterTypeRequiredDescription
id string yes user identifier
body object no patch request (RFC 6902 - https://datatracker.ietf.org/doc/html/rfc6902)
send_password_reset_email_user Read

Send a password reset email to a user Official SmartRecruiters endpoint: POST /users/{id}/reset-password from users-api.json.

Lua path
app.integrations.smartrecruiters.send_password_reset_email_user
Full name
smartrecruiters.smartrecruiters_users_users_password_reset
ParameterTypeRequiredDescription
id string yes user identifier
send_activation_email_user Read

Send an activation email to a user Official SmartRecruiters endpoint: POST /users/{id}/activation-email from users-api.json.

Lua path
app.integrations.smartrecruiters.send_activation_email_user
Full name
smartrecruiters.smartrecruiters_users_users_activation_email_send
ParameterTypeRequiredDescription
id string yes user identifier
activate_user Read

Activate a user Official SmartRecruiters endpoint: PUT /users/{id}/activation from users-api.json.

Lua path
app.integrations.smartrecruiters.activate_user
Full name
smartrecruiters.smartrecruiters_users_users_activation_activate
ParameterTypeRequiredDescription
id string yes user identifier
deactivate_user Read

Deactivate a user Official SmartRecruiters endpoint: DELETE /users/{id}/activation from users-api.json.

Lua path
app.integrations.smartrecruiters.deactivate_user
Full name
smartrecruiters.smartrecruiters_users_users_activation_deactivate
ParameterTypeRequiredDescription
id string yes user identifier
update_user_avatar Read

Update user avatar Official SmartRecruiters endpoint: PUT /users/{id}/avatar from users-api.json.

Lua path
app.integrations.smartrecruiters.update_user_avatar
Full name
smartrecruiters.smartrecruiters_users_users_avatar_update
ParameterTypeRequiredDescription
id string yes user identifier
body object no Request body matching the official SmartRecruiters users-api.json schema for Update user avatar.
list_system_roles Read

List system roles Official SmartRecruiters endpoint: GET /system-roles from users-api.json.

Lua path
app.integrations.smartrecruiters.list_system_roles
Full name
smartrecruiters.smartrecruiters_users_system_roles_all
ParameterTypeRequiredDescription
No parameters.
list_access_groups_configured_your_company Read

List access groups configured in your company Official SmartRecruiters endpoint: GET /access-groups from users-api.json.

Lua path
app.integrations.smartrecruiters.list_access_groups_configured_your_company
Full name
smartrecruiters.smartrecruiters_users_access_groups_all
ParameterTypeRequiredDescription
No parameters.
remove_user_from_access_group Read

Remove user from access group Official SmartRecruiters endpoint: DELETE /access-groups/{accessGroupId}/users/{id} from users-api.json.

Lua path
app.integrations.smartrecruiters.remove_user_from_access_group
Full name
smartrecruiters.smartrecruiters_users_access_groups_users_remove
ParameterTypeRequiredDescription
access_group_id string yes access group identifier
id string yes user identifier
assign_users_access_group Read

Assign users to access group Official SmartRecruiters endpoint: POST /access-groups/{accessGroupId}/users from users-api.json.

Lua path
app.integrations.smartrecruiters.assign_users_access_group
Full name
smartrecruiters.smartrecruiters_users_access_groups_users_assign
ParameterTypeRequiredDescription
access_group_id string yes access group identifier
body object no Request body matching the official SmartRecruiters users-api.json schema for Assign users to access group.
subscribe_webhook Read

Subscribe to a webhook. Official SmartRecruiters endpoint: POST /subscriptions from webhooks.json.

Lua path
app.integrations.smartrecruiters.subscribe_webhook
Full name
smartrecruiters.smartrecruiters_webhooks_subscriptions_create
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters webhooks.json schema for Subscribe to a webhook..
retrieve_webhook_subscriptions Read

Retrieve webhook subscriptions. Official SmartRecruiters endpoint: GET /subscriptions from webhooks.json.

Lua path
app.integrations.smartrecruiters.retrieve_webhook_subscriptions
Full name
smartrecruiters.smartrecruiters_webhooks_subscriptions_get_all
ParameterTypeRequiredDescription
page_id string no identifier of the next page of subscriptions
limit integer no number of elements to return
retrieve_single_webhook_subscription Read

Retrieve single webhook subscription. Official SmartRecruiters endpoint: GET /subscriptions/{id} from webhooks.json.

Lua path
app.integrations.smartrecruiters.retrieve_single_webhook_subscription
Full name
smartrecruiters.smartrecruiters_webhooks_subscriptions_get
ParameterTypeRequiredDescription
id string yes subscription identifier
delete_webhook_subscription Read

Delete webhook subscription. Official SmartRecruiters endpoint: DELETE /subscriptions/{id} from webhooks.json.

Lua path
app.integrations.smartrecruiters.delete_webhook_subscription
Full name
smartrecruiters.smartrecruiters_webhooks_subscriptions_delete
ParameterTypeRequiredDescription
id string yes subscription identifier
activate_webhook_subscription Read

Activate webhook subscription. Official SmartRecruiters endpoint: PUT /subscriptions/{id}/activation from webhooks.json.

Lua path
app.integrations.smartrecruiters.activate_webhook_subscription
Full name
smartrecruiters.smartrecruiters_webhooks_subscriptions_activate
ParameterTypeRequiredDescription
id string yes subscription identifier
generate_secret_key_webhook_subscription Read

Generate a secret key for a webhook subscription. Official SmartRecruiters endpoint: POST /subscriptions/{id}/secret-key from webhooks.json.

Lua path
app.integrations.smartrecruiters.generate_secret_key_webhook_subscription
Full name
smartrecruiters.smartrecruiters_webhooks_subscriptions_generate_secret_key
ParameterTypeRequiredDescription
id string yes subscription identifier
retrieve_subscription_secret_key Read

Retrieve subscription secret key Official SmartRecruiters endpoint: GET /subscriptions/{id}/secret-key from webhooks.json.

Lua path
app.integrations.smartrecruiters.retrieve_subscription_secret_key
Full name
smartrecruiters.smartrecruiters_webhooks_subscriptions_get_secret_key
ParameterTypeRequiredDescription
id string yes subscription identifier
retrieve_callback_request_details_starting_from_newest Read

Retrieve callback request details starting from the newest. Official SmartRecruiters endpoint: GET /subscriptions/{id}/callbacks-log from webhooks.json.

Lua path
app.integrations.smartrecruiters.retrieve_callback_request_details_starting_from_newest
Full name
smartrecruiters.smartrecruiters_webhooks_subscriptions_search_callback_log
ParameterTypeRequiredDescription
id string yes subscription identifier
page_id string no identifier of the next page of subscriptions
limit integer no number of elements to return
callback_status string no status of callback, when absent all statuses will be returned
after string no Requests sent after the timestamp. The minimum value is 30 days ago. Format ISO8601: yyyy-MM-ddTHH:mm:ss.SSSZZ
before string no Requests sent before timestamp. The minimum value is 30 days ago. Format ISO8601: yyyy-MM-ddTHH:mm:ss.SSSZZ
get_partner_configuration Read

get partner configuration Official SmartRecruiters endpoint: GET /partner/configuration from assessment-partner-api.json.

Lua path
app.integrations.smartrecruiters.get_partner_configuration
Full name
smartrecruiters.smartrecruiters_assessment_partner_get_partner_config
ParameterTypeRequiredDescription
No parameters.
saves_configuration_partner Read

saves configuration for partner Official SmartRecruiters endpoint: PUT /partner/configuration from assessment-partner-api.json.

Lua path
app.integrations.smartrecruiters.saves_configuration_partner
Full name
smartrecruiters.smartrecruiters_assessment_partner_save_partner_config
ParameterTypeRequiredDescription
body object no Request body matching the official SmartRecruiters assessment-partner-api.json schema for saves configuration for partner.
enable_company_integration Read

enable the company integration Official SmartRecruiters endpoint: POST /integration/company/{companyId} from assessment-partner-api.json.

Lua path
app.integrations.smartrecruiters.enable_company_integration
Full name
smartrecruiters.smartrecruiters_assessment_partner_set_up_integration
ParameterTypeRequiredDescription
company_id string yes path parameter `companyId`.
body object no Request body matching the official SmartRecruiters assessment-partner-api.json schema for enable the company integration.
updates_package_result Read

updates package result Official SmartRecruiters endpoint: PATCH /orders/{orderId}/results from assessment-partner-api.json.

Lua path
app.integrations.smartrecruiters.updates_package_result
Full name
smartrecruiters.smartrecruiters_assessment_partner_package_result_update
ParameterTypeRequiredDescription
order_id string yes Order ID
body object no Request body matching the official SmartRecruiters assessment-partner-api.json schema for updates package result.
add_attachment_order Write

add attachment to order Official SmartRecruiters endpoint: POST /orders/{orderId}/results/attachment from assessment-partner-api.json.

Lua path
app.integrations.smartrecruiters.add_attachment_order
Full name
smartrecruiters.smartrecruiters_assessment_partner_add_attachment_to_order
ParameterTypeRequiredDescription
order_id string yes Order ID
body object no Request body matching the official SmartRecruiters assessment-partner-api.json schema for add attachment to order.
get_event_details Read

Get event's details Official SmartRecruiters endpoint: GET /events/{eventId} from event-management-api.json.

Lua path
app.integrations.smartrecruiters.get_event_details
Full name
smartrecruiters.smartrecruiters_event_management_get_event_details
ParameterTypeRequiredDescription
event_id string yes path parameter `eventId`.
update_event Write

Update event Official SmartRecruiters endpoint: PUT /events/{eventId} from event-management-api.json.

Lua path
app.integrations.smartrecruiters.update_event
Full name
smartrecruiters.smartrecruiters_event_management_update_event
ParameterTypeRequiredDescription
event_id string yes path parameter `eventId`.
body object yes Request body matching the official SmartRecruiters event-management-api.json schema for Update event.
delete_event Write

Delete event Official SmartRecruiters endpoint: DELETE /events/{eventId} from event-management-api.json.

Lua path
app.integrations.smartrecruiters.delete_event
Full name
smartrecruiters.smartrecruiters_event_management_delete_event
ParameterTypeRequiredDescription
event_id string yes path parameter `eventId`.
add_interviewers_event_session Write

Add interviewers to event's session Official SmartRecruiters endpoint: PUT /events/{eventId}/sessions/{sessionId}/interviewers from event-management-api.json.

Lua path
app.integrations.smartrecruiters.add_interviewers_event_session
Full name
smartrecruiters.smartrecruiters_event_management_add_interviewers_to_session
ParameterTypeRequiredDescription
event_id string yes path parameter `eventId`.
session_id string yes path parameter `sessionId`.
body object yes Request body matching the official SmartRecruiters event-management-api.json schema for Add interviewers to event's session.
remove_interviewers_from_event_session Write

Remove interviewers from event's session Official SmartRecruiters endpoint: DELETE /events/{eventId}/sessions/{sessionId}/interviewers from event-management-api.json.

Lua path
app.integrations.smartrecruiters.remove_interviewers_from_event_session
Full name
smartrecruiters.smartrecruiters_event_management_remove_interviewers_from_session
ParameterTypeRequiredDescription
event_id string yes path parameter `eventId`.
session_id string yes path parameter `sessionId`.
body object yes Request body matching the official SmartRecruiters event-management-api.json schema for Remove interviewers from event's session.
move_applicants_from_session_session Write

Move applicants from session to session Official SmartRecruiters endpoint: PUT /events/{eventId}/sessions/{sessionId}/applicants from event-management-api.json.

Lua path
app.integrations.smartrecruiters.move_applicants_from_session_session
Full name
smartrecruiters.smartrecruiters_event_management_move_applicants_to_session
ParameterTypeRequiredDescription
event_id string yes path parameter `eventId`.
session_id string yes path parameter `sessionId`.
body object yes Request body matching the official SmartRecruiters event-management-api.json schema for Move applicants from session to session.
add_applicants_from_event_pool_session Write

Add applicants from event pool to session Official SmartRecruiters endpoint: POST /events/{eventId}/sessions/{sessionId}/applicants from event-management-api.json.

Lua path
app.integrations.smartrecruiters.add_applicants_from_event_pool_session
Full name
smartrecruiters.smartrecruiters_event_management_add_applicants_to_session
ParameterTypeRequiredDescription
event_id string yes path parameter `eventId`.
session_id string yes path parameter `sessionId`.
body object yes Request body matching the official SmartRecruiters event-management-api.json schema for Add applicants from event pool to session.
get_job_events Read

Get job's events Official SmartRecruiters endpoint: GET /events from event-management-api.json.

Lua path
app.integrations.smartrecruiters.get_job_events
Full name
smartrecruiters.smartrecruiters_event_management_get_events
ParameterTypeRequiredDescription
job_id string yes Job ID
state string yes Event state
page integer no Page number beginning from 0
page_size integer no Page size default is 10
create_event Write

Create event Official SmartRecruiters endpoint: POST /events from event-management-api.json.

Lua path
app.integrations.smartrecruiters.create_event
Full name
smartrecruiters.smartrecruiters_event_management_create_event
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters event-management-api.json schema for Create event.
get_all_applicants_both_event_applicants_pool_and_session_applicants_specified_event Read

Get all applicants (both event-applicants-pool and session-applicants) for specified event Official SmartRecruiters endpoint: GET /events/{eventId}/applicants from event-management-api.json.

Lua path
app.integrations.smartrecruiters.get_all_applicants_both_event_applicants_pool_and_session_applicants_specified_event
Full name
smartrecruiters.smartrecruiters_event_management_get_all_applicants
ParameterTypeRequiredDescription
event_id string yes path parameter `eventId`.
add_applicants_event_pool Write

Add applicants to event pool Official SmartRecruiters endpoint: POST /events/{eventId}/applicants from event-management-api.json.

Lua path
app.integrations.smartrecruiters.add_applicants_event_pool
Full name
smartrecruiters.smartrecruiters_event_management_add_applicants_to_event
ParameterTypeRequiredDescription
event_id string yes path parameter `eventId`.
body object yes Request body matching the official SmartRecruiters event-management-api.json schema for Add applicants to event pool.
get_event_session_details Read

Get event's session details Official SmartRecruiters endpoint: GET /events/{eventId}/sessions/{sessionId} from event-management-api.json.

Lua path
app.integrations.smartrecruiters.get_event_session_details
Full name
smartrecruiters.smartrecruiters_event_management_get_session_details
ParameterTypeRequiredDescription
event_id string yes path parameter `eventId`.
session_id string yes path parameter `sessionId`.
delete_event_session Write

Delete event's session Official SmartRecruiters endpoint: DELETE /events/{eventId}/sessions/{sessionId} from event-management-api.json.

Lua path
app.integrations.smartrecruiters.delete_event_session
Full name
smartrecruiters.smartrecruiters_event_management_delete_session
ParameterTypeRequiredDescription
event_id string yes path parameter `eventId`.
session_id string yes path parameter `sessionId`.
get_event_applicants Read

Get event's applicants Official SmartRecruiters endpoint: GET /events/{eventId}/pool-applicants from event-management-api.json.

Lua path
app.integrations.smartrecruiters.get_event_applicants
Full name
smartrecruiters.smartrecruiters_event_management_get_applicants_by_event_id
ParameterTypeRequiredDescription
event_id string yes path parameter `eventId`.
page integer no query parameter `page`.
page_size integer no query parameter `pageSize`.
get_candidate_events Read

Get candidate events Official SmartRecruiters endpoint: GET /events/candidates/{profileId} from event-management-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_events
Full name
smartrecruiters.smartrecruiters_event_management_get_events_for_candidate
ParameterTypeRequiredDescription
profile_id string yes Candidate profile ID
state string yes Event state
get_application_events Read

Get application events Official SmartRecruiters endpoint: GET /events/applications/{applicationId} from event-management-api.json.

Lua path
app.integrations.smartrecruiters.get_application_events
Full name
smartrecruiters.smartrecruiters_event_management_get_events_for_application
ParameterTypeRequiredDescription
application_id string yes Application ID
state string yes Event state
removes_integration_partner_side Write

Removes integration on partner side Official SmartRecruiters endpoint: DELETE /integrations/companies/{companyId} from assessment-partner-app.json.

Lua path
app.integrations.smartrecruiters.removes_integration_partner_side
Full name
smartrecruiters.smartrecruiters_assessment_partner_app_delete_integration
ParameterTypeRequiredDescription
company_id string yes id of company with integration
retrieves_list_packages Read

Retrieves a list of packages Official SmartRecruiters endpoint: GET /packages from assessment-partner-app.json.

Lua path
app.integrations.smartrecruiters.retrieves_list_packages
Full name
smartrecruiters.smartrecruiters_assessment_partner_app_list_packages
ParameterTypeRequiredDescription
requester object no Information about recruiter requesting list of packages
country_code string no country code
region_abbr string no region abbreviation
city string no city
address string no address
postal_code string no postal code
remote boolean no describe whether job is remote or not
partner_field_id string no Example partner field. Partner defines list of allowed fields in configuration. Client binds job fields in his configuration. All fields with non-empty values will be included in this call.
retrieves_package_by_id Read

Retrieves a package by id Official SmartRecruiters endpoint: GET /packages/{assessmentPackageId} from assessment-partner-app.json.

Lua path
app.integrations.smartrecruiters.retrieves_package_by_id
Full name
smartrecruiters.smartrecruiters_assessment_partner_app_get_package_by_id
ParameterTypeRequiredDescription
assessment_package_id string yes path parameter `assessmentPackageId`.
orders_assessment_package_candidate Read

Orders assessment package for candidate Official SmartRecruiters endpoint: POST /packages/orders from assessment-partner-app.json.

Lua path
app.integrations.smartrecruiters.orders_assessment_package_candidate
Full name
smartrecruiters.smartrecruiters_assessment_partner_app_orders_assessment_package
ParameterTypeRequiredDescription
body object no Request body matching the official SmartRecruiters assessment-partner-app.json schema for Orders assessment package for candidate.
orders_inline_assessment_package_candidate Read

Orders inline assessment package for candidate Official SmartRecruiters endpoint: POST /packages/inline/orders from assessment-partner-app.json.

Lua path
app.integrations.smartrecruiters.orders_inline_assessment_package_candidate
Full name
smartrecruiters.smartrecruiters_assessment_partner_app_orders_inline_assessment_package
ParameterTypeRequiredDescription
body object no Request body matching the official SmartRecruiters assessment-partner-app.json schema for Orders inline assessment package for candidate.
exchange_credentials_access_token Read

Exchange credentials for an access token Official SmartRecruiters endpoint: POST /oauth/token from assessment-partner-app.json.

Lua path
app.integrations.smartrecruiters.exchange_credentials_access_token
Full name
smartrecruiters.smartrecruiters_assessment_partner_app_get_token
ParameterTypeRequiredDescription
body object no Request body matching the official SmartRecruiters assessment-partner-app.json schema for Exchange credentials for an access token.
enables_integration Write

Enables integration Official SmartRecruiters endpoint: POST /partner-api/integrations from apps-integrations.json.

Lua path
app.integrations.smartrecruiters.enables_integration
Full name
smartrecruiters.smartrecruiters_apps_integrations_enable_integration
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters apps-integrations.json schema for Enables integration.
get_candidate_status Read

Get candidate status Official SmartRecruiters endpoint: GET /status/{applicationUuid} from candidate-status-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_status
Full name
smartrecruiters.smartrecruiters_candidate_status_get_status
ParameterTypeRequiredDescription
application_uuid string yes path parameter `applicationUuid`.
get_posting_by_id Read

Get posting by id Official SmartRecruiters endpoint: GET /publications/{postingId} from feed-api.json.

Lua path
app.integrations.smartrecruiters.get_posting_by_id
Full name
smartrecruiters.smartrecruiters_feed_find_posting_using_json
ParameterTypeRequiredDescription
posting_id integer yes Posting id to find
update_posting_information Write

Update posting information Official SmartRecruiters endpoint: PUT /publications/{postingId} from feed-api.json.

Lua path
app.integrations.smartrecruiters.update_posting_information
Full name
smartrecruiters.smartrecruiters_feed_update_posting_using_json
ParameterTypeRequiredDescription
posting_id integer yes A single posting id. Allows updating information only for the defined postings.
body object yes Request body matching the official SmartRecruiters feed-api.json schema for Update posting information.
get_list_postings Read

Get a list of postings Official SmartRecruiters endpoint: GET /publications from feed-api.json.

Lua path
app.integrations.smartrecruiters.get_list_postings
Full name
smartrecruiters.smartrecruiters_feed_postings_json_stream
ParameterTypeRequiredDescription
updated_after string no List postings created after the specified date.Date should be in ISO 8601 format: (e.g.: '2015-07-27T08:43:33.000Z').If no value is provided, only postings created in the last 30 days will be returned.
status array no List of posting statuses separated by comma.Status definition:Pending - this is a new posting that is pending publication on your job board. You should always retrieve these postings, publish them, and then update the status via the PUT method.UnderPosting - this is a status that is only set by you. It indicates that a posting is currently being published but is not yet available on the job board. SmartRecruiters will never set this status ourselves.Active - this is a status that is only set by you. It indicates that the posting has been successfully published and is available on the job board. SmartRecruiters will never set this status ourselves.toUnpost - this posting has either expired or has manually been requested for removal by the client. As a job board, you should unpost these postings immediately, and then update the status to Inactive via the PUT method.Inactive - this is a status that is only set by you. It indicates that the posting has been successfully unpublished and is no longer available on the job board. SmartRecruiters will never set this status ourselves.Error - this is a status only set by you. It indicates that the posting could not be published. SmartRecruiters will never set this status ourselves.Example: status=Active,Error
offset string no Number of elements to skip while processing result.Allowed range: [0, 2^31-1].
limit string no Maximum number of postings returned.Allowed range: [0, 100].
get_interview_template_by_id Read

Get interview template by id. Official SmartRecruiters endpoint: GET /templates/{id} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.get_interview_template_by_id
Full name
smartrecruiters.smartrecruiters_interview_templates_get_template_by_id
ParameterTypeRequiredDescription
id string yes path parameter `id`.
update_interview_template Write

Update interview template. Official SmartRecruiters endpoint: PUT /templates/{id} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.update_interview_template
Full name
smartrecruiters.smartrecruiters_interview_templates_update_template
ParameterTypeRequiredDescription
id string yes path parameter `id`.
body object yes Request body matching the official SmartRecruiters interview-templates.json schema for Update interview template..
removes_interview_template Write

Removes interview template. Official SmartRecruiters endpoint: DELETE /templates/{id} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.removes_interview_template
Full name
smartrecruiters.smartrecruiters_interview_templates_delete_template
ParameterTypeRequiredDescription
id string yes path parameter `id`.
get_managed_hiring_process_steps_job Read

Get managed hiring process steps for the job. Official SmartRecruiters endpoint: GET /managed-steps/jobs/{jobId} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.get_managed_hiring_process_steps_job
Full name
smartrecruiters.smartrecruiters_interview_templates_get_job_managed_steps
ParameterTypeRequiredDescription
job_id string yes The job id
update_managed_steps_job Write

Update managed steps for the job. Official SmartRecruiters endpoint: PUT /managed-steps/jobs/{jobId} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.update_managed_steps_job
Full name
smartrecruiters.smartrecruiters_interview_templates_update_job_managed_steps
ParameterTypeRequiredDescription
job_id string yes The job id
body object yes Request body matching the official SmartRecruiters interview-templates.json schema for Update managed steps for the job..
update_job_level_interview_template Write

Update job level interview template. Official SmartRecruiters endpoint: PUT /job-templates/{jobInterviewTemplateId} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.update_job_level_interview_template
Full name
smartrecruiters.smartrecruiters_interview_templates_update_job_template
ParameterTypeRequiredDescription
job_interview_template_id string yes The job level interview templates id
body object yes Request body matching the official SmartRecruiters interview-templates.json schema for Update job level interview template..
patches_job_level_interview_template_interviewers_pool Read

Patches job level interview template's interviewers pool. Official SmartRecruiters endpoint: PATCH /job-templates/{jobInterviewTemplateId} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.patches_job_level_interview_template_interviewers_pool
Full name
smartrecruiters.smartrecruiters_interview_templates_patch_job_template_interviewers
ParameterTypeRequiredDescription
job_interview_template_id string yes job level interview template id
body object yes Request body matching the official SmartRecruiters interview-templates.json schema for Patches job level interview template's interviewers pool..
finds_job_level_interview_templates_job_id_hiring_step_and_hiring_stage Read

Finds job level interview templates for job id, hiring step and hiring stage. Official SmartRecruiters endpoint: GET /job-templates/jobs/{jobId}/hiringStages/{hiringStage} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.finds_job_level_interview_templates_job_id_hiring_step_and_hiring_stage
Full name
smartrecruiters.smartrecruiters_interview_templates_find_job_template_by_hiring_state
ParameterTypeRequiredDescription
job_id string yes Job id
hiring_stage string yes Hiring stage
hiring_step string yes Hiring step
save_replace_job_level_interview_templates_job_id_hiring_step_and_hiring_stage Read

Save / replace job level interview templates for job id, hiring step and hiring stage. Official SmartRecruiters endpoint: PUT /job-templates/jobs/{jobId}/hiringStages/{hiringStage} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.save_replace_job_level_interview_templates_job_id_hiring_step_and_hiring_stage
Full name
smartrecruiters.smartrecruiters_interview_templates_upsert_job_template
ParameterTypeRequiredDescription
job_id string yes Job id
hiring_stage string yes Hiring stage
hiring_step string yes Hiring step
body object yes Request body matching the official SmartRecruiters interview-templates.json schema for Save / replace job level interview templates for job id, hiring step and hiring stage..
get_interview_template_by_id Read

Get interview template by id. Official SmartRecruiters endpoint: GET /interview/templates/{id} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.get_interview_template_by_id
Full name
smartrecruiters.smartrecruiters_interview_templates_get_interview_template_by_id
ParameterTypeRequiredDescription
id string yes The interview template id.
update_interview_template_by_id Write

Update interview template by id. Official SmartRecruiters endpoint: PUT /interview/templates/{id} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.update_interview_template_by_id
Full name
smartrecruiters.smartrecruiters_interview_templates_update_interview_template
ParameterTypeRequiredDescription
id string yes The interview template id.
body object yes Request body matching the official SmartRecruiters interview-templates.json schema for Update interview template by id..
remove_interview_template_by_id Write

Remove interview template by id. Official SmartRecruiters endpoint: DELETE /interview/templates/{id} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.remove_interview_template_by_id
Full name
smartrecruiters.smartrecruiters_interview_templates_delete_interview_template
ParameterTypeRequiredDescription
id string yes The interview template id.
update_job_interview_template Write

Update job interview template. Official SmartRecruiters endpoint: PUT /interview/templates/job/{jobInterviewTemplateId} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.update_job_interview_template
Full name
smartrecruiters.smartrecruiters_interview_templates_update_job_interview_template
ParameterTypeRequiredDescription
job_interview_template_id string yes The job interview template id
body object yes Request body matching the official SmartRecruiters interview-templates.json schema for Update job interview template..
update_interviewers_selection_job_interview_template Write

Update interviewers selection for job interview template. Official SmartRecruiters endpoint: PATCH /interview/templates/job/{jobInterviewTemplateId} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.update_interviewers_selection_job_interview_template
Full name
smartrecruiters.smartrecruiters_interview_templates_update_job_interview_template_interviewers
ParameterTypeRequiredDescription
job_interview_template_id string yes The job interview template id
body object yes Request body matching the official SmartRecruiters interview-templates.json schema for Update interviewers selection for job interview template..
get_interview_templates_current_company Read

Get interview templates for the current company. Official SmartRecruiters endpoint: GET /templates from interview-templates.json.

Lua path
app.integrations.smartrecruiters.get_interview_templates_current_company
Full name
smartrecruiters.smartrecruiters_interview_templates_get_templates
ParameterTypeRequiredDescription
page integer no Page number beginning from 0
page_size integer no Page size default is 20
hiring_stage string no Hiring stage (if used both Hiring stage and Hiring step must be used)
hiring_step string no Hiring step (if used both Hiring stage and Hiring step must be used)
type string no Type of the template (if not passed in then will return all types)
search string no query parameter `search`.
create_interview_template Write

Create a interview template. Official SmartRecruiters endpoint: POST /templates from interview-templates.json.

Lua path
app.integrations.smartrecruiters.create_interview_template
Full name
smartrecruiters.smartrecruiters_interview_templates_create_template
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters interview-templates.json schema for Create a interview template..
finds_job_level_interview_templates_by_job_application_ids Read

Finds job level interview templates by job application IDs Official SmartRecruiters endpoint: POST /job-templates/jobs/{jobId}/search from interview-templates.json.

Lua path
app.integrations.smartrecruiters.finds_job_level_interview_templates_by_job_application_ids
Full name
smartrecruiters.smartrecruiters_interview_templates_search_job_template_by_job_application_ids
ParameterTypeRequiredDescription
job_id string yes Job id
body object yes Request body matching the official SmartRecruiters interview-templates.json schema for Finds job level interview templates by job application IDs.
search_all_interview_templates Read

Search for all interview templates. Official SmartRecruiters endpoint: GET /interview/templates from interview-templates.json.

Lua path
app.integrations.smartrecruiters.search_all_interview_templates
Full name
smartrecruiters.smartrecruiters_interview_templates_search_interview_templates
ParameterTypeRequiredDescription
page integer no The page number to retrieve.
limit integer no The number of items per page.
search string no The search query to filter the results. By default all items are returned.
create_interview_template Write

Create interview template. Official SmartRecruiters endpoint: POST /interview/templates from interview-templates.json.

Lua path
app.integrations.smartrecruiters.create_interview_template
Full name
smartrecruiters.smartrecruiters_interview_templates_create_interview_template
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters interview-templates.json schema for Create interview template..
find_schedule_preferences Read

Find schedule preferences Official SmartRecruiters endpoint: GET /schedule/preferences/users/{userId} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.find_schedule_preferences
Full name
smartrecruiters.smartrecruiters_interview_templates_get_schedule_preferences
ParameterTypeRequiredDescription
user_id string yes Identifier of the user for which schedule preferences should be found
finds_job_level_interview_templates_job Read

Finds job level interview templates for a job Official SmartRecruiters endpoint: GET /job-templates/jobs/{jobId} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.finds_job_level_interview_templates_job
Full name
smartrecruiters.smartrecruiters_interview_templates_find_job_templates_by_job_id
ParameterTypeRequiredDescription
job_id string yes Job id
finds_job_level_interview_templates_by_job_application_id Read

Finds job level interview templates by job application id Official SmartRecruiters endpoint: GET /job-templates/job-applications/{applicationId} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.finds_job_level_interview_templates_by_job_application_id
Full name
smartrecruiters.smartrecruiters_interview_templates_find_job_template_by_application_id
ParameterTypeRequiredDescription
application_id string yes application id
find_interview_templates_job Read

Find interview templates for the job Official SmartRecruiters endpoint: GET /interview/templates/jobs/{jobId} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.find_interview_templates_job
Full name
smartrecruiters.smartrecruiters_interview_templates_get_job_interview_templates
ParameterTypeRequiredDescription
job_id string yes The job id
find_interview_templates_job_application_id Read

Find interview templates for job application id. Official SmartRecruiters endpoint: GET /interview/templates/job-applications/{applicationId} from interview-templates.json.

Lua path
app.integrations.smartrecruiters.find_interview_templates_job_application_id
Full name
smartrecruiters.smartrecruiters_interview_templates_get_job_application_interview_templates
ParameterTypeRequiredDescription
application_id string yes The job application id
get_candidate_offers Read

Get candidate's offers Official SmartRecruiters endpoint: GET /candidates/{id}/jobs/{jobId}/offers from offers-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_offers
Full name
smartrecruiters.smartrecruiters_offers_candidates_offers_all
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
get_candidate_offer Read

Get candidate's offer Official SmartRecruiters endpoint: GET /candidates/{id}/jobs/{jobId}/offers/{offerId} from offers-api.json.

Lua path
app.integrations.smartrecruiters.get_candidate_offer
Full name
smartrecruiters.smartrecruiters_offers_candidates_offers_get
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
offer_id string yes Identifier of a Offer
get_latest_approval_request_candidate_offer Read

Get latest approval request for candidate's offer Official SmartRecruiters endpoint: GET /candidates/{id}/jobs/{jobId}/offers/{offerId}/approvals/latest from offers-api.json.

Lua path
app.integrations.smartrecruiters.get_latest_approval_request_candidate_offer
Full name
smartrecruiters.smartrecruiters_offers_candidates_offers_approvals_latest
ParameterTypeRequiredDescription
id string yes candidate identifier
job_id string yes job identifier
offer_id string yes Identifier of a Offer
search_offers Read

Search offers Official SmartRecruiters endpoint: GET /offers from offers-api.json.

Lua path
app.integrations.smartrecruiters.search_offers
Full name
smartrecruiters.smartrecruiters_offers_candidates_offers_find
ParameterTypeRequiredDescription
limit integer no number of elements to return. max value is 100
offset integer no number of elements to skip while processing result
created_after string no ISO8601-formatted time boundaries for the offer creation time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ
created_before string no ISO8601-formatted time boundaries for the offer creation time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ
age string no word-based offer age; when age is specified createdAfter and createdBefore are ignored, Examples: 10 days, 7 hours, 1 week, etc.
status array no offer states that need to be included in the results; by default all states are included
get_given_document_given_sent_offer Read

Get a given document in a given sent offer Official SmartRecruiters endpoint: GET /offers/{offerId}/documents/{documentId} from offers-api.json.

Lua path
app.integrations.smartrecruiters.get_given_document_given_sent_offer
Full name
smartrecruiters.smartrecruiters_offers_offers_documents_get_document
ParameterTypeRequiredDescription
offer_id string yes Identifier of an offer.
document_id string yes Identifier of a document.
fetch_list_vendor_configs Read

Fetch list of vendor configs Official SmartRecruiters endpoint: GET /configs from partners-public-api.json.

Lua path
app.integrations.smartrecruiters.fetch_list_vendor_configs
Full name
smartrecruiters.smartrecruiters_partners_public_get_configs
ParameterTypeRequiredDescription
No parameters.
add_new_config Write

Add new config Official SmartRecruiters endpoint: POST /configs from partners-public-api.json.

Lua path
app.integrations.smartrecruiters.add_new_config
Full name
smartrecruiters.smartrecruiters_partners_public_add_config
ParameterTypeRequiredDescription
body object yes Config object that needs to contain Id and Value set. Please see the Model Schema on the right.
get_config_vendor Read

Get config for vendor Official SmartRecruiters endpoint: GET /configs/{configId} from partners-public-api.json.

Lua path
app.integrations.smartrecruiters.get_config_vendor
Full name
smartrecruiters.smartrecruiters_partners_public_get_config
ParameterTypeRequiredDescription
config_id string yes unique id of a config entry
update_config Write

Update config Official SmartRecruiters endpoint: POST /configs/{configId} from partners-public-api.json.

Lua path
app.integrations.smartrecruiters.update_config
Full name
smartrecruiters.smartrecruiters_partners_public_update_config
ParameterTypeRequiredDescription
config_id string yes unique id of a config entry
body object yes Config object that needs to contain Id and Value set. Please see the Model Schema on the right.
search_offers_by_criteria Read

Search offers by criteria Official SmartRecruiters endpoint: GET /offers from partners-public-api.json.

Lua path
app.integrations.smartrecruiters.search_offers_by_criteria
Full name
smartrecruiters.smartrecruiters_partners_public_search_offers
ParameterTypeRequiredDescription
limit integer no number of offers to return. max number of offers returned by single call is 100
offset integer no number of offers to skip while processing result
status string no offer status; available values are: INACTIVE, UNDER_REVIEW, ACTIVE, REJECTED
q string no full text query. will match offers with name and description matching query string
posting_id string no id of a job posting; allows getting offer information using Posting Id coming from Job Board API; not relevant for Assessment vendors
lists_active_postings_published_by_given_company Read

Lists active postings published by given company Official SmartRecruiters endpoint: GET /v1/companies/{companyIdentifier}/postings from posting-api.json.

Lua path
app.integrations.smartrecruiters.lists_active_postings_published_by_given_company
Full name
smartrecruiters.smartrecruiters_posting_v1_list_postings
ParameterTypeRequiredDescription
accept_language string no Language of translation
company_identifier string yes Identifier of a company
q string no full-text search query based on a job title, location
limit integer no number of elements to return. max value is 100
offset integer no number of elements to skip while processing result
destination string no Filter indicating which postings to return: * **PUBLIC**: response will include ONLY public postings * **INTERNAL**: response will include ONLY internal postings * **INTERNAL_OR_PUBLIC**: response will include internal postings or public postings, but not both for a single job. If a job has both types of postings, only internal postings will be returned. NOTE: when selected, all postings, internal and public, will be treated as internal. Among other things, this means that screening questions will not be displayed, and candidates will be marked with the EMPLOYEE label.
location_type array no Filter indicating which postings to return: * **REMOTE**: response will include ONLY postings with remote location type * **HYBRID**: response will include ONLY postings with hybrid location type * **ONSITE**: response will include ONLY postings with onsite location type * **ANY**: response will include ANY location type
country string no country code filter (part of the location object)
region string no region filter (part of the location object)
city string no city filter (part of the location object)
department string no department filter (department id)
job_ad_id string no job ad id filter
language array no Job ad language; accepts 2-letter ISO 639-1 language code; multiple codes can be provided, separated by comma (",") Exceptions to the language code ISO format: * "en-GB" - "English - English (UK)" * "fr-CA" - "French - franais (Canada)" * "pt-BR" - "Portugal - portugus (Brasil)" * "pt-PT" - "Portugal - portugus (Portugal)" * "zh-TW" - "Chinese (Traditional) - ()" * "zh-CN" - "Chinese (Simplified) - ()"
released_after string no Released after filter (ISO8601-formatted) Format: yyyy-MM-ddTHH:mm:ss.SSSZZ
custom_field object no Filters postings by custom fields. Multiple custom field values can be provided, separated by comma (","). Format: custom_field.CUSTOM_FIELD_ID=CUSTOM_FIELD_VALUE1_ID,CUSTOM_FIELD_VALUE2_ID
get_posting_by_posting_id_or_uuid_given_company Read

Get posting by posting id or uuid for given company Official SmartRecruiters endpoint: GET /v1/companies/{companyIdentifier}/postings/{postingId} from posting-api.json.

Lua path
app.integrations.smartrecruiters.get_posting_by_posting_id_or_uuid_given_company
Full name
smartrecruiters.smartrecruiters_posting_v1_get_posting
ParameterTypeRequiredDescription
accept_language string no Language of translation
company_identifier string yes Identifier of a company
posting_id string yes Posting identifier or uuid
source_type_id string no sourceTypeId can be retrieved using endpoint. Used together with **sourceId** and **sourceSubTypeId** to add source tracking parameter to **applyUrl**.
source_sub_type_id string no sourceSubTypeId can be retrieved using endpoint. Used together with **sourceId** and **sourceTypeId** to add source tracking parameter to **applyUrl**.
source_id string no sourceId can be retrieved using endpoint. Used together with **sourceTypeId** and **sourceSubTypeId** to add source tracking parameter to **applyUrl**.
list_departments_given_company Read

List departments for given company Official SmartRecruiters endpoint: GET /v1/companies/{companyIdentifier}/departments from posting-api.json.

Lua path
app.integrations.smartrecruiters.list_departments_given_company
Full name
smartrecruiters.smartrecruiters_posting_v1_list_departments
ParameterTypeRequiredDescription
accept_language string no Language of translation
company_identifier string yes Identifier of a company
returns_self_scheduled_interview Read

Returns self-scheduled interview Official SmartRecruiters endpoint: GET /self-schedules/{id}/application/{applicationUuid}/interview from self-scheduling.json.

Lua path
app.integrations.smartrecruiters.returns_self_scheduled_interview
Full name
smartrecruiters.smartrecruiters_self_scheduling_get_self_scheduled_interview
ParameterTypeRequiredDescription
id string yes path parameter `id`.
application_uuid string yes path parameter `applicationUuid`.
update_self_schedule_interview Write

Update a self schedule interview Official SmartRecruiters endpoint: PUT /self-schedules/{id}/application/{applicationUuid}/interview from self-scheduling.json.

Lua path
app.integrations.smartrecruiters.update_self_schedule_interview
Full name
smartrecruiters.smartrecruiters_self_scheduling_update_self_schedule_interview
ParameterTypeRequiredDescription
id string yes path parameter `id`.
application_uuid string yes path parameter `applicationUuid`.
body object yes Request body matching the official SmartRecruiters self-scheduling.json schema for Update a self schedule interview.
create_self_schedule_interview Write

Create a self schedule interview Official SmartRecruiters endpoint: POST /self-schedules/{id}/application/{applicationUuid}/interview from self-scheduling.json.

Lua path
app.integrations.smartrecruiters.create_self_schedule_interview
Full name
smartrecruiters.smartrecruiters_self_scheduling_create_self_schedule_interview
ParameterTypeRequiredDescription
id string yes path parameter `id`.
application_uuid string yes path parameter `applicationUuid`.
body object yes Request body matching the official SmartRecruiters self-scheduling.json schema for Create a self schedule interview.
creates_automated_self_schedule Read

Creates automated self schedule. Official SmartRecruiters endpoint: POST /automated-self-schedules from self-scheduling.json.

Lua path
app.integrations.smartrecruiters.creates_automated_self_schedule
Full name
smartrecruiters.smartrecruiters_self_scheduling_automated_self_scheduling
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters self-scheduling.json schema for Creates automated self schedule..
returns_automated_schedule_available_slots_count_based_interviewers_availability_and_specified_date_params Read

Returns the automated schedule available slots count based on interviewers availability and specified date params. Official SmartRecruiters endpoint: POST /automated-self-schedules/{scheduleType}/application/{applicationUuid}/slots/count/by-role from self-scheduling.json.

Lua path
app.integrations.smartrecruiters.returns_automated_schedule_available_slots_count_based_interviewers_availability_and_specified_date_params
Full name
smartrecruiters.smartrecruiters_self_scheduling_get_automated_schedules_available_slots_count_by_interviewer_with_roles
ParameterTypeRequiredDescription
schedule_type string yes path parameter `scheduleType`.
application_uuid string yes path parameter `applicationUuid`.
body object yes Request body matching the official SmartRecruiters self-scheduling.json schema for Returns the automated schedule available slots count based on interviewers availability and specified date params..
requests_invite_update_automated_self_schedule Write

Requests invite update for automated self-schedule Official SmartRecruiters endpoint: POST /automated-self-schedules/update-invite from self-scheduling.json.

Lua path
app.integrations.smartrecruiters.requests_invite_update_automated_self_schedule
Full name
smartrecruiters.smartrecruiters_self_scheduling_update_self_schedule_invite
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters self-scheduling.json schema for Requests invite update for automated self-schedule.
requests_self_reschedule_candidate_automated_self_schedule Read

Requests self reschedule for candidate for automated self-schedule. Official SmartRecruiters endpoint: POST /automated-self-schedules/reschedule from self-scheduling.json.

Lua path
app.integrations.smartrecruiters.requests_self_reschedule_candidate_automated_self_schedule
Full name
smartrecruiters.smartrecruiters_self_scheduling_request_self_reschedule
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters self-scheduling.json schema for Requests self reschedule for candidate for automated self-schedule..
search_self_scheduling_instances Read

Search for a self-scheduling instances Official SmartRecruiters endpoint: GET /self-schedules from self-scheduling.json.

Lua path
app.integrations.smartrecruiters.search_self_scheduling_instances
Full name
smartrecruiters.smartrecruiters_self_scheduling_search_self_schedules
ParameterTypeRequiredDescription
with_interviews boolean no If set - filters out self schedules with interviews created/not created
application_id string yes query parameter `applicationId`.
limit integer no query parameter `limit`.
offset integer no query parameter `offset`.
gets_self_schedule_by_id Read

Gets self schedule by id Official SmartRecruiters endpoint: GET /self-schedules/{id} from self-scheduling.json.

Lua path
app.integrations.smartrecruiters.gets_self_schedule_by_id
Full name
smartrecruiters.smartrecruiters_self_scheduling_get_self_schedule
ParameterTypeRequiredDescription
id string yes path parameter `id`.
cancels_self_schedule Write

Cancels self schedule Official SmartRecruiters endpoint: DELETE /self-schedules/{id} from self-scheduling.json.

Lua path
app.integrations.smartrecruiters.cancels_self_schedule
Full name
smartrecruiters.smartrecruiters_self_scheduling_cancel_self_schedule
ParameterTypeRequiredDescription
id string yes path parameter `id`.
get_self_schedule_slots_application Read

Get self-schedule slots for application Official SmartRecruiters endpoint: GET /self-schedules/{id}/application/{applicationUuid}/slots from self-scheduling.json.

Lua path
app.integrations.smartrecruiters.get_self_schedule_slots_application
Full name
smartrecruiters.smartrecruiters_self_scheduling_available_slots_for_application
ParameterTypeRequiredDescription
id string yes path parameter `id`.
application_uuid string yes path parameter `applicationUuid`.
shorten_url Read

Shorten URL Official SmartRecruiters endpoint: POST /shorten from url-shortener.json.

Lua path
app.integrations.smartrecruiters.shorten_url
Full name
smartrecruiters.smartrecruiters_url_shortener_public_shorten
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters url-shortener.json schema for Shorten URL.
get_list_employee_notifications_preferences_specific_channel Read

Get list of employee notifications preferences for a specific channel. Official SmartRecruiters endpoint: GET /employee-preferences from notifications-api.json.

Lua path
app.integrations.smartrecruiters.get_list_employee_notifications_preferences_specific_channel
Full name
smartrecruiters.smartrecruiters_notifications_get_employee_preferences
ParameterTypeRequiredDescription
channel string yes query parameter `channel`.
save_employee_notifications_preferences Read

Save employee notifications preferences. Official SmartRecruiters endpoint: POST /employee-preferences from notifications-api.json.

Lua path
app.integrations.smartrecruiters.save_employee_notifications_preferences
Full name
smartrecruiters.smartrecruiters_notifications_save_employee_preferences
ParameterTypeRequiredDescription
channel string yes query parameter `channel`.
body object yes Request body matching the official SmartRecruiters notifications-api.json schema for Save employee notifications preferences..
activate_or_deactivate_employee_notification_preferences_hiring_roles_and_notification_channels_bulk Read

Activate or deactivate employee notification preferences for hiring roles and notification channels in bulk. Official SmartRecruiters endpoint: PATCH /employee-preferences from notifications-api.json.

Lua path
app.integrations.smartrecruiters.activate_or_deactivate_employee_notification_preferences_hiring_roles_and_notification_channels_bulk
Full name
smartrecruiters.smartrecruiters_notifications_upsert_employee_preferences
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters notifications-api.json schema for Activate or deactivate employee notification preferences for hiring roles and notification channels in bulk..
find_global_notification_preferences Read

Find global notification preferences. Official SmartRecruiters endpoint: GET /global-preferences from notifications-api.json.

Lua path
app.integrations.smartrecruiters.find_global_notification_preferences
Full name
smartrecruiters.smartrecruiters_notifications_find_global_preferences
ParameterTypeRequiredDescription
No parameters.
activate_or_deactivate_global_notification_preferences_hiring_roles_and_notification_channels_bulk Read

Activate or deactivate global notification preferences for hiring roles and notification channels in bulk. Official SmartRecruiters endpoint: PATCH /global-preferences from notifications-api.json.

Lua path
app.integrations.smartrecruiters.activate_or_deactivate_global_notification_preferences_hiring_roles_and_notification_channels_bulk
Full name
smartrecruiters.smartrecruiters_notifications_upsert_global_preferences
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters notifications-api.json schema for Activate or deactivate global notification preferences for hiring roles and notification channels in bulk..
update_employee_notifications_preferences Write

Update employee notifications preferences. Official SmartRecruiters endpoint: PATCH /employee-preferences/preferences/{preferenceId} from notifications-api.json.

Lua path
app.integrations.smartrecruiters.update_employee_notifications_preferences
Full name
smartrecruiters.smartrecruiters_notifications_update_employee_preferences
ParameterTypeRequiredDescription
preference_id string yes path parameter `preferenceId`.
enabled boolean no query parameter `enabled`.
find_all_supported_notification_types_along_with_applicable_roles_and_channels_they_can_be_delivered Read

Find all supported notification types along with applicable roles and channels they can be delivered. Official SmartRecruiters endpoint: GET /notification-types from notifications-api.json.

Lua path
app.integrations.smartrecruiters.find_all_supported_notification_types_along_with_applicable_roles_and_channels_they_can_be_delivered
Full name
smartrecruiters.smartrecruiters_notifications_find_all_notification_types
ParameterTypeRequiredDescription
No parameters.
get_list_all_employee_notifications_preferences Read

Get list of all employee notifications preferences. Official SmartRecruiters endpoint: GET /employee-preferences/all from notifications-api.json.

Lua path
app.integrations.smartrecruiters.get_list_all_employee_notifications_preferences
Full name
smartrecruiters.smartrecruiters_notifications_get_all_employee_preferences
ParameterTypeRequiredDescription
No parameters.
get_message_template_by_id Read

Get a message template by id. Official SmartRecruiters endpoint: GET /message-templates/{messageTemplateId} from email-company.json.

Lua path
app.integrations.smartrecruiters.get_message_template_by_id
Full name
smartrecruiters.smartrecruiters_email_company_get_message_template
ParameterTypeRequiredDescription
message_template_id string yes path parameter `messageTemplateId`.
update_message_template Write

Update Message Template Official SmartRecruiters endpoint: PUT /message-templates/{messageTemplateId} from email-company.json.

Lua path
app.integrations.smartrecruiters.update_message_template
Full name
smartrecruiters.smartrecruiters_email_company_update_message_template
ParameterTypeRequiredDescription
message_template_id string yes path parameter `messageTemplateId`.
body object yes Request body matching the official SmartRecruiters email-company.json schema for Update Message Template.
remove_message_template_by_id Write

Remove a message template by id. Official SmartRecruiters endpoint: DELETE /message-templates/{messageTemplateId} from email-company.json.

Lua path
app.integrations.smartrecruiters.remove_message_template_by_id
Full name
smartrecruiters.smartrecruiters_email_company_remove_message_template
ParameterTypeRequiredDescription
message_template_id string yes path parameter `messageTemplateId`.
get_message_templates Read

Get Message Templates Official SmartRecruiters endpoint: GET /message-templates from email-company.json.

Lua path
app.integrations.smartrecruiters.get_message_templates
Full name
smartrecruiters.smartrecruiters_email_company_get_message_templates
ParameterTypeRequiredDescription
type array no query parameter `type`.
channel array no query parameter `channel`.
name string no query parameter `name`.
create_message_template Write

Create Message Template Official SmartRecruiters endpoint: POST /message-templates from email-company.json.

Lua path
app.integrations.smartrecruiters.create_message_template
Full name
smartrecruiters.smartrecruiters_email_company_create_message_template
ParameterTypeRequiredDescription
body object yes Request body matching the official SmartRecruiters email-company.json schema for Create Message Template.