# SmartRecruiters Webhooks API

> SmartRecruiters Webhooks API on Apizie: 184 endpoints (Create a New Candidate Application, Get candidate status, Get application configuration for posting, Get approval request by id, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/open-data:smartrecruiters/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:smartrecruiters`
- Category: Open Data
- Status: byok
- Source: https://smartrecruiters.com
- Page: https://apizie.tech/api/open-data/smartrecruiters
- OpenAPI: https://apizie.tech/api/open-data/smartrecruiters/openapi.json

SmartOnboard Public API

## Endpoints

### Create a New Candidate Application
`POST https://apizie.tech/v1/open-data:smartrecruiters/application-api-create-new-candidate-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| uuid | string | yes | Posting UUID |
| body | object | yes | JSON request body |

### Get candidate status
`GET https://apizie.tech/v1/open-data:smartrecruiters/application-api-get-candidate-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| uuid | string | yes | Posting UUID |
| candidateId | string | yes |  |

### Get application configuration for posting
`GET https://apizie.tech/v1/open-data:smartrecruiters/application-api-get-posting-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Accept-Language | string | no | Language for screening questions. By default 'en'. |
| uuid | string | yes | Posting UUID |
| conditionalsIncluded | boolean | no | Specifies whether conditional questions should be returned in the response. 'false' if not specified - Only available for BETA customers |

### Get approval request by id
`GET https://apizie.tech/v1/open-data:smartrecruiters/approvals-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| approvalRequestId | string | yes | Approval request identifier |

### Get comments for given approval request
`GET https://apizie.tech/v1/open-data:smartrecruiters/approvals-get-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| approvalRequestId | string | yes | Approval request identifier |

### Add comment to given approval request
`POST https://apizie.tech/v1/open-data:smartrecruiters/approvals-add-comment-to-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| approvalRequestId | string | yes | Approval request identifier |
| body | object | no | JSON request body |

### Get pending approvals requests where you are an approver.
`GET https://apizie.tech/v1/open-data:smartrecruiters/approvals-get-pending-requests` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageId | string | no | Identifier for the paged list of approval requests. To get the first page of approval request, leave it blank. |

### Create approval request
`POST https://apizie.tech/v1/open-data:smartrecruiters/approvals-create-approval-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Approve the approval request by id
`POST https://apizie.tech/v1/open-data:smartrecruiters/approvals-approve-decisions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| approvalRequestId | string | yes | Approval request identifier |
| body | object | no | JSON request body |

### Reject the approval request by id
`POST https://apizie.tech/v1/open-data:smartrecruiters/approvals-reject-request-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| approvalRequestId | string | yes | Approval request identifier |
| body | object | no | JSON request body |

### get partner configuration
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-details` (byok)

### saves configuration for partner
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-save-partner-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### enable the company integration
`POST https://apizie.tech/v1/open-data:smartrecruiters/integration-integration-setup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes |  |
| body | object | no | JSON request body |

### updates package result
`POST https://apizie.tech/v1/open-data:smartrecruiters/result-update-package-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orderId | string | yes | Order ID |
| body | object | no | JSON request body |

### add attachment to order
`POST https://apizie.tech/v1/open-data:smartrecruiters/result-add-attachment-to-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orderId | string | yes | Order ID |
| body | object | no | Form fields as a JSON object |

### Shows consent form on partner side
`GET https://apizie.tech/v1/open-data:smartrecruiters/integration-show-consent-form-on-partner-side` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | no | id of company setting up the integration |

### Removes integration on partner side
`POST https://apizie.tech/v1/open-data:smartrecruiters/integration-remove-integration-on-partner-side` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | id of company with integration |

### Retrieves a list of packages
`GET https://apizie.tech/v1/open-data:smartrecruiters/packages-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| 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… |

### Retrieves a package by id
`GET https://apizie.tech/v1/open-data:smartrecruiters/packages-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assessmentPackageId | string | yes |  |

### Orders assessment package for candidate
`POST https://apizie.tech/v1/open-data:smartrecruiters/orders-assess-package-for-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Orders inline assessment package for candidate
`POST https://apizie.tech/v1/open-data:smartrecruiters/orders-assess-package-for-candidate-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Exchange credentials for an access token
`POST https://apizie.tech/v1/open-data:smartrecruiters/token-exchange-credentials-for-access-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Retrieves all assessment orders for specified application
`GET https://apizie.tech/v1/open-data:smartrecruiters/assessment-orders-get-all-for-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicationId | string | yes | ID of the application |

### List audit events
`GET https://apizie.tech/v1/open-data:smartrecruiters/audit-list-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| eventDateAfter | string | no | ISO8601-formatted time boundaries for the event time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ (example: 2023-01-21T12:50:02.594Z) |
| eventDateBefore | string | no | ISO8601-formatted time boundaries for the event time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ (example: 2023-01-21T12:50:02.594Z) |
| eventName | array | no | Name of the event |
| authorType | array | no | Type of the author who generated the event |
| authorId | string | no | Unique identifier of the author |
| entityType | array | no | Type of the entity that the event is related to |
| entityId | string | no | Unique identifier of the entity that the event is related to |
| nextPageId | string | no | Unique identifier for the next page of events |
| limit | integer | no | Number of audit events to return. Maximum value is 100. |

### Get tags for a candidate
`GET https://apizie.tech/v1/open-data:smartrecruiters/candidates-get-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |

### Add tags to a candidate
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-add-tags-to-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| body | object | yes | JSON request body |

### Update tags for a candidate
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-update-candidate-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| body | object | yes | JSON request body |

### Delete tags for a candidate
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-remove-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |

### Get Onboarding Status for a candidate associated with given job
`GET https://apizie.tech/v1/open-data:smartrecruiters/candidates-get-onboarding-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| jobId | string | yes | job identifier |

### Sets Onboarding Status for a candidate associated with given job
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-set-onboarding-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| jobId | string | yes | job identifier |
| body | object | yes | JSON request body |

### Search candidates
`GET https://apizie.tech/v1/open-data:smartrecruiters/candidates-search-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | no | keyword search, for more infromation see [SmartRecruiters… |
| limit | integer | no | number of elements to return. max value is 100 |
| pageId | 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… |
| jobId | 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 candidate’s location data; can be used repeatedly; case insensitive; e.g. Krakow |
| averageRating | array | no | average rating filter to display candidates with a specific average rating (integer); can be used repeatedly; e.g. 4 |
| status | array | no | candidate’s status filter in a context of a job; can be used repeatedly |
| consentStatus | array | no | candidate’s consent status filter; can be used repeatedly |
| subStatus | string | no | candidate’s 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 |
| updatedAfter | string | no | ISO8601-formatted time boundaries for the candidate update time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ |
| onboardingStatus | string | no | candidate's onboarding status |
| propertyId | array | no | candidate's property id (1-N). Currently it is only possible to filter by single-select application fields. Other application field type… |
| propertyValueId | array | no | candidate's property value id (1-N) |
| sourceType | array | no | candidate's source type (1-N) |
| sourceSubType | array | no | candidate's source subtype (1-N) |
| sourceValueId | array | no | candidate's source value id (1-N) |
| questionCategory | array | no | screening question category (1-N) |
| questionFieldId | array | no | screening question field id (1-N) |
| questionFieldValueId | array | no | screening question field value id (1-N) |

### Create a new candidate and assign to a Talent Pool
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-create-with-source-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Parse a resume, create a candidate and assign to a Talent Pool.
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-parse-resume-and-assign-to-talent-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Request consent from multiple candidates
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-request-consent-from-multiple` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Status of candidate consent
`GET https://apizie.tech/v1/open-data:smartrecruiters/candidates-get-status-of-consent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |

### Candidate consent decisions
`GET https://apizie.tech/v1/open-data:smartrecruiters/candidates-get-consent-decisions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |

### Get details of a candidate
`GET https://apizie.tech/v1/open-data:smartrecruiters/candidates-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |

### Update candidate personal information
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-update-personal-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| body | object | no | JSON request body |

### Delete Candidate
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-remove-candidate-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |

### Get list of candidate's attachments in context of given job.
`GET https://apizie.tech/v1/open-data:smartrecruiters/candidates-get-attachments-by-job-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| jobId | string | yes | job identifier |

### Attach file to candidate in context of given job.
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-attach-file-to-job-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| jobId | string | yes | job identifier |
| body | object | no | Form fields as a JSON object |

### Get candidate's attachment.
`GET https://apizie.tech/v1/open-data:smartrecruiters/candidates-get-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| attachmentId | string | yes | attachment identifier |

### Delete attachment.
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-delete-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| attachmentId | string | yes | attachment identifier |

### Update a candidate's status
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-update-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| jobId | string | yes | job identifier |
| body | object | no | JSON request body |

### Get candidate's status history for a candidate's job
`GET https://apizie.tech/v1/open-data:smartrecruiters/candidates-get-status-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| jobId | string | yes | job identifier |

### Update a candidate's source
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-update-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| jobId | string | yes | job identifier |
| body | object | yes | JSON request body |

### Get candidate property values for a candidate's job
`GET https://apizie.tech/v1/open-data:smartrecruiters/candidates-get-property-values-for-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| jobId | string | yes | job identifier |
| context | string | no | context for candidate properties to display |

### Add/update candidate properties values
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-update-candidate-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| jobId | string | yes | job identifier |
| body | object | no | JSON request body |

### Get candidate screening answers for a candidate's job
`GET https://apizie.tech/v1/open-data:smartrecruiters/candidates-get-screening-answers-by-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| jobId | string | yes | job identifier |

### Create a new candidate and assign to a job
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-create-with-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| body | object | yes | JSON request body |

### Parse a resume, create a candidate and assign to a job.
`POST https://apizie.tech/v1/open-data:smartrecruiters/candidates-parse-resume-and-assign-to-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| body | object | no | Form fields as a JSON object |

### Get details of a candidate's application to a job
`GET https://apizie.tech/v1/open-data:smartrecruiters/candidates-get-application-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate identifier |
| jobId | string | yes | job identifier |

### Get company information
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-company-information` (byok)

### Get a list of available job properties
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-available-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Accept-Language | string | no | language of returned content |

### Create a job property
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-create-job-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get job property by id
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-property-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| Accept-Language | string | no | language of returned content |

### Update a job property
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-update-job-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| body | object | no | JSON request body |

### Add a job property's translations
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-add-job-property-translations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| body | object | yes | JSON request body |

### Get available job property values
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-job-property-values` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| Accept-Language | string | no | language of returned content |
| page_id | string | no | identifier of the next page of subscriptions |
| pageSize | integer | no | pageSize |

### Create a job property value
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-create-job-property-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| body | object | no | JSON request body |

### Update a job property value
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-update-job-property-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| valueId | string | yes | job property's value identifier |
| body | object | no | JSON request body |

### Add a job property value's translations
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-add-job-property-value-translations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| valueId | string | yes | job property's value identifier |
| body | object | yes | JSON request body |

### Archive a job property value
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-archive-job-property-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| valueId | string | yes | job property's value identifier |

### Unarchive a job property value
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-unarchive-job-property-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| valueId | string | yes | job property's value identifier |

### Activate a job property
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-activate-job-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |

### Deactivate a job property
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-deactivate-job-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |

### Get job property's dependents
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-job-property-dependents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| Accept-Language | string | no | language of returned content |

### Create job property dependents
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-create-job-property-dependents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| body | object | yes | JSON request body |

### Remove job property's dependent
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-remove-dependent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| dependentId | string | yes | job property's dependent identifier |

### Get job property's dependent values
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-dependent-values` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| valueId | string | yes | job property's value identifier |
| dependentId | string | yes | job property's dependent identifier |
| Accept-Language | string | no | language of returned content |
| page_id | string | no | identifier of the next page of subscriptions |
| pageSize | integer | no | pageSize |

### Add job property's dependent value
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-add-dependent-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| valueId | string | yes | job property's value identifier |
| dependentId | string | yes | job property's dependent identifier |
| body | object | yes | JSON request body |

### Remove job property's dependent values relationship
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-remove-dependent-values-relationship` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | job property identifier |
| valueId | string | yes | job property's value identifier |
| dependentId | string | yes | job property's dependent identifier |
| dependentValueId | string | yes | job property's dependent value identifier |

### Get departments
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-departments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Accept-Language | string | no | language of returned content |

### Creates department
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-create-department` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get department
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-department-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of a department |

### Get list of hiring process
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-hiring-processes` (byok)

### Get hiring process
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-hiring-process` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of a hiring process |

### Get a list of available offer properties
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-list-offer-properties` (byok)

### Get a list of available candidate properties
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-candidate-properties` (byok)

### Get candidate property by id
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-candidate-property-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate property identifier |

### Get Candidate Property values
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-candidate-property-values` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate property identifier |

### Create candidate property value
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-create-candidate-property-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate property identifier |
| body | object | yes | JSON request body |

### Get Candidate Property value by id
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-candidate-property-value-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate property identifier |
| valueId | string | yes | candidate property's value identifier |

### Update candidate property value label
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-update-property-value-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate property identifier |
| valueId | string | yes | candidate property's value identifier |
| body | object | yes | JSON request body |

### Remove candidate property value
`POST https://apizie.tech/v1/open-data:smartrecruiters/configuration-remove-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | candidate property identifier |
| valueId | string | yes | candidate property's value identifier |

### List candidate source types with subtypes
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-list-candidate-source-types-with-subtypes` (byok)

### List candidate sources
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-list-candidate-sources-by-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sourceType | string | yes | Source type from /configuration/sources |
| sourceSubType | 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 a candidate source
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-candidate-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sourceType | string | yes | Source type from /configuration/sources |
| sourceValueId | string | yes | Source id |
| sourceSubType | string | no | Source SubType from /configuration/sources |

### Get a candidate source by identifier.
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-candidate-source-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sourceIdentifier | string | yes | Source identifier |

### Get rejection reasons
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-rejection-reasons` (byok)

### Get withdrawal reasons
`GET https://apizie.tech/v1/open-data:smartrecruiters/configuration-get-withdrawal-reasons` (byok)

### Get posting by id
`GET https://apizie.tech/v1/open-data:smartrecruiters/feed-get-posting-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| postingId | integer | yes | Posting id to find |

### Update posting information
`POST https://apizie.tech/v1/open-data:smartrecruiters/feed-update-posting-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| postingId | integer | yes | A single posting id. Allows updating information only for the defined postings. |
| body | object | yes | JSON request body |

### GET /info/metrics.prometheus
`GET https://apizie.tech/v1/open-data:smartrecruiters/info-get-metrics` (byok)

### Get a list of postings
`GET https://apizie.tech/v1/open-data:smartrecruiters/feed-list-postings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| updatedAfter | 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… |
| 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… |
| 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]. |

### Retrieves interview types
`GET https://apizie.tech/v1/open-data:smartrecruiters/interview-types-get-types` (byok)

### Adds interview types to already existing ones
`POST https://apizie.tech/v1/open-data:smartrecruiters/interview-types-add-existing-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Removes interview type with given name
`POST https://apizie.tech/v1/open-data:smartrecruiters/interview-types-remove-by-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| interviewType | string | yes | Interview type name |

### Retrieves a list of interviews
`GET https://apizie.tech/v1/open-data:smartrecruiters/interviews-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicationId | string | yes | ID of the application |

### Creates an interview
`POST https://apizie.tech/v1/open-data:smartrecruiters/interviews-create-new-interview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieves an interview
`GET https://apizie.tech/v1/open-data:smartrecruiters/interviews-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| interviewId | string | yes | ID of the interview |

### Modifies an interview
`POST https://apizie.tech/v1/open-data:smartrecruiters/interviews-modify-interview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| interviewId | string | yes | ID of the interview |
| body | object | yes | JSON request body |

### Deletes an interview
`POST https://apizie.tech/v1/open-data:smartrecruiters/interviews-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| interviewId | string | yes | ID of the interview |

### Creates a timeslot
`POST https://apizie.tech/v1/open-data:smartrecruiters/timeslots-create-new-timeslot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| interviewId | string | yes | ID of the interview |
| body | object | yes | JSON request body |

### Retrieves a timeslot
`GET https://apizie.tech/v1/open-data:smartrecruiters/timeslots-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| interviewId | string | yes | ID of the interview |
| timeslotId | string | yes | ID of the timeslot |

### Modifies a timeslot
`POST https://apizie.tech/v1/open-data:smartrecruiters/timeslots-modify-time-slot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| interviewId | string | yes | ID of the interview |
| timeslotId | string | yes | ID of the timeslot |
| body | object | yes | JSON request body |

### Deletes a timeslot
`POST https://apizie.tech/v1/open-data:smartrecruiters/timeslots-delete-timeslot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| interviewId | string | yes | ID of the interview |
| timeslotId | string | yes | ID of the timeslot |

### Changes a interviewer's status in given timeslot
`POST https://apizie.tech/v1/open-data:smartrecruiters/statuses-update-interviewer-status-in-slot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| interviewId | string | yes | ID of the interview |
| timeslotId | string | yes | ID of the timeslot |
| userId | string | yes | ID of the user |
| body | object | yes | JSON request body |

### Changes a candidate's status in given timeslot
`POST https://apizie.tech/v1/open-data:smartrecruiters/statuses-update-candidate-timeslot-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| interviewId | string | yes | ID of the interview |
| timeslotId | string | yes | ID of the timeslot |
| body | object | yes | JSON request body |

### Positions for a job
`GET https://apizie.tech/v1/open-data:smartrecruiters/jobs-get-positions-for-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| Accept-Language | string | no | language of returned content |

### Create a new position for a job
`POST https://apizie.tech/v1/open-data:smartrecruiters/jobs-create-new-position` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| body | object | yes | JSON request body |

### Get a single position
`GET https://apizie.tech/v1/open-data:smartrecruiters/jobs-get-single-position` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| positionId | string | yes | position identifier |
| Accept-Language | string | no | language of returned content |

### Update position
`POST https://apizie.tech/v1/open-data:smartrecruiters/jobs-update-position` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| positionId | string | yes | position identifier |
| body | object | yes | JSON request body |

### Delete position
`POST https://apizie.tech/v1/open-data:smartrecruiters/jobs-delete-position` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| positionId | string | yes | position identifier |

### Find and list job ads for a given job
`GET https://apizie.tech/v1/open-data:smartrecruiters/jobs-find-job-ads-for-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| Accept-Language | string | no | language of returned content |

### Create a new job ad
`POST https://apizie.tech/v1/open-data:smartrecruiters/jobs-create-job-ad` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| body | object | yes | JSON request body |

### Get a job ad
`GET https://apizie.tech/v1/open-data:smartrecruiters/jobs-get-job-ad` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| jobAdId | string | yes | job ad identifier |
| Accept-Language | string | no | language of returned content |

### Update a job ad
`POST https://apizie.tech/v1/open-data:smartrecruiters/jobs-update-job-ad` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| jobAdId | string | yes | job ad identifier |
| body | object | yes | JSON request body |

### List publications for a job ad
`GET https://apizie.tech/v1/open-data:smartrecruiters/jobs-list-publications-for-job-ad` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| jobAdId | string | yes | job ad identifier |
| Accept-Language | string | no | language of returned content |
| activeOnly | boolean | no | publication status filter; when omitted, defaults to 'true' (only active publications are returned); 'false' returns active and inactive… |

### Publishes a job ad
`POST https://apizie.tech/v1/open-data:smartrecruiters/jobs-publish-job-ad-postings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | job identifier |
| jobAdId | string | yes | job ad identifier |
| body | object | no | JSON request body |

…and 64 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/open-data:smartrecruiters/application-api-create-new-candidate-application" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the SmartRecruiters Webhooks API?
Create a free Apizie key, then send POST https://apizie.tech/v1/open-data:smartrecruiters/application-api-create-new-candidate-application with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the SmartRecruiters Webhooks API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. SmartRecruiters Webhooks itself also needs your own key from api.smartrecruiters.com.

### Can AI agents use the SmartRecruiters Webhooks API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:smartrecruiters.

### What is the status of the SmartRecruiters Webhooks API?
Needs your own provider key (bring your own key)