---
updatedAt: 2026-10-05T10:05:44.000Z
agentTools:
projectIndex: https://developers.pinpointhq.com/llms.txt
---
# Create Application
### Request format
In order to create an application you must send a [JSON:API spec JSON object](https://jsonapi.org/format/#crud-creating) representing a job application.
### Required attributes
As a bare minimum, `first_name`, `last_name`, and `email` must be supplied. Other required attributes will vary depending on the job configuration.
| Job requirement | Application Required fields |
| :--------------- | :---------------------------------------- |
| Phone | `phone`, `phone_iso2` |
| Address | `address1`, `town`, `country`, `postcode` |
| Résumè / CV | `cv_base64_filename`, `cv_base64_data` |
| Personal Summary | `summary` |
### Required relationships
Only the `job` is required when creating an application, although the `stage` and `answers` can also be optionally specified.
The application will automatically be assigned to the `applied` stage of the job if no stage is specified.
### Sending Notifications
When an application is created there are two notifications that are sent out:
* *Application Received* is sent to the applicant
* *New Application* is sent to relevant Pinpoint users
If you want to avoid sending notifications, E.g. if you are importing applicants into Pinpoint as part of a migration, then supply a `skip_notifications_on_create` attribute with a value of `true`.
### Examples
```json Basic request
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev"
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
}
}
}
}
```
```json Basic request with stage
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev"
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
},
"stage": {
"data": {
"type": "stages",
"id": "1"
}
}
}
}
}
```
```json Complex request with all fields and relationships
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev",
"phone": "02033189441",
"phone_iso2": "JE",
"address1": "One Waverley Place",
"address2": "Union Street",
"town": "St Helier",
"country": "Jersey",
"postcode": "JE1 2PP",
"date_of_birth": "1970-01-01",
"linkedin_url": "https://www.linkedin.com/company/pinpointhq",
"summary": "This is my personal summary",
"cv_base64_filename": "joe_bloggs_resume.pdf",
"cv_base64_data": "data:application/pdf;base64,...[DATA]...",
"equality_monitoring_option_ids": ["1","11"],
"channel": "event",
"channel_source": "Spring marketing campaign"
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
},
"custom_attributes": {
"data": [
{
"type": "custom_attributes",
"temp-id": "temp-id-1",
"method": "create"
}
]
},
"answers": {
"data": [
{
"type": "answers",
"method": "create",
"temp-id": "1"
},
{
"type": "answers",
"method": "create",
"temp-id": "2"
},
{
"type": "answers",
"method": "create",
"temp-id": "3"
},
{
"type": "answers",
"method": "create",
"temp-id": "4"
},
{
"type": "answers",
"method": "create",
"temp-id": "5"
},
{
"type": "answers",
"method": "create",
"temp-id": "6"
},
{
"type": "answers",
"method": "create",
"temp-id": "7"
},
{
"type": "answers",
"method": "create",
"temp-id": "8"
}
]
}
}
},
"included": [
{
"type": "custom_attributes",
"temp-id": "temp-id-1",
"attributes": {
"varchar_value": "example text value"
},
"relationships": {
"custom_field": {
"data": {
"type": "custom_fields",
"id": "11"
}
}
}
},
{
"type": "answers",
"temp-id": "1",
"attributes": {
"boolean_answer": true
},
"relationships": {
"question": {
"data": {
"id": "1",
"type": "questions"
}
}
}
},
{
"type": "answers",
"temp-id": "2",
"attributes": {
"text_answer": "This is the first line of a multiline answer/nThis is the second line"
},
"relationships": {
"question": {
"data": {
"id": "2",
"type": "questions"
}
}
}
},
{
"type": "answers",
"temp-id": "3",
"attributes": {},
"relationships": {
"answer_options": {
"data": [
{
"type": "answer_options",
"method": "create",
"temp-id": "answer-option-1"
},
{
"type": "answer_options",
"method": "create",
"temp-id": "answer-option-2"
}
]
},
"question": {
"data": {
"id": "3",
"type": "questions"
}
}
}
},
{
"type": "answers",
"temp-id": "4",
"attributes": {
"document_base64_filename": "some other pdf.pdf",
"document_base64_data": "data:application/pdf;base64,...[DATA]..."
},
"relationships": {
"question": {
"data": {
"id": "4",
"type": "questions"
}
}
}
},
{
"type": "answers",
"temp-id": "5",
"attributes": {
"date_answer": "2024-06-06"
},
"relationships": {
"question": {
"data": {
"id": "5",
"type": "questions"
}
}
}
},
{
"type": "answers",
"temp-id": "6",
"attributes": {
"url_answer": "https://pinpointhq.com"
},
"relationships": {
"question": {
"data": {
"id": "6",
"type": "questions"
}
}
}
},
{
"type": "answers",
"temp-id": "7",
"attributes": {
"text_answer": "Ruby"
},
"relationships": {
"question": {
"data": {
"id": "7",
"type": "questions"
}
}
}
},
{
"type": "answers",
"temp-id": "8",
"attributes": {
"number_answer": 42
},
"relationships": {
"question": {
"data": {
"id": "8",
"type": "questions"
}
}
}
},
{
"type": "answer_options",
"temp-id": "answer-option-1",
"attributes": {
"text": "Ruby"
}
},
{
"type": "answer_options",
"temp-id": "answer-option-2",
"attributes": {
"text": "Blue"
}
}
]
}
```
```json Basic request skipping notifications
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev",
"skip_notifications_on_create": true
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
}
}
}
}
```
## Attaching a résumè / CV
A CV can be supplied with the request by populating both fields shown below. If only one of the fields is present then no CV will be saved.
| Field Name | Description |
| :------------------- | :----------------------------------------------------------------------------------------------------- |
| cv\_base64\_filename | The name of the file. This is how it will appear within Pinpoint. |
| cv\_base64\_data | A Base64 encoded [DataURL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) |
### Validations
* Accepted file formats are `pdf`, `doc`, and `docx`.
* File size limit is 30 megabytes.
### Example
```json With CV
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev",
"cv_base64_filename": "cv.pdf",
"cv_base64_data": "data:application/pdf;base64,...[DATA]..."
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
}
}
}
}
```
## Attaching cover letter
A cover letter works in the same way.
| Field Name | Description |
| :------------------------------ | :----------------------------------------------------------------------------------------------------- |
| cover\_letter\_base64\_filename | The name of the file. This is how it will appear within Pinpoint. |
| cover\_letter\_base64\_data | A Base64 encoded [DataURL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) |
### Validations
* Accepted file formats are `pdf`, `doc`, `docx`, `txt`, `rtf`
* File size limit is 30 megabytes.
### Example
```json With CV
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev",
"cover_letter_base64_filename": "cover_letter.pdf",
"cover_letter_base64_data": "data:application/pdf;base64,...[DATA]..."
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
}
}
}
}
```
## Upload documents
You can upload multiple documents (besides CV) using the `documents_base64` array on the attributes.
```json Example value for documents_base64
[
{
"data": "data:application/pdf;base64,...[DATA]...",
"filename": "background_check.pdf"
},
{
"data": "data:image/jpeg;base64,...[DATA]...",
"filename": "scan.jpg"
}
]
```
Accepted file types: `pdf, doc, docx, png, jpeg, xls, xlsx, pptx, mp4, mov, txt`.
Maximum file size: `10 MB` per file.
There is currently no way to delete application documents via the API.
## Submitting answers along with an application
Applications can be created with additional answers in a single request. These answers will relate to job specific questions, which can be retrieved using the job API endpoints.
A `temp-id` field is required when detailing the answer under the `relationships` key of the POST body. This `temp-id` can be any UUID and will help to:
* Connect relevant sections of the payload.
* Associate in-memory objects with the ids returned from the server.
* Make it easy to associate any errors returned from failed requests.
### Required Fields and relationships.
An answers required attributes will depend on the type of the question that it's associated with.
| Question type | Required attributes | Required Relationships |
| :-------------------------- | :---------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- |
| `short_text` or `long_text` | `text_answer` | `question` |
| `boolean` | `boolean_answer` | `question` |
| `number` | `number_answer` | `question` |
| `url` | `url_answer` | `question` |
| `document` | `document_base64_filename`, `document_base64_data`. This is done in the same way as submitting a CV. | `question` |
| `multiple_choice` | None | `question`, `answer_options`. See the example below for how to submit the answer options. |
### Required questions
When creating an application through the API, Pinpoint will not validate that answers to required questions are present.
I.e. if you have a job that has a *required* question, you can still create an application without providing an answer to this question. It is because of this that validations for required answers must be done on the client side.
### Conditional questions
Answers for conditional questions should be sent the same as for regular questions, but only if the conditions are met. Make sure to include `include=questions.conditional_questions` when getting questions from the job endpoints.
See [Conditional questions](https://developers.pinpointhq.com/reference/get-questions#conditional-questions) for interpreting their conditions and submitting answers.
### Examples of how to submit different answer types
```json Long Text / Short Text
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev"
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
},
"answers": {
"data": [
{
"type": "answers",
"method": "create",
"temp-id": "1"
}
]
}
}
},
"included": [
{
"type": "answers",
"temp-id": "1",
"attributes": {
"text_answer": "This is the first line of a multiline answer/nThis is the second line"
},
"relationships": {
"question": {
"data": {
"id": "1",
"type": "questions"
}
}
}
}
]
}
```
```json Boolean
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev"
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
},
"answers": {
"data": [
{
"type": "answers",
"method": "create",
"temp-id": "1"
}
]
}
}
},
"included": [
{
"type": "answers",
"temp-id": "1",
"attributes": {
"boolean_answer": true
},
"relationships": {
"question": {
"data": {
"id": "1",
"type": "questions"
}
}
}
}
]
}
```
```json Number
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev"
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
},
"answers": {
"data": [
{
"type": "answers",
"method": "create",
"temp-id": "1"
}
]
}
}
},
"included": [
{
"type": "answers",
"temp-id": "1",
"attributes": {
"number_answer": 123
},
"relationships": {
"question": {
"data": {
"id": "2",
"type": "questions"
}
}
}
}
]
}
```
```json URL
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev"
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
},
"answers": {
"data": [
{
"type": "answers",
"method": "create",
"temp-id": "1"
}
]
}
}
},
"included": [
{
"type": "answers",
"temp-id": "1",
"attributes": {
"url_answer": "https://pinpointhq.com"
},
"relationships": {
"question": {
"data": {
"id": "1",
"type": "questions"
}
}
}
}
]
}
```
```json Document
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev"
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
},
"answers": {
"data": [
{
"type": "answers",
"method": "create",
"temp-id": "1"
}
]
}
}
},
"included": [
{
"type": "answers",
"temp-id": "1",
"attributes": {
"document_base64_filename": "example.pdf",
"document_base64_data": "data:application/pdf;base64,...[REDACTED_DATA]..."
},
"relationships": {
"question": {
"data": {
"id": "1",
"type": "questions"
}
}
}
}
]
}
```
```json Date
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev"
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
},
"answers": {
"data": [
{
"type": "answers",
"method": "create",
"temp-id": "1"
}
]
}
}
},
"included": [
{
"type": "answers",
"temp-id": "1",
"attributes": {
"date_answer": "2020-04-01"
},
"relationships": {
"question": {
"data": {
"id": "1",
"type": "questions"
}
}
}
}
]
}
```
```json Multiple Choice
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev"
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
},
"answers": {
"data": [
{
"type": "answers",
"method": "create",
"temp-id": "1"
}
]
}
}
},
"included": [
{
"type": "answers",
"temp-id": "1",
"attributes": {},
"relationships": {
"answer_options": {
"data": [
{
"type": "answer_options",
"method": "create",
"temp-id": "answer-option-1"
},
{
"type": "answer_options",
"method": "create",
"temp-id": "answer-option-2"
}
]
},
"question": {
"data": {
"id": "1",
"type": "questions"
}
}
}
},
{
"type": "answer_options",
"temp-id": "answer-option-1",
"attributes": {
"text": "Ruby"
}
},
{
"type": "answer_options",
"temp-id": "answer-option-2",
"attributes": {
"text": "Blue"
}
}
]
}
```
## Collecting equality monitoring (DEI) information
An array of `equality_monitoring_option_ids` can optionally be supplied as an attribute of an application. These option IDs relate to the equality monitoring option IDs that can be retrieved with a request to the equality monitoring categories endpoint.
* **All data is optional**: In this way you can allow users to supply only those details that they feel comfortable with.
* **Only one option is allowed to be supplied per category**: E.g. you cannot supply options that indicate both *Male* and *Female* for the gender category.
```json
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev",
"equality_monitoring_option_ids": ["1","11"]
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
}
}
}
}
```
## Source attribution
Optional `channel` and `channel_source` attributes can be supplied when creating or updating applications. These allow you to categorise where applicants were sourced from. If these are not supplied then the application will have its channel set to `undetermined`.
The `channel` must be one of a predefined list, where as the `channel_source` can be free text up to 255 characters in length. For a full list of the available channels, see the [detailed list of all source attribution channels](https://developers.pinpointhq.com/docs/channels).
```json JSON
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Joe",
"last_name": "Bloggs",
"email": "joe.bloggs@pinpoint.dev",
"channel": "event",
"channel_source": "Spring marketing campaign"
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
}
}
}
```
### Add or remove tags
You can add and remove tags on the application. You need to specify the tag name and tag `context`.
```json Add tags
{
"data": {
"type": "applications",
"attributes": {
"add_tags_with_context": [
{
"tag": "Assessment: Passed",
"context": "assessment"
},
{
"tag": "Background check: Rejected",
"context": "background_check"
}
]
}
}
}
```
## Adding Custom Attributes to an Application
### Custom Field - IMPORTANT
It is important to read about [Custom Fields](https://developers.pinpointhq.com/reference/post-custom-fields) and their `resource_type` and `field_type` and how they must be confirmed before you can create [Custom Attributes](https://developers.pinpointhq.com/reference/post-custom-attributes) alongside `applications`.
`custom_attributes` created for `applications` must have be associated with `custom_fields` that have a `resource_type` of `application`. The appropriate value for the new `custom_attribute` must also align with the `field_type` of the `custom_field`.
### Adding Custom Attributes to the request body
* You must add `custom_attributes` to the `relationships` section of the request body and give each one a `temp-id`.
* These `temp-id` must match the `temp-id` that you assign the corresponding `custom_attribute` that you create in the `included` section of the request body.
* The `included` section is where you will pass all of the attributes and relationships for the `custom_attribute`, to properly create it along side the `application`. The only required relationship for the `custom_attribute` is the `custom_field`
```Text Basic Request + Custom Attribute Example
{
"data": {
"type": "applications",
"attributes": {
"first_name": "Test",
"last_name": "User",
"email": "test_user@example.com"
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
},
"custom_attributes": {
"data": [
{
"type": "custom_attributes",
"temp-id": "temp-id-1",
"method": "create"
}
]
}
}
},
"included": [
{
"type": "custom_attributes",
"temp-id": "temp-id-1",
"attributes": {
"varchar_value": "example text value"
},
"relationships": {
"custom_field": {
"data": {
"type": "custom_fields",
"id": "1"
}
}
}
}
]
}
```
### Important
All relationships that also need to be created will need to be in the JSON request body's `included` section, as seen in the example below. To see this example, please click on the drop down in the top-right corner and select `WITH_ANSWERS`.
# OpenAPI definition
````json
{
"openapi": "3.0.1",
"info": {
"contact": {
"email": "integrations@pinpointhq.com",
"name": "Pinpoint Integrations"
},
"description": "Documentation for Pinpoint External API endpoints",
"title": "Pinpoint External API Reference",
"version": "v1.0.27"
},
"security": [
{
"ApiKeyAuth": []
}
],
"x-readme": {
"samples-languages": [
"curl",
"python",
"ruby"
]
},
"servers": [
{
"url": "https://{subdomain}.pinpointhq.com",
"description": "Pinpoint Production Environment",
"variables": {
"subdomain": {
"default": "your-subdomain",
"description": "Subdomain"
}
}
}
],
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "X-API-KEY"
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/jsonapi_failure"
},
"examples": {
"invalid_param": {
"description": "Malformed query params",
"value": {
"errors": [
{
"code": "bad_request",
"status": "400",
"title": "Bad Request",
"detail": "Malformed query params"
}
]
}
},
"invalid_locale": {
"description": "Invalid locale",
"value": {
"errors": [
{
"code": "bad_request",
"status": "400",
"title": "Bad Request",
"detail": "{locale} is not a valid locale"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/jsonapi_failure"
},
"examples": {
"api_key_not_provided": {
"description": "X-API-KEY header not provided",
"value": {
"errors": [
{
"code": "unauthorized",
"status": "401",
"title": "Unauthorized",
"detail": "X-API-KEY header not provided"
}
]
}
},
"invalid_api_key": {
"description": "Invalid API key",
"value": {
"errors": [
{
"code": "unauthorized",
"status": "401",
"title": "Unauthorized",
"detail": "Invalid API key"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/jsonapi_failure"
},
"examples": {
"integration_not_enabled": {
"description": "Integration not enabled",
"value": {
"errors": [
{
"code": "forbidden",
"status": "403",
"title": "Forbidden",
"detail": "Integration not enabled"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/jsonapi_failure"
},
"examples": {
"not_found": {
"description": "Unprocessable Entity",
"value": {
"errors": [
{
"code": "unprocessable_entity",
"status": "422",
"title": "Validation Error",
"detail": "{attribute_name} can't be blank"
}
]
}
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/jsonapi_failure"
},
"examples": {
"not_found": {
"description": "Too Many Requests",
"value": {
"errors": [
{
"code": "too_many_requests",
"status": "429",
"title": "Too Many Requests",
"detail": "Rate limit exceeded"
}
]
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/jsonapi_failure"
},
"examples": {
"not_found": {
"description": "Internal Server Error",
"value": {
"errors": [
{
"code": "internal_server_error",
"status": "500",
"title": "Internal Server Error",
"detail": "We've notified our engineers and hope to address this issue shortly."
}
]
}
}
}
}
}
},
"applications_201": {
"description": "Created: Application resource",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/applications_single"
},
"examples": {
"jsonapi": {
"$ref": "#/components/examples/jsonapi_applications_single"
}
}
}
},
"links": {
"get-application-id": {
"$ref": "#/components/links/get-application-id"
},
"update-application-id": {
"$ref": "#/components/links/update-application-id"
},
"delete-application-id": {
"$ref": "#/components/links/delete-application-id"
}
}
}
},
"schemas": {
"answers": {
"type": "object",
"description": "Answer attributes",
"properties": {
"title": {
"type": "string",
"readOnly": true
},
"additional_information": {
"type": "string",
"readOnly": true
},
"boolean_answer": {
"type": "boolean"
},
"number_answer": {
"type": "string",
"format": "decimal"
},
"document_answer": {
"type": "object",
"additionalProperties": true,
"readOnly": true
},
"question_type": {
"type": "string",
"readOnly": true
},
"date_answer": {
"type": "string",
"format": "date"
},
"url_answer": {
"type": "string"
},
"date_from_answer": {
"type": "string",
"format": "date"
},
"date_to_answer": {
"type": "string",
"format": "date"
},
"multiple_choice_answer": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
}
]
},
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"document_base64_data": {
"type": "string",
"writeOnly": true
},
"document_base64_filename": {
"type": "string",
"writeOnly": true
},
"document_signed_id": {
"type": "string",
"writeOnly": true
},
"text_answer": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
}
},
"additionalProperties": false
},
"answers_attributes_post": {
"type": "object",
"description": "Answer post attributes",
"properties": {
"boolean_answer": {
"type": "boolean"
},
"number_answer": {
"type": "string",
"format": "decimal"
},
"date_answer": {
"type": "string",
"format": "date"
},
"url_answer": {
"type": "string"
},
"date_from_answer": {
"type": "string",
"format": "date"
},
"date_to_answer": {
"type": "string",
"format": "date"
},
"document_base64_data": {
"type": "string",
"writeOnly": true
},
"document_base64_filename": {
"type": "string",
"writeOnly": true
},
"document_signed_id": {
"type": "string",
"writeOnly": true
},
"text_answer": {
"type": "string"
}
},
"additionalProperties": false
},
"answers_relationships": {
"type": "object",
"properties": {
"answer_options": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "answer_options",
"enum": [
"answer_options"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"question": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "questions",
"enum": [
"questions"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"answerable": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "applications",
"enum": [
"applications",
"job_seekers",
"candidate_surveys"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"answers_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"answers"
]
},
"attributes": {
"$ref": "#/components/schemas/answers"
},
"relationships": {
"$ref": "#/components/schemas/answers_relationships"
}
},
"additionalProperties": false
},
"applications": {
"type": "object",
"description": "Application attributes",
"properties": {
"uuid": {
"type": "string",
"description": "A stable UUID for this application. Safe to share with third-party integrations as a unique application identifier.",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"candidate_id": {
"type": "integer",
"readOnly": true
},
"external_system_reference": {
"type": "string",
"description": "Used to store the ID or reference from an external system that the record was created from."
},
"hired_at": {
"type": "string",
"format": "date-time"
},
"internal_candidate": {
"type": "boolean",
"readOnly": true
},
"job_id": {
"type": "integer",
"readOnly": true
},
"job_posting_id": {
"type": "integer",
"description": "The posting the candidate applied through. Blank for applications created outside a careers site posting form, such as those created through this API or by an integration.",
"readOnly": true
},
"locale": {
"type": "string"
},
"stage_id": {
"type": "integer",
"readOnly": true
},
"rejected_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"phone_iso2": {
"type": "string"
},
"start_on": {
"type": "string",
"format": "date"
},
"equality_monitoring_option_ids": {
"type": "array",
"items": {},
"writeOnly": true
},
"skip_notifications_on_create": {
"type": "boolean",
"writeOnly": true
},
"is_demo": {
"type": "boolean"
},
"add_tag_with_context": {
"type": "object",
"additionalProperties": true,
"writeOnly": true
},
"add_tags_with_context": {
"type": "array",
"items": {},
"description": "Add multiple **tags** at once\nExample: `[{\"tag\": \"Celery\", \"context\": \"custom_green\"}, {\"tag\": \"Availability\", \"context\": \"rejection\"}]`",
"writeOnly": true
},
"remove_tag_with_context": {
"type": "object",
"additionalProperties": true,
"writeOnly": true
},
"cv_base64_data": {
"type": "string",
"writeOnly": true
},
"cv_base64_filename": {
"type": "string",
"writeOnly": true
},
"cover_letter_base64_data": {
"type": "string",
"description": "Base64-encoded cover letter file content, including the data URI prefix (e.g. `data:application/pdf;base64,...`).",
"writeOnly": true
},
"cover_letter_base64_filename": {
"type": "string",
"description": "Original filename for the cover letter, e.g. `cover_letter.pdf`. Accepted file types: `pdf`, `doc`, `docx`, `txt`, `rtf`. Maximum file size: **30 MB**.",
"writeOnly": true
},
"documents_base64": {
"type": "array",
"items": {},
"description": "Array of documents to attach. Each item must be an object with the following fields:\n\n```\n[\n {\n \"data\": \"[Base64 encoded file content, including data URI prefix]\",\n \"filename\": \"[Original filename, e.g. report.pdf]\"\n }\n]\n```\n\nAccepted file types: `pdf`, `doc`, `docx`, `png`, `jpeg`, `xls`, `xlsx`, `pptx`, `mp4`, `mov`, `txt`.\nMaximum file size: **10 MB** per file.\n",
"writeOnly": true
},
"cv_signed_id": {
"type": "string",
"writeOnly": true
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"preferred_name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"date_of_birth": {
"type": "string"
},
"linkedin_url": {
"type": "string"
},
"summary": {
"type": "string"
},
"preferred_pronouns": {
"type": "string"
},
"channel_source": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string",
"description": "Address line 2 for non-US addresses. Returns `null` for US addresses. Writing this attribute is not supported when `country` is `US`."
},
"town": {
"type": "string"
},
"state_province": {
"type": "string",
"description": "State or province for US addresses. Returns `null` for non-US addresses. Writing this attribute is only supported when `country` is `US`."
},
"postcode": {
"type": "string"
},
"country": {
"type": "string"
},
"country_code": {
"type": "string",
"readOnly": true
},
"country_code_alpha3": {
"type": "string",
"readOnly": true
},
"country_name": {
"type": "string",
"readOnly": true
},
"full_name": {
"type": "string",
"readOnly": true
},
"national_identifier": {
"type": "string",
"readOnly": true
},
"channel": {
"type": "string"
},
"concealed": {
"type": "boolean",
"readOnly": true
},
"ai_score": {
"type": "object",
"additionalProperties": true,
"description": "AI-generated score for the application. Only returned when AI Match Score is enabled for the company.\n`null` when AI Match Score is disabled or no score exists for this application.\n\nExample:\n```\n{\n \"status\": \"completed\",\n \"score\": 87,\n \"verdict\": \"Strong match for the role\",\n \"strengths\": [\"Relevant experience\", \"Strong technical skills\"],\n \"concerns\": [\"Limited management experience\"],\n \"interview_focus\": [\"Leadership scenarios\"],\n \"scored_at\": \"2026-04-01T10:00:00Z\"\n}\n```\n",
"readOnly": true
},
"create_pdf_application": {
"type": "boolean",
"writeOnly": true
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
},
"average_rating": {
"type": "number",
"format": "float",
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
},
"tags": {
"type": "array",
"items": {},
"description": "A list of tags assigned to the application.\nExample: `[{\"context\": \"custom_green\", \"name\": \"Celery\"}, {\"context\": \"rejection\", \"name\": \"Availability\"}]`\n. This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
},
"days_in_current_stage": {
"type": "integer",
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
}
},
"additionalProperties": false
},
"applications_attributes_post": {
"type": "object",
"description": "Application post attributes",
"properties": {
"external_system_reference": {
"type": "string",
"description": "Used to store the ID or reference from an external system that the record was created from."
},
"hired_at": {
"type": "string",
"format": "date-time"
},
"locale": {
"type": "string"
},
"phone_iso2": {
"type": "string"
},
"start_on": {
"type": "string",
"format": "date"
},
"equality_monitoring_option_ids": {
"type": "array",
"items": {},
"writeOnly": true
},
"skip_notifications_on_create": {
"type": "boolean",
"writeOnly": true
},
"is_demo": {
"type": "boolean"
},
"add_tag_with_context": {
"type": "object",
"additionalProperties": true,
"writeOnly": true
},
"add_tags_with_context": {
"type": "array",
"items": {},
"description": "Add multiple **tags** at once\nExample: `[{\"tag\": \"Celery\", \"context\": \"custom_green\"}, {\"tag\": \"Availability\", \"context\": \"rejection\"}]`",
"writeOnly": true
},
"remove_tag_with_context": {
"type": "object",
"additionalProperties": true,
"writeOnly": true
},
"cv_base64_data": {
"type": "string",
"writeOnly": true
},
"cv_base64_filename": {
"type": "string",
"writeOnly": true
},
"cover_letter_base64_data": {
"type": "string",
"description": "Base64-encoded cover letter file content, including the data URI prefix (e.g. `data:application/pdf;base64,...`).",
"writeOnly": true
},
"cover_letter_base64_filename": {
"type": "string",
"description": "Original filename for the cover letter, e.g. `cover_letter.pdf`. Accepted file types: `pdf`, `doc`, `docx`, `txt`, `rtf`. Maximum file size: **30 MB**.",
"writeOnly": true
},
"documents_base64": {
"type": "array",
"items": {},
"description": "Array of documents to attach. Each item must be an object with the following fields:\n\n```\n[\n {\n \"data\": \"[Base64 encoded file content, including data URI prefix]\",\n \"filename\": \"[Original filename, e.g. report.pdf]\"\n }\n]\n```\n\nAccepted file types: `pdf`, `doc`, `docx`, `png`, `jpeg`, `xls`, `xlsx`, `pptx`, `mp4`, `mov`, `txt`.\nMaximum file size: **10 MB** per file.\n",
"writeOnly": true
},
"cv_signed_id": {
"type": "string",
"writeOnly": true
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"preferred_name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"date_of_birth": {
"type": "string"
},
"linkedin_url": {
"type": "string"
},
"summary": {
"type": "string"
},
"preferred_pronouns": {
"type": "string"
},
"channel_source": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string",
"description": "Address line 2 for non-US addresses. Returns `null` for US addresses. Writing this attribute is not supported when `country` is `US`."
},
"town": {
"type": "string"
},
"state_province": {
"type": "string",
"description": "State or province for US addresses. Returns `null` for non-US addresses. Writing this attribute is only supported when `country` is `US`."
},
"postcode": {
"type": "string"
},
"country": {
"type": "string"
},
"channel": {
"type": "string"
},
"create_pdf_application": {
"type": "boolean",
"writeOnly": true
}
},
"additionalProperties": false
},
"applications_relationships": {
"type": "object",
"properties": {
"job": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "jobs",
"enum": [
"jobs"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"job_posting": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "job_postings",
"enum": [
"job_postings"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"stage": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "stages",
"enum": [
"stages"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"furthest_stage": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "stages",
"enum": [
"stages"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"candidate": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "candidates",
"enum": [
"candidates"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"hris_reference": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "hris_exports",
"enum": [
"hris_exports"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"onboarding_application": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "onboarding_applications",
"enum": [
"onboarding_applications"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"document_requests": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "document_requests",
"enum": [
"document_requests"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"offers": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "offers",
"enum": [
"offers"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"answers": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "answers",
"enum": [
"answers"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"custom_attributes": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "custom_attributes",
"enum": [
"custom_attributes"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"structured_section_responses": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "structured_section_responses",
"enum": [
"structured_section_responses"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"scorecard_ratings": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "scorecard_ratings",
"enum": [
"scorecard_ratings"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"scorecard_notes": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "scorecard_notes",
"enum": [
"scorecard_notes"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"scorecard_answers": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "scorecard_answers",
"enum": [
"scorecard_answers"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"user_scorecards": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "user_scorecards",
"enum": [
"user_scorecards"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"comments": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "comments",
"enum": [
"comments"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"resume": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "resumes",
"enum": [
"resumes"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"applications_relationships_post": {
"type": "object",
"properties": {
"job": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/jsonapi_relationship_applications_belongs_to_jobs_post"
}
}
},
"job_posting": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/jsonapi_relationship_applications_belongs_to_job_postings_post"
}
}
},
"stage": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/jsonapi_relationship_applications_belongs_to_stages_post"
}
}
},
"candidate": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/jsonapi_relationship_applications_belongs_to_candidates_post"
}
}
},
"answers": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/jsonapi_relationship_applications_has_many_answers_post"
}
}
},
"custom_attributes": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/jsonapi_relationship_applications_has_many_custom_attributes_post"
}
}
},
"structured_section_responses": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/jsonapi_relationship_applications_has_many_structured_section_responses_post"
}
}
},
"comments": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/jsonapi_relationship_applications_has_many_comments_post"
}
}
}
},
"additionalProperties": false
},
"jsonapi_relationship_applications_belongs_to_jobs_post": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"jobs"
]
},
"id": {
"type": "string"
}
},
"additionalProperties": false
},
"jsonapi_relationship_applications_belongs_to_job_postings_post": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"job_postings"
]
},
"id": {
"type": "string"
}
},
"additionalProperties": false
},
"jsonapi_relationship_applications_belongs_to_stages_post": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"stages"
]
},
"id": {
"type": "string"
}
},
"additionalProperties": false
},
"jsonapi_relationship_applications_belongs_to_candidates_post": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"candidates"
]
},
"id": {
"type": "string"
}
},
"additionalProperties": false
},
"jsonapi_relationship_applications_has_many_answers_post": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id",
"temp-id",
"method"
],
"properties": {
"type": {
"type": "string",
"enum": [
"answers"
]
},
"id": {
"type": "string",
"description": "Required for `update, destroy` methods"
},
"temp-id": {
"type": "string",
"description": "Required for `create` method"
},
"method": {
"type": "string",
"enum": [
"create"
]
}
},
"additionalProperties": false
},
"uniqueItems": true
},
"jsonapi_relationship_applications_has_many_custom_attributes_post": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id",
"temp-id",
"method"
],
"properties": {
"type": {
"type": "string",
"enum": [
"custom_attributes"
]
},
"id": {
"type": "string",
"description": "Required for `update, destroy` methods"
},
"temp-id": {
"type": "string",
"description": "Required for `create` method"
},
"method": {
"type": "string",
"enum": [
"create"
]
}
},
"additionalProperties": false
},
"uniqueItems": true
},
"jsonapi_relationship_applications_has_many_structured_section_responses_post": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id",
"temp-id",
"method"
],
"properties": {
"type": {
"type": "string",
"enum": [
"structured_section_responses"
]
},
"id": {
"type": "string",
"description": "Required for `update, destroy` methods"
},
"temp-id": {
"type": "string",
"description": "Required for `create` method"
},
"method": {
"type": "string",
"enum": [
"create"
]
}
},
"additionalProperties": false
},
"uniqueItems": true
},
"jsonapi_relationship_applications_has_many_comments_post": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id",
"temp-id",
"method"
],
"properties": {
"type": {
"type": "string",
"enum": [
"comments"
]
},
"id": {
"type": "string",
"description": "Required for `update, destroy` methods"
},
"temp-id": {
"type": "string",
"description": "Required for `create` method"
},
"method": {
"type": "string",
"enum": [
"create"
]
}
},
"additionalProperties": false
},
"uniqueItems": true
},
"applications_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"applications"
]
},
"attributes": {
"$ref": "#/components/schemas/applications"
},
"relationships": {
"$ref": "#/components/schemas/applications_relationships"
}
},
"additionalProperties": false
},
"applications_resource_post": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"applications"
]
},
"attributes": {
"$ref": "#/components/schemas/applications_attributes_post"
},
"relationships": {
"$ref": "#/components/schemas/applications_relationships_post"
}
},
"additionalProperties": false
},
"applications_single": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/applications_resource"
},
"included": {
"description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".",
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/jobs_resource"
},
{
"$ref": "#/components/schemas/job_postings_resource"
},
{
"$ref": "#/components/schemas/stages_resource"
},
{
"$ref": "#/components/schemas/candidates_resource"
},
{
"$ref": "#/components/schemas/hris_exports_resource"
},
{
"$ref": "#/components/schemas/onboarding_applications_resource"
},
{
"$ref": "#/components/schemas/document_requests_resource"
},
{
"$ref": "#/components/schemas/offers_resource"
},
{
"$ref": "#/components/schemas/answers_resource"
},
{
"$ref": "#/components/schemas/custom_attributes_resource"
},
{
"$ref": "#/components/schemas/structured_section_responses_resource"
},
{
"$ref": "#/components/schemas/scorecard_ratings_resource"
},
{
"$ref": "#/components/schemas/scorecard_notes_resource"
},
{
"$ref": "#/components/schemas/scorecard_answers_resource"
},
{
"$ref": "#/components/schemas/user_scorecards_resource"
},
{
"$ref": "#/components/schemas/comments_resource"
},
{
"$ref": "#/components/schemas/resumes_resource"
}
]
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_meta"
}
},
"additionalProperties": false
},
"applications_request_post": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/applications_resource_post"
},
"included": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"answers",
"custom_attributes",
"structured_section_responses",
"comments"
]
},
"id": {
"type": "string"
},
"temp-id": {
"type": "string"
},
"attributes": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/answers_attributes_post"
},
{
"$ref": "#/components/schemas/custom_attributes_attributes_post"
},
{
"$ref": "#/components/schemas/structured_section_responses_attributes_post"
},
{
"$ref": "#/components/schemas/comments_attributes_post"
}
]
}
}
}
}
}
},
"candidates": {
"type": "object",
"description": "Candidate attributes",
"properties": {
"date_of_birth": {
"type": "string",
"format": "date"
},
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"full_name": {
"type": "string",
"readOnly": true
},
"last_name": {
"type": "string"
},
"middle_name": {
"type": "string"
},
"preferred_name": {
"type": "string"
},
"blocked": {
"type": "boolean"
},
"locale": {
"type": "string"
},
"phone": {
"type": "string"
},
"phone_iso2": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string",
"description": "Address line 2 for non-US addresses. Returns `null` for US addresses. Writing this attribute is not supported when `country` is `US`."
},
"town": {
"type": "string"
},
"state_province": {
"type": "string",
"description": "State or province for US addresses. Returns `null` for non-US addresses. Writing this attribute is only supported when `country` is `US`."
},
"postcode": {
"type": "string"
},
"country": {
"type": "string"
},
"documents_base64": {
"type": "array",
"items": {},
"description": "Array of `{ data: [Base64], filename: [String] }`",
"writeOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"external_system_reference": {
"type": "string",
"description": "Used to store the ID or reference from an external system that the record was created from."
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
},
"tags": {
"type": "array",
"items": {},
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
}
},
"additionalProperties": false
},
"candidates_relationships": {
"type": "object",
"properties": {
"applications": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "applications",
"enum": [
"applications"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"hris_references": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "hris_exports",
"enum": [
"hris_exports"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"job_seekers": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "job_seekers",
"enum": [
"job_seekers"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"skills": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "skills",
"enum": [
"skills"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"custom_attributes": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "custom_attributes",
"enum": [
"custom_attributes"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"candidates_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"candidates"
]
},
"attributes": {
"$ref": "#/components/schemas/candidates"
},
"relationships": {
"$ref": "#/components/schemas/candidates_relationships"
}
},
"additionalProperties": false
},
"comments": {
"type": "object",
"description": "Comment attributes",
"properties": {
"body_text": {
"type": "string"
},
"category": {
"type": "string",
"writeOnly": true
},
"commentable_id": {
"type": "integer",
"readOnly": true
},
"commentable_type": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"private_comment": {
"type": "boolean",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"user_id": {
"type": "integer",
"readOnly": true
}
},
"additionalProperties": false
},
"comments_attributes_post": {
"type": "object",
"description": "Comment post attributes",
"properties": {
"body_text": {
"type": "string"
},
"category": {
"type": "string",
"writeOnly": true
}
},
"additionalProperties": false
},
"comments_relationships": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "users",
"enum": [
"users"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"commentable": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "applications",
"enum": [
"applications",
"job_seekers",
"candidates"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"comments_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"comments"
]
},
"attributes": {
"$ref": "#/components/schemas/comments"
},
"relationships": {
"$ref": "#/components/schemas/comments_relationships"
}
},
"additionalProperties": false
},
"custom_attributes": {
"type": "object",
"description": "Custom Attribute attributes",
"properties": {
"value": {
"type": "string",
"readOnly": true
},
"field_name": {
"type": "string",
"readOnly": true
},
"option_value": {
"type": "string",
"readOnly": true
},
"option_label": {
"type": "string",
"readOnly": true
},
"custom_attributable_id": {
"type": "integer",
"writeOnly": true
},
"custom_attributable_type": {
"type": "string",
"writeOnly": true
},
"custom_field_id": {
"type": "integer",
"writeOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"boolean_value": {
"type": "boolean",
"writeOnly": true
},
"date_value": {
"type": "string",
"format": "date",
"writeOnly": true
},
"decimal_value": {
"type": "string",
"format": "decimal",
"writeOnly": true
},
"integer_value": {
"type": "integer",
"writeOnly": true
},
"multi_select_value": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
}
]
},
"writeOnly": true
},
"single_select_value": {
"type": "string",
"writeOnly": true
},
"text_value": {
"type": "string",
"writeOnly": true
},
"users_value": {
"type": "array",
"items": {},
"writeOnly": true
},
"varchar_value": {
"type": "string",
"writeOnly": true
}
},
"additionalProperties": false
},
"custom_attributes_attributes_post": {
"type": "object",
"description": "Custom Attribute post attributes",
"properties": {
"custom_attributable_id": {
"type": "integer",
"writeOnly": true
},
"custom_attributable_type": {
"type": "string",
"writeOnly": true
},
"custom_field_id": {
"type": "integer",
"writeOnly": true
},
"boolean_value": {
"type": "boolean",
"writeOnly": true
},
"date_value": {
"type": "string",
"format": "date",
"writeOnly": true
},
"decimal_value": {
"type": "string",
"format": "decimal",
"writeOnly": true
},
"integer_value": {
"type": "integer",
"writeOnly": true
},
"multi_select_value": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
}
]
},
"writeOnly": true
},
"single_select_value": {
"type": "string",
"writeOnly": true
},
"text_value": {
"type": "string",
"writeOnly": true
},
"users_value": {
"type": "array",
"items": {},
"writeOnly": true
},
"varchar_value": {
"type": "string",
"writeOnly": true
}
},
"additionalProperties": false
},
"custom_attributes_relationships": {
"type": "object",
"properties": {
"custom_field": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "custom_fields",
"enum": [
"custom_fields"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"custom_attributable": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "applications",
"enum": [
"applications",
"candidates",
"jobs",
"job_seekers",
"job_templates",
"offers",
"positions"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"custom_attributes_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"custom_attributes"
]
},
"attributes": {
"$ref": "#/components/schemas/custom_attributes"
},
"relationships": {
"$ref": "#/components/schemas/custom_attributes_relationships"
}
},
"additionalProperties": false
},
"document_requests": {
"type": "object",
"description": "Document Request attributes",
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"status": {
"type": "string",
"readOnly": true
},
"sent_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
}
},
"additionalProperties": false
},
"document_requests_relationships": {
"type": "object",
"properties": {
"answers": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "answers",
"enum": [
"answers"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"document_requests_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"document_requests"
]
},
"attributes": {
"$ref": "#/components/schemas/document_requests"
},
"relationships": {
"$ref": "#/components/schemas/document_requests_relationships"
}
},
"additionalProperties": false
},
"hris_exports": {
"type": "object",
"description": "Hris Export attributes",
"properties": {
"exportable_type": {
"type": "string",
"writeOnly": true
},
"hris_reference": {
"type": "string",
"readOnly": true
},
"hris_system": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"additionalProperties": false
},
"hris_exports_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"hris_exports"
]
},
"attributes": {
"$ref": "#/components/schemas/hris_exports"
}
},
"additionalProperties": false
},
"job_postings": {
"type": "object",
"description": "Job Posting attributes",
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"application_form_url": {
"type": "string",
"readOnly": true
},
"benefits": {
"type": "string",
"readOnly": true
},
"benefits_header": {
"type": "string",
"readOnly": true
},
"compensation": {
"type": "string",
"readOnly": true
},
"compensation_minimum": {
"type": "number",
"format": "float",
"readOnly": true
},
"compensation_maximum": {
"type": "number",
"format": "float",
"readOnly": true
},
"compensation_currency": {
"type": "string",
"readOnly": true
},
"compensation_frequency": {
"type": "string",
"readOnly": true
},
"compensation_visible": {
"type": "boolean",
"readOnly": true
},
"default_for_job": {
"type": "boolean",
"description": "True for the posting Pinpoint keeps in step with the job itself. Any other posting on the job is an additional one, created to advertise the same job differently.",
"readOnly": true
},
"deadline_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string",
"readOnly": true
},
"employment_type": {
"type": "string",
"readOnly": true
},
"employment_type_text": {
"type": "string",
"readOnly": true
},
"key_responsibilities": {
"type": "string",
"readOnly": true
},
"key_responsibilities_header": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "The internal label for this posting, shown to your team rather than to candidates.",
"readOnly": true
},
"reporting_to": {
"type": "string",
"readOnly": true
},
"skills_knowledge_expertise": {
"type": "string",
"readOnly": true
},
"skills_knowledge_expertise_header": {
"type": "string",
"readOnly": true
},
"status": {
"type": "string",
"readOnly": true
},
"title": {
"type": "string",
"readOnly": true
},
"url": {
"type": "string",
"readOnly": true
},
"path": {
"type": "string",
"readOnly": true
},
"workplace_type": {
"type": "string",
"readOnly": true
},
"workplace_type_text": {
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"job_postings_relationships": {
"type": "object",
"properties": {
"job": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "jobs",
"enum": [
"jobs"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"location": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "locations",
"enum": [
"locations"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"job_postings_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"job_postings"
]
},
"attributes": {
"$ref": "#/components/schemas/job_postings"
},
"relationships": {
"$ref": "#/components/schemas/job_postings_relationships"
}
},
"additionalProperties": false
},
"jobs": {
"type": "object",
"description": "Job attributes",
"properties": {
"ask_for_address": {
"type": "boolean"
},
"ask_for_date_of_birth": {
"type": "boolean"
},
"ask_for_linkedin_profile": {
"type": "boolean"
},
"ask_for_middle_name": {
"type": "boolean"
},
"cover_letter_requirement": {
"type": "string"
},
"personal_summary_requirement": {
"type": "string"
},
"require_phone": {
"type": "boolean"
},
"resume_requirement": {
"type": "string"
},
"title": {
"type": "string"
},
"benefits": {
"type": "string"
},
"description": {
"type": "string"
},
"skills_knowledge_expertise": {
"type": "string"
},
"key_responsibilities": {
"type": "string"
},
"reporting_to": {
"type": "string"
},
"external_key_responsibilities_header": {
"type": "string"
},
"key_responsibilities_header": {
"type": "string",
"readOnly": true
},
"external_benefits_header": {
"type": "string"
},
"benefits_header": {
"type": "string",
"readOnly": true
},
"external_skills_knowledge_expertise_header": {
"type": "string"
},
"skills_knowledge_expertise_header": {
"type": "string",
"readOnly": true
},
"about_company_theme_section_header": {
"type": "string",
"readOnly": true
},
"about_company_theme_section": {
"type": "string",
"readOnly": true
},
"compensation": {
"type": "string"
},
"compensation_minimum": {
"type": "number",
"format": "float"
},
"compensation_maximum": {
"type": "number",
"format": "float"
},
"compensation_currency": {
"type": "string"
},
"compensation_frequency": {
"type": "string"
},
"is_compensation_visible": {
"type": "boolean"
},
"compensation_visible": {
"type": "boolean",
"readOnly": true
},
"country_code": {
"type": "string",
"readOnly": true
},
"uuid": {
"type": "string",
"description": "A stable UUID for this job. Safe to share with third-party integrations as a unique job identifier.",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"deadline_on": {
"type": "string",
"format": "date"
},
"external_system_reference": {
"type": "string",
"description": "Used to store the ID or reference from an external system that the record was created from."
},
"deadline_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"opened_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"draft_job_additional_information": {
"type": "string"
},
"requisition_id": {
"type": "string"
},
"closed_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"filled_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"on_hold_in_seconds": {
"type": "integer",
"readOnly": true
},
"blind_screening": {
"type": "boolean"
},
"diversity_monitoring": {
"type": "boolean"
},
"diversity_monitoring_requirement": {
"type": "string",
"readOnly": true
},
"employment_type": {
"type": "string"
},
"employment_type_text": {
"type": "string",
"readOnly": true
},
"headcount_maximum_enabled": {
"type": "boolean"
},
"headcount_maximum": {
"type": "integer"
},
"notify": {
"type": "boolean"
},
"workplace_type": {
"type": "string"
},
"workplace_type_text": {
"type": "string",
"readOnly": true
},
"visibility": {
"type": "string"
},
"status": {
"type": "string"
},
"application_form_url": {
"type": "string",
"readOnly": true
},
"url": {
"type": "string",
"readOnly": true
},
"path": {
"type": "string",
"readOnly": true
},
"referrals_enabled": {
"type": "boolean"
},
"referral_amount": {
"type": "number",
"format": "float"
},
"referral_currency": {
"type": "string"
},
"referral_details": {
"type": "string"
},
"monster": {
"type": "boolean"
},
"talentdotcom": {
"type": "boolean"
},
"ziprecruiter": {
"type": "boolean"
},
"linkedin": {
"type": "boolean"
},
"experience_level": {
"type": "string"
},
"linkedin_company_id": {
"type": "string"
},
"is_remote_with_location_restrictions": {
"type": "boolean"
},
"custom_town": {
"type": "string"
},
"custom_county": {
"type": "string"
},
"custom_country": {
"type": "string"
},
"company_name_override": {
"type": "string"
},
"remote": {
"type": "boolean",
"readOnly": true
},
"selected_hiring_workflow_id": {
"type": "string"
},
"hiring_manager_user_email": {
"type": "string",
"writeOnly": true
},
"recruitment_manager_user_email": {
"type": "string",
"writeOnly": true
},
"onboarding_process_id": {
"type": "integer",
"writeOnly": true
},
"hiring_user_id": {
"type": "string",
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
},
"recruitment_manager_user_id": {
"type": "string",
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
},
"assigned_onboarding_process_id": {
"type": "integer",
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
},
"assigned_onboarding_process_name": {
"type": "string",
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
},
"assigned_onboarding_candidate_owner_user_id": {
"type": "integer",
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
},
"assigned_onboarding_candidate_owner_user_email": {
"type": "string",
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
},
"users_emails_with_job_level_visibility": {
"type": "array",
"items": {},
"description": "**Reading (GET):** Returns the email addresses of all users who have visibility of this job at the job level (i.e. not through company-wide visibility).\n\n**Writing (POST/PUT):** Sets job visibility to exactly the list of emails provided. This is a **full replacement** — you must include every user who should have job level visibility, not just new additions.\n\n> ⚠️ **Any user whose email is omitted from the array will have their job level visibility removed.**. This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
}
},
"additionalProperties": false
},
"jobs_relationships": {
"type": "object",
"properties": {
"department": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "departments",
"enum": [
"departments"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"division": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "divisions",
"enum": [
"divisions"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"location": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "locations",
"enum": [
"locations"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"structure_custom_group_one": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "structure_custom_group_ones",
"enum": [
"structure_custom_group_ones"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"company": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "companies",
"enum": [
"companies"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"structure_link": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "structure_links",
"enum": [
"structure_links"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"hiring_manager_user": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "users",
"enum": [
"users"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"recruitment_manager_user": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "users",
"enum": [
"users"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"creator_user": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "users",
"enum": [
"users"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"applications": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "applications",
"enum": [
"applications"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"job_postings": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "job_postings",
"enum": [
"job_postings"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"questions": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "questions",
"enum": [
"questions"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"custom_attributes": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "custom_attributes",
"enum": [
"custom_attributes"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"stages": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "stages",
"enum": [
"stages"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"jobs_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"jobs"
]
},
"attributes": {
"$ref": "#/components/schemas/jobs"
},
"relationships": {
"$ref": "#/components/schemas/jobs_relationships"
}
},
"additionalProperties": false
},
"offers": {
"type": "object",
"description": "Offer attributes",
"properties": {
"application_id": {
"type": "integer",
"readOnly": true
},
"comment": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"creator_id": {
"type": "integer",
"readOnly": true
},
"expires_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"job_title": {
"type": "string",
"readOnly": true
},
"manager_id": {
"type": "integer",
"readOnly": true
},
"paid_days_off": {
"type": "string",
"readOnly": true
},
"result": {
"type": "string",
"readOnly": true
},
"result_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"salary_amount": {
"type": "number",
"format": "float",
"readOnly": true
},
"salary_currency": {
"type": "string",
"readOnly": true
},
"salary_period": {
"type": "string",
"readOnly": true
},
"sent_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"signature_type": {
"type": "string",
"readOnly": true
},
"stage_id": {
"type": "integer",
"readOnly": true
},
"start_on": {
"type": "string",
"format": "date",
"readOnly": true
},
"status": {
"type": "string",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"work_address": {
"type": "string",
"readOnly": true
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)",
"readOnly": true
}
},
"additionalProperties": false
},
"offers_relationships": {
"type": "object",
"properties": {
"creator": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "users",
"enum": [
"users"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"manager": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "users",
"enum": [
"users"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"stage": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "stages",
"enum": [
"stages"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"custom_attributes": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "custom_attributes",
"enum": [
"custom_attributes"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"offers_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"offers"
]
},
"attributes": {
"$ref": "#/components/schemas/offers"
},
"relationships": {
"$ref": "#/components/schemas/offers_relationships"
}
},
"additionalProperties": false
},
"onboarding_applications": {
"type": "object",
"description": "Onboarding Application attributes",
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"start_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"status": {
"type": "string",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"additionalProperties": false
},
"onboarding_applications_relationships": {
"type": "object",
"properties": {
"application": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "applications",
"enum": [
"applications"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"onboarding_answers": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "onboarding_answers",
"enum": [
"onboarding_answers"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"onboarding_applications_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"onboarding_applications"
]
},
"attributes": {
"$ref": "#/components/schemas/onboarding_applications"
},
"relationships": {
"$ref": "#/components/schemas/onboarding_applications_relationships"
}
},
"additionalProperties": false
},
"resumes": {
"type": "object",
"description": "Resume attributes",
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"additionalProperties": false
},
"resumes_relationships": {
"type": "object",
"properties": {
"employment_histories": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "employment_histories",
"enum": [
"employment_histories"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"education_histories": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "education_histories",
"enum": [
"education_histories"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"resumes_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"resumes"
]
},
"attributes": {
"$ref": "#/components/schemas/resumes"
},
"relationships": {
"$ref": "#/components/schemas/resumes_relationships"
}
},
"additionalProperties": false
},
"scorecard_answers": {
"type": "object",
"description": "Scorecard Answer attributes",
"properties": {
"question_id": {
"type": "integer",
"readOnly": true
},
"boolean_answer": {
"type": "boolean",
"readOnly": true
},
"text_answer": {
"type": "string",
"readOnly": true
},
"user_id": {
"type": "integer",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"additionalProperties": false
},
"scorecard_answers_relationships": {
"type": "object",
"properties": {
"question": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "questions",
"enum": [
"questions"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"user": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "users",
"enum": [
"users"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"user_scorecard": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "user_scorecards",
"enum": [
"user_scorecards"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"scorecard_answers_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"scorecard_answers"
]
},
"attributes": {
"$ref": "#/components/schemas/scorecard_answers"
},
"relationships": {
"$ref": "#/components/schemas/scorecard_answers_relationships"
}
},
"additionalProperties": false
},
"scorecard_notes": {
"type": "object",
"description": "Scorecard Note attributes",
"properties": {
"body": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"user_id": {
"type": "integer",
"readOnly": true
}
},
"additionalProperties": false
},
"scorecard_notes_relationships": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "users",
"enum": [
"users"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"user_scorecard": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "user_scorecards",
"enum": [
"user_scorecards"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"scorecard_notes_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"scorecard_notes"
]
},
"attributes": {
"$ref": "#/components/schemas/scorecard_notes"
},
"relationships": {
"$ref": "#/components/schemas/scorecard_notes_relationships"
}
},
"additionalProperties": false
},
"scorecard_ratings": {
"type": "object",
"description": "Scorecard Rating attributes",
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"score": {
"type": "integer",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"user_id": {
"type": "integer",
"readOnly": true
}
},
"additionalProperties": false
},
"scorecard_ratings_relationships": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "users",
"enum": [
"users"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"scorecard_option": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "scorecard_options",
"enum": [
"scorecard_options"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"user_scorecard": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "user_scorecards",
"enum": [
"user_scorecards"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"scorecard_ratings_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"scorecard_ratings"
]
},
"attributes": {
"$ref": "#/components/schemas/scorecard_ratings"
},
"relationships": {
"$ref": "#/components/schemas/scorecard_ratings_relationships"
}
},
"additionalProperties": false
},
"stages": {
"type": "object",
"description": "Stage attributes",
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"external_system_reference": {
"type": "string",
"description": "Used to store the ID or reference from an external system that the record was created from.",
"readOnly": true
},
"external_name": {
"type": "string",
"readOnly": true
},
"description": {
"type": "string",
"readOnly": true
},
"visible": {
"type": "boolean",
"readOnly": true
},
"position": {
"type": "integer",
"readOnly": true
},
"basic_type": {
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"stages_relationships": {
"type": "object",
"properties": {
"stageable": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "jobs",
"enum": [
"jobs",
"hiring_workflows"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"applications": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "applications",
"enum": [
"applications"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"stages_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"stages"
]
},
"attributes": {
"$ref": "#/components/schemas/stages"
},
"relationships": {
"$ref": "#/components/schemas/stages_relationships"
}
},
"additionalProperties": false
},
"structured_section_responses": {
"type": "object",
"description": "Structured Section Response attributes",
"properties": {
"date_from_answer": {
"type": "string",
"format": "date",
"readOnly": true
},
"date_to_answer": {
"type": "string",
"format": "date",
"readOnly": true
},
"position": {
"type": "integer",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"additionalProperties": false
},
"structured_section_responses_attributes_post": {
"type": "object",
"description": "Structured Section Response post attributes",
"additionalProperties": false
},
"structured_section_responses_relationships": {
"type": "object",
"properties": {
"answerable": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "applications",
"enum": [
"applications",
"job_seekers"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"answers": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "answers",
"enum": [
"answers"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"structured_section": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "structured_sections",
"enum": [
"structured_sections"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"structured_section_responses_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"structured_section_responses"
]
},
"attributes": {
"$ref": "#/components/schemas/structured_section_responses"
},
"relationships": {
"$ref": "#/components/schemas/structured_section_responses_relationships"
}
},
"additionalProperties": false
},
"user_scorecards": {
"type": "object",
"description": "User Scorecard attributes",
"properties": {
"completed_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"locked": {
"type": "boolean",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"sentiment": {
"type": "string",
"readOnly": true
},
"status": {
"type": "string",
"readOnly": true
},
"summary": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"additionalProperties": false
},
"user_scorecards_relationships": {
"type": "object",
"properties": {
"scorecard": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "scorecards",
"enum": [
"scorecards"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"user": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "users",
"enum": [
"users"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"scorecard_note": {
"type": "object",
"properties": {
"data": {
"description": "References to other resource objects in a to-one (\"relationship\").",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "scorecard_notes",
"enum": [
"scorecard_notes"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"scorecard_answers": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "scorecard_answers",
"enum": [
"scorecard_answers"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
},
"scorecard_ratings": {
"type": "object",
"properties": {
"data": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"type": "array",
"items": {
"description": "The \"type\" and \"id\" to non-empty members.",
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "scorecard_ratings",
"enum": [
"scorecard_ratings"
]
},
"id": {
"type": "string",
"example": "1"
}
}
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_metaResource"
}
}
}
},
"additionalProperties": false
},
"user_scorecards_resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "1"
},
"type": {
"type": "string",
"enum": [
"user_scorecards"
]
},
"attributes": {
"$ref": "#/components/schemas/user_scorecards"
},
"relationships": {
"$ref": "#/components/schemas/user_scorecards_relationships"
}
},
"additionalProperties": false
},
"jsonapi_failure": {
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_error"
},
"uniqueItems": true
},
"meta": {
"$ref": "#/components/schemas/jsonapi_meta"
},
"jsonapi": {
"$ref": "#/components/schemas/jsonapi_jsonapi"
},
"links": {
"$ref": "#/components/schemas/jsonapi_links"
}
},
"additionalProperties": false
},
"jsonapi_meta": {
"description": "Non-standard meta-information that can not be represented as an attribute or relationship.",
"type": "object",
"additionalProperties": true
},
"jsonapi_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/jsonapi_link"
}
},
"jsonapi_link": {
"description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.",
"oneOf": [
{
"description": "A string containing the link's URL.",
"type": "string",
"format": "uri-reference"
},
{
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "A string containing the link's URL.",
"type": "string",
"format": "uri-reference"
},
"meta": {
"$ref": "#/components/schemas/jsonapi_meta"
}
}
}
]
},
"jsonapi_jsonapi": {
"description": "An object describing the server's implementation",
"type": "object",
"properties": {
"version": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/jsonapi_meta"
}
},
"additionalProperties": false
},
"jsonapi_error": {
"type": "object",
"properties": {
"links": {
"$ref": "#/components/schemas/jsonapi_links"
},
"status": {
"description": "The HTTP status code applicable to this problem, expressed as a string value.",
"type": "string"
},
"code": {
"description": "An application-specific error code, expressed as a string value.",
"type": "string"
},
"title": {
"description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.",
"type": "string"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.",
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].",
"type": "string"
},
"parameter": {
"description": "A string indicating which query parameter caused the error.",
"type": "string"
}
}
},
"meta": {
"$ref": "#/components/schemas/jsonapi_meta"
}
},
"additionalProperties": false
},
"jsonapi_metaResource": {
"description": "Non-standard meta-information that can not be represented as an attribute or relationship.",
"type": "object",
"additionalProperties": false,
"properties": {
"included": {
"enum": [
false
]
}
}
}
},
"requestBodies": {
"applications_post": {
"required": true,
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/applications_request_post"
},
"examples": {
"basic": {
"$ref": "#/components/examples/jsonapi_applications_post"
}
}
}
}
}
},
"examples": {
"jsonapi_applications_single": {
"value": {
"data": {
"id": "1",
"type": "applications",
"attributes": {
"uuid": "string",
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00",
"candidate_id": "1",
"external_system_reference": "string",
"hired_at": "2019-01-01T00:00:00+00:00",
"internal_candidate": true,
"job_id": "1",
"job_posting_id": "1",
"locale": "string",
"stage_id": "1",
"rejected_at": "2019-01-01T00:00:00+00:00",
"phone_iso2": "string",
"start_on": "2025-04-30",
"is_demo": true,
"first_name": "string",
"last_name": "string",
"preferred_name": "string",
"email": "string",
"phone": "string",
"date_of_birth": "string",
"linkedin_url": "string",
"summary": "string",
"preferred_pronouns": "string",
"channel_source": "string",
"address1": "string",
"address2": "string",
"town": "string",
"state_province": "string",
"postcode": "string",
"country": "string",
"country_code": "string",
"country_code_alpha3": "string",
"country_name": "string",
"full_name": "string",
"national_identifier": "string",
"channel": "string",
"concealed": true,
"ai_score": {},
"attachments": [],
"average_rating": 4.33,
"tags": [],
"days_in_current_stage": 0
},
"relationships": {
"job": {
"data": {
"type": "jobs",
"id": "1"
}
},
"job_posting": {
"data": {
"type": "job_postings",
"id": "1"
}
},
"stage": {
"data": {
"type": "stages",
"id": "1"
}
},
"furthest_stage": {
"data": {
"type": "stages",
"id": "1"
}
},
"candidate": {
"data": {
"type": "candidates",
"id": "1"
}
},
"hris_reference": {
"data": {
"type": "hris_exports",
"id": "1"
}
},
"onboarding_application": {
"data": {
"type": "onboarding_applications",
"id": "1"
}
},
"document_requests": {
"data": [
{
"type": "document_requests",
"id": "1"
}
]
},
"offers": {
"data": [
{
"type": "offers",
"id": "1"
}
]
},
"answers": {
"data": [
{
"type": "answers",
"id": "1"
}
]
},
"custom_attributes": {
"data": [
{
"type": "custom_attributes",
"id": "1"
}
]
},
"structured_section_responses": {
"data": [
{
"type": "structured_section_responses",
"id": "1"
}
]
},
"scorecard_ratings": {
"data": [
{
"type": "scorecard_ratings",
"id": "1"
}
]
},
"scorecard_notes": {
"data": [
{
"type": "scorecard_notes",
"id": "1"
}
]
},
"scorecard_answers": {
"data": [
{
"type": "scorecard_answers",
"id": "1"
}
]
},
"user_scorecards": {
"data": [
{
"type": "user_scorecards",
"id": "1"
}
]
},
"comments": {
"data": [
{
"type": "comments",
"id": "1"
}
]
},
"resume": {
"data": {
"type": "resumes",
"id": "1"
}
}
}
},
"included": [
{
"id": "1",
"type": "jobs",
"attributes": {
"ask_for_address": true,
"ask_for_date_of_birth": true,
"ask_for_linkedin_profile": true,
"ask_for_middle_name": true,
"cover_letter_requirement": "string",
"personal_summary_requirement": "string",
"require_phone": true,
"resume_requirement": "string",
"title": "string",
"benefits": "string",
"description": "string",
"skills_knowledge_expertise": "string",
"key_responsibilities": "string",
"reporting_to": "string",
"external_key_responsibilities_header": "string",
"key_responsibilities_header": "string",
"external_benefits_header": "string",
"benefits_header": "string",
"external_skills_knowledge_expertise_header": "string",
"skills_knowledge_expertise_header": "string",
"about_company_theme_section_header": "string",
"about_company_theme_section": "string",
"compensation": "string",
"compensation_minimum": 4.33,
"compensation_maximum": 4.33,
"compensation_currency": "string",
"compensation_frequency": "string",
"is_compensation_visible": true,
"compensation_visible": true,
"country_code": "string",
"uuid": "string",
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00",
"deadline_on": "2025-04-30",
"external_system_reference": "string",
"deadline_at": "2019-01-01T00:00:00+00:00",
"opened_at": "2019-01-01T00:00:00+00:00",
"draft_job_additional_information": "string",
"requisition_id": "string",
"closed_at": "2019-01-01T00:00:00+00:00",
"filled_at": "2019-01-01T00:00:00+00:00",
"on_hold_in_seconds": 0,
"blind_screening": true,
"diversity_monitoring": true,
"diversity_monitoring_requirement": "string",
"employment_type": "string",
"employment_type_text": "string",
"headcount_maximum_enabled": true,
"headcount_maximum": 0,
"notify": true,
"workplace_type": "string",
"workplace_type_text": "string",
"visibility": "string",
"status": "string",
"application_form_url": "string",
"url": "string",
"path": "string",
"referrals_enabled": true,
"referral_amount": 4.33,
"referral_currency": "string",
"referral_details": "string",
"monster": true,
"talentdotcom": true,
"ziprecruiter": true,
"linkedin": true,
"experience_level": "string",
"linkedin_company_id": "string",
"is_remote_with_location_restrictions": true,
"custom_town": "string",
"custom_county": "string",
"custom_country": "string",
"company_name_override": "string",
"remote": true,
"selected_hiring_workflow_id": "string",
"hiring_user_id": "string",
"recruitment_manager_user_id": "string",
"assigned_onboarding_process_id": "1",
"assigned_onboarding_process_name": "string",
"assigned_onboarding_candidate_owner_user_id": "1",
"assigned_onboarding_candidate_owner_user_email": "string",
"users_emails_with_job_level_visibility": []
},
"relationships": {
"department": {
"meta": {
"included": false
}
},
"division": {
"meta": {
"included": false
}
},
"location": {
"meta": {
"included": false
}
},
"structure_custom_group_one": {
"meta": {
"included": false
}
},
"company": {
"meta": {
"included": false
}
},
"structure_link": {
"meta": {
"included": false
}
},
"hiring_manager_user": {
"meta": {
"included": false
}
},
"recruitment_manager_user": {
"meta": {
"included": false
}
},
"creator_user": {
"meta": {
"included": false
}
},
"applications": {
"meta": {
"included": false
}
},
"job_postings": {
"meta": {
"included": false
}
},
"questions": {
"meta": {
"included": false
}
},
"custom_attributes": {
"meta": {
"included": false
}
},
"stages": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "job_postings",
"attributes": {
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00",
"application_form_url": "string",
"benefits": "string",
"benefits_header": "string",
"compensation": "string",
"compensation_minimum": 4.33,
"compensation_maximum": 4.33,
"compensation_currency": "string",
"compensation_frequency": "string",
"compensation_visible": true,
"default_for_job": true,
"deadline_at": "2019-01-01T00:00:00+00:00",
"description": "string",
"employment_type": "string",
"employment_type_text": "string",
"key_responsibilities": "string",
"key_responsibilities_header": "string",
"name": "string",
"reporting_to": "string",
"skills_knowledge_expertise": "string",
"skills_knowledge_expertise_header": "string",
"status": "string",
"title": "string",
"url": "string",
"path": "string",
"workplace_type": "string",
"workplace_type_text": "string"
},
"relationships": {
"job": {
"meta": {
"included": false
}
},
"location": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "stages",
"attributes": {
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00",
"name": "string",
"external_system_reference": "string",
"external_name": "string",
"description": "string",
"visible": true,
"position": 0,
"basic_type": "string"
},
"relationships": {
"stageable": {
"meta": {
"included": false
}
},
"applications": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "stages",
"attributes": {
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00",
"name": "string",
"external_system_reference": "string",
"external_name": "string",
"description": "string",
"visible": true,
"position": 0,
"basic_type": "string"
},
"relationships": {
"stageable": {
"meta": {
"included": false
}
},
"applications": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "candidates",
"attributes": {
"date_of_birth": "2025-04-30",
"email": "string",
"first_name": "string",
"full_name": "string",
"last_name": "string",
"middle_name": "string",
"preferred_name": "string",
"blocked": true,
"locale": "string",
"phone": "string",
"phone_iso2": "string",
"address1": "string",
"address2": "string",
"town": "string",
"state_province": "string",
"postcode": "string",
"country": "string",
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00",
"external_system_reference": "string",
"attachments": [],
"tags": []
},
"relationships": {
"applications": {
"meta": {
"included": false
}
},
"hris_references": {
"meta": {
"included": false
}
},
"job_seekers": {
"meta": {
"included": false
}
},
"skills": {
"meta": {
"included": false
}
},
"custom_attributes": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "hris_exports",
"attributes": {
"hris_reference": "string",
"hris_system": "string",
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00"
}
},
{
"id": "1",
"type": "onboarding_applications",
"attributes": {
"created_at": "2019-01-01T00:00:00+00:00",
"start_at": "2019-01-01T00:00:00+00:00",
"status": "string",
"updated_at": "2019-01-01T00:00:00+00:00"
},
"relationships": {
"application": {
"meta": {
"included": false
}
},
"onboarding_answers": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "document_requests",
"attributes": {
"created_at": "2019-01-01T00:00:00+00:00",
"status": "string",
"sent_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00",
"attachments": []
},
"relationships": {
"answers": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "offers",
"attributes": {
"application_id": "1",
"comment": "string",
"created_at": "2019-01-01T00:00:00+00:00",
"creator_id": "1",
"expires_at": "2019-01-01T00:00:00+00:00",
"job_title": "string",
"manager_id": "1",
"paid_days_off": "string",
"result": "string",
"result_at": "2019-01-01T00:00:00+00:00",
"salary_amount": 4.33,
"salary_currency": "string",
"salary_period": "string",
"sent_at": "2019-01-01T00:00:00+00:00",
"signature_type": "string",
"stage_id": "1",
"start_on": "2025-04-30",
"status": "string",
"updated_at": "2019-01-01T00:00:00+00:00",
"work_address": "string",
"attachments": []
},
"relationships": {
"creator": {
"meta": {
"included": false
}
},
"manager": {
"meta": {
"included": false
}
},
"stage": {
"meta": {
"included": false
}
},
"custom_attributes": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "answers",
"attributes": {
"title": "string",
"additional_information": "string",
"boolean_answer": true,
"number_answer": 0.777777777,
"document_answer": {},
"question_type": "string",
"date_answer": "2025-04-30",
"url_answer": "string",
"date_from_answer": "2025-04-30",
"date_to_answer": "2025-04-30",
"multiple_choice_answer": [
"string"
],
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00",
"text_answer": "string",
"attachments": []
},
"relationships": {
"answer_options": {
"meta": {
"included": false
}
},
"question": {
"meta": {
"included": false
}
},
"answerable": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "custom_attributes",
"attributes": {
"value": "string",
"field_name": "string",
"option_value": "string",
"option_label": "string",
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00"
},
"relationships": {
"custom_field": {
"meta": {
"included": false
}
},
"custom_attributable": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "structured_section_responses",
"attributes": {
"date_from_answer": "2025-04-30",
"date_to_answer": "2025-04-30",
"position": 0,
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00"
},
"relationships": {
"answerable": {
"meta": {
"included": false
}
},
"answers": {
"meta": {
"included": false
}
},
"structured_section": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "scorecard_ratings",
"attributes": {
"created_at": "2019-01-01T00:00:00+00:00",
"score": 0,
"updated_at": "2019-01-01T00:00:00+00:00",
"user_id": "1"
},
"relationships": {
"user": {
"meta": {
"included": false
}
},
"scorecard_option": {
"meta": {
"included": false
}
},
"user_scorecard": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "scorecard_notes",
"attributes": {
"body": "string",
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00",
"user_id": "1"
},
"relationships": {
"user": {
"meta": {
"included": false
}
},
"user_scorecard": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "scorecard_answers",
"attributes": {
"question_id": "1",
"boolean_answer": true,
"text_answer": "string",
"user_id": "1",
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00"
},
"relationships": {
"question": {
"meta": {
"included": false
}
},
"user": {
"meta": {
"included": false
}
},
"user_scorecard": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "user_scorecards",
"attributes": {
"completed_at": "2019-01-01T00:00:00+00:00",
"locked": true,
"name": "string",
"sentiment": "string",
"status": "string",
"summary": "string",
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00"
},
"relationships": {
"scorecard": {
"meta": {
"included": false
}
},
"user": {
"meta": {
"included": false
}
},
"scorecard_note": {
"meta": {
"included": false
}
},
"scorecard_answers": {
"meta": {
"included": false
}
},
"scorecard_ratings": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "comments",
"attributes": {
"body_text": "string",
"commentable_id": "1",
"commentable_type": "string",
"created_at": "2019-01-01T00:00:00+00:00",
"private_comment": true,
"updated_at": "2019-01-01T00:00:00+00:00",
"user_id": "1"
},
"relationships": {
"user": {
"meta": {
"included": false
}
},
"commentable": {
"meta": {
"included": false
}
}
}
},
{
"id": "1",
"type": "resumes",
"attributes": {
"created_at": "2019-01-01T00:00:00+00:00",
"updated_at": "2019-01-01T00:00:00+00:00"
},
"relationships": {
"employment_histories": {
"meta": {
"included": false
}
},
"education_histories": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
},
"jsonapi_applications_post": {
"value": {
"data": {
"type": "applications",
"attributes": {
"external_system_reference": "string",
"hired_at": "2019-01-01T00:00:00+00:00",
"locale": "string",
"phone_iso2": "string",
"start_on": "2025-04-30",
"equality_monitoring_option_ids": [],
"skip_notifications_on_create": true,
"is_demo": true,
"add_tag_with_context": {},
"add_tags_with_context": [],
"remove_tag_with_context": {},
"cv_base64_data": "string",
"cv_base64_filename": "string",
"cover_letter_base64_data": "string",
"cover_letter_base64_filename": "string",
"documents_base64": [],
"cv_signed_id": "string",
"first_name": "string",
"last_name": "string",
"preferred_name": "string",
"email": "string",
"phone": "string",
"date_of_birth": "string",
"linkedin_url": "string",
"summary": "string",
"preferred_pronouns": "string",
"channel_source": "string",
"address1": "string",
"address2": "string",
"town": "string",
"state_province": "string",
"postcode": "string",
"country": "string",
"channel": "string",
"create_pdf_application": true
},
"relationships": {
"job": {
"data": {
"id": "1",
"type": "jobs"
}
},
"job_posting": {
"data": {
"id": "1",
"type": "job_postings"
}
},
"stage": {
"data": {
"id": "1",
"type": "stages"
}
},
"candidate": {
"data": {
"id": "1",
"type": "candidates"
}
},
"answers": {
"data": [
{
"type": "answers",
"temp-id": "temp-1",
"method": "create"
}
]
},
"custom_attributes": {
"data": [
{
"type": "custom_attributes",
"temp-id": "temp-1",
"method": "create"
}
]
},
"structured_section_responses": {
"data": [
{
"type": "structured_section_responses",
"temp-id": "temp-1",
"method": "create"
}
]
},
"comments": {
"data": [
{
"type": "comments",
"temp-id": "temp-1",
"method": "create"
}
]
}
}
},
"included": [
{
"type": "answers",
"temp-id": "temp-1",
"attributes": {}
},
{
"type": "custom_attributes",
"temp-id": "temp-1",
"attributes": {}
},
{
"type": "structured_section_responses",
"temp-id": "temp-1",
"attributes": {}
},
{
"type": "comments",
"temp-id": "temp-1",
"attributes": {}
}
]
}
}
},
"links": {
"get-application-id": {
"operationId": "get-application",
"parameters": {
"id": "$response.body#/data/id"
}
},
"update-application-id": {
"operationId": "update-application",
"parameters": {
"id": "$response.body#/data/id"
}
},
"delete-application-id": {
"operationId": "delete-application",
"parameters": {
"id": "$response.body#/data/id"
}
}
}
},
"paths": {
"/api/v1/applications": {
"post": {
"operationId": "post-applications",
"summary": "Create Application",
"tags": [
"Applications"
],
"responses": {
"201": {
"$ref": "#/components/responses/applications_201"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/applications_post"
}
}
}
},
"tags": [
{
"name": "Applications",
"description": "Applications operations"
}
]
}
````