---
updatedAt: 2026-10-05T11:23:49.000Z
agentTools:
projectIndex: https://developers.pinpointhq.com/llms.txt
---
# List Applications
### Job Visibility filter
> 📘 Confidential jobs
>
> This endpoint **doesn't return applications belonging to confidential jobs by default**.
If you want to include applications belonging to confidential jobs add `confidential` to `job_visibility` filter (`filter[job_visibility]`) alongside other visibility options.
Example: Use`filter[job_visibility]=confidential,external,internal,private_job`to get applications from jobs with any visibility.
### Candidate Phone filter
Use `filter[candidate_phone]` to filter applications by the candidate's phone number.
Phone numbers should be provided in E.164 format. When passing the value in a query string, URL-encode a leading `+` as `%2B`.
Example: `filter[candidate_phone]=%2B44000000000`
### Attachments
To include application attachments (e.g. CVs) in your response, use the extra\_fields parameter:
```
[https://your-subdomain.pinpointhq.com/api/v1/applications?extra_fields[applications]=attachments](https://your-subdomain.pinpointhq.com/api/v1/applications?extra_fields\[applications]=attachments)
```
This will return applications with their attachments.
**Note:** You must scope the extra field under applications:
:white\_check\_mark: `extra_fields[applications]=attachments`
:red\_circle: `extra_fields=attachments` (wrong)
```
```
### Parsed CV data (work and education history)
# 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"
}
]
}
}
}
}
}
},
"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_200_collection": {
"description": "OK: Applications collection",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/applications_collection"
},
"examples": {
"jsonapi": {
"$ref": "#/components/examples/jsonapi_applications_collection"
}
}
}
}
}
},
"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_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
},
"answers_readable_attribute": {
"description": "Answer readable attributes",
"type": "string",
"enum": [
"id",
"title",
"additional_information",
"boolean_answer",
"number_answer",
"document_answer",
"question_type",
"date_answer",
"url_answer",
"date_from_answer",
"date_to_answer",
"multiple_choice_answer",
"created_at",
"updated_at",
"text_answer"
]
},
"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_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_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_collection": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$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_readable_attribute": {
"description": "Application readable attributes",
"type": "string",
"enum": [
"id",
"uuid",
"created_at",
"updated_at",
"candidate_id",
"external_system_reference",
"hired_at",
"internal_candidate",
"job_id",
"job_posting_id",
"locale",
"stage_id",
"rejected_at",
"phone_iso2",
"start_on",
"is_demo",
"first_name",
"last_name",
"preferred_name",
"email",
"phone",
"date_of_birth",
"linkedin_url",
"summary",
"preferred_pronouns",
"channel_source",
"address1",
"address2",
"town",
"state_province",
"postcode",
"country",
"country_code",
"country_code_alpha3",
"country_name",
"full_name",
"national_identifier",
"channel",
"concealed",
"ai_score"
]
},
"applications_sortable_attributes_list": {
"description": "Application sortable attributes",
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"-id",
"created_at",
"-created_at",
"updated_at",
"-updated_at"
]
},
"uniqueItems": true
},
"applications_related": {
"description": "Application relationships available for inclusion",
"type": "array",
"items": {
"type": "string",
"enum": [
"job",
"job_posting",
"stage",
"furthest_stage",
"candidate",
"hris_reference",
"onboarding_application",
"document_requests",
"offers",
"answers",
"custom_attributes",
"structured_section_responses",
"scorecard_ratings",
"scorecard_notes",
"scorecard_answers",
"user_scorecards",
"comments",
"resume"
]
},
"uniqueItems": true
},
"applications_extra_fields": {
"description": "Application extra fields",
"type": "string",
"enum": [
"attachments",
"average_rating",
"tags",
"days_in_current_stage"
]
},
"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
},
"candidates_readable_attribute": {
"description": "Candidate readable attributes",
"type": "string",
"enum": [
"id",
"date_of_birth",
"email",
"first_name",
"full_name",
"last_name",
"middle_name",
"preferred_name",
"blocked",
"locale",
"phone",
"phone_iso2",
"address1",
"address2",
"town",
"state_province",
"postcode",
"country",
"created_at",
"updated_at",
"external_system_reference"
]
},
"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_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
},
"comments_readable_attribute": {
"description": "Comment readable attributes",
"type": "string",
"enum": [
"id",
"body_text",
"commentable_id",
"commentable_type",
"created_at",
"private_comment",
"updated_at",
"user_id"
]
},
"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_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
},
"custom_attributes_readable_attribute": {
"description": "Custom Attribute readable attributes",
"type": "string",
"enum": [
"id",
"value",
"field_name",
"option_value",
"option_label",
"created_at",
"updated_at"
]
},
"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
},
"document_requests_readable_attribute": {
"description": "Document Request readable attributes",
"type": "string",
"enum": [
"id",
"created_at",
"status",
"sent_at",
"updated_at"
]
},
"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
},
"hris_exports_readable_attribute": {
"description": "Hris Export readable attributes",
"type": "string",
"enum": [
"id",
"hris_reference",
"hris_system",
"created_at",
"updated_at"
]
},
"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
},
"job_postings_readable_attribute": {
"description": "Job Posting readable attributes",
"type": "string",
"enum": [
"id",
"created_at",
"updated_at",
"application_form_url",
"benefits",
"benefits_header",
"compensation",
"compensation_minimum",
"compensation_maximum",
"compensation_currency",
"compensation_frequency",
"compensation_visible",
"default_for_job",
"deadline_at",
"description",
"employment_type",
"employment_type_text",
"key_responsibilities",
"key_responsibilities_header",
"name",
"reporting_to",
"skills_knowledge_expertise",
"skills_knowledge_expertise_header",
"status",
"title",
"url",
"path",
"workplace_type",
"workplace_type_text"
]
},
"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
},
"jobs_readable_attribute": {
"description": "Job readable attributes",
"type": "string",
"enum": [
"id",
"ask_for_address",
"ask_for_date_of_birth",
"ask_for_linkedin_profile",
"ask_for_middle_name",
"cover_letter_requirement",
"personal_summary_requirement",
"require_phone",
"resume_requirement",
"title",
"benefits",
"description",
"skills_knowledge_expertise",
"key_responsibilities",
"reporting_to",
"external_key_responsibilities_header",
"key_responsibilities_header",
"external_benefits_header",
"benefits_header",
"external_skills_knowledge_expertise_header",
"skills_knowledge_expertise_header",
"about_company_theme_section_header",
"about_company_theme_section",
"compensation",
"compensation_minimum",
"compensation_maximum",
"compensation_currency",
"compensation_frequency",
"is_compensation_visible",
"compensation_visible",
"country_code",
"uuid",
"created_at",
"updated_at",
"deadline_on",
"external_system_reference",
"deadline_at",
"opened_at",
"draft_job_additional_information",
"requisition_id",
"closed_at",
"filled_at",
"on_hold_in_seconds",
"blind_screening",
"diversity_monitoring",
"diversity_monitoring_requirement",
"employment_type",
"employment_type_text",
"headcount_maximum_enabled",
"headcount_maximum",
"notify",
"workplace_type",
"workplace_type_text",
"visibility",
"status",
"application_form_url",
"url",
"path",
"referrals_enabled",
"referral_amount",
"referral_currency",
"referral_details",
"monster",
"talentdotcom",
"ziprecruiter",
"linkedin",
"experience_level",
"linkedin_company_id",
"is_remote_with_location_restrictions",
"custom_town",
"custom_county",
"custom_country",
"company_name_override",
"remote",
"selected_hiring_workflow_id"
]
},
"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
},
"offers_readable_attribute": {
"description": "Offer readable attributes",
"type": "string",
"enum": [
"id",
"application_id",
"comment",
"created_at",
"creator_id",
"expires_at",
"job_title",
"manager_id",
"paid_days_off",
"result",
"result_at",
"salary_amount",
"salary_currency",
"salary_period",
"sent_at",
"signature_type",
"stage_id",
"start_on",
"status",
"updated_at",
"work_address"
]
},
"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
},
"onboarding_applications_readable_attribute": {
"description": "Onboarding Application readable attributes",
"type": "string",
"enum": [
"id",
"created_at",
"start_at",
"status",
"updated_at"
]
},
"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
},
"resumes_readable_attribute": {
"description": "Resume readable attributes",
"type": "string",
"enum": [
"id",
"created_at",
"updated_at"
]
},
"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_answers_readable_attribute": {
"description": "Scorecard Answer readable attributes",
"type": "string",
"enum": [
"id",
"question_id",
"boolean_answer",
"text_answer",
"user_id",
"created_at",
"updated_at"
]
},
"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_notes_readable_attribute": {
"description": "Scorecard Note readable attributes",
"type": "string",
"enum": [
"id",
"body",
"created_at",
"updated_at",
"user_id"
]
},
"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
},
"scorecard_ratings_readable_attribute": {
"description": "Scorecard Rating readable attributes",
"type": "string",
"enum": [
"id",
"created_at",
"score",
"updated_at",
"user_id"
]
},
"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
},
"stages_readable_attribute": {
"description": "Stage readable attributes",
"type": "string",
"enum": [
"id",
"created_at",
"updated_at",
"name",
"external_system_reference",
"external_name",
"description",
"visible",
"position",
"basic_type"
]
},
"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_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
},
"structured_section_responses_readable_attribute": {
"description": "Structured Section Response readable attributes",
"type": "string",
"enum": [
"id",
"date_from_answer",
"date_to_answer",
"position",
"created_at",
"updated_at"
]
},
"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
},
"user_scorecards_readable_attribute": {
"description": "User Scorecard readable attributes",
"type": "string",
"enum": [
"id",
"completed_at",
"locked",
"name",
"sentiment",
"status",
"summary",
"created_at",
"updated_at"
]
},
"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
]
}
}
}
},
"parameters": {
"created_at_gt_filters": {
"in": "query",
"explode": false,
"name": "filter[created_at][gt]",
"description": "Filter records with created_at greater than this value",
"schema": {
"description": "String representation of datetime",
"type": "string",
"format": "date-time",
"example": "2019-01-01T00:00:00+00:00"
}
},
"created_at_lt_filters": {
"in": "query",
"explode": false,
"name": "filter[created_at][lt]",
"description": "Filter records with created_at less than this value",
"schema": {
"description": "String representation of datetime",
"type": "string",
"format": "date-time",
"example": "2019-01-01T00:00:00+00:00"
}
},
"updated_at_gt_filters": {
"in": "query",
"explode": false,
"name": "filter[updated_at][gt]",
"description": "Filter records with updated_at greater than this value",
"schema": {
"description": "String representation of datetime",
"type": "string",
"format": "date-time",
"example": "2019-01-01T00:00:00+00:00"
}
},
"updated_at_lt_filters": {
"in": "query",
"explode": false,
"name": "filter[updated_at][lt]",
"description": "Filter records with updated_at less than this value",
"schema": {
"description": "String representation of datetime",
"type": "string",
"format": "date-time",
"example": "2019-01-01T00:00:00+00:00"
}
},
"applications_uuid_filters": {
"in": "query",
"explode": false,
"name": "filter[uuid]",
"description": "Filter records by Uuid",
"schema": {
"description": "Uuid filter",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"applications_candidate_id_filters": {
"in": "query",
"explode": false,
"name": "filter[candidate_id]",
"description": "Filter records by Candidate id",
"schema": {
"description": "Candidate id filter",
"type": "string"
}
},
"applications_external_system_reference_filters": {
"in": "query",
"explode": false,
"name": "filter[external_system_reference]",
"description": "Filter records by External system reference",
"schema": {
"description": "External system reference filter",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"applications_internal_candidate_filters": {
"in": "query",
"explode": false,
"name": "filter[internal_candidate]",
"description": "Filter records based on whether they're marked as internal_candidate",
"schema": {
"description": "Internal candidate filter",
"type": "boolean",
"example": false
}
},
"applications_job_id_filters": {
"in": "query",
"explode": false,
"name": "filter[job_id]",
"description": "Filter records by Job id",
"schema": {
"description": "Job id filter",
"type": "string"
}
},
"applications_job_posting_id_filters": {
"in": "query",
"explode": false,
"name": "filter[job_posting_id]",
"description": "Filter records by Job posting id",
"schema": {
"description": "Job posting id filter",
"type": "string"
}
},
"applications_locale_filters": {
"in": "query",
"explode": false,
"name": "filter[locale]",
"description": "Filter records with locale equal to this value",
"schema": {
"description": "Locale filter",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"ar",
"bg",
"cs",
"cy",
"da",
"de",
"de-CH",
"de-F",
"en",
"es",
"es-419",
"fr",
"ga",
"he",
"hu",
"hy",
"it",
"ja",
"ko",
"nl",
"pl",
"pt",
"pt-BR",
"ro",
"ru",
"sv",
"sw-CD",
"sw-KE",
"sw-TZ",
"sw-UG",
"tl",
"th",
"tr",
"uk",
"uz",
"vi",
"zh"
]
}
}
},
"applications_stage_id_filters": {
"in": "query",
"explode": false,
"name": "filter[stage_id]",
"description": "Filter records by Stage id",
"schema": {
"description": "Stage id filter",
"type": "string"
}
},
"applications_stage_basic_type_filters": {
"in": "query",
"explode": false,
"name": "filter[stage_basic_type]",
"description": "Filter records with stage_basic_type equal to this value",
"schema": {
"description": "Stage basic type filter",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"applied",
"rejected",
"review",
"interview",
"hired",
"offer"
]
}
}
},
"applications_candidate_email_filters": {
"in": "query",
"explode": false,
"name": "filter[candidate_email]",
"description": "Filter records by Candidate email",
"schema": {
"description": "Candidate email filter",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"applications_candidate_phone_filters": {
"in": "query",
"explode": false,
"name": "filter[candidate_phone]",
"description": "Filter records by Candidate phone",
"schema": {
"description": "Candidate phone filter",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"applications_job_visibility_filters": {
"in": "query",
"explode": false,
"name": "filter[job_visibility]",
"description": "Filter records with job_visibility equal to this value",
"schema": {
"description": "Job visibility filter",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"internal",
"external",
"confidential",
"private_job"
]
}
}
},
"applications_concealed_filters": {
"in": "query",
"explode": false,
"name": "filter[concealed]",
"description": "Filter records based on whether they're marked as concealed",
"schema": {
"description": "Concealed filter",
"type": "boolean",
"example": false
}
},
"stats_total": {
"in": "query",
"name": "stats[total]",
"style": "form",
"explode": false,
"description": "Include the total number of matched records within the meta key of the response object.",
"schema": {
"type": "string",
"enum": [
"count"
],
"example": "count"
}
},
"page_number_filters": {
"in": "query",
"name": "page[number]",
"description": "The page number of records to return",
"schema": {
"type": "integer",
"example": 1,
"default": 1
}
},
"page_size_filters": {
"in": "query",
"name": "page[size]",
"description": "The number of records to return",
"schema": {
"type": "integer",
"default": 100,
"minimum": 0,
"maximum": 1000
}
},
"answers_fields": {
"in": "query",
"schema": {
"description": "Answer readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/answers_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[answers]",
"description": "[Include only specified fields of Answer in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"applications_include": {
"in": "query",
"schema": {
"$ref": "#/components/schemas/applications_related"
},
"explode": false,
"name": "include",
"description": "[Include related resources](https://jsonapi.org/format/#fetching-includes)"
},
"applications_fields": {
"in": "query",
"schema": {
"description": "Application readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/applications_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[applications]",
"description": "[Include only specified fields of Application in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"applications_extra_fields": {
"in": "query",
"schema": {
"description": "Application extra fields list",
"type": "array",
"items": {
"$ref": "#/components/schemas/applications_extra_fields"
},
"uniqueItems": true
},
"style": "form",
"explode": false,
"name": "extra_fields[applications]",
"description": "Include fields that are not always needed, or perhaps computationally expensive"
},
"applications_sort": {
"in": "query",
"schema": {
"$ref": "#/components/schemas/applications_sortable_attributes_list"
},
"style": "form",
"explode": false,
"name": "sort",
"description": "[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting)\n\nYou should not include both ascending `id` and descending `-id` fields the same time\n"
},
"candidates_fields": {
"in": "query",
"schema": {
"description": "Candidate readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/candidates_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[candidates]",
"description": "[Include only specified fields of Candidate in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"comments_fields": {
"in": "query",
"schema": {
"description": "Comment readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/comments_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[comments]",
"description": "[Include only specified fields of Comment in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"custom_attributes_fields": {
"in": "query",
"schema": {
"description": "Custom Attribute readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/custom_attributes_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[custom_attributes]",
"description": "[Include only specified fields of Custom Attribute in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"document_requests_fields": {
"in": "query",
"schema": {
"description": "Document Request readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/document_requests_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[document_requests]",
"description": "[Include only specified fields of Document Request in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"hris_exports_fields": {
"in": "query",
"schema": {
"description": "Hris Export readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/hris_exports_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[hris_exports]",
"description": "[Include only specified fields of Hris Export in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"job_postings_fields": {
"in": "query",
"schema": {
"description": "Job Posting readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/job_postings_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[job_postings]",
"description": "[Include only specified fields of Job Posting in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"jobs_fields": {
"in": "query",
"schema": {
"description": "Job readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/jobs_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[jobs]",
"description": "[Include only specified fields of Job in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"offers_fields": {
"in": "query",
"schema": {
"description": "Offer readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/offers_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[offers]",
"description": "[Include only specified fields of Offer in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"onboarding_applications_fields": {
"in": "query",
"schema": {
"description": "Onboarding Application readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/onboarding_applications_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[onboarding_applications]",
"description": "[Include only specified fields of Onboarding Application in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"resumes_fields": {
"in": "query",
"schema": {
"description": "Resume readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/resumes_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[resumes]",
"description": "[Include only specified fields of Resume in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"scorecard_answers_fields": {
"in": "query",
"schema": {
"description": "Scorecard Answer readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/scorecard_answers_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[scorecard_answers]",
"description": "[Include only specified fields of Scorecard Answer in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"scorecard_notes_fields": {
"in": "query",
"schema": {
"description": "Scorecard Note readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/scorecard_notes_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[scorecard_notes]",
"description": "[Include only specified fields of Scorecard Note in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"scorecard_ratings_fields": {
"in": "query",
"schema": {
"description": "Scorecard Rating readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/scorecard_ratings_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[scorecard_ratings]",
"description": "[Include only specified fields of Scorecard Rating in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"stages_fields": {
"in": "query",
"schema": {
"description": "Stage readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/stages_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[stages]",
"description": "[Include only specified fields of Stage in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"structured_section_responses_fields": {
"in": "query",
"schema": {
"description": "Structured Section Response readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/structured_section_responses_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[structured_section_responses]",
"description": "[Include only specified fields of Structured Section Response in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
},
"user_scorecards_fields": {
"in": "query",
"schema": {
"description": "User Scorecard readable attributes list",
"type": "array",
"items": {
"$ref": "#/components/schemas/user_scorecards_readable_attribute"
},
"uniqueItems": true
},
"explode": false,
"name": "fields[user_scorecards]",
"description": "[Include only specified fields of User Scorecard in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"
}
},
"examples": {
"jsonapi_applications_collection": {
"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": {}
}
}
}
},
"paths": {
"/api/v1/applications": {
"get": {
"operationId": "get-applications",
"summary": "List Applications",
"tags": [
"Applications"
],
"responses": {
"200": {
"$ref": "#/components/responses/applications_200_collection"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"429": {
"$ref": "#/components/responses/429"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"parameters": [
{
"$ref": "#/components/parameters/applications_extra_fields"
},
{
"$ref": "#/components/parameters/applications_include"
},
{
"$ref": "#/components/parameters/applications_fields"
},
{
"$ref": "#/components/parameters/jobs_fields"
},
{
"$ref": "#/components/parameters/job_postings_fields"
},
{
"$ref": "#/components/parameters/stages_fields"
},
{
"$ref": "#/components/parameters/candidates_fields"
},
{
"$ref": "#/components/parameters/hris_exports_fields"
},
{
"$ref": "#/components/parameters/onboarding_applications_fields"
},
{
"$ref": "#/components/parameters/document_requests_fields"
},
{
"$ref": "#/components/parameters/offers_fields"
},
{
"$ref": "#/components/parameters/answers_fields"
},
{
"$ref": "#/components/parameters/custom_attributes_fields"
},
{
"$ref": "#/components/parameters/structured_section_responses_fields"
},
{
"$ref": "#/components/parameters/scorecard_ratings_fields"
},
{
"$ref": "#/components/parameters/scorecard_notes_fields"
},
{
"$ref": "#/components/parameters/scorecard_answers_fields"
},
{
"$ref": "#/components/parameters/user_scorecards_fields"
},
{
"$ref": "#/components/parameters/comments_fields"
},
{
"$ref": "#/components/parameters/resumes_fields"
},
{
"$ref": "#/components/parameters/applications_uuid_filters"
},
{
"$ref": "#/components/parameters/created_at_gt_filters"
},
{
"$ref": "#/components/parameters/created_at_lt_filters"
},
{
"$ref": "#/components/parameters/updated_at_gt_filters"
},
{
"$ref": "#/components/parameters/updated_at_lt_filters"
},
{
"$ref": "#/components/parameters/applications_candidate_id_filters"
},
{
"$ref": "#/components/parameters/applications_external_system_reference_filters"
},
{
"$ref": "#/components/parameters/applications_internal_candidate_filters"
},
{
"$ref": "#/components/parameters/applications_job_id_filters"
},
{
"$ref": "#/components/parameters/applications_job_posting_id_filters"
},
{
"$ref": "#/components/parameters/applications_locale_filters"
},
{
"$ref": "#/components/parameters/applications_stage_id_filters"
},
{
"$ref": "#/components/parameters/applications_stage_basic_type_filters"
},
{
"$ref": "#/components/parameters/applications_candidate_email_filters"
},
{
"$ref": "#/components/parameters/applications_candidate_phone_filters"
},
{
"$ref": "#/components/parameters/applications_job_visibility_filters"
},
{
"$ref": "#/components/parameters/applications_concealed_filters"
},
{
"$ref": "#/components/parameters/applications_sort"
},
{
"$ref": "#/components/parameters/page_number_filters"
},
{
"$ref": "#/components/parameters/page_size_filters"
},
{
"$ref": "#/components/parameters/stats_total"
}
]
}
}
},
"tags": [
{
"name": "Applications",
"description": "Applications operations"
}
]
}
````