openapi: 3.0.1
info:
title: API Reference
description: >-
Applicant tracking software that’s ready for anything. Get more control with
branded careers sites, flexible templates, tailored workflows, beautiful
reports, and an easier hiring process—not just for your candidates, but for
your own team too. Make better hiring decisions—faster–with Pinpoint.
version: 1.0.23
contact:
email: developers@pinpointhq.com
name: Pinpoint Engineering
x-api-status-urls: false
x-konfig-ignore:
object-with-no-properties: true
potential-incorrect-type: true
servers:
- description: Production server
url: https://{subdomain}.pinpointhq.com
variables:
subdomain:
description: Subdomain of the company making requests
default: your-subdomain
tags:
- description: Custom Field operations
name: Custom Fields
- description: Department operations
name: Departments
- description: Division operations
name: Divisions
- description: Job operations
name: Jobs
- description: Location operations
name: Locations
- description: Structure Custom Group One operations
name: Structure Custom Group Ones
- description: Structure Link operations
name: Structure Links
- description: Custom Attribute operations
name: Custom Attributes
- name: Requisitions
- description: Application operations
name: Applications
- description: User operations
name: Users
- description: Comment operations
name: Comments
- description: Job Seeker operations
name: Job Seekers
- name: Equality Monitoring Categories
- name: Interviews
- name: Hiring Workflows
- name: Onboarding Applications
- name: Requisition Templates
paths:
/api/v1/applications:
get:
tags:
- Applications
summary: List Applications
operationId: Applications_list
parameters:
- $ref: '#/components/parameters/applications_extra_fields'
- $ref: '#/components/parameters/applications_fields'
- $ref: '#/components/parameters/locale_filters'
- $ref: '#/components/parameters/created_at_gt_filters'
- $ref: '#/components/parameters/created_at_lt_filters'
- $ref: '#/components/parameters/applications_internal_candidate_filters'
- $ref: '#/components/parameters/applications_job_id_filters'
- $ref: '#/components/parameters/applications_job_visibility_filters'
- $ref: '#/components/parameters/applications_stage_basic_type_filters'
- $ref: '#/components/parameters/applications_stage_id_filters'
- $ref: '#/components/parameters/updated_at_gt_filters'
- $ref: '#/components/parameters/updated_at_lt_filters'
- $ref: '#/components/parameters/applications_include'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/applications_sort'
- $ref: '#/components/parameters/stats_total'
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'
post:
tags:
- Applications
summary: Create Application
operationId: Applications_createNewApplication
requestBody:
$ref: '#/components/requestBodies/applications_post'
responses:
'201':
$ref: '#/components/responses/applications_201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/applications/{id}:
parameters:
- $ref: '#/components/parameters/applications_id'
get:
tags:
- Applications
summary: Fetch Application
operationId: Applications_getById
parameters:
- $ref: '#/components/parameters/applications_include'
- $ref: '#/components/parameters/applications_fields'
- $ref: '#/components/parameters/applications_extra_fields'
responses:
'200':
$ref: '#/components/responses/applications_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
put:
tags:
- Applications
summary: Update Application
operationId: Applications_updateById
requestBody:
$ref: '#/components/requestBodies/applications_put'
responses:
'200':
$ref: '#/components/responses/applications_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/comments:
get:
tags:
- Comments
summary: List Comments
operationId: Comments_listGet
parameters:
- $ref: '#/components/parameters/comments_fields'
- $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/comments_commentable_id_filters'
- $ref: '#/components/parameters/comments_commentable_type_filters'
- $ref: '#/components/parameters/comments_include'
- $ref: '#/components/parameters/comments_sort'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/comments_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'
post:
tags:
- Comments
summary: Create Comment
operationId: Comments_createNew
requestBody:
$ref: '#/components/requestBodies/comments_post'
responses:
'201':
$ref: '#/components/responses/comments_201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/comments/{id}:
parameters:
- $ref: '#/components/parameters/comments_id'
get:
tags:
- Comments
summary: Fetch Comment
operationId: Comments_getById
parameters:
- $ref: '#/components/parameters/comments_include'
- $ref: '#/components/parameters/comments_fields'
responses:
'200':
$ref: '#/components/responses/comments_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/custom_attributes:
get:
tags:
- Custom Attributes
summary: List Custom Attributes
operationId: CustomAttributes_listAttributes
parameters:
- $ref: '#/components/parameters/custom_attributes_fields'
- $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/custom_attributes_custom_attributable_id_filters
- $ref: >-
#/components/parameters/custom_attributes_custom_attributable_type_filters
- $ref: '#/components/parameters/custom_attributes_include'
- $ref: '#/components/parameters/custom_attributes_sort'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/custom_attributes_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'
post:
tags:
- Custom Attributes
summary: Create Custom Attribute
operationId: CustomAttributes_createNewAttribute
requestBody:
$ref: '#/components/requestBodies/custom_attributes_post'
responses:
'201':
$ref: '#/components/responses/custom_attributes_201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/custom_attributes/{id}:
parameters:
- $ref: '#/components/parameters/custom_attributes_id'
get:
tags:
- Custom Attributes
summary: Fetch Custom Attribute
operationId: CustomAttributes_getAttribute
parameters:
- $ref: '#/components/parameters/custom_attributes_fields'
- $ref: '#/components/parameters/custom_attributes_include'
responses:
'200':
$ref: '#/components/responses/custom_attributes_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
put:
tags:
- Custom Attributes
summary: Update Custom Attribute
operationId: CustomAttributes_updateAttributeById
requestBody:
$ref: '#/components/requestBodies/custom_attributes_put'
responses:
'200':
$ref: '#/components/responses/custom_attributes_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Custom Attributes
summary: Delete Custom Attribute
operationId: CustomAttributes_removeById
responses:
'200':
$ref: '#/components/responses/200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/custom_fields:
get:
tags:
- Custom Fields
summary: List Custom Fields
operationId: CustomFields_list
parameters:
- $ref: '#/components/parameters/custom_fields_fields'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/custom_fields_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'
post:
tags:
- Custom Fields
summary: Create Custom Field
operationId: CustomFields_createNewField
requestBody:
$ref: '#/components/requestBodies/custom_fields_post'
responses:
'201':
$ref: '#/components/responses/custom_fields_201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/custom_fields/{id}:
parameters:
- $ref: '#/components/parameters/custom_fields_id'
get:
tags:
- Custom Fields
summary: Fetch Custom Field
operationId: CustomFields_getField
parameters:
- $ref: '#/components/parameters/custom_fields_fields'
responses:
'200':
$ref: '#/components/responses/custom_fields_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'
put:
tags:
- Custom Fields
summary: Update Custom Field
operationId: CustomFields_updateFieldById
requestBody:
$ref: '#/components/requestBodies/custom_fields_put'
responses:
'200':
$ref: '#/components/responses/custom_fields_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Custom Fields
summary: Delete Custom Field
operationId: CustomFields_deleteField
responses:
'200':
$ref: '#/components/responses/200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/departments:
get:
tags:
- Departments
summary: List Departments
operationId: Departments_list
parameters:
- $ref: '#/components/parameters/departments_fields'
- $ref: '#/components/parameters/departments_sort'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/departments_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'
post:
tags:
- Departments
summary: Create Department
operationId: Departments_createNewDepartment
requestBody:
$ref: '#/components/requestBodies/departments_post'
responses:
'201':
$ref: '#/components/responses/departments_201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/departments/{id}:
parameters:
- $ref: '#/components/parameters/departments_id'
get:
tags:
- Departments
summary: Fetch Department
operationId: Departments_getById
parameters:
- $ref: '#/components/parameters/departments_fields'
responses:
'200':
$ref: '#/components/responses/departments_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
put:
tags:
- Departments
summary: Update Department
operationId: Departments_updateById
requestBody:
$ref: '#/components/requestBodies/departments_put'
responses:
'200':
$ref: '#/components/responses/departments_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Departments
summary: Delete Department
operationId: Departments_removeById
responses:
'200':
$ref: '#/components/responses/200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/divisions:
get:
tags:
- Divisions
summary: List Divisions
operationId: Divisions_list
parameters:
- $ref: '#/components/parameters/divisions_fields'
- $ref: '#/components/parameters/divisions_sort'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/divisions_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'
post:
tags:
- Divisions
summary: Create Division
operationId: Divisions_createDivision
requestBody:
$ref: '#/components/requestBodies/divisions_post'
responses:
'201':
$ref: '#/components/responses/divisions_201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/divisions/{id}:
parameters:
- $ref: '#/components/parameters/divisions_id'
get:
tags:
- Divisions
summary: Fetch Division
operationId: Divisions_getById
parameters:
- $ref: '#/components/parameters/divisions_fields'
responses:
'200':
$ref: '#/components/responses/divisions_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
put:
tags:
- Divisions
summary: Update Division
operationId: Divisions_updateById
requestBody:
$ref: '#/components/requestBodies/divisions_put'
responses:
'200':
$ref: '#/components/responses/divisions_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Divisions
summary: Delete Division
operationId: Divisions_removeById
responses:
'200':
$ref: '#/components/responses/200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/equality_monitoring_categories:
get:
tags:
- Equality Monitoring Categories
summary: List equality monitoring categories
operationId: EqualityMonitoringCategories_list
parameters:
- $ref: '#/components/parameters/created_at_gt_filters'
- $ref: '#/components/parameters/created_at_lt_filters'
- $ref: '#/components/parameters/equality_monitoring_categories_fields'
- $ref: >-
#/components/parameters/equality_monitoring_categories_enabled_filters
- $ref: '#/components/parameters/equality_monitoring_categories_sort'
- $ref: '#/components/parameters/equality_monitoring_categories_include'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
- $ref: '#/components/parameters/updated_at_gt_filters'
- $ref: '#/components/parameters/updated_at_lt_filters'
responses:
'200':
$ref: '#/components/responses/equality_monitoring_categories_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'
/api/v1/equality_monitoring_categories/{id}:
parameters:
- $ref: '#/components/parameters/equality_monitoring_categories_id'
get:
tags:
- Equality Monitoring Categories
summary: Fetch equality monitoring category
operationId: EqualityMonitoringCategories_getCategoryById
parameters:
- $ref: '#/components/parameters/equality_monitoring_categories_include'
- $ref: '#/components/parameters/equality_monitoring_categories_fields'
responses:
'200':
$ref: '#/components/responses/equality_monitoring_categories_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/interviews:
get:
tags:
- Interviews
summary: List Interviews
operationId: Interviews_listAll
parameters:
- $ref: '#/components/parameters/interviews_fields'
- $ref: '#/components/parameters/created_at_gt_filters'
- $ref: '#/components/parameters/created_at_lt_filters'
- $ref: '#/components/parameters/interviews_interviewable_id_filters'
- $ref: '#/components/parameters/interviews_interviewable_type_filters'
- $ref: '#/components/parameters/interviews_job_visibility_filters'
- $ref: '#/components/parameters/start_at_gt_filters'
- $ref: '#/components/parameters/start_at_lt_filters'
- $ref: '#/components/parameters/interviews_include'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/interviews_sort'
responses:
'200':
$ref: '#/components/responses/interviews_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'
/api/v1/interviews/{id}:
parameters:
- $ref: '#/components/parameters/interviews_id'
get:
tags:
- Interviews
summary: Fetch Interview
operationId: Interviews_getById
parameters:
- $ref: '#/components/parameters/interviews_fields'
- $ref: '#/components/parameters/interviews_include'
responses:
'200':
$ref: '#/components/responses/interviews_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/hiring_workflows:
get:
tags:
- Hiring Workflows
summary: List Hiring Workflows
operationId: HiringWorkflows_listWorkflows
responses:
'200':
$ref: '#/components/responses/hiring_workflows_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'
/api/v1/hiring_workflows/{id}:
parameters:
- $ref: '#/components/parameters/hiring_workflows_id'
get:
tags:
- Hiring Workflows
summary: Fetch Hiring Workflow
operationId: HiringWorkflows_getWorkflowById
responses:
'200':
$ref: '#/components/responses/hiring_workflows_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/jobs:
get:
tags:
- Jobs
summary: List Jobs
operationId: Jobs_list
parameters:
- $ref: '#/components/parameters/created_at_gt_filters'
- $ref: '#/components/parameters/created_at_lt_filters'
- $ref: '#/components/parameters/jobs_department_id_filters'
- $ref: '#/components/parameters/jobs_department_name_filters'
- $ref: '#/components/parameters/jobs_division_id_filters'
- $ref: '#/components/parameters/jobs_division_name_filters'
- $ref: '#/components/parameters/jobs_employment_type_filters'
- $ref: '#/components/parameters/jobs_hiring_manager_user_id_filters'
- $ref: '#/components/parameters/jobs_location_id_filters'
- $ref: '#/components/parameters/jobs_location_name_filters'
- $ref: '#/components/parameters/jobs_recruitment_manager_user_id_filters'
- $ref: '#/components/parameters/jobs_remote_filters'
- $ref: '#/components/parameters/jobs_search_filters'
- $ref: '#/components/parameters/jobs_status_filters'
- $ref: '#/components/parameters/jobs_structure_custom_group_one_id_filters'
- $ref: '#/components/parameters/jobs_structure_custom_group_one_name_filters'
- $ref: '#/components/parameters/jobs_visibility_filters'
- $ref: '#/components/parameters/jobs_workplace_type_filters'
- $ref: '#/components/parameters/jobs_include'
- $ref: '#/components/parameters/locale'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/jobs_sort'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/jobs_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'
post:
tags:
- Jobs
summary: Create Job
operationId: Jobs_createJob
requestBody:
$ref: '#/components/requestBodies/jobs_post'
responses:
'201':
$ref: '#/components/responses/jobs_201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/jobs/{id}:
parameters:
- $ref: '#/components/parameters/jobs_id'
get:
tags:
- Jobs
summary: Fetch Job
operationId: Jobs_getJobById
parameters:
- $ref: '#/components/parameters/locale'
- $ref: '#/components/parameters/jobs_include'
- $ref: '#/components/parameters/jobs_fields'
responses:
'200':
$ref: '#/components/responses/jobs_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
put:
tags:
- Jobs
summary: Update Job
operationId: Jobs_updateJobById
requestBody:
$ref: '#/components/requestBodies/jobs_put'
responses:
'200':
$ref: '#/components/responses/jobs_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Jobs
summary: Delete Job
operationId: Jobs_deleteJob
responses:
'200':
$ref: '#/components/responses/200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/job_seekers:
get:
tags:
- Job Seekers
summary: List Job Seekers
operationId: JobSeekers_listJobSeekers
parameters:
- $ref: '#/components/parameters/job_seekers_extra_fields'
- $ref: '#/components/parameters/job_seekers_fields'
- $ref: '#/components/parameters/job_seekers_include'
- $ref: '#/components/parameters/job_seekers_sort'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/job_seekers_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'
/api/v1/job_seekers/{id}:
parameters:
- $ref: '#/components/parameters/job_seekers_id'
get:
tags:
- Job Seekers
summary: Fetch Job Seeker
operationId: JobSeekers_getJobSeekerById
parameters:
- $ref: '#/components/parameters/job_seekers_extra_fields'
- $ref: '#/components/parameters/job_seekers_fields'
- $ref: '#/components/parameters/job_seekers_include'
responses:
'200':
$ref: '#/components/responses/job_seekers_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/locations:
get:
tags:
- Locations
summary: List Locations
operationId: Locations_list
parameters:
- $ref: '#/components/parameters/locations_fields'
- $ref: '#/components/parameters/locations_sort'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/locations_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'
post:
tags:
- Locations
summary: Create Location
operationId: Locations_createLocation
requestBody:
$ref: '#/components/requestBodies/locations_post'
responses:
'201':
$ref: '#/components/responses/locations_201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/locations/{id}:
parameters:
- $ref: '#/components/parameters/locations_id'
get:
tags:
- Locations
summary: Fetch Location
operationId: Locations_getLocation
parameters:
- $ref: '#/components/parameters/locations_fields'
responses:
'200':
$ref: '#/components/responses/locations_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
put:
tags:
- Locations
summary: Update Location
operationId: Locations_updateLocationById
requestBody:
$ref: '#/components/requestBodies/locations_put'
responses:
'200':
$ref: '#/components/responses/locations_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Locations
summary: Delete Location
operationId: Locations_removeLocation
responses:
'200':
$ref: '#/components/responses/200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/onboarding_applications:
get:
tags:
- Onboarding Applications
summary: List Onboarding Applications
operationId: OnboardingApplications_listApplications
parameters:
- $ref: '#/components/parameters/created_at_gt_filters'
- $ref: '#/components/parameters/created_at_lt_filters'
- $ref: '#/components/parameters/onboarding_applications_fields'
- $ref: '#/components/parameters/onboarding_applications_include'
- $ref: '#/components/parameters/onboarding_applications_sort'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/start_at_gt_filters'
- $ref: '#/components/parameters/start_at_lt_filters'
- $ref: '#/components/parameters/stats_total'
- $ref: '#/components/parameters/updated_at_gt_filters'
- $ref: '#/components/parameters/updated_at_lt_filters'
responses:
'200':
$ref: '#/components/responses/onboarding_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'
/api/v1/onboarding_applications/{id}:
parameters:
- $ref: '#/components/parameters/onboarding_applications_id'
get:
tags:
- Onboarding Applications
summary: Fetch Onboarding Application
operationId: OnboardingApplications_getById
parameters:
- $ref: '#/components/parameters/onboarding_applications_fields'
- $ref: '#/components/parameters/onboarding_applications_include'
responses:
'200':
$ref: '#/components/responses/onboarding_applications_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/requisition_templates:
get:
tags:
- Requisition Templates
summary: List Requisition Templates
operationId: RequisitionTemplates_listTemplates
parameters:
- $ref: '#/components/parameters/requisition_templates_fields'
- $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/requisition_templates_include'
- $ref: '#/components/parameters/requisition_templates_sort'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/requisition_templates_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'
/api/v1/requisition_templates/{id}:
parameters:
- $ref: '#/components/parameters/requisition_templates_id'
get:
tags:
- Requisition Templates
summary: Fetch Requisition Template
operationId: RequisitionTemplates_getById
parameters:
- $ref: '#/components/parameters/requisition_templates_include'
- $ref: '#/components/parameters/requisition_templates_fields'
responses:
'200':
$ref: '#/components/responses/requisition_templates_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/requisitions:
get:
tags:
- Requisitions
summary: List Requisitions
operationId: Requisitions_listRequisitions
parameters:
- $ref: '#/components/parameters/requisitions_fields'
- $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/requisitions_include'
- $ref: '#/components/parameters/requisitions_sort'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/requisitions_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'
post:
tags:
- Requisitions
summary: Create Requisition
operationId: Requisitions_createNewRequisition
requestBody:
$ref: '#/components/requestBodies/requisitions_post'
responses:
'201':
$ref: '#/components/responses/requisitions_201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/requisitions/{id}:
parameters:
- $ref: '#/components/parameters/requisitions_id'
get:
tags:
- Requisitions
summary: Fetch Requisition
operationId: Requisitions_getById
parameters:
- $ref: '#/components/parameters/requisitions_include'
- $ref: '#/components/parameters/requisitions_fields'
responses:
'200':
$ref: '#/components/responses/requisitions_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
put:
tags:
- Requisitions
summary: Update Requisition
operationId: Requisitions_updateById
requestBody:
$ref: '#/components/requestBodies/requisitions_put'
responses:
'200':
$ref: '#/components/responses/requisitions_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Requisitions
summary: Delete Requisition
operationId: Requisitions_removeById
responses:
'200':
$ref: '#/components/responses/200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/structure_custom_group_ones:
get:
tags:
- Structure Custom Group Ones
summary: List Structure Custom Group Ones
operationId: StructureCustomGroupOnes_list
parameters:
- $ref: '#/components/parameters/structure_custom_group_ones_fields'
- $ref: '#/components/parameters/structure_custom_group_ones_sort'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/structure_custom_group_ones_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'
post:
tags:
- Structure Custom Group Ones
summary: Create Structure Custom Group One
operationId: StructureCustomGroupOnes_createNewGroup
requestBody:
$ref: '#/components/requestBodies/structure_custom_group_ones_post'
responses:
'201':
$ref: '#/components/responses/structure_custom_group_ones_201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/structure_custom_group_ones/{id}:
parameters:
- $ref: '#/components/parameters/structure_custom_group_ones_id'
get:
tags:
- Structure Custom Group Ones
summary: Fetch Structure Custom Group One
operationId: StructureCustomGroupOnes_getOne
parameters:
- $ref: '#/components/parameters/structure_custom_group_ones_fields'
responses:
'200':
$ref: '#/components/responses/structure_custom_group_ones_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
put:
tags:
- Structure Custom Group Ones
summary: Update Structure Custom Group One
operationId: StructureCustomGroupOnes_updateOne
requestBody:
$ref: '#/components/requestBodies/structure_custom_group_ones_put'
responses:
'200':
$ref: '#/components/responses/structure_custom_group_ones_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Structure Custom Group Ones
summary: Delete Structure Custom Group One
operationId: StructureCustomGroupOnes_delete
responses:
'200':
$ref: '#/components/responses/200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/structure_links:
get:
tags:
- Structure Links
summary: List Structure Links
operationId: StructureLinks_list
parameters:
- $ref: '#/components/parameters/structure_links_fields'
- $ref: '#/components/parameters/structure_links_extra_fields'
- $ref: '#/components/parameters/structure_links_include'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/structure_links_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'
post:
tags:
- Structure Links
summary: Create Structure Link
operationId: StructureLinks_createLink
requestBody:
$ref: '#/components/requestBodies/structure_links_post'
responses:
'201':
$ref: '#/components/responses/structure_links_201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/structure_links/{id}:
parameters:
- $ref: '#/components/parameters/structure_links_id'
get:
tags:
- Structure Links
summary: Fetch Structure Links
operationId: StructureLinks_getById
parameters:
- $ref: '#/components/parameters/structure_links_fields'
- $ref: '#/components/parameters/structure_links_extra_fields'
- $ref: '#/components/parameters/structure_links_include'
responses:
'200':
$ref: '#/components/responses/structure_links_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'
put:
tags:
- Structure Links
summary: Update Structure Link
operationId: StructureLinks_updateLinkById
requestBody:
$ref: '#/components/requestBodies/structure_links_put'
responses:
'200':
$ref: '#/components/responses/structure_links_200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
tags:
- Structure Links
summary: Delete Structure Link
operationId: StructureLinks_removeById
responses:
'200':
$ref: '#/components/responses/200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'409':
$ref: '#/components/responses/409'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/users:
get:
tags:
- Users
summary: List users
operationId: Users_listUsers
parameters:
- $ref: '#/components/parameters/users_fields'
- $ref: '#/components/parameters/users_employee_filters'
- $ref: '#/components/parameters/page_number_filters'
- $ref: '#/components/parameters/page_size_filters'
- $ref: '#/components/parameters/stats_total'
responses:
'200':
$ref: '#/components/responses/users_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'
post:
tags:
- Users
summary: Create User
operationId: Users_createUser
requestBody:
$ref: '#/components/requestBodies/users_post'
responses:
'201':
$ref: '#/components/responses/users_201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/api/v1/users/{id}:
parameters:
- $ref: '#/components/parameters/users_id'
get:
tags:
- Users
summary: Fetch users
operationId: Users_getById
parameters:
- $ref: '#/components/parameters/users_fields'
responses:
'200':
$ref: '#/components/responses/users_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'
delete:
tags:
- Users
summary: Delete User
operationId: Users_removeUser
responses:
'200':
$ref: '#/components/responses/200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
components:
parameters:
applications_extra_fields:
description: >-
Include fields that are not always needed, or perhaps computationally
expensive
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]
applications_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Application readable attributes list
type: array
items:
$ref: '#/components/schemas/applications_readable_attribute'
uniqueItems: true
style: form
explode: false
name: fields[applications]
applications_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
applications_include:
description: >-
[Include related
resources](https://jsonapi.org/format/#fetching-includes)
in: query
schema:
$ref: '#/components/schemas/applications_related'
style: form
explode: false
name: include
applications_internal_candidate_filters:
description: |
Filter records based on whether they're marked as an internal candidate
in: query
schema:
description: Whether the candidate has been marked as internal
type: boolean
example: false
name: filter[internal_candidate]
applications_job_id_filters:
description: |
Filter records by their job ID
in: query
schema:
description: Job ID
type: string
name: filter[job_id]
applications_job_visibility_filters:
description: >
Filter records by the visibility of the job that they belong to. To
ensure backwards compatibility, applications belonging to confidential
jobs are excluded from results unless a `job_visibility` of
`confidential` is explicitly specified.
in: query
schema:
description: Job visibility
type: array
items:
type: string
enum:
- confidential
- external
- internal
uniqueItems: true
style: form
explode: false
name: filter[job_visibility]
applications_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: '#/components/schemas/applications_sortable_attributes_list'
style: form
explode: false
name: sort
applications_stage_basic_type_filters:
description: Filter records based on their stage basic type
in: query
schema:
description: Application stage basic type filter
type: array
items:
type: string
enum:
- applied
- rejected
- review
- interview
- hired
- offer
uniqueItems: true
style: form
explode: false
name: filter[stage_basic_type]
applications_stage_id_filters:
description: |
Filter records by their stage ID.
in: query
schema:
description: Stage ID
type: string
name: filter[stage_id]
comments_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Comment readable attributes list
type: array
items:
$ref: '#/components/schemas/comments_readable_attribute'
uniqueItems: true
style: form
explode: false
name: fields[comments]
comments_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
comments_include:
description: >-
[Include related
resources](https://jsonapi.org/format/#fetching-includes)
in: query
schema:
$ref: '#/components/schemas/comments_related'
style: form
explode: false
name: include
comments_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: '#/components/schemas/comments_sortable_attributes_list'
style: form
explode: false
name: sort
comments_commentable_id_filters:
description: |
Filter records by their commentable ID
in: query
schema:
description: The `commentable_id` is the id of the associated resource
type: integer
name: filter[commentable_id]
comments_commentable_type_filters:
description: |
Filter records based on whether they are for applications or job seekers
in: query
schema:
description: The `commentable_type` is the type of the associated resource
type: array
items:
type: string
enum:
- Application
- JobSeeker
uniqueItems: true
style: form
explode: false
name: filter[commentable_type]
created_at_lt_filters:
description: |
Filter records with a creation time less than this value.
in: query
schema:
description: String representation of datetime
type: string
format: date-time
example: '2021-04-01T00:00:00+01:00'
name: filter[created_at][lt]
created_at_gt_filters:
description: |
Filter records with a creation time greater than this value.
in: query
schema:
description: String representation of datetime
type: string
format: date-time
example: '2021-04-01T00:00:00+01:00'
name: filter[created_at][gt]
custom_attributes_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Custom Attribute readable attributes list
type: array
items:
$ref: '#/components/schemas/custom_attributes_readable_attributes'
uniqueItems: true
style: form
explode: false
name: fields[custom_attributes]
custom_attributes_include:
description: >-
[Include related
resources](https://jsonapi.org/format/#fetching-includes)
in: query
schema:
$ref: '#/components/schemas/custom_attributes_related'
style: form
explode: false
name: include
custom_attributes_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
custom_attributes_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: '#/components/schemas/custom_attributes_sortable_attributes_list'
style: form
explode: false
name: sort
custom_attributes_custom_attributable_id_filters:
description: |
Filter records by their custom_attributable ID
in: query
schema:
description: The `custom_attributable_id` is the id of the associated resource
type: integer
name: filter[custom_attributable_id]
custom_attributes_custom_attributable_type_filters:
description: |
Filter records by the type of the associated resource
in: query
schema:
description: The `custom_attributable_type` is the type of the associated resource
type: array
items:
type: string
enum:
- Application
- Job
- JobTemplate
- JobSeeker
- Offer
uniqueItems: true
style: form
explode: false
name: filter[custom_attributable_type]
custom_fields_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Custom Field readable attributes list
type: array
items:
$ref: '#/components/schemas/custom_fields_readable_attributes'
uniqueItems: true
style: form
explode: false
name: fields[custom_fields]
custom_fields_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
departments_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Department readable attributes list
type: array
items:
$ref: '#/components/schemas/departments_readable_attributes'
uniqueItems: true
style: form
explode: false
name: fields[departments]
departments_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
departments_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: '#/components/schemas/departments_sortable_attributes_list'
style: form
explode: false
name: sort
divisions_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Division readable attributes list
type: array
items:
$ref: '#/components/schemas/divisions_readable_attributes'
uniqueItems: true
style: form
explode: false
name: fields[divisions]
divisions_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
divisions_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: '#/components/schemas/divisions_sortable_attributes_list'
style: form
explode: false
name: sort
equality_monitoring_categories_enabled_filters:
description: |
Filter records based on whether they're marked as enabled
in: query
schema:
description: Whether the category is enabled
type: boolean
example: false
name: filter[enabled]
equality_monitoring_categories_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Equality Monitoring Category readable attributes list
type: array
items:
$ref: >-
#/components/schemas/equality_monitoring_categories_readable_attributes
uniqueItems: true
style: form
explode: false
name: fields[equality_monitoring_categories]
equality_monitoring_categories_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
equality_monitoring_categories_include:
description: >-
[Include related
resources](https://jsonapi.org/format/#fetching-includes)
in: query
schema:
$ref: '#/components/schemas/equality_monitoring_categories_related'
style: form
explode: false
name: include
equality_monitoring_categories_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: >-
#/components/schemas/equality_monitoring_categories_sortable_attributes_list
style: form
explode: false
name: sort
interviews_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
hiring_workflows_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
interviews_include:
description: >-
[Include related
resources](https://jsonapi.org/format/#fetching-includes)
in: query
schema:
$ref: '#/components/schemas/interviews_related'
style: form
explode: false
name: include
interviews_fields:
description: >-
[Include only specified fields of Interview in
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Interview readable attributes list
type: array
items:
$ref: '#/components/schemas/interviews_readable_attribute'
uniqueItems: true
style: form
explode: false
name: fields[interviews]
interviews_interviewable_id_filters:
description: Filter records by interviewable ID
in: query
schema:
description: Interviewable ID filter
type: integer
explode: false
name: filter[interviewable_id]
interviews_interviewable_type_filters:
description: Filter records based on whether they are for applications or job seekers
in: query
schema:
description: Interviewable type filter
type: string
enum:
- Application
- JobSeeker
name: filter[interviewable_type]
interviews_job_visibility_filters:
description: >
Filter records by the visibility of the job that they belong to. By
default, interviews associated with applications for confidential jobs
are excluded from results unless a `job_visibility` of `confidential` is
explicitly specified.
in: query
schema:
description: >-
Job visibility (only applies to interviews associated with
applications)
type: array
items:
type: string
enum:
- confidential
- external
- internal
uniqueItems: true
style: form
explode: false
name: filter[job_visibility]
interviews_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: '#/components/schemas/interviews_sortable_attributes_list'
style: form
explode: false
name: sort
jobs_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
jobs_include:
description: >-
[Include related
resources](https://jsonapi.org/format/#fetching-includes)
in: query
schema:
$ref: '#/components/schemas/jobs_related'
style: form
explode: false
name: include
jobs_fields:
description: >-
[Include only specified fields of Job in
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Job readable attributes list
type: array
items:
$ref: '#/components/schemas/jobs_readable_attribute'
uniqueItems: true
style: form
explode: false
name: fields[jobs]
jobs_department_id_filters:
description: Filter by department ID
in: query
schema:
description: Job department ID filter
type: integer
explode: false
name: filter[department_id]
jobs_department_name_filters:
description: Filter by department name
in: query
schema:
description: Job department name filter
type: string
explode: false
name: filter[department_name]
jobs_division_id_filters:
description: Filter by division ID
in: query
schema:
description: Job division ID filter
type: integer
explode: false
name: filter[division_id]
jobs_division_name_filters:
description: Filter by division name
in: query
schema:
description: Job division name filter
type: string
explode: false
name: filter[division_name]
jobs_employment_type_filters:
description: Filter by employment type
in: query
schema:
description: Job employment type filter
type: array
items:
type: string
enum:
- contract_temp
- fixed_term_contract
- fixed_term_full_time
- fixed_term_part_time
- flexible
- freelance
- full_time
- internship
- part_time
- permanent
- permanent_full_time
- permanent_part_time
- zero_hours
uniqueItems: true
style: form
explode: false
name: filter[employment_type]
jobs_hiring_manager_user_id_filters:
description: Filter by hiring manager user ID
in: query
schema:
description: Job hiring manager user ID filter
type: integer
explode: false
name: filter[hiring_manager_user_id]
jobs_location_id_filters:
description: Filter by location ID
in: query
schema:
description: Job location ID filter
type: integer
explode: false
name: filter[location_id]
jobs_location_name_filters:
description: Filter by location name
in: query
schema:
description: Job location name filter
type: string
explode: false
name: filter[location_name]
jobs_recruitment_manager_user_id_filters:
description: Filter by recruitment manager user ID
in: query
schema:
description: Job recruitment manager user ID filter
type: integer
explode: false
name: filter[recruitment_manager_user_id]
jobs_remote_filters:
description: Filter by whether the role is remote
in: query
schema:
description: Job remote filter
type: boolean
uniqueItems: true
explode: false
name: filter[remote]
jobs_status_filters:
description: Filter by status
in: query
schema:
description: Job status filter
type: array
items:
type: string
enum:
- archived
- closed
- draft
- open
uniqueItems: true
style: form
explode: false
name: filter[status]
jobs_visibility_filters:
description: >-
Filter by whether this job is confidential, internal, external. To
ensure backwards compatibility, confidential jobs are excluded from
results unless explicitly specified.
in: query
schema:
description: Job visibility filter
type: array
items:
type: string
enum:
- confidential
- external
- internal
uniqueItems: true
style: form
explode: false
name: filter[visibility]
jobs_workplace_type_filters:
description: Filter by workplace type
in: query
schema:
description: Job workplace type filter
type: array
items:
type: string
enum:
- hybrid
- onsite
- remote
uniqueItems: true
style: form
explode: false
name: filter[workplace_type]
jobs_search_filters:
description: Perform a keyword search on the job title
in: query
schema:
description: Job title search filter
type: string
explode: false
name: filter[search]
jobs_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: '#/components/schemas/jobs_sortable_attributes_list'
explode: false
name: sort
jobs_structure_custom_group_one_id_filters:
description: Filter by custom structure group ID
in: query
schema:
description: Job custom structure group ID filter
type: integer
explode: false
name: filter[structure_custom_group_one_id]
jobs_structure_custom_group_one_name_filters:
description: Filter by custom structure group name
in: query
schema:
description: Job custom structure group name filter
type: string
explode: false
name: filter[structure_custom_group_one_name]
job_seekers_extra_fields:
description: >-
Include fields that are not always needed, and perhaps computationally
expensive
in: query
schema:
description: Job Seeker extra fields list
type: array
items:
$ref: '#/components/schemas/job_seekers_extra_fields'
uniqueItems: true
style: form
explode: false
name: extra_fields[job_seekers]
job_seekers_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
job_seekers_include:
description: >-
[Include related
resources](https://jsonapi.org/format/#fetching-includes)
in: query
schema:
$ref: '#/components/schemas/job_seekers_related'
style: form
explode: false
name: include
job_seekers_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Job Seeker readable attributes list
type: array
items:
$ref: '#/components/schemas/job_seekers_readable_attribute'
uniqueItems: true
style: form
explode: false
name: fields[job_seekers]
job_seekers_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: '#/components/schemas/job_seekers_sortable_attributes_list'
style: form
explode: false
name: sort
locale:
description: >-
Return translatable fields in the locale specified. `null` will be
returned for a field if a translation has not been provided.
in: query
schema:
$ref: '#/components/schemas/locales'
name: locale
locations_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Location readable attributes list
type: array
items:
$ref: '#/components/schemas/locations_readable_attributes'
uniqueItems: true
style: form
explode: false
name: fields[locations]
locations_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
locations_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: '#/components/schemas/locations_sortable_attributes_list'
style: form
explode: false
name: sort
locale_filters:
description: Filter records that were submitted under that locale.
in: query
schema:
$ref: '#/components/schemas/locales'
name: filters[locale]
onboarding_applications_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Onboarding application readable attributes list
type: array
items:
$ref: '#/components/schemas/onboarding_applications_readable_attributes'
uniqueItems: true
style: form
explode: false
name: fields[onboarding_applications]
onboarding_applications_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
onboarding_applications_include:
description: >-
[Include related
resources](https://jsonapi.org/format/#fetching-includes)
in: query
schema:
$ref: '#/components/schemas/onboarding_applications_related'
style: form
explode: false
name: include
onboarding_applications_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: '#/components/schemas/onboarding_applications_sortable_attributes_list'
style: form
explode: false
name: sort
start_at_lt_filters:
description: |
Filter records with a start at time less than this value.
in: query
schema:
description: String representation of datetime
type: string
format: date-time
example: '2021-04-01T00:00:00+01:00'
name: filter[start_at][lt]
start_at_gt_filters:
description: |
Filter records with a start at time greater than this value.
in: query
schema:
description: String representation of datetime
type: string
format: date-time
example: '2021-04-01T00:00:00+01:00'
name: filter[start_at][gt]
page_number_filters:
description: The page number of records to return
in: query
schema:
type: integer
example: 1
default: 1
name: page[number]
page_size_filters:
description: The number of records to return.
in: query
schema:
type: integer
default: 100
minimum: 0
maximum: 1000
name: page[size]
stats_total:
description: >
Include the total number of matched records within the meta key of the
response object.
in: query
schema:
type: string
enum:
- count
example: count
style: form
explode: false
name: stats[total]
requisitions_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
requisitions_include:
description: >-
[Include related
resources](https://jsonapi.org/format/#fetching-includes)
in: query
schema:
$ref: '#/components/schemas/requisitions_related'
style: form
explode: false
name: include
requisitions_fields:
description: >-
[Include only specified fields of Requisition in
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Requisition readable attributes list
type: array
items:
$ref: '#/components/schemas/requisitions_readable_attributes'
uniqueItems: true
style: form
explode: false
name: fields[requisitions]
requisitions_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: '#/components/schemas/requisitions_sortable_attributes_list'
style: form
explode: false
name: sort
requisition_templates_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
requisition_templates_include:
description: >-
[Include related
resources](https://jsonapi.org/format/#fetching-includes)
in: query
schema:
$ref: '#/components/schemas/requisition_templates_related'
style: form
explode: false
name: include
requisition_templates_fields:
description: >-
[Include only specified fields of Requisition template in
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Requisition template readable attributes list
type: array
items:
$ref: '#/components/schemas/requisition_templates_readable_attributes'
uniqueItems: true
style: form
explode: false
name: fields[requisition_templates]
requisition_templates_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: '#/components/schemas/requisition_templates_sortable_attributes_list'
style: form
explode: false
name: sort
structure_custom_group_ones_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Structure Custom Group One readable attributes list
type: array
items:
$ref: '#/components/schemas/structure_custom_group_ones_readable_attributes'
uniqueItems: true
style: form
explode: false
name: fields[structure_custom_group_ones]
structure_custom_group_ones_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
structure_custom_group_ones_sort:
description: >
[Sort records according to one or more
criteria](https://jsonapi.org/format/#fetching-sorting)
You should not include both ascending `id` and descending `-id` fields
the same time
in: query
schema:
$ref: >-
#/components/schemas/structure_custom_group_ones_sortable_attributes_list
style: form
explode: false
name: sort
structure_links_extra_fields:
description: >-
Include fields that are not always needed, or perhaps computationally
expensive
in: query
schema:
description: Application extra fields list
type: array
items:
$ref: '#/components/schemas/structure_links_extra_fields'
uniqueItems: true
style: form
explode: false
name: extra_fields[structure_links]
structure_links_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: Application readable attributes list
type: array
items:
$ref: '#/components/schemas/structure_links_readable_attribute'
uniqueItems: true
style: form
explode: false
name: fields[structure_links]
structure_links_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
structure_links_include:
description: >-
[Include related
resources](https://jsonapi.org/format/#fetching-includes)
in: query
schema:
$ref: '#/components/schemas/structure_links_related'
style: form
explode: false
name: include
updated_at_lt_filters:
description: |
Filter records with a last update time less than this value.
in: query
schema:
description: String representation of datetime
type: string
format: date-time
example: '2021-04-01T00:00:00+01:00'
name: filter[updated_at][lt]
updated_at_gt_filters:
description: |
Filter records with a last update time greater than this value.
in: query
schema:
description: String representation of datetime
type: string
format: date-time
example: '2021-04-01T00:00:00+01:00'
name: filter[updated_at][gt]
users_employee_filters:
description: Filter records based on whether the user is an employee of your company
in: query
schema:
type: boolean
enum:
- true
- false
name: filter[employee]
users_fields:
description: >-
[Include only specified fields in the
response](https://jsonapi.org/format/#fetching-sparse-fieldsets)
in: query
schema:
description: User readable attributes list
type: array
items:
type: string
enum:
- id
- created_at
- email
- first_name
- last_name
- time_zone
- updated_at
uniqueItems: true
style: form
explode: false
name: fields[users]
users_id:
description: ID of the resource
in: path
required: true
schema:
type: string
name: id
responses:
'200':
description: OK
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/jsonapi_info'
examples:
deleted:
value:
meta: null
'201':
description: Created
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/jsonapi_info'
'400':
description: Bad Request
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/jsonapi_failure'
examples:
invalid_param:
description: Malformed query params
value:
errors:
- title: Bad Request
code: bad_request
status: '400'
detail: Malformed query params
invalid_locale:
description: Invalid locale
value:
errors:
- title: Bad Request
code: bad_request
status: '400'
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:
- title: Unauthorized
code: unauthorized
status: '401'
detail: X-API-KEY header not provided
invalid_api_key:
description: Invalid API key
value:
errors:
- title: Unauthorized
code: unauthorized
status: '401'
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:
- title: Forbidden
code: forbidden
status: '403'
detail: Integration not enabled
'404':
description: Not Found
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/jsonapi_failure'
examples:
not_found:
description: Record not found
value:
errors:
- title: Not Found
code: not_found
status: '404'
detail: Record not found
'409':
description: Conflict
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/jsonapi_failure'
examples:
record_in_use:
description: Conflict
value:
errors:
- title: Conflict
code: conflict
status: '409'
detail: Record is in use
'422':
description: Unprocessable Entity
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/jsonapi_failure'
examples:
not_found:
description: Unprocessable Entity
value:
errors:
- title: Validation Error
code: unprocessable_entity
status: '422'
detail: '{attribute_name} can''t be blank'
'429':
description: Too Many Requests
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/jsonapi_failure'
examples:
not_found:
description: Too Many Requests
value:
errors:
- title: Too Many Requests
code: too_many_requests
status: '429'
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:
- title: Internal Server Error
code: internal_server_error
status: '500'
detail: >-
We've notified our engineers and hope to address this
issue shortly.
applications_200:
description: 'OK: Application resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_applications_single'
applications_200_collection:
description: 'OK: Applications collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_applications_collection'
applications_201:
description: 'Created: Application resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_applications_single'
comments_200:
description: 'OK: Comment resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_comments_single'
comments_200_collection:
description: 'OK: Comments collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_comments_collection'
comments_201:
description: 'Created: Comment resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_comments_single'
custom_attributes_200:
description: 'OK: Custom Attribute resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_custom_attributes_single'
custom_attributes_200_collection:
description: 'OK: Custom Attributes collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_custom_attributes_collection'
custom_attributes_201:
description: 'Created: Custom Attribute resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_custom_attributes_single'
custom_fields_200:
description: 'OK: Custom Field resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_custom_fields_single'
custom_fields_200_collection:
description: 'OK: Custom Fields collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_custom_fields_collection'
custom_fields_201:
description: 'Created: Custom Field resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_custom_fields_single'
departments_200:
description: 'OK: Department resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_departments_single'
departments_200_collection:
description: 'OK: Departments collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_departments_collection'
departments_201:
description: 'Created: Department resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_departments_single'
divisions_200:
description: 'OK: Division resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_divisions_single'
divisions_200_collection:
description: 'OK: Divisions collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_divisions_collection'
divisions_201:
description: 'Created: Division resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_divisions_single'
equality_monitoring_categories_200:
description: 'OK: Equality Monitoring Category resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: >-
#/components/examples/jsonapi_equality_monitoring_categories_single
equality_monitoring_categories_200_collection:
description: 'OK: Equality Monitoring Categories collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: >-
#/components/examples/jsonapi_equality_monitoring_categories_collection
hiring_workflows_200:
description: 'OK: Hiring Workflow resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_hiring_workflows_single'
hiring_workflows_200_collection:
description: 'OK: Hiring Workflow collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_hiring_workflows_collection'
interviews_200:
description: 'OK: Interview resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_interviews_single'
interviews_200_collection:
description: 'OK: Interviews collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_interviews_collection'
jobs_200:
description: 'OK: Job resource'
content:
application/vnd.api+json:
examples:
sample:
$ref: '#/components/examples/jsonapi_jobs_collection'
jobs_201:
description: 'Created: Job resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_jobs_post'
jobs_200_collection:
description: 'OK: Jobs collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_jobs_collection'
job_seekers_200:
description: 'OK: Job Seeker resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_job_seekers_single'
job_seekers_200_collection:
description: 'OK: Job Seekers collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_job_seekers_collection'
locations_200:
description: 'OK: Location resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_locations_single'
locations_201:
description: 'Created: Location resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_locations_single'
locations_200_collection:
description: 'OK: Locations collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_locations_collection'
onboarding_applications_200:
description: 'OK: Onboarding application resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_onboarding_applications_single'
onboarding_applications_200_collection:
description: 'OK: Onboarding applications collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_onboarding_applications_collection'
requisitions_200:
description: 'OK: Requisition Template resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_requisitions_single'
requisitions_201:
description: 'Created: Requisition resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_requisitions_single'
requisitions_200_collection:
description: 'OK: Requisition Templates collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_requisitions_collection'
requisition_templates_200:
description: 'OK: Requisition Template resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_requisition_templates_single'
requisition_templates_200_collection:
description: 'OK: Requisition Templates collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_requisition_templates_collection'
structure_custom_group_ones_200:
description: 'OK: Structure Custom Group One resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_structure_custom_group_ones_single'
structure_custom_group_ones_200_collection:
description: 'OK: Structure Custom Group Ones collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: >-
#/components/examples/jsonapi_structure_custom_group_ones_collection
structure_custom_group_ones_201:
description: 'Created: Structure Custom Group One resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_structure_custom_group_ones_single'
structure_links_200:
description: 'OK: Structure Link resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_structure_links_single'
structure_links_200_collection:
description: 'OK: Structure Links collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_structure_links_collection'
structure_links_201:
description: 'Created: Structure Link resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_structure_links_single'
users_200:
description: 'OK: User resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_users_single'
users_201:
description: 'Created: User resource'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_users_single'
users_200_collection:
description: 'OK: Users collection'
content:
application/vnd.api+json:
examples:
jsonapi:
$ref: '#/components/examples/jsonapi_users_collection'
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
examples:
jsonapi_applications_collection:
value:
data:
- id: '1000014'
type: applications
attributes:
tags:
- context: rejection
name: Under-qualified for this role
summary: >-
I'm not a great developer, but I try and be a good developer
with great habits
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
hired_at: null
internal_candidate: false
job_id: '1000008'
locale: en
stage_id: '1000009'
rejected_at: '2019-01-01T00:00:00+00:00'
phone_iso2: JE
start_on: '2022-01-01'
is_demo: false
first_name: Joe
last_name: Bloggs
email: joe.bloggs@pinpoint.dev
phone: '+447797000000'
date_of_birth: null
linkedin_url: null
address1: One Waverley Place
address2: Union Street
town: St Helier
country: Jersey
postcode: JE1 2PP
preferred_pronouns: null
channel_source: Added manually
full_name: Joe Bloggs
national_identifier: null
channel: manual
concealed: false
attachments:
- context: cv
filename: luce_resume_pdf.pdf
url: >-
https://pinpointhq.com/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBcFFJIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--af3e54b95f524b3ccbada81286e0fce1b8da0279/luce_resume_pdf.pdf
average_rating: 1
relationships:
job:
data:
type: jobs
id: '1000008'
stage:
data:
type: stages
id: '1000009'
onboarding_application:
meta:
included: false
offers:
meta:
included: false
answers:
data:
- type: answers
id: '1000017'
- type: answers
id: '1000019'
- type: answers
id: '1000021'
- type: answers
id: '1000023'
- type: answers
id: '1000025'
- type: answers
id: '1000027'
- type: answers
id: '1000029'
custom_attributes:
data:
- type: custom_attributes
id: '447'
- type: custom_attributes
id: '448'
- type: custom_attributes
id: '449'
- type: custom_attributes
id: '450'
- type: custom_attributes
id: '451'
- type: custom_attributes
id: '452'
- type: custom_attributes
id: '453'
scorecard_ratings:
meta:
included: false
scorecard_notes:
meta:
included: false
scorecard_answers:
meta:
included: false
comments:
meta:
included: false
included:
- id: 1000008X
type: jobs
attributes:
title: Paint Watcher
description: "- >Ordered 1
>
\uFEFF![](\"https://res.cloudinary.com/pinpointhq/image/upload/v1656695528/uploads/development/p8qjvqbgk0tmr6sjqf4i.png\")
\uFEFF\uFEFFHealthcare plan
Generous vacation allowance
benefits_header: Benefits
compensation: £40,000 - £50,000 / year
compensation_minimum: 40000
compensation_maximum: 50000
compensation_currency: GBP
compensation_frequency: year
compensation_visible: true
deadline_at: '2030-01-01T00:00:00+00:00'
employment_type: full_time
employment_type_text: Full Time
key_responsibilities: >-
Ensuring dryness of paint
Keeping insects away from
paint
key_responsibilities_header: Key Responsibilities
opened_at: '2019-01-01T00:00:00+00:00'
remote: false
reporting_to: CTO
requisition_id: PAINT-4
skills_knowledge_expertise: >-
- Art Degree
- Experience with paint
- Clean
driving record
skills_knowledge_expertise_header: Skills, Knowledge and Experience
status: open
visibility: external
url: https://api-docs-subdomain.pinpointhq.com/en/jobs/1000008
path: /en/jobs/1000008
workplace_type: onsite
workplace_type_text: Onsite
relationships:
department:
meta:
included: false
division:
meta:
included: false
location:
meta:
included: false
structure_custom_group_one:
meta:
included: false
hiring_manager_user:
meta:
included: false
recruitment_manager_user:
meta:
included: false
applications:
meta:
included: false
questions:
meta:
included: false
custom_attributes:
meta:
included: false
stages:
meta:
included: false
- id: 1000009X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: rejected
external_name: null
visible: true
position: 1
basic_type: rejected
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
- id: 1000017X
type: answers
attributes:
title: Whats your greatest achievement?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: long_text
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: >-
I went back in a time machine and taught Claude Monet how to
paint
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000019X
type: answers
attributes:
title: Are you good at coding?
additional_information: Please answer the question
boolean_answer: true
document_answer: null
question_type: boolean
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000021X
type: answers
attributes:
title: What start date would you like?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: date
date_answer: '2024-06-06'
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000023X
type: answers
attributes:
title: What is your portfolio URL?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: url
date_answer: null
url_answer: https://www.google.com
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000025X
type: answers
attributes:
title: What is your favourite color?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: short_text
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: Red
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000027X
type: answers
attributes:
title: What are your favourite programming languages?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: multiple_choice
date_answer: null
url_answer: null
multiple_choice_answer:
- rose
- magenta
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000029X
type: answers
attributes:
title: Attach your favourite PDF
additional_information: Please answer the question
boolean_answer: null
document_answer:
context: document
filename: custom.pdf
url: >-
https://pinpointhq.com/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBcFVJIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--5d44aca931948a4a421c45a006820d73ba309487/custom.pdf
question_type: document
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 447X
type: custom_attributes
attributes:
value: Maroon
field_name: Favourite colour
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 448X
type: custom_attributes
attributes:
value: Someone finally bought a copy of your book sir!
field_name: Favourite Simpsons quotation
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 449X
type: custom_attributes
attributes:
value: '13'
field_name: Lucky number
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 450X
type: custom_attributes
attributes:
value: '3.14'
field_name: Lucky decimal number
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 451X
type: custom_attributes
attributes:
value: 'true'
field_name: Was a checkbox ticked?
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 452X
type: custom_attributes
attributes:
value: Tomato
field_name: Favourite vegetable
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 453X
type: custom_attributes
attributes:
value: Maroon, Vermillion, and Blue
field_name: Favourite colours
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
meta: {}
jsonapi_applications_post:
value:
data:
type: applications
attributes:
summary: This is my personal summary
first_name: Joe
last_name: Bloggs
email: joe.bloggs@pinpoint.dev
phone: '02033189441'
phone_iso2: JE
start_on: '2022-01-01'
address1: One Waverley Place
address2: Union Street
town: St Helier
country: Jersey
postcode: JE1 2PP
date_of_birth: '1970-01-01'
linkedin_url: https://www.linkedin.com/company/pinpointhq
cv_base64_filename: resume.pdf
cv_base64_data: data:application/pdf;base64,...[DATA]...
relationships:
job:
data:
type: jobs
id: '1'
answers:
data:
- type: answers
method: create
temp-id: '1'
- type: answers
method: create
temp-id: '2'
- type: answers
method: create
temp-id: '3'
- type: answers
method: create
temp-id: '4'
- type: answers
method: create
temp-id: '5'
- type: answers
method: create
temp-id: '6'
- type: answers
method: create
temp-id: '7'
included:
- type: answers
temp-id: '1'
attributes:
boolean_answer: true
relationships:
question:
data:
id: 1X
type: questions
- type: answers
temp-id: '2'
attributes:
text_answer: >-
This is the first line of a multiline answer/nThis is the second
line
relationships:
question:
data:
id: '2'
type: questions
- type: answers
temp-id: '3'
attributes: {}
relationships:
answer_options:
data:
- type: answer_options
method: create
temp-id: answer-option-1
- type: answer_options
method: create
temp-id: answer-option-2
question:
data:
id: '3'
type: questions
- type: answers
temp-id: '4'
attributes:
document_base64_filename: another.pdf
document_base64_data: data:application/pdf;base64,...[DATA]...
relationships:
question:
data:
id: '4'
type: questions
- type: answers
temp-id: '5'
attributes:
date_answer: '2024-06-06'
relationships:
question:
data:
id: '5'
type: questions
- type: answers
temp-id: '6'
attributes:
url_answer: https://pinpointhq.com
relationships:
question:
data:
id: '6'
type: questions
- type: answers
temp-id: '7'
attributes:
text_answer: Ruby
relationships:
question:
data:
id: '7'
type: questions
- type: answer_options
temp-id: answer-option-1
attributes:
text: Ruby
- type: answer_options
temp-id: answer-option-2
attributes:
text: Blue
jsonapi_applications_put:
value:
data:
id: 1X
type: applications
attributes:
first_name: Joe
last_name: Bloggs
email: joe.bloggs@pinpoint.dev
phone: '02033189441'
phone_iso2: JE
start_on: '2022-01-01'
address1: One Waverley Place
address2: Union Street
town: St Helier
country: Jersey
postcode: JE1 2PP
date_of_birth: '1970-01-01'
linkedin_url: https://www.linkedin.com/company/pinpointhq
relationships:
job:
data:
type: stages
id: 2X
jsonapi_applications_single:
value:
data:
id: '1000050'
type: applications
attributes:
tags:
- context: rejection
name: Under-qualified for this role
summary: >-
I'm not a great developer, but I try and be a good developer with
great habits
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
hired_at: null
internal_candidate: false
job_id: '1000044'
locale: en
stage_id: '1000045'
rejected_at: '2019-01-01T00:00:00+00:00'
phone_iso2: JE
start_on: '2022-01-01'
is_demo: false
first_name: Joe
last_name: Bloggs
email: joe.bloggs@pinpoint.dev
phone: '+447797000000'
date_of_birth: null
linkedin_url: null
address1: One Waverley Place
address2: Union Street
town: St Helier
country: Jersey
postcode: JE1 2PP
preferred_pronouns: null
channel_source: Added manually
full_name: Joe Bloggs
national_identifier: null
channel: manual
concealed: false
attachments:
- context: cv
filename: luce_resume_pdf.pdf
url: >-
https://pinpointhq.com/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBcFlJIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--22125b214a8a187d3388509251d893b140b787e2/luce_resume_pdf.pdf
average_rating: 1
relationships:
job:
data:
type: jobs
id: '1000044'
stage:
data:
type: stages
id: '1000045'
onboarding_application:
meta:
included: false
offers:
meta:
included: false
answers:
data:
- type: answers
id: '1000053'
- type: answers
id: '1000055'
- type: answers
id: '1000057'
- type: answers
id: '1000059'
- type: answers
id: '1000061'
- type: answers
id: '1000063'
- type: answers
id: '1000065'
custom_attributes:
data:
- type: custom_attributes
id: '454'
- type: custom_attributes
id: '455'
- type: custom_attributes
id: '456'
- type: custom_attributes
id: '457'
- type: custom_attributes
id: '458'
- type: custom_attributes
id: '459'
- type: custom_attributes
id: '460'
scorecard_ratings:
meta:
included: false
scorecard_notes:
meta:
included: false
scorecard_answers:
meta:
included: false
comments:
meta:
included: false
included:
- id: 1000044X
type: jobs
attributes:
title: Paint Watcher
description: "- >Ordered 1
>
\uFEFF\uFEFF\uFEFFHealthcare plan
Generous vacation allowance
benefits_header: Benefits
compensation: £40,000 - £50,000 / year
compensation_minimum: 40000
compensation_maximum: 50000
compensation_currency: GBP
compensation_frequency: year
compensation_visible: true
deadline_at: '2030-01-01T00:00:00+00:00'
employment_type: full_time
employment_type_text: Full Time
key_responsibilities: >-
Ensuring dryness of paint
Keeping insects away from
paint
key_responsibilities_header: Key Responsibilities
opened_at: '2019-01-01T00:00:00+00:00'
remote: false
reporting_to: CTO
requisition_id: PAINT-4
skills_knowledge_expertise: >-
- Art Degree
- Experience with paint
- Clean
driving record
skills_knowledge_expertise_header: Skills, Knowledge and Experience
status: open
visibility: external
url: https://api-docs-subdomain.pinpointhq.com/en/jobs/1000044
path: /en/jobs/1000044
workplace_type: onsite
workplace_type_text: Onsite
relationships:
department:
meta:
included: false
division:
meta:
included: false
location:
meta:
included: false
structure_custom_group_one:
meta:
included: false
hiring_manager_user:
meta:
included: false
recruitment_manager_user:
meta:
included: false
applications:
meta:
included: false
questions:
meta:
included: false
custom_attributes:
meta:
included: false
stages:
meta:
included: false
- id: 1000045X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: rejected
external_name: null
visible: true
position: 1
basic_type: rejected
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
- id: 1000053X
type: answers
attributes:
title: Whats your greatest achievement?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: long_text
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: >-
I went back in a time machine and taught Claude Monet how to
paint
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000055X
type: answers
attributes:
title: Are you good at coding?
additional_information: Please answer the question
boolean_answer: true
document_answer: null
question_type: boolean
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000057X
type: answers
attributes:
title: What start date would you like?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: date
date_answer: '2024-06-06'
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000059X
type: answers
attributes:
title: What is your portfolio URL?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: url
date_answer: null
url_answer: https://www.google.com
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000061X
type: answers
attributes:
title: What is your favourite color?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: short_text
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: Red
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000063X
type: answers
attributes:
title: What are your favourite programming languages?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: multiple_choice
date_answer: null
url_answer: null
multiple_choice_answer:
- sky
- lemon
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000065X
type: answers
attributes:
title: Attach your favourite PDF
additional_information: Please answer the question
boolean_answer: null
document_answer:
context: document
filename: custom.pdf
url: >-
https://pinpointhq.com/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBcGNJIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--7051f874fb9ccb9ccf47f382100f5759a94434c6/custom.pdf
question_type: document
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 454X
type: custom_attributes
attributes:
value: Maroon
field_name: Favourite colour
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 455X
type: custom_attributes
attributes:
value: Someone finally bought a copy of your book sir!
field_name: Favourite Simpsons quotation
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 456X
type: custom_attributes
attributes:
value: '13'
field_name: Lucky number
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 457X
type: custom_attributes
attributes:
value: '3.14'
field_name: Lucky decimal number
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 458X
type: custom_attributes
attributes:
value: 'true'
field_name: Was a checkbox ticked?
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 459X
type: custom_attributes
attributes:
value: Tomato
field_name: Favourite vegetable
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 460X
type: custom_attributes
attributes:
value: Maroon, Vermillion, and Blue
field_name: Favourite colours
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
meta: {}
jsonapi_comments_collection:
value:
data:
- id: '1000088'
type: comments
attributes:
body_text: This candidate is fantastic!
commentable_id: '1000086'
commentable_type: Application
created_at: '2019-01-01T00:00:00+00:00'
private_comment: false
updated_at: '2019-01-01T00:00:00+00:00'
user_id: '1000087'
relationships:
user:
data:
type: users
id: '1000087'
commentable:
data:
type: applications
id: '1000086'
included:
- id: 1000087X
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person6@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000086X
type: applications
attributes:
summary: >-
I'm not a great developer, but I try and be a good developer
with great habits
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
hired_at: null
internal_candidate: false
job_id: '1000080'
locale: en
stage_id: '1000081'
rejected_at: '2019-01-01T00:00:00+00:00'
phone_iso2: JE
start_on: '2022-01-01'
is_demo: false
first_name: Joe
last_name: Bloggs
email: joe.bloggs@pinpoint.dev
phone: '+447797000000'
date_of_birth: null
linkedin_url: null
address1: One Waverley Place
address2: Union Street
town: St Helier
country: Jersey
postcode: JE1 2PP
preferred_pronouns: null
channel_source: Added manually
full_name: Joe Bloggs
national_identifier: null
channel: manual
concealed: false
relationships:
job:
meta:
included: false
stage:
meta:
included: false
onboarding_application:
meta:
included: false
offers:
meta:
included: false
answers:
meta:
included: false
custom_attributes:
meta:
included: false
scorecard_ratings:
meta:
included: false
scorecard_notes:
meta:
included: false
scorecard_answers:
meta:
included: false
comments:
meta:
included: false
meta: {}
jsonapi_comments_post:
value:
data:
type: comments
attributes:
body_text: This candidate is fantastic!
relationships:
commentable:
data:
type: applications
id: 1X
jsonapi_comments_single:
value:
data:
id: '1000104'
type: comments
attributes:
body_text: This candidate is fantastic!
commentable_id: '1000102'
commentable_type: Application
created_at: '2019-01-01T00:00:00+00:00'
private_comment: false
updated_at: '2019-01-01T00:00:00+00:00'
user_id: '1000103'
relationships:
user:
data:
type: users
id: '1000103'
commentable:
data:
type: applications
id: '1000102'
included:
- id: 1000103X
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person8@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000102X
type: applications
attributes:
summary: >-
I'm not a great developer, but I try and be a good developer
with great habits
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
hired_at: null
internal_candidate: false
job_id: '1000096'
locale: en
stage_id: '1000097'
rejected_at: '2019-01-01T00:00:00+00:00'
phone_iso2: JE
start_on: '2022-01-01'
is_demo: false
first_name: Joe
last_name: Bloggs
email: joe.bloggs@pinpoint.dev
phone: '+447797000000'
date_of_birth: null
linkedin_url: null
address1: One Waverley Place
address2: Union Street
town: St Helier
country: Jersey
postcode: JE1 2PP
preferred_pronouns: null
channel_source: Added manually
full_name: Joe Bloggs
national_identifier: null
channel: manual
concealed: false
relationships:
job:
meta:
included: false
stage:
meta:
included: false
onboarding_application:
meta:
included: false
offers:
meta:
included: false
answers:
meta:
included: false
custom_attributes:
meta:
included: false
scorecard_ratings:
meta:
included: false
scorecard_notes:
meta:
included: false
scorecard_answers:
meta:
included: false
comments:
meta:
included: false
meta: {}
jsonapi_custom_attributes_collection:
value:
data:
- id: '17'
type: custom_attributes
attributes:
value: Tomato
field_name: Favourite vegetable
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_field:
data:
type: custom_fields
id: '1000119'
custom_attributable:
data:
type: jobs
id: '1000113'
included:
- id: 1000119X
type: custom_fields
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
field_type: single_select
name: Favourite vegetable
options:
- option 1
- options 2
position: 1
required: false
resource_type: job
sample_value: Sample value
unique_reference: custom_field_1000119
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000113X
type: jobs
attributes:
title: Paint Watcher
description: "- >Ordered 1
>
\uFEFF\uFEFF\uFEFFHealthcare plan
Generous vacation allowance
benefits_header: Benefits
compensation: £40,000 - £50,000 / year
compensation_minimum: 40000
compensation_maximum: 50000
compensation_currency: GBP
compensation_frequency: year
compensation_visible: true
deadline_at: '2030-01-01T00:00:00+00:00'
employment_type: full_time
employment_type_text: Full Time
key_responsibilities: >-
Ensuring dryness of paint
Keeping insects away from
paint
key_responsibilities_header: Key Responsibilities
opened_at: '2019-01-01T00:00:00+00:00'
remote: false
reporting_to: CTO
requisition_id: PAINT-4
skills_knowledge_expertise: >-
- Art Degree
- Experience with paint
- Clean
driving record
skills_knowledge_expertise_header: Skills, Knowledge and Experience
status: open
visibility: external
url: https://api-docs-subdomain.pinpointhq.com/en/jobs/1000168
path: /en/jobs/1000168
workplace_type: onsite
workplace_type_text: Onsite
relationships:
department:
meta:
included: false
division:
meta:
included: false
location:
meta:
included: false
structure_custom_group_one:
meta:
included: false
hiring_manager_user:
meta:
included: false
recruitment_manager_user:
meta:
included: false
applications:
meta:
included: false
questions:
meta:
included: false
custom_attributes:
meta:
included: false
stages:
meta:
included: false
meta: {}
jsonapi_custom_attributes_post_boolean:
description: Boolean value
value:
data:
type: custom_attributes
attributes:
boolean_value: true
relationships:
custom_field:
data:
type: custom_fields
id: 1X
custom_attributable:
data:
type: jobs
id: 1X
jsonapi_custom_attributes_post_date:
description: Date value
value:
data:
type: custom_attributes
attributes:
date_value: '2020-01-01T00:00:00.000Z'
relationships:
custom_field:
data:
type: custom_fields
id: 1X
custom_attributable:
data:
type: jobs
id: 1X
jsonapi_custom_attributes_post_decimal:
description: Decimal value
value:
data:
type: custom_attributes
attributes:
decimal_value: 123.123
relationships:
custom_field:
data:
type: custom_fields
id: 1X
custom_attributable:
data:
type: jobs
id: 1X
jsonapi_custom_attributes_post_integer:
description: Integer value
value:
data:
type: custom_attributes
attributes:
integer_value: 123
relationships:
custom_field:
data:
type: custom_fields
id: 1X
custom_attributable:
data:
type: jobs
id: 1X
jsonapi_custom_attributes_post_multi_select:
description: Multi-select value
value:
data:
type: custom_attributes
attributes:
multi_select_value:
- Option one
- Option two
relationships:
custom_field:
data:
type: custom_fields
id: 1X
custom_attributable:
data:
id: 1X
type: jobs
jsonapi_custom_attributes_post_single_select:
description: Single-select value
value:
data:
type: custom_attributes
attributes:
single_select_value: Option one
relationships:
custom_field:
data:
type: custom_fields
id: 1X
custom_attributable:
data:
type: jobs
id: 1X
jsonapi_custom_attributes_post_text:
description: Text value
value:
data:
type: custom_attributes
attributes:
text_value: Hello, Globe!
relationships:
custom_field:
data:
type: custom_fields
id: 1X
custom_attributable:
data:
type: jobs
id: 1X
jsonapi_custom_attributes_post_varchar:
description: Varchar value
value:
data:
type: custom_attributes
attributes:
varchar_value: Hello, Globe!
relationships:
custom_field:
data:
type: custom_fields
id: 1X
custom_attributable:
data:
type: jobs
id: 1X
jsonapi_custom_attributes_put_boolean:
description: Boolean value
value:
data:
type: custom_attributes
attributes:
boolean_value: true
jsonapi_custom_attributes_put_date:
description: Date value
value:
data:
type: custom_attributes
attributes:
date_value: '2020-01-01T00:00:00.000Z'
jsonapi_custom_attributes_put_decimal:
description: Decimal value
value:
data:
type: custom_attributes
attributes:
decimal_value: 123.123
jsonapi_custom_attributes_put_integer:
description: Integer value
value:
data:
type: custom_attributes
attributes:
integer_value: 123
jsonapi_custom_attributes_put_multi_select:
description: Multi-select value
value:
data:
type: custom_attributes
attributes:
multi_select_value:
- Option one
jsonapi_custom_attributes_put_single_select:
description: Single-select value
value:
data:
type: custom_attributes
attributes:
single_select_value: Option one
jsonapi_custom_attributes_put_text:
description: Text value
value:
data:
type: custom_attributes
attributes:
text_value: Hello, Globe!
jsonapi_custom_attributes_put_varchar:
description: Varchar value
value:
data:
type: custom_attributes
attributes:
varchar_value: Hello, Globe!
jsonapi_custom_attributes_single:
value:
data:
id: '18'
type: custom_attributes
attributes:
value: Tomato
field_name: Favourite vegetable
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_field:
data:
type: custom_fields
id: '1000134'
custom_attributable:
data:
type: jobs
id: '1000128'
included:
- id: 1000134X
type: custom_fields
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
field_type: single_select
name: Favourite vegetable
options:
- option 1
- options 2
position: 1
required: false
resource_type: job
sample_value: Sample value
unique_reference: custom_field_1000134
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000128X
type: jobs
attributes:
title: Paint Watcher
description: "- >Ordered 1
>
\uFEFF\uFEFF\uFEFFHealthcare plan
Generous vacation allowance
benefits_header: Benefits
compensation: £40,000 - £50,000 / year
compensation_minimum: 40000
compensation_maximum: 50000
compensation_currency: GBP
compensation_frequency: year
compensation_visible: true
deadline_at: '2030-01-01T00:00:00+00:00'
employment_type: full_time
employment_type_text: Full Time
key_responsibilities: >-
Ensuring dryness of paint
Keeping insects away from
paint
key_responsibilities_header: Key Responsibilities
opened_at: '2019-01-01T00:00:00+00:00'
remote: false
reporting_to: CTO
requisition_id: PAINT-4
skills_knowledge_expertise: >-
- Art Degree
- Experience with paint
- Clean
driving record
skills_knowledge_expertise_header: Skills, Knowledge and Experience
status: open
visibility: external
url: https://api-docs-subdomain.pinpointhq.com/en/jobs/1000168
path: /en/jobs/1000168
workplace_type: onsite
workplace_type_text: Onsite
relationships:
department:
meta:
included: false
division:
meta:
included: false
location:
meta:
included: false
structure_custom_group_one:
meta:
included: false
hiring_manager_user:
meta:
included: false
recruitment_manager_user:
meta:
included: false
applications:
meta:
included: false
questions:
meta:
included: false
custom_attributes:
meta:
included: false
stages:
meta:
included: false
meta: {}
jsonapi_custom_fields_collection:
value:
data:
- id: '1000107'
type: custom_fields
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
field_type: single_select
name: Single select - job 1
options:
- option 1
- options 2
position: 0
required: false
resource_type: job
sample_value: Sample value
unique_reference: custom_field_1000107
updated_at: '2019-01-01T00:00:00+00:00'
meta: {}
jsonapi_custom_fields_post:
value:
data:
type: custom_fields
attributes:
description: Our internal code for the role
name: Internal job code
resource_type: job
field_type: single_select
options:
- Option one
- Option two
required: true
sample_value: Option one
jsonapi_custom_fields_put:
value:
data:
id: 1X
type: custom_fields
attributes:
description: Our internal code for the role
name: Internal job code
options:
- Option one
- Option two
required: true
sample_value: Option one
jsonapi_custom_fields_single:
value:
data:
id: '1000110'
type: custom_fields
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
field_type: single_select
name: Single select - job 2
options:
- option 1
- options 2
position: 0
required: false
resource_type: job
sample_value: Sample value
unique_reference: custom_field_1000110
updated_at: '2019-01-01T00:00:00+00:00'
meta: {}
jsonapi_departments_collection:
value:
data:
- id: 1000113X
type: departments
attributes:
created_at: '2019-01-01T00:00:00+00:00'
name: Software Development
updated_at: '2019-01-01T00:00:00+00:00'
meta: {}
jsonapi_departments_post:
value:
data:
type: departments
attributes:
name: Software Development
jsonapi_departments_put:
value:
data:
id: 1XX
type: departments
attributes:
name: Software Development
jsonapi_departments_single:
value:
data:
id: '1000116'
type: departments
attributes:
created_at: '2019-01-01T00:00:00+00:00'
name: Software Development
updated_at: '2019-01-01T00:00:00+00:00'
meta: {}
jsonapi_divisions_collection:
value:
data:
- id: 1000119X
type: divisions
attributes:
created_at: '2019-01-01T00:00:00+00:00'
name: EU
updated_at: '2019-01-01T00:00:00+00:00'
meta: {}
jsonapi_divisions_post:
value:
data:
type: divisions
attributes:
name: EU
jsonapi_divisions_put:
value:
data:
id: 1XX
type: divisions
attributes:
name: EU
jsonapi_divisions_single:
value:
data:
id: '1000122'
type: divisions
attributes:
created_at: '2019-01-01T00:00:00+00:00'
name: EU
updated_at: '2019-01-01T00:00:00+00:00'
meta: {}
jsonapi_equality_monitoring_categories_collection:
value:
data:
- id: '1000125'
type: equality_monitoring_categories
attributes:
created_at: '2019-01-01T00:00:00+00:00'
enabled: true
name: Gender
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
equality_monitoring_options:
meta:
included: false
meta: {}
jsonapi_equality_monitoring_categories_single:
value:
data:
id: 1000128X
type: equality_monitoring_categories
attributes:
created_at: '2019-01-01T00:00:00+00:00'
enabled: true
name: Gender
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
equality_monitoring_options:
meta:
included: false
meta: {}
jsonapi_interviews_collection:
value:
data:
- id: '23'
type: interviews
attributes:
start_at: '2031-01-02T08:00:00+00:00'
end_at: '2031-01-02T09:00:00+00:00'
interviewable_id: '1000142'
interviewable_type: Application
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
status: scheduled
relationships:
stage:
data:
type: stages
id: '1000140'
interview_parts:
data:
- type: interview_parts
id: '41'
- type: interview_parts
id: '42'
interviewable:
data:
type: applications
id: '1000142'
included:
- id: 1000140X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: interview
external_name: null
visible: true
position: 4
basic_type: interview
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
- id: 41X
type: interview_parts
attributes:
created_at: '2019-01-01T00:00:00+00:00'
company_id: '1000130'
conferencing_join_url: null
conferencing_provider_name: null
interview_id: '23'
position: 2
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
interview:
meta:
included: false
interviewing_users:
data:
- type: users
id: '1000143'
- id: 42X
type: interview_parts
attributes:
created_at: '2019-01-01T00:00:00+00:00'
company_id: '1000130'
conferencing_join_url: null
conferencing_provider_name: null
interview_id: '23'
position: 1
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
interview:
meta:
included: false
interviewing_users:
data:
- type: users
id: '1000144'
- id: 1000142X
type: applications
attributes:
summary: >-
I'm not a great developer, but I try and be a good developer
with great habits
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
hired_at: null
internal_candidate: false
job_id: '1000136'
locale: en
stage_id: '1000137'
rejected_at: '2019-01-01T00:00:00+00:00'
phone_iso2: JE
start_on: '2022-01-01'
is_demo: false
first_name: Joe
last_name: Bloggs
email: joe.bloggs@pinpoint.dev
phone: '+447797000000'
date_of_birth: null
linkedin_url: null
address1: One Waverley Place
address2: Union Street
town: St Helier
country: Jersey
postcode: JE1 2PP
preferred_pronouns: null
channel_source: Added manually
full_name: Joe Bloggs
national_identifier: null
channel: manual
concealed: false
relationships:
job:
meta:
included: false
stage:
meta:
included: false
onboarding_application:
meta:
included: false
offers:
meta:
included: false
answers:
meta:
included: false
custom_attributes:
meta:
included: false
scorecard_ratings:
meta:
included: false
scorecard_notes:
meta:
included: false
scorecard_answers:
meta:
included: false
comments:
meta:
included: false
- id: 1000143X
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person18@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000144X
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person19@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
meta: {}
jsonapi_interviews_single:
value:
data:
id: '24'
type: interviews
attributes:
start_at: '2031-01-02T08:00:00+00:00'
end_at: '2031-01-02T09:00:00+00:00'
interviewable_id: '1000158'
interviewable_type: Application
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
status: scheduled
relationships:
stage:
data:
type: stages
id: '1000156'
interview_parts:
data:
- type: interview_parts
id: '43'
- type: interview_parts
id: '44'
interviewable:
data:
type: applications
id: '1000158'
included:
- id: 1000156X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: interview
external_name: null
visible: true
position: 4
basic_type: interview
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
- id: 43X
type: interview_parts
attributes:
created_at: '2019-01-01T00:00:00+00:00'
company_id: '1000146'
conferencing_join_url: null
conferencing_provider_name: null
interview_id: '24'
position: 2
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
interview:
meta:
included: false
interviewing_users:
data:
- type: users
id: '1000159'
- id: 44X
type: interview_parts
attributes:
created_at: '2019-01-01T00:00:00+00:00'
company_id: '1000146'
conferencing_join_url: null
conferencing_provider_name: null
interview_id: '24'
position: 1
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
interview:
meta:
included: false
interviewing_users:
data:
- type: users
id: '1000160'
- id: 1000158X
type: applications
attributes:
summary: >-
I'm not a great developer, but I try and be a good developer
with great habits
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
hired_at: null
internal_candidate: false
job_id: '1000152'
locale: en
stage_id: '1000153'
rejected_at: '2019-01-01T00:00:00+00:00'
phone_iso2: JE
start_on: '2022-01-01'
is_demo: false
first_name: Joe
last_name: Bloggs
email: joe.bloggs@pinpoint.dev
phone: '+447797000000'
date_of_birth: null
linkedin_url: null
address1: One Waverley Place
address2: Union Street
town: St Helier
country: Jersey
postcode: JE1 2PP
preferred_pronouns: null
channel_source: Added manually
full_name: Joe Bloggs
national_identifier: null
channel: manual
concealed: false
relationships:
job:
meta:
included: false
stage:
meta:
included: false
onboarding_application:
meta:
included: false
offers:
meta:
included: false
answers:
meta:
included: false
custom_attributes:
meta:
included: false
scorecard_ratings:
meta:
included: false
scorecard_notes:
meta:
included: false
scorecard_answers:
meta:
included: false
comments:
meta:
included: false
- id: 1000159X
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person25@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000160X
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person26@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
meta: {}
jsonapi_hiring_workflows_single:
value:
data:
id: 1X
type: hiring_workflows
attributes:
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: Hiring workflow
relationships:
stages:
meta:
included: false
meta: {}
jsonapi_hiring_workflows_collection:
value:
data:
- id: 1X
type: hiring_workflows
attributes:
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: Hiring workflow
relationships:
stages:
meta:
included: false
meta: {}
jsonapi_jobs_collection:
value:
data:
- id: '1000168'
type: jobs
attributes:
title: Paint Watcher
description: "- >Ordered 1
>
\uFEFF\uFEFF\uFEFFHealthcare plan
Generous vacation allowance
benefits_header: Benefits
compensation: £40,000 - £50,000 / year
compensation_minimum: 40000
compensation_maximum: 50000
compensation_currency: GBP
compensation_frequency: year
compensation_visible: true
deadline_at: '2030-01-01T00:00:00+00:00'
employment_type: full_time
employment_type_text: Full Time
key_responsibilities: >-
Ensuring dryness of paint
Keeping insects away from
paint
key_responsibilities_header: Key Responsibilities
opened_at: '2019-01-01T00:00:00+00:00'
remote: false
reporting_to: CTO
requisition_id: PAINT-4
skills_knowledge_expertise: >-
- Art Degree
- Experience with paint
- Clean
driving record
skills_knowledge_expertise_header: Skills, Knowledge and Experience
status: open
visibility: external
url: https://api-docs-subdomain.pinpointhq.com/en/jobs/1000168
path: /en/jobs/1000168
workplace_type: onsite
workplace_type_text: Onsite
relationships:
department:
data:
type: departments
id: '1000165'
division:
data:
type: divisions
id: '1000163'
location:
data:
type: locations
id: '1000164'
structure_custom_group_one:
data:
type: structure_custom_group_ones
id: '1000166'
hiring_manager_user:
data:
type: users
id: '1000188'
recruitment_manager_user:
data:
type: users
id: '1000189'
applications:
meta:
included: false
questions:
data: []
custom_attributes:
data:
- type: custom_attributes
id: '461'
- type: custom_attributes
id: '462'
- type: custom_attributes
id: '463'
- type: custom_attributes
id: '464'
- type: custom_attributes
id: '465'
- type: custom_attributes
id: '466'
- type: custom_attributes
id: '467'
stages:
data:
- type: stages
id: '1000169'
- type: stages
id: '1000170'
- type: stages
id: '1000171'
- type: stages
id: '1000172'
- type: stages
id: '1000173'
included:
- id: 1000165X
type: departments
attributes:
created_at: '2019-01-01T00:00:00+00:00'
name: Software Development
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000163X
type: divisions
attributes:
created_at: '2019-01-01T00:00:00+00:00'
name: EU
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000164X
type: locations
attributes:
city: South Thurmanbury
country_code: DO
created_at: '2019-01-01T00:00:00+00:00'
name: Jersey
postal_code: 49138-3806
province: California
street_address: 782 Leslie Motorway
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
equality_monitoring_template:
meta:
included: false
- id: 1000166X
type: structure_custom_group_ones
attributes:
title: Sub Department
created_at: '2019-01-01T00:00:00+00:00'
name: DevOps
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
jobs:
meta:
included: false
- id: 1000188X
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person32@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000189X
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person33@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
- id: 461X
type: custom_attributes
attributes:
value: Maroon
field_name: Favourite colour
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 462X
type: custom_attributes
attributes:
value: Someone finally bought a copy of your book sir!
field_name: Favourite Simpsons quotation
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 463X
type: custom_attributes
attributes:
value: '13'
field_name: Lucky number
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 464X
type: custom_attributes
attributes:
value: '3.14'
field_name: Lucky decimal number
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 465X
type: custom_attributes
attributes:
value: 'true'
field_name: Was a checkbox ticked?
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 466X
type: custom_attributes
attributes:
value: Tomato
field_name: Favourite vegetable
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 467X
type: custom_attributes
attributes:
value: Maroon, Vermillion, and Blue
field_name: Favourite colours
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 1000169X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: rejected
external_name: null
visible: true
position: 1
basic_type: rejected
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
- id: 1000170X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: applied
external_name: null
visible: true
position: 2
basic_type: applied
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
- id: 1000171X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: review
external_name: null
visible: true
position: 3
basic_type: review
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
- id: 1000172X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: interview
external_name: null
visible: true
position: 4
basic_type: interview
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
- id: 1000173X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: hired
external_name: null
visible: true
position: 5
basic_type: hired
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
meta: {}
jsonapi_jobs_post:
value:
data:
id: 1XX
type: jobs
attributes:
title: Test Job
description: This is a test job
ask_for_address: true
ask_for_date_of_birth: true
ask_for_linkedin_profile: true
ask_for_middle_name: true
blind_screening: true
benefits: All the benefits
created_at: '2023-11-10T10:57:58+00:00'
updated_at: '2023-11-10T10:57:58+00:00'
application_form_url: https://acme.pinpointhq.com/en/jobs/1/applications/new
benefits_header: External benefits header
compensation: £25,000 - £50,000 / year
compensation_minimum: '25000.0'
compensation_maximum: '50000.0'
compensation_currency: GBP
compensation_frequency: year
cover_letter_requirement: required
deadline_on: '2025-01-01'
compensation_visible: true
custom_town: Dorking
custom_county: Surrey
custom_country: United Kingdom
company_name_override: Company name override
deadline_at: '2025-01-01T00:00:00+00:00'
diversity_monitoring: true
diversity_monitoring_requirement: optional
draft_job_additional_information: Draft job additional information
employment_type: full_time
employment_type_text: Full Time
experience_level: director
external_key_responsibilities_header: External key responsibilities header
external_skills_knowledge_expertise_header: External skills/knowledge/expertise header
external_benefits_header: External benefits header
headcount_maximum_enabled: true
headcount_maximum: 10
include_in_linkedin_rss: true
include_in_indeed: true
key_responsibilities: Key responsibilities
key_responsibilities_header: External key responsibilities header
linkedin_company_id: '12345'
notify: true
opened_at: '2023-11-10T10:57:58+00:00'
personal_summary_requirement: required
referrals_enabled: true
referral_amount: 1000
referral_currency: GBP
referral_details: Tell us about your best co-workers
reporting_to: CTO
require_phone: true
resume_requirement: required
remote: false
is_compensation_visible: true
is_remote_with_location_restrictions: true
requisition_id: '1'
skills_knowledge_expertise_header: External skills/knowledge/expertise header
skills_knowledge_expertise: Skills/knowledge/expertise
status: draft
visibility: external
url: https://acme.pinpointhq.com/en/jobs/1
path: /en/jobs/1
workplace_type: hybrid
workplace_type_text: Hybrid
company_id: '1'
structure_link_id: '1'
hiring_user_id: '1'
recruitment_manager_user_id: '1'
facebookjobs: true
monster: true
talentdotcom: true
ziprecruiter: true
selected_hiring_workflow_id: '1'
relationships:
department:
meta:
included: false
division:
meta:
included: false
location:
meta:
included: false
structure_custom_group_one:
meta:
included: false
company:
data:
type: companies
id: 1XX
structure_link:
data:
type: structure_links
id: 1XX
hiring_manager_user:
meta:
included: false
recruitment_manager_user:
meta:
included: false
applications:
meta:
included: false
questions:
meta:
included: false
custom_attributes:
meta:
included: false
stages:
meta:
included: false
included:
- id: 1XX
type: companies
attributes:
created_at: '2023-11-02T11:13:39+00:00'
updated_at: '2023-11-02T11:19:02+00:00'
name: ACME Corporation
industry: Software
location: Jersey
website: https://www.pinpointhq.com
- id: 1XX
type: structure_links
attributes:
created_at: '2023-11-02T11:13:55+00:00'
updated_at: '2023-11-02T11:13:55+00:00'
division_id: null
location_id: '3'
department_id: '5'
structure_custom_group_one_id: null
accepts_speculative_applications: true
relationships:
location:
meta:
included: false
department:
meta:
included: false
division:
meta:
included: false
structure_custom_group_one:
meta:
included: false
meta: {}
jsonapi_jobs_put:
value:
data:
id: 1XX
type: jobs
attributes:
title: Test Job
description: This is a test job
ask_for_address: true
ask_for_date_of_birth: true
ask_for_linkedin_profile: true
ask_for_middle_name: true
blind_screening: true
benefits: All the benefits
created_at: '2023-11-10T10:57:58+00:00'
updated_at: '2023-11-10T10:57:58+00:00'
application_form_url: https://acme.pinpointhq.com/en/jobs/1/applications/new
benefits_header: External benefits header
compensation: £25,000 - £50,000 / year
compensation_minimum: '25000.0'
compensation_maximum: '50000.0'
compensation_currency: GBP
compensation_frequency: year
cover_letter_requirement: required
deadline_on: '2025-01-01'
compensation_visible: true
custom_town: Dorking
custom_county: Surrey
custom_country: United Kingdom
company_name_override: Company name override
deadline_at: '2025-01-01T00:00:00+00:00'
diversity_monitoring: true
diversity_monitoring_requirement: optional
draft_job_additional_information: Draft job additional information
employment_type: full_time
employment_type_text: Full Time
experience_level: director
external_key_responsibilities_header: External key responsibilities header
external_skills_knowledge_expertise_header: External skills/knowledge/expertise header
external_benefits_header: External benefits header
headcount_maximum_enabled: true
headcount_maximum: 10
include_in_linkedin_rss: true
include_in_indeed: true
key_responsibilities: Key responsibilities
key_responsibilities_header: External key responsibilities header
linkedin_company_id: '12345'
notify: true
opened_at: '2023-11-10T10:57:58+00:00'
personal_summary_requirement: required
referrals_enabled: true
referral_amount: 1000
referral_currency: GBP
referral_details: Tell us about your best co-workers
reporting_to: CTO
require_phone: true
resume_requirement: required
remote: false
is_compensation_visible: true
is_remote_with_location_restrictions: true
requisition_id: '1'
skills_knowledge_expertise_header: External skills/knowledge/expertise header
skills_knowledge_expertise: Skills/knowledge/expertise
status: draft
visibility: external
url: https://acme.pinpointhq.com/en/jobs/1
path: /en/jobs/1
workplace_type: hybrid
workplace_type_text: Hybrid
company_id: '1'
structure_link_id: '1'
hiring_user_id: '1'
recruitment_manager_user_id: '1'
facebookjobs: true
monster: true
talentdotcom: true
ziprecruiter: true
selected_hiring_workflow_id: '1'
relationships:
department:
meta:
included: false
division:
meta:
included: false
location:
meta:
included: false
structure_custom_group_one:
meta:
included: false
company:
data:
type: companies
id: 1XX
structure_link:
data:
type: structure_links
id: 1XX
hiring_manager_user:
meta:
included: false
recruitment_manager_user:
meta:
included: false
applications:
meta:
included: false
questions:
meta:
included: false
custom_attributes:
meta:
included: false
stages:
meta:
included: false
included:
- id: 1XX
type: companies
attributes:
created_at: '2023-11-02T11:13:39+00:00'
updated_at: '2023-11-02T11:19:02+00:00'
name: ACME Corporation
industry: Software
location: Jersey
website: https://www.pinpointhq.com
- id: 1XX
type: structure_links
attributes:
created_at: '2023-11-02T11:13:55+00:00'
updated_at: '2023-11-02T11:13:55+00:00'
division_id: null
location_id: '3'
department_id: '5'
structure_custom_group_one_id: null
accepts_speculative_applications: true
relationships:
location:
meta:
included: false
department:
meta:
included: false
division:
meta:
included: false
structure_custom_group_one:
meta:
included: false
meta: {}
jsonapi_jobs_single:
value:
data:
id: '1000197'
type: jobs
attributes:
title: Paint Watcher
description: "- >Ordered 1
>
\uFEFF\uFEFF\uFEFFHealthcare plan
Generous vacation allowance
benefits_header: Benefits
compensation: £40,000 - £50,000 / year
compensation_minimum: 40000
compensation_maximum: 50000
compensation_currency: GBP
compensation_frequency: year
compensation_visible: true
deadline_at: '2030-01-01T00:00:00+00:00'
employment_type: full_time
employment_type_text: Full Time
key_responsibilities: >-
Ensuring dryness of paint
Keeping insects away from
paint
key_responsibilities_header: Key Responsibilities
opened_at: '2019-01-01T00:00:00+00:00'
remote: false
reporting_to: CTO
requisition_id: PAINT-4
skills_knowledge_expertise: >-
- Art Degree
- Experience with paint
- Clean
driving record
skills_knowledge_expertise_header: Skills, Knowledge and Experience
status: open
visibility: external
url: https://api-docs-subdomain.pinpointhq.com/en/jobs/1000197
path: /en/jobs/1000197
workplace_type: onsite
workplace_type_text: Onsite
relationships:
department:
data:
type: departments
id: '1000194'
division:
data:
type: divisions
id: '1000192'
location:
data:
type: locations
id: '1000193'
structure_custom_group_one:
data:
type: structure_custom_group_ones
id: '1000195'
hiring_manager_user:
data:
type: users
id: '1000217'
recruitment_manager_user:
data:
type: users
id: '1000218'
applications:
meta:
included: false
questions:
data: []
custom_attributes:
data:
- type: custom_attributes
id: '468'
- type: custom_attributes
id: '469'
- type: custom_attributes
id: '470'
- type: custom_attributes
id: '471'
- type: custom_attributes
id: '472'
- type: custom_attributes
id: '473'
- type: custom_attributes
id: '474'
stages:
data:
- type: stages
id: '1000198'
- type: stages
id: '1000199'
- type: stages
id: '1000200'
- type: stages
id: '1000201'
- type: stages
id: '1000202'
included:
- id: 1000194X
type: departments
attributes:
created_at: '2019-01-01T00:00:00+00:00'
name: Software Development
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000192X
type: divisions
attributes:
created_at: '2019-01-01T00:00:00+00:00'
name: EU
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000193X
type: locations
attributes:
city: West Carlitachester
country_code: PK
created_at: '2019-01-01T00:00:00+00:00'
name: Jersey
postal_code: '04923'
province: New York
street_address: 77551 Ethel Corners
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
equality_monitoring_template:
meta:
included: false
- id: 1000195X
type: structure_custom_group_ones
attributes:
title: Sub Department
created_at: '2019-01-01T00:00:00+00:00'
name: DevOps
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
jobs:
meta:
included: false
- id: 1000217X
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person35@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000218X
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person36@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
- id: 468X
type: custom_attributes
attributes:
value: Maroon
field_name: Favourite colour
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 469X
type: custom_attributes
attributes:
value: Someone finally bought a copy of your book sir!
field_name: Favourite Simpsons quotation
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 470X
type: custom_attributes
attributes:
value: '13'
field_name: Lucky number
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 471X
type: custom_attributes
attributes:
value: '3.14'
field_name: Lucky decimal number
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 472X
type: custom_attributes
attributes:
value: 'true'
field_name: Was a checkbox ticked?
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 473X
type: custom_attributes
attributes:
value: Tomato
field_name: Favourite vegetable
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 474X
type: custom_attributes
attributes:
value: Maroon, Vermillion, and Blue
field_name: Favourite colours
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 1000198X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: rejected
external_name: null
visible: true
position: 1
basic_type: rejected
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
- id: 1000199X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: applied
external_name: null
visible: true
position: 2
basic_type: applied
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
- id: 1000200X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: review
external_name: null
visible: true
position: 3
basic_type: review
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
- id: 1000201X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: interview
external_name: null
visible: true
position: 4
basic_type: interview
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
- id: 1000202X
type: stages
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
name: hired
external_name: null
visible: true
position: 5
basic_type: hired
relationships:
stageable:
meta:
included: false
applications:
meta:
included: false
meta: {}
jsonapi_job_seekers_collection:
value:
data:
- id: '1000221'
type: job_seekers
attributes:
summary: >-
I'm not a great developer, but I try and be a good developer
with great habits
first_name: Joe
last_name: Bloggs
full_name: Joe Bloggs
email: joe.bloggs@pinpoint.dev
phone: '+447797000000'
phone_iso2: JE
date_of_birth: '1987-04-05'
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
locale: en
channel: manual
channel_source: Added manually
pipeline_source: self_registered
address1: One Waverley Place
address2: Union Street
town: St Helier
country: Jersey
postcode: JE1 2PP
relationships:
answers:
data:
- type: answers
id: '1000224'
- type: answers
id: '1000226'
- type: answers
id: '1000228'
- type: answers
id: '1000230'
- type: answers
id: '1000232'
- type: answers
id: '1000234'
- type: answers
id: '1000236'
custom_attributes:
data:
- type: custom_attributes
id: '475'
- type: custom_attributes
id: '476'
- type: custom_attributes
id: '477'
- type: custom_attributes
id: '478'
- type: custom_attributes
id: '479'
- type: custom_attributes
id: '480'
- type: custom_attributes
id: '481'
comments:
meta:
included: false
included:
- id: 1000224X
type: answers
attributes:
title: Whats your greatest achievement?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: long_text
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: >-
I went back in a time machine and taught Claude Monet how to
paint
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000226X
type: answers
attributes:
title: Are you good at coding?
additional_information: Please answer the question
boolean_answer: true
document_answer: null
question_type: boolean
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000228X
type: answers
attributes:
title: What start date would you like?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: date
date_answer: '2024-06-06'
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000230X
type: answers
attributes:
title: What is your portfolio URL?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: url
date_answer: null
url_answer: https://www.google.com
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000232X
type: answers
attributes:
title: What is your favourite color?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: short_text
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: Red
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000234X
type: answers
attributes:
title: What are your favourite programming languages?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: multiple_choice
date_answer: null
url_answer: null
multiple_choice_answer:
- amaranth
- lemon
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000236X
type: answers
attributes:
title: Attach your favourite PDF
additional_information: Please answer the question
boolean_answer: null
document_answer:
context: document
filename: custom.pdf
url: >-
https://pinpointhq.com/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBcG9JIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--38b674dde997a34e5839cf8010bf1ef3d7581f94/custom.pdf
question_type: document
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 475X
type: custom_attributes
attributes:
value: Maroon
field_name: Favourite colour
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 476X
type: custom_attributes
attributes:
value: Someone finally bought a copy of your book sir!
field_name: Favourite Simpsons quotation
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 477X
type: custom_attributes
attributes:
value: '13'
field_name: Lucky number
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 478X
type: custom_attributes
attributes:
value: '3.14'
field_name: Lucky decimal number
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 479X
type: custom_attributes
attributes:
value: 'true'
field_name: Was a checkbox ticked?
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 480X
type: custom_attributes
attributes:
value: Tomato
field_name: Favourite vegetable
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 481X
type: custom_attributes
attributes:
value: Maroon, Vermillion, and Blue
field_name: Favourite colours
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
meta: {}
jsonapi_job_seekers_single:
value:
data:
id: '1000246'
type: job_seekers
attributes:
summary: >-
I'm not a great developer, but I try and be a good developer with
great habits
first_name: Joe
last_name: Bloggs
full_name: Joe Bloggs
email: joe.bloggs@pinpoint.dev
phone: '+447797000000'
phone_iso2: JE
date_of_birth: '1987-04-05'
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
locale: en
channel: manual
channel_source: Added manually
pipeline_source: self_registered
address1: One Waverley Place
address2: Union Street
town: St Helier
country: Jersey
postcode: JE1 2PP
relationships:
answers:
data:
- type: answers
id: '1000249'
- type: answers
id: '1000251'
- type: answers
id: '1000253'
- type: answers
id: '1000255'
- type: answers
id: '1000257'
- type: answers
id: '1000259'
- type: answers
id: '1000261'
custom_attributes:
data:
- type: custom_attributes
id: '482'
- type: custom_attributes
id: '483'
- type: custom_attributes
id: '484'
- type: custom_attributes
id: '485'
- type: custom_attributes
id: '486'
- type: custom_attributes
id: '487'
- type: custom_attributes
id: '488'
comments:
meta:
included: false
included:
- id: 1000249X
type: answers
attributes:
title: Whats your greatest achievement?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: long_text
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: >-
I went back in a time machine and taught Claude Monet how to
paint
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000251X
type: answers
attributes:
title: Are you good at coding?
additional_information: Please answer the question
boolean_answer: true
document_answer: null
question_type: boolean
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000253X
type: answers
attributes:
title: What start date would you like?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: date
date_answer: '2024-06-06'
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000255X
type: answers
attributes:
title: What is your portfolio URL?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: url
date_answer: null
url_answer: https://www.google.com
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000257X
type: answers
attributes:
title: What is your favourite color?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: short_text
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: Red
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000259X
type: answers
attributes:
title: What are your favourite programming languages?
additional_information: Please answer the question
boolean_answer: null
document_answer: null
question_type: multiple_choice
date_answer: null
url_answer: null
multiple_choice_answer:
- coffee
- rose
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 1000261X
type: answers
attributes:
title: Attach your favourite PDF
additional_information: Please answer the question
boolean_answer: null
document_answer:
context: document
filename: custom.pdf
url: >-
https://pinpointhq.com/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBcDBJIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--933d9ef1c6ca4569d3e22cad9fc5817a7b65b350/custom.pdf
question_type: document
date_answer: null
url_answer: null
multiple_choice_answer: []
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
text_answer: null
relationships:
question:
meta:
included: false
answer_options:
meta:
included: false
- id: 482X
type: custom_attributes
attributes:
value: Maroon
field_name: Favourite colour
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 483X
type: custom_attributes
attributes:
value: Someone finally bought a copy of your book sir!
field_name: Favourite Simpsons quotation
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 484X
type: custom_attributes
attributes:
value: '13'
field_name: Lucky number
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 485X
type: custom_attributes
attributes:
value: '3.14'
field_name: Lucky decimal number
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 486X
type: custom_attributes
attributes:
value: 'true'
field_name: Was a checkbox ticked?
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 487X
type: custom_attributes
attributes:
value: Tomato
field_name: Favourite vegetable
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
- id: 488X
type: custom_attributes
attributes:
value: Maroon, Vermillion, and Blue
field_name: Favourite colours
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
custom_fields:
meta:
included: false
custom_attributable:
meta:
included: false
meta: {}
jsonapi_locations_collection:
value:
data:
- id: '1000271'
type: locations
attributes:
city: Hungmouth
country_code: GP
created_at: '2019-01-01T00:00:00+00:00'
name: Jersey
postal_code: 92759-6607
province: Kentucky
street_address: 80786 Oliver Spur
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
equality_monitoring_template:
meta:
included: false
meta: {}
jsonapi_locations_post:
value:
data:
type: locations
attributes:
name: Jersey
city: St Helier
country_code: GB
province: ''
street_address: Union Street
postal_code: JE1 2PP
jsonapi_locations_put:
value:
data:
id: 1XX
type: locations
attributes:
name: Jersey
city: St Helier
country_code: GB
province: ''
street_address: Union Street
postal_code: JE1 2PP
jsonapi_locations_single:
value:
data:
id: '1000274'
type: locations
attributes:
city: Devonmouth
country_code: MA
created_at: '2019-01-01T00:00:00+00:00'
name: Jersey
postal_code: '22005'
province: Idaho
street_address: 88336 Bradtke Pike
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
equality_monitoring_template:
meta:
included: false
meta: {}
jsonapi_onboarding_applications_collection:
value:
data:
- id: '1000289'
type: onboarding_applications
attributes:
created_at: '2019-01-01T00:00:00+00:00'
start_at: '2020-01-01T00:00:00+00:00'
status: not_started
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
application:
data:
type: applications
id: '1000288'
onboarding_answers:
meta:
included: false
included:
- id: 1000288X
type: applications
attributes:
summary: >-
I'm not a great developer, but I try and be a good developer
with great habits
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
hired_at: null
internal_candidate: false
job_id: '1000282'
locale: en
stage_id: '1000283'
rejected_at: '2019-01-01T00:00:00+00:00'
phone_iso2: JE
start_on: '2022-01-01'
is_demo: false
first_name: Joe
last_name: Bloggs
email: joe.bloggs@pinpoint.dev
phone: '+447797000000'
date_of_birth: null
linkedin_url: null
address1: One Waverley Place
address2: Union Street
town: St Helier
country: Jersey
postcode: JE1 2PP
preferred_pronouns: null
channel_source: Added manually
full_name: Joe Bloggs
national_identifier: null
channel: manual
concealed: false
relationships:
job:
meta:
included: false
stage:
meta:
included: false
onboarding_application:
meta:
included: false
offers:
meta:
included: false
answers:
meta:
included: false
custom_attributes:
meta:
included: false
scorecard_ratings:
meta:
included: false
scorecard_notes:
meta:
included: false
scorecard_answers:
meta:
included: false
comments:
meta:
included: false
meta: {}
jsonapi_onboarding_applications_single:
value:
data:
id: '1000304'
type: onboarding_applications
attributes:
created_at: '2019-01-01T00:00:00+00:00'
start_at: '2020-01-01T00:00:00+00:00'
status: not_started
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
application:
data:
type: applications
id: '1000303'
onboarding_answers:
meta:
included: false
included:
- id: 1000303X
type: applications
attributes:
summary: >-
I'm not a great developer, but I try and be a good developer
with great habits
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
hired_at: null
internal_candidate: false
job_id: '1000297'
locale: en
stage_id: '1000298'
rejected_at: '2019-01-01T00:00:00+00:00'
phone_iso2: JE
start_on: '2022-01-01'
is_demo: false
first_name: Joe
last_name: Bloggs
email: joe.bloggs@pinpoint.dev
phone: '+447797000000'
date_of_birth: null
linkedin_url: null
address1: One Waverley Place
address2: Union Street
town: St Helier
country: Jersey
postcode: JE1 2PP
preferred_pronouns: null
channel_source: Added manually
full_name: Joe Bloggs
national_identifier: null
channel: manual
concealed: false
relationships:
job:
meta:
included: false
stage:
meta:
included: false
onboarding_application:
meta:
included: false
offers:
meta:
included: false
answers:
meta:
included: false
custom_attributes:
meta:
included: false
scorecard_ratings:
meta:
included: false
scorecard_notes:
meta:
included: false
scorecard_answers:
meta:
included: false
comments:
meta:
included: false
meta: {}
jsonapi_requisitions_collection:
value:
data:
- id: '115'
type: requisitions
attributes:
requisition_template_id: '73'
name: Standard
identifier: XXX
job_id: null
creator_id: '1000307'
status: pending_approval
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
data:
type: requisition_templates
id: '73'
creator:
data:
type: users
id: '1000307'
requisition_details:
data:
- type: requisition_details
id: '370'
- type: requisition_details
id: '371'
- type: requisition_details
id: '372'
- type: requisition_details
id: '373'
- type: requisition_details
id: '374'
- type: requisition_details
id: '375'
- type: requisition_details
id: '376'
- type: requisition_details
id: '377'
included:
- id: 73X
type: requisition_templates
attributes:
name: New Headcount
enforced_maximum_headcount: null
has_enforced_maximum_headcount: false
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template_fields:
meta:
included: false
- id: 1000307X
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person46@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
- id: 370X
type: requisition_details
attributes:
requisition_id: '115'
requisition_template_field_id: '656'
varchar_value: Software Engineer
text_value: null
boolean_value: null
date_value: null
decimal_value: null
integer_value: null
single_select_value: null
multi_select_value: []
field_type: varchar
label: Title
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 371X
type: requisition_details
attributes:
requisition_id: '115'
requisition_template_field_id: '657'
varchar_value: null
text_value: null
boolean_value: null
date_value: null
decimal_value: null
integer_value: null
single_select_value: full_time
multi_select_value: []
field_type: single_select_contract_type
label: Contract Type
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 372X
type: requisition_details
attributes:
requisition_id: '115'
requisition_template_field_id: '658'
varchar_value: Tom Luce
text_value: null
boolean_value: null
date_value: null
decimal_value: null
integer_value: null
single_select_value: null
multi_select_value: []
field_type: varchar
label: Reporting To
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 373X
type: requisition_details
attributes:
requisition_id: '115'
requisition_template_field_id: '659'
varchar_value: null
text_value: null
boolean_value: null
date_value: null
decimal_value: '500.0'
integer_value: null
single_select_value: null
multi_select_value: []
field_type: decimal
label: Compensation Minimum
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 374X
type: requisition_details
attributes:
requisition_id: '115'
requisition_template_field_id: '660'
varchar_value: null
text_value: null
boolean_value: null
date_value: null
decimal_value: '2500.0'
integer_value: null
single_select_value: null
multi_select_value: []
field_type: decimal
label: Compensation Maximum
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 375X
type: requisition_details
attributes:
requisition_id: '115'
requisition_template_field_id: '661'
varchar_value: null
text_value: null
boolean_value: null
date_value: '2030-01-01'
decimal_value: null
integer_value: null
single_select_value: null
multi_select_value: []
field_type: date
label: Proposed Start Date
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 376X
type: requisition_details
attributes:
requisition_id: '115'
requisition_template_field_id: '662'
varchar_value: null
text_value: null
boolean_value: null
date_value: null
decimal_value: null
integer_value: 10
single_select_value: null
multi_select_value: []
field_type: integer
label: Headcount
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 377X
type: requisition_details
attributes:
requisition_id: '115'
requisition_template_field_id: '663'
varchar_value: null
text_value: null
boolean_value: null
date_value: null
decimal_value: null
integer_value: null
single_select_value: null
multi_select_value: []
field_type: document
label: Requisition document
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
meta: {}
jsonapi_requisitions_post:
value:
data:
type: requisitions
attributes:
name: Standard
relationships:
requisition_template:
data:
type: requisition_templates
id: '45'
method: update
requisition_details:
data:
- type: requisition_details
temp-id: temp-id-1
method: create
- type: requisition_details
temp-id: temp-id-2
method: create
- type: requisition_details
temp-id: temp-id-3
method: create
- type: requisition_details
temp-id: temp-id-4
method: create
- type: requisition_details
temp-id: temp-id-5
method: create
- type: requisition_details
temp-id: temp-id-6
method: create
included:
- type: requisition_details
temp-id: temp-id-1
attributes:
varchar_value: Support Engineer
relationships:
requisition_template_field:
data:
type: requisition_template_fields
id: '382'
method: update
- type: requisition_details
temp-id: temp-id-2
attributes:
integer_value: 1
relationships:
requisition_template_field:
data:
type: requisition_template_fields
id: '378'
method: update
- type: requisition_details
temp-id: temp-id-3
attributes:
single_select_value: full_time
relationships:
requisition_template_field:
data:
type: requisition_template_fields
id: '379'
method: update
- type: requisition_details
temp-id: temp-id-4
attributes:
single_select_value: '5'
relationships:
requisition_template_field:
data:
type: requisition_template_fields
id: '380'
method: update
- type: requisition_details
temp-id: temp-id-5
attributes:
single_select_value: Jane Pallot
relationships:
requisition_template_field:
data:
type: requisition_template_fields
id: '381'
method: update
- type: requisition_details
temp-id: temp-id-6
attributes:
boolean_value: true
relationships:
requisition_template_field:
data:
type: requisition_template_fields
id: '13'
method: update
jsonapi_requisitions_put:
value:
data:
type: requisitions
id: '9'
attributes:
archive: true
jsonapi_requisitions_single:
value:
data:
id: '116'
type: requisitions
attributes:
requisition_template_id: '74'
name: Standard
identifier: XXX
job_id: null
creator_id: '1000310'
status: pending_approval
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
data:
type: requisition_templates
id: '74'
creator:
data:
type: users
id: '1000310'
requisition_details:
data:
- type: requisition_details
id: 378X
- type: requisition_details
id: 379X
- type: requisition_details
id: 380X
- type: requisition_details
id: 381X
- type: requisition_details
id: 382X
- type: requisition_details
id: '383'
- type: requisition_details
id: '384'
- type: requisition_details
id: '385'
included:
- id: 74X
type: requisition_templates
attributes:
name: New Headcount
enforced_maximum_headcount: null
has_enforced_maximum_headcount: false
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template_fields:
meta:
included: false
- id: 1000310X
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person48@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
- id: 378X
type: requisition_details
attributes:
requisition_id: '116'
requisition_template_field_id: '673'
varchar_value: Software Engineer
text_value: null
boolean_value: null
date_value: null
decimal_value: null
integer_value: null
single_select_value: null
multi_select_value: []
field_type: varchar
label: Title
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 379X
type: requisition_details
attributes:
requisition_id: '116'
requisition_template_field_id: '674'
varchar_value: null
text_value: null
boolean_value: null
date_value: null
decimal_value: null
integer_value: null
single_select_value: full_time
multi_select_value: []
field_type: single_select_contract_type
label: Contract Type
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 380X
type: requisition_details
attributes:
requisition_id: '116'
requisition_template_field_id: '675'
varchar_value: Tom Luce
text_value: null
boolean_value: null
date_value: null
decimal_value: null
integer_value: null
single_select_value: null
multi_select_value: []
field_type: varchar
label: Reporting To
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 381X
type: requisition_details
attributes:
requisition_id: '116'
requisition_template_field_id: '676'
varchar_value: null
text_value: null
boolean_value: null
date_value: null
decimal_value: '500.0'
integer_value: null
single_select_value: null
multi_select_value: []
field_type: decimal
label: Compensation Minimum
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 382X
type: requisition_details
attributes:
requisition_id: '116'
requisition_template_field_id: '677'
varchar_value: null
text_value: null
boolean_value: null
date_value: null
decimal_value: '2500.0'
integer_value: null
single_select_value: null
multi_select_value: []
field_type: decimal
label: Compensation Maximum
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 383X
type: requisition_details
attributes:
requisition_id: '116'
requisition_template_field_id: '678'
varchar_value: null
text_value: null
boolean_value: null
date_value: '2030-01-01'
decimal_value: null
integer_value: null
single_select_value: null
multi_select_value: []
field_type: date
label: Proposed Start Date
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 384X
type: requisition_details
attributes:
requisition_id: '116'
requisition_template_field_id: '679'
varchar_value: null
text_value: null
boolean_value: null
date_value: null
decimal_value: null
integer_value: 10
single_select_value: null
multi_select_value: []
field_type: integer
label: Headcount
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
- id: 385X
type: requisition_details
attributes:
requisition_id: '116'
requisition_template_field_id: '680'
varchar_value: null
text_value: null
boolean_value: null
date_value: null
decimal_value: null
integer_value: null
single_select_value: null
multi_select_value: []
field_type: document
label: Requisition document
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition:
meta:
included: false
requisition_template_field:
meta:
included: false
meta: {}
jsonapi_requisition_templates_collection:
value:
data:
- id: '75'
type: requisition_templates
attributes:
name: Standard
enforced_maximum_headcount: null
has_enforced_maximum_headcount: false
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template_fields:
data:
- type: requisition_template_fields
id: '681'
- type: requisition_template_fields
id: '682'
- type: requisition_template_fields
id: '683'
- type: requisition_template_fields
id: '684'
- type: requisition_template_fields
id: '685'
- type: requisition_template_fields
id: '686'
included:
- id: 681X
type: requisition_template_fields
attributes:
description: What is the role?
requisition_template_id: '75'
label: Title
field_type: varchar
mapped_job_form_field: title
options: []
position: 1
required: true
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
meta:
included: false
template_custom_field:
data: null
- id: 682X
type: requisition_template_fields
attributes:
description: What is the headcount requirement for this requisition?
requisition_template_id: '75'
label: Headcount
field_type: integer
mapped_job_form_field: headcount_maximum
options: []
position: 2
required: true
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
meta:
included: false
template_custom_field:
data: null
- id: 683X
type: requisition_template_fields
attributes:
description: What type of contract are you looking for?
requisition_template_id: '75'
label: Contract Type
field_type: single_select_contract_type
mapped_job_form_field: employment_type
options: []
position: 3
required: true
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
meta:
included: false
template_custom_field:
data: null
- id: 684X
type: requisition_template_fields
attributes:
description: Which part of the company will this role sit under?
requisition_template_id: '75'
label: Structure Link
field_type: single_select_structure_link
mapped_job_form_field: structure_link_id
options: []
position: 4
required: true
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
meta:
included: false
template_custom_field:
data: null
- id: 685X
type: requisition_template_fields
attributes:
description: Who does this role report to?
requisition_template_id: '75'
label: Reporting To
field_type: varchar
mapped_job_form_field: reporting_to
options: []
position: 5
required: true
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
meta:
included: false
template_custom_field:
data: null
- id: 686X
type: requisition_template_fields
attributes:
description: Description for a custom field
requisition_template_id: '75'
label: Custom field label
field_type: custom_field_1000309
mapped_job_form_field: null
options: []
position: 6
required: true
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
meta:
included: false
template_custom_field:
data:
type: custom_fields
id: '1000309'
- id: 1000309X
type: custom_fields
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
field_type: boolean
name: Boolean - job 1
options: []
position: 0
required: false
resource_type: job
sample_value: Sample value
unique_reference: custom_field_1000309
updated_at: '2019-01-01T00:00:00+00:00'
meta: {}
jsonapi_requisition_templates_single:
value:
data:
id: '76'
type: requisition_templates
attributes:
name: Standard
enforced_maximum_headcount: null
has_enforced_maximum_headcount: false
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template_fields:
data:
- type: requisition_template_fields
id: '687'
- type: requisition_template_fields
id: '688'
- type: requisition_template_fields
id: '689'
- type: requisition_template_fields
id: '690'
- type: requisition_template_fields
id: '691'
- type: requisition_template_fields
id: '692'
included:
- id: 687X
type: requisition_template_fields
attributes:
description: What is the role?
requisition_template_id: '76'
label: Title
field_type: varchar
mapped_job_form_field: title
options: []
position: 1
required: true
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
meta:
included: false
template_custom_field:
data: null
- id: 688X
type: requisition_template_fields
attributes:
description: What is the headcount requirement for this requisition?
requisition_template_id: '76'
label: Headcount
field_type: integer
mapped_job_form_field: headcount_maximum
options: []
position: 2
required: true
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
meta:
included: false
template_custom_field:
data: null
- id: 689X
type: requisition_template_fields
attributes:
description: What type of contract are you looking for?
requisition_template_id: '76'
label: Contract Type
field_type: single_select_contract_type
mapped_job_form_field: employment_type
options: []
position: 3
required: true
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
meta:
included: false
template_custom_field:
data: null
- id: 690X
type: requisition_template_fields
attributes:
description: Which part of the company will this role sit under?
requisition_template_id: '76'
label: Structure Link
field_type: single_select_structure_link
mapped_job_form_field: structure_link_id
options: []
position: 4
required: true
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
meta:
included: false
template_custom_field:
data: null
- id: 691X
type: requisition_template_fields
attributes:
description: Who does this role report to?
requisition_template_id: '76'
label: Reporting To
field_type: varchar
mapped_job_form_field: reporting_to
options: []
position: 5
required: true
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
meta:
included: false
template_custom_field:
data: null
- id: 692X
type: requisition_template_fields
attributes:
description: Description for a custom field
requisition_template_id: '76'
label: Custom field label
field_type: custom_field_1000310
mapped_job_form_field: null
options: []
position: 6
required: true
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
requisition_template:
meta:
included: false
template_custom_field:
data:
type: custom_fields
id: 1000310X
- id: 1000310X
type: custom_fields
attributes:
description: null
created_at: '2019-01-01T00:00:00+00:00'
field_type: boolean
name: Boolean - job 2
options: []
position: 0
required: false
resource_type: job
sample_value: Sample value
unique_reference: custom_field_1000310
updated_at: '2019-01-01T00:00:00+00:00'
meta: {}
jsonapi_structure_custom_group_ones_collection:
value:
data:
- id: '1000317'
type: structure_custom_group_ones
attributes:
title: Sub Department
created_at: '2019-01-01T00:00:00+00:00'
name: DevOps
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
jobs:
meta:
included: false
meta: {}
jsonapi_structure_custom_group_ones_post:
value:
data:
type: structure_custom_group_ones
attributes:
name: DevOps
jsonapi_structure_custom_group_ones_put:
value:
data:
id: 1XX
type: structure_custom_group_ones
attributes:
name: DevOps
jsonapi_structure_custom_group_ones_single:
value:
data:
id: '1000320'
type: structure_custom_group_ones
attributes:
title: Sub Department
created_at: '2019-01-01T00:00:00+00:00'
name: DevOps
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
jobs:
meta:
included: false
meta: {}
jsonapi_structure_links_collection:
value:
data:
- id: '1000327'
type: structure_links
attributes:
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
division_id: '1000323'
location_id: '1000324'
department_id: '1000325'
structure_custom_group_one_id: '1000326'
accepts_speculative_applications: true
names:
- EU
- Jersey
- Software Development
- DevOps
in_use: false
relationships:
location:
data:
type: locations
id: '1000324'
department:
data:
type: departments
id: '1000325'
division:
data:
type: divisions
id: '1000323'
structure_custom_group_one:
data:
type: structure_custom_group_ones
id: '1000326'
included:
- id: 1000324X
type: locations
attributes:
city: Darbyton
country_code: NR
created_at: '2019-01-01T00:00:00+00:00'
name: Jersey
postal_code: '16863'
province: North Carolina
street_address: 4272 Rosia Estates
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
equality_monitoring_template:
meta:
included: false
- id: 1000325X
type: departments
attributes:
created_at: '2019-01-01T00:00:00+00:00'
name: Software Development
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000323X
type: divisions
attributes:
created_at: '2019-01-01T00:00:00+00:00'
name: EU
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000326X
type: structure_custom_group_ones
attributes:
title: Sub Department
created_at: '2019-01-01T00:00:00+00:00'
name: DevOps
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
jobs:
meta:
included: false
meta: {}
jsonapi_structure_links_post:
value:
data:
type: structure_links
attributes:
accepts_speculative_applications: true
relationships:
location:
data:
type: locations
id: 1XX
department:
data:
type: departments
id: 1XX
division:
data:
type: divisions
id: 1XX
structure_custom_group_one:
data:
type: structure_custom_group_ones
id: 1XX
jsonapi_structure_links_put:
value:
data:
id: 1XX
type: structure_links
attributes:
accepts_speculative_applications: true
jsonapi_structure_links_single:
value:
data:
id: '1000334'
type: structure_links
attributes:
created_at: '2019-01-01T00:00:00+00:00'
updated_at: '2019-01-01T00:00:00+00:00'
division_id: '1000330'
location_id: '1000331'
department_id: '1000332'
structure_custom_group_one_id: '1000333'
accepts_speculative_applications: true
names:
- EU
- Jersey
- Software Development
- DevOps
in_use: false
relationships:
location:
data:
type: locations
id: '1000331'
department:
data:
type: departments
id: '1000332'
division:
data:
type: divisions
id: '1000330'
structure_custom_group_one:
data:
type: structure_custom_group_ones
id: '1000333'
included:
- id: 1000331X
type: locations
attributes:
city: Melvinland
country_code: JO
created_at: '2019-01-01T00:00:00+00:00'
name: Jersey
postal_code: '02204'
province: Delaware
street_address: 801 Marvin Loaf
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
equality_monitoring_template:
meta:
included: false
- id: 1000332X
type: departments
attributes:
created_at: '2019-01-01T00:00:00+00:00'
name: Software Development
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000330X
type: divisions
attributes:
created_at: '2019-01-01T00:00:00+00:00'
name: EU
updated_at: '2019-01-01T00:00:00+00:00'
- id: 1000333X
type: structure_custom_group_ones
attributes:
title: Sub Department
created_at: '2019-01-01T00:00:00+00:00'
name: DevOps
updated_at: '2019-01-01T00:00:00+00:00'
relationships:
jobs:
meta:
included: false
meta: {}
jsonapi_users_collection:
value:
data:
- id: '1000337'
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person56@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
meta: {}
jsonapi_users_post:
value:
data:
type: users
attributes:
email: joe.bloggs@pinpoint.dev
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
user_type: employee
send_invitation: true
jsonapi_users_single:
value:
data:
id: '1000340'
type: users
attributes:
created_at: '2019-01-01T00:00:00+00:00'
email: person58@example.com
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
updated_at: '2019-01-01T00:00:00+00:00'
meta: {}
schemas:
types:
type: string
enum:
- answer_options
- answers
- applications
- comments
- custom_attributes
- departments
- jobs
- job_seekers
- locations
- offers
- questions
- stages
answer_options:
description: Answer option attributes
type: object
properties:
text:
type: string
answer_options_resource:
type: object
properties:
id:
type: string
example: '24'
type:
type: string
enum:
- answer_options
attributes:
$ref: '#/components/schemas/answer_options'
relationships:
$ref: '#/components/schemas/jsonapi_relationships'
answers:
description: Answer attributes
type: object
properties:
title:
type: string
readOnly: true
additional_information:
type: string
readOnly: true
boolean_answer:
type: boolean
document_answer:
type: object
additionalProperties: true
readOnly: true
question_type:
type: string
enum:
- long_text
- boolean
- multiple_choice
- document
- date
- url
- short_text
readOnly: true
date_answer:
type: string
format: date
url_answer:
type: string
multiple_choice_answer:
type: string
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
answers_relationships:
type: object
properties:
question:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToOne'
meta:
$ref: '#/components/schemas/jsonapi_meta'
answer_options:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToMany'
meta:
$ref: '#/components/schemas/jsonapi_meta'
answers_resource:
type: object
properties:
id:
type: string
example: '28'
type:
type: string
enum:
- answers
attributes:
$ref: '#/components/schemas/answers'
relationships:
$ref: '#/components/schemas/answers_relationships'
applications_attributes:
description: Application attributes
type: object
properties:
tags:
type: array
items:
$ref: '#/components/schemas/tag_object'
readOnly: true
summary:
type: string
created_at:
type: string
format: date-time
readOnly: true
hired_at:
type: string
format: date-time
readOnly: true
internal_candidate:
type: boolean
readOnly: true
job_id:
type: string
readOnly: true
locale:
$ref: '#/components/schemas/locales'
stage_id:
type: string
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
rejected_at:
type: string
format: date-time
readOnly: true
phone_iso2:
description: ISO 3166-1 Alpha2 code representing a country
type: string
cv_base64_data:
description: >
A Base64 encoded
[DataURL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs)
type: string
writeOnly: true
cv_base64_filename:
type: string
writeOnly: true
first_name:
type: string
last_name:
type: string
email:
type: string
phone:
type: string
date_of_birth:
description: ISO 8601 formatted date
type: string
format: date
linkedin_url:
type: string
address1:
type: string
address2:
type: string
town:
description: Town / City
type: string
country:
description: Country / State
type: string
postcode:
description: Postcode / Zipcode
type: string
full_name:
type: string
readOnly: true
channel:
type: string
enum:
- undetermined
- other
- direct
- recruiter
- manual
- invited
- employee_referral
- web_traffic_referral
- paid_search
- organic_search
- social
- paid_social
- email
- job_board
- paid_job_board
- chrome_extension
- in_store
- event
- Hidden due to blind screening
readOnly: true
channel_source:
type: string
readOnly: true
concealed:
type: boolean
readOnly: true
attachments:
type: array
items:
$ref: '#/components/schemas/attachment_object'
readOnly: true
average_rating:
type: number
readOnly: true
preferred_pronouns:
type: string
start_on:
type: string
format: date
required:
- first_name
- last_name
- email
applications_attributes_post:
description: Application attributes
type: object
properties:
summary:
description: Personal summary of the applicant
type: string
locale:
$ref: '#/components/schemas/locales'
phone_iso2:
description: ISO 3166-1 Alpha2 code representing a country
type: string
first_name:
type: string
last_name:
type: string
email:
type: string
phone:
type: string
date_of_birth:
description: ISO 8601 formatted date
type: string
format: date
linkedin_url:
type: string
address1:
type: string
address2:
type: string
town:
description: Town / City
type: string
country:
description: Country / State
type: string
postcode:
description: Postcode / Zipcode
type: string
cv_base64_data:
description: >
A Base64 encoded
[DataURL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs)
type: string
writeOnly: true
cv_base64_filename:
type: string
writeOnly: true
start_on:
description: ISO 8601 formatted date
type: string
format: date
required:
- first_name
- last_name
- email
applications_attributes_put:
description: Application attributes
type: object
properties:
locale:
$ref: '#/components/schemas/locales'
phone_iso2:
description: ISO 3166-1 Alpha2 code representing a country
type: string
first_name:
type: string
last_name:
type: string
email:
type: string
phone:
type: string
date_of_birth:
description: ISO 8601 formatted date
type: string
format: date
linkedin_url:
type: string
address1:
type: string
address2:
type: string
town:
description: Town / City
type: string
country:
description: Country / State
type: string
postcode:
description: Postcode / Zipcode
type: string
start_on:
description: ISO 8601 formatted date
type: string
format: date
applications_extra_fields:
description: Application extra fields
type: string
enum:
- attachments
- average_rating
- tags
applications_relationships:
type: object
properties:
answers:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/answers_resource'
comments:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/comments_resource'
custom_attributes:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/custom_attributes_resource'
job:
type: object
properties:
data:
$ref: '#/components/schemas/jobs_resource'
offers:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/offers_resource'
stage:
type: object
properties:
data:
$ref: '#/components/schemas/stages_resource'
applications_relationships_post:
type: object
properties:
job:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationship_to_one_job'
stage:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationship_to_one_stage'
answers:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationship_to_many_answers'
required:
- job
applications_relationships_put:
type: object
properties:
stage:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationship_to_one_stage'
applications_resource:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
enum:
- applications
attributes:
$ref: '#/components/schemas/applications_attributes'
relationships:
$ref: '#/components/schemas/applications_relationships'
applications_resource_post:
type: object
properties:
type:
type: string
enum:
- applications
attributes:
$ref: '#/components/schemas/applications_attributes_post'
relationships:
$ref: '#/components/schemas/applications_relationships_post'
applications_resource_put:
type: object
properties:
id:
type: string
type:
type: string
enum:
- applications
attributes:
$ref: '#/components/schemas/applications_attributes_put'
relationships:
$ref: '#/components/schemas/applications_relationships_put'
required:
- id
- type
applications_request_post:
type: object
properties:
data:
$ref: '#/components/schemas/applications_resource_post'
applications_request_put:
type: object
properties:
data:
$ref: '#/components/schemas/applications_resource_put'
applications_readable_attribute:
description: Application readable attributes
type: string
enum:
- id
- created_at
- hired_at
- internal_candidate
- job_id
- locale
- stage_id
- updated_at
- rejected_at
- phone_iso2
- first_name
- last_name
- email
- phone
- date_of_birth
- linkedin_url
- summary
- address1
- address2
- town
- country
- postcode
- full_name
- channel
- channel_source
- concealed
- start_on
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:
- answers
- comments
- custom_attributes
- job
- offers
- stage
uniqueItems: true
attachment_object:
description: Attached file
type: object
properties:
context:
type: string
readOnly: true
filename:
type: string
readOnly: true
url:
type: string
readOnly: true
comments_attributes:
description: Comment attributes
type: object
properties:
body_text:
type: string
commentable_id:
type: string
readOnly: true
commentable_type:
type: string
readOnly: true
enum:
- Application
- JobSeeker
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: string
readOnly: true
comments_attributes_post:
description: Comment attributes
type: object
properties:
body_text:
type: string
required:
- body_text
comments_relationships:
type: object
properties:
user:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/users_resource'
application:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/applications_resource'
job_seeker:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/job_seekers_resource'
comments_relationships_post:
type: object
properties:
commentable:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationship_to_one_commentable'
required:
- commentable
comments_resource:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
enum:
- comments
attributes:
$ref: '#/components/schemas/comments_attributes'
relationships:
$ref: '#/components/schemas/comments_relationships'
comments_resource_post:
type: object
properties:
type:
type: string
enum:
- comments
attributes:
$ref: '#/components/schemas/comments_attributes_post'
relationships:
$ref: '#/components/schemas/comments_relationships_post'
comments_request_post:
type: object
properties:
data:
$ref: '#/components/schemas/comments_resource_post'
custom_attributes_attributes_post_put:
description: Custom Attributes attributes
type: object
properties:
boolean_value:
type: boolean
example: true
date_value:
type: string
format: date
example: '2021-01-01 00:00:00 +00:00'
decimal_value:
type: number
example: 1
integer_value:
type: integer
example: 1
multi_select_value:
type: array
items:
type: string
example:
- Option 1
- Option 2
single_select_value:
type: string
example: Option 1
text_value:
type: string
example: Text value
varchar_value:
type: string
example: Varchar value
custom_attributes_resource_post:
type: object
properties:
type:
type: string
enum:
- custom_attributes
attributes:
$ref: '#/components/schemas/custom_attributes_attributes_post_put'
relationships:
type: object
properties:
custom_field:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
enum:
- custom_fields
required:
- id
- type
custom_attributable:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
enum:
- applications
- jobs
- job_templates
- job_seekers
- offers
required:
- id
- type
required:
- custom_field
- custom_attributable
required:
- type
- attributes
- relationships
custom_attributes_resource_put:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
enum:
- custom_attributes
attributes:
$ref: '#/components/schemas/custom_attributes_attributes_post_put'
custom_attributes_request_post:
type: object
properties:
data:
$ref: '#/components/schemas/custom_attributes_resource_post'
required:
- data
custom_attributes_request_put:
type: object
properties:
data:
$ref: '#/components/schemas/custom_attributes_resource_put'
required:
- data
comments_readable_attribute:
description: Comment readable attributes
type: string
enum:
- id
- body_text
- commentable_id
- commentable_type
- created_at
- updated_at
- private_comment
- user_id
comments_sortable_attributes_list:
description: Comment sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- updated_at
- '-updated_at'
uniqueItems: true
comments_related:
description: >-
Comment relationships available for inclusion. The commentable
relationship is polymorphic so will resolve to either an Application or
a JobSeeker
type: array
items:
type: string
enum:
- user
- commentable
uniqueItems: true
custom_attributes:
description: Custom attributes attributes
type: object
properties:
field_name:
type: string
readOnly: true
value:
type: string
readOnly: true
custom_attributes_resource:
type: object
properties:
id:
type: string
example: '67'
type:
type: string
enum:
- custom_attributes
attributes:
$ref: '#/components/schemas/custom_attributes'
custom_attributes_readable_attributes:
description: Custom Attribute readable attributes
type: string
enum:
- id
- field_name
- value
- created_at
- updated_at
custom_attributes_related:
description: Custom Attribute relationships available for inclusion
type: array
items:
type: string
enum:
- custom_field
- custom_attributable
uniqueItems: true
custom_attributes_sortable_attributes_list:
description: Custom Attributes sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- updated_at
- '-updated_at'
uniqueItems: true
custom_fields_readable_attributes:
description: Custom Field readable attributes
type: string
enum:
- id
- created_at
- description
- field_type
- name
- options
- position
- required
- resource_type
- sample_value
- unique_reference
- updated_at
departments:
description: Department attributes
type: object
properties:
created_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
name:
type: string
readOnly: true
example: Software Development
updated_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
departments_collection:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/departments_resource'
meta:
$ref: '#/components/schemas/jsonapi_meta'
departments_readable_attributes:
description: Department readable attributes
type: string
enum:
- id
- created_at
- name
- updated_at
departments_resource:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
enum:
- departments
attributes:
$ref: '#/components/schemas/departments'
departments_single:
type: object
properties:
data:
$ref: '#/components/schemas/departments_resource'
meta:
$ref: '#/components/schemas/jsonapi_meta'
departments_sortable_attributes_list:
description: Department sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- updated_at
- '-updated_at'
uniqueItems: true
divisions:
description: Division attributes
type: object
properties:
created_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
name:
type: string
readOnly: true
example: Product
updated_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
divisions_collection:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/divisions_resource'
meta:
$ref: '#/components/schemas/jsonapi_meta'
divisions_readable_attributes:
description: Division readable attributes
type: string
enum:
- id
- created_at
- name
- updated_at
divisions_resource:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
enum:
- divisions
attributes:
$ref: '#/components/schemas/divisions'
divisions_single:
type: object
properties:
data:
$ref: '#/components/schemas/divisions_resource'
meta:
$ref: '#/components/schemas/jsonapi_meta'
divisions_sortable_attributes_list:
description: Division sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- updated_at
- '-updated_at'
uniqueItems: true
equality_monitoring_categories:
description: Equality Monitoring Category attributes
type: object
properties:
created_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
enabled:
type: boolean
readOnly: true
example: true
name:
type: string
readOnly: true
example: Gender
updated_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
equality_monitoring_categories_collection:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/equality_monitoring_categories_resource'
meta:
$ref: '#/components/schemas/jsonapi_meta'
equality_monitoring_categories_readable_attributes:
description: Equality Monitoring Category readable attributes
type: string
enum:
- id
- created_at
- enabled
- name
- updated_at
equality_monitoring_categories_related:
description: Equality Monitoring Category relationships available for inclusion
type: array
items:
type: string
enum:
- equality_monitoring_options
uniqueItems: true
equality_monitoring_categories_resource:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
enum:
- equality_monitoring_categories
attributes:
$ref: '#/components/schemas/equality_monitoring_categories'
equality_monitoring_categories_single:
type: object
properties:
data:
$ref: '#/components/schemas/equality_monitoring_categories_resource'
meta:
$ref: '#/components/schemas/jsonapi_meta'
equality_monitoring_categories_sortable_attributes_list:
description: Equality Monitoring Category sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- updated_at
- '-updated_at'
uniqueItems: true
interviews:
description: Interview attributes
type: object
properties:
start_at:
type: string
format: date-time
readOnly: true
end_at:
type: string
format: date-time
readOnly: true
interviewable_id:
type: integer
readOnly: true
interviewable_type:
type: string
enum:
- Application
- JobSeeker
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
status:
type: string
enum:
- in_progress
- completed
- scheduled
readOnly: true
interviews_sortable_attributes_list:
description: Interview sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- updated_at
- '-updated_at'
- start_at
- '-start_at'
uniqueItems: true
interviews_readable_attribute:
description: Interview readable attributes
type: string
enum:
- id
- start_at
- end_at
- interviewable_id
- interviewable_type
- created_at
- updated_at
- status
interviews_resource:
type: object
properties:
id:
type: string
example: '31'
type:
type: string
enum:
- interviews
attributes:
$ref: '#/components/schemas/interviews'
relationships:
$ref: '#/components/schemas/interviews_relationships'
interviews_related:
description: Interview relationships available for inclusion
type: array
items:
type: string
enum:
- interview_parts.interviewing_users
- stage
- interviewable
uniqueItems: true
interviews_relationships:
type: object
properties:
interviewable:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToOne'
interview_parts.interviewing_users:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToMany'
meta:
$ref: '#/components/schemas/jsonapi_meta'
stage:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationship_to_one_stage'
jobs:
description: Job attributes
type: object
properties:
title:
type: string
readOnly: true
description:
type: string
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
readOnly: true
compensation_maximum:
type: number
readOnly: true
compensation_currency:
type: string
readOnly: true
compensation_frequency:
type: string
enum:
- hour
- day
- week
- month
- year
readOnly: true
compensation_visible:
type: boolean
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
deadline_at:
type: string
format: date-time
readOnly: true
employment_type:
type: string
enum:
- contract_temp
- fixed_term_contract
- fixed_term_full_time
- fixed_term_part_time
- flexible
- freelance
- full_time
- internship
- part_time
- permanent
- permanent_full_time
- permanent_part_time
- zero_hours
readOnly: true
employment_type_text:
description: This is a humanized representation of the `employment_type` enum.
type: string
readOnly: true
key_responsibilities:
type: string
readOnly: true
key_responsibilities_header:
type: string
readOnly: true
opened_at:
type: string
format: date-time
readOnly: true
remote:
type: boolean
readOnly: true
reporting_to:
type: string
readOnly: true
requisition_id:
type: string
readOnly: true
skills_knowledge_expertise:
type: string
readOnly: true
skills_knowledge_expertise_header:
type: string
readOnly: true
status:
type: string
enum:
- archived
- closed
- draft
- open
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
visibility:
type: string
enum:
- confidential
- external
- internal
readOnly: true
url:
type: string
readOnly: true
workplace_type:
type: string
enum:
- hybrid
- onsite
- remote
readOnly: true
workplace_type_text:
type: string
readOnly: true
jobs_relationships:
type: object
properties:
custom_attributes:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToOne'
meta:
$ref: '#/components/schemas/jsonapi_meta'
department:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToOne'
meta:
$ref: '#/components/schemas/jsonapi_meta'
division:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToOne'
meta:
$ref: '#/components/schemas/jsonapi_meta'
location:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToOne'
meta:
$ref: '#/components/schemas/jsonapi_meta'
questions:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToMany'
meta:
$ref: '#/components/schemas/jsonapi_meta'
structure_custom_group_one:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToOne'
meta:
$ref: '#/components/schemas/jsonapi_meta'
jobs_resource:
type: object
properties:
id:
type: string
example: '31'
type:
type: string
enum:
- jobs
attributes:
$ref: '#/components/schemas/jobs'
relationships:
$ref: '#/components/schemas/jobs_relationships'
jobs_readable_attribute:
description: Job readable attributes
type: string
enum:
- id
- application_form_url
- benefits
- benefits_header
- compensation
- compensation_minimum
- compensation_maximum
- compensation_currency
- compensation_frequency
- compensation_visible
- created_at
- deadline_at
- description
- employment_type
- employment_type_text
- key_responsibilities
- key_responsibilities_header
- opened_at
- remote
- reporting_to
- requisition_id
- skills_knowledge_expertise
- skills_knowledge_expertise_header
- status
- title
- updated_at
- visibility
- url
- workplace_type
- workplace_type_text
jobs_sortable_attributes_list:
description: Job sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- opened_at
- '-opened_at'
- updated_at
- '-updated_at'
uniqueItems: true
jobs_related:
description: Job relationships available for inclusion
type: array
items:
type: string
enum:
- custom_attributes
- department
- division
- hiring_manager_user
- location
- questions
- recruitment_manager_user
- stages
- structure_custom_group_one
uniqueItems: true
job_seekers:
description: Job Seeker attributes
type: object
properties:
tags:
type: array
items:
$ref: '#/components/schemas/tag_object'
readOnly: true
summary:
type: string
readOnly: true
first_name:
type: string
readOnly: true
last_name:
type: string
readOnly: true
full_name:
type: string
readOnly: true
email:
type: string
readOnly: true
phone:
type: string
readOnly: true
phone_iso2:
description: ISO 3166-1 Alpha2 code representing a country
type: string
readOnly: true
date_of_birth:
description: ISO 8601 formatted date
type: string
format: date
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
locale:
type: string
readOnly: true
channel:
type: string
enum:
- undetermined
- other
- direct
- recruiter
- manual
- invited
- employee_referral
- web_traffic_referral
- paid_search
- organic_search
- social
- paid_social
- email
- job_board
- paid_job_board
- chrome_extension
- in_store
- event
readOnly: true
channel_source:
type: string
readOnly: true
pipeline_source:
type: string
enum:
- invited
- self_registered
readOnly: true
address1:
type: string
readOnly: true
address2:
type: string
readOnly: true
town:
description: Town / City
type: string
readOnly: true
country:
description: Country / State
type: string
readOnly: true
postcode:
description: Postcode / Zipcode
type: string
readOnly: true
attachments:
type: array
items:
$ref: '#/components/schemas/attachment_object'
readOnly: true
average_rating:
type: number
readOnly: true
job_seekers_extra_fields:
description: Job Seeker extra fields
type: string
enum:
- attachments
- average_rating
- tags
job_seekers_relationships:
type: object
properties:
answers:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToMany'
meta:
$ref: '#/components/schemas/jsonapi_meta'
comments:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToMany'
meta:
$ref: '#/components/schemas/jsonapi_meta'
job_seekers_resource:
type: object
properties:
id:
type: string
example: '18'
type:
type: string
enum:
- job_seekers
attributes:
$ref: '#/components/schemas/job_seekers'
relationships:
$ref: '#/components/schemas/job_seekers_relationships'
job_seekers_single:
type: object
properties:
data:
$ref: '#/components/schemas/job_seekers_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:
$ref: '#/components/schemas/jsonapi_resource'
uniqueItems: true
meta:
$ref: '#/components/schemas/jsonapi_meta'
links:
description: Link members related to the primary data.
allOf:
- $ref: '#/components/schemas/jsonapi_links'
- $ref: '#/components/schemas/jsonapi_pagination'
job_seekers_collection:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/job_seekers_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:
$ref: '#/components/schemas/jsonapi_resource'
uniqueItems: true
meta:
$ref: '#/components/schemas/jsonapi_meta'
links:
description: Link members related to the primary data.
allOf:
- $ref: '#/components/schemas/jsonapi_links'
- $ref: '#/components/schemas/jsonapi_pagination'
job_seekers_readable_attribute:
description: Job Seeker readable attributes
type: string
enum:
- id
- first_name
- last_name
- full_name
- email
- phone
- phone_iso2
- date_of_birth
- summary
- created_at
- updated_at
- locale
- channel
- channel_source
- pipeline_source
- address1
- address2
- town
- country
- postcode
job_seekers_sortable_attributes_list:
description: Job Seeker sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- updated_at
- '-updated_at'
uniqueItems: true
job_seekers_related:
description: Job Seeker relationships available for inclusion
type: array
items:
type: string
enum:
- custom_attributes
- answers
- comments
uniqueItems: true
locales:
description: >-
Code describing the language/region
[](https://en.wikipedia.org/wiki/Locale_(computer_software))
type: string
default: en
enum:
- de
- en
- es
- fr
- pt
- pt-BR
locations:
description: Location attributes
type: object
properties:
city:
type: string
readOnly: true
example: St Helier
country_code:
type: string
readOnly: true
example: JE
created_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
name:
type: string
readOnly: true
example: Head Office
postal_code:
type: string
readOnly: true
example: JE1 2PP
province:
type: string
readOnly: true
example: Channel Islands
street_address:
type: string
readOnly: true
example: 1 Waverley Place
updated_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
locations_collection:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/locations_resource'
meta:
$ref: '#/components/schemas/jsonapi_meta'
locations_readable_attributes:
description: Location readable attributes
type: string
enum:
- id
- city
- country_code
- created_at
- name
- postal_code
- province
- street_address
- updated_at
locations_resource:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
enum:
- locations
attributes:
$ref: '#/components/schemas/locations'
locations_single:
type: object
properties:
data:
$ref: '#/components/schemas/locations_resource'
meta:
$ref: '#/components/schemas/jsonapi_meta'
locations_sortable_attributes_list:
description: Location sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- updated_at
- '-updated_at'
uniqueItems: true
onboarding_applications:
description: Onboarding application attributes
type: object
properties:
created_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
start_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
status:
type: string
enum:
- archived
- completed
- invited
- uninvited
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
onboarding_applications_collection:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/onboarding_applications_resource'
meta:
$ref: '#/components/schemas/jsonapi_meta'
onboarding_applications_readable_attributes:
description: Onboarding application readable attributes
type: string
enum:
- id
- created_at
- start_at
- status
- updated_at
onboarding_applications_related:
description: Onboarding applications relationships available for inclusion
type: array
items:
type: string
enum:
- application
- onboarding_answers
uniqueItems: true
onboarding_applications_resource:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
enum:
- onboarding_applications
attributes:
$ref: '#/components/schemas/onboarding_applications'
onboarding_applications_single:
type: object
properties:
data:
$ref: '#/components/schemas/onboarding_applications_resource'
meta:
$ref: '#/components/schemas/jsonapi_meta'
onboarding_applications_sortable_attributes_list:
description: Onboarding application sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- start_at
- '-start_at'
- updated_at
- '-updated_at'
uniqueItems: true
offers:
description: Offer attributes
type: object
properties:
application_id:
type: string
readOnly: true
comment:
type: string
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
creator_id:
description: User ID
type: string
readOnly: true
expires_at:
type: string
format: date-time
readOnly: true
job_title:
type: string
readOnly: true
manager_id:
description: User ID
type: string
readOnly: true
paid_days_off:
type: string
readOnly: true
result:
type: string
enum:
- accepted
- pending
- rejected
- retracted
readOnly: true
result_at:
type: string
format: date-time
readOnly: true
salary_amount:
type: number
format: float
readOnly: true
salary_currency:
description: ISO 4217 alpha 3 currency code
type: string
readOnly: true
salary_period:
type: string
enum:
- hour
- day
- week
- two_weeks
- month
- year
readOnly: true
sent_at:
type: string
format: date-time
readOnly: true
signature_type:
type: string
enum:
- electronic
- not_required
- wet
readOnly: true
stage_id:
type: string
readOnly: true
start_on:
type: string
format: date
readOnly: true
status:
type: string
enum:
- draft
- open
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
work_address:
type: string
readOnly: true
offers_extra_fields:
description: Offers extra fields
type: string
enum:
- attachments
offers_relationships:
type: object
properties:
creator:
type: object
properties:
data:
$ref: '#/components/schemas/users_resource'
custom_attributes:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/custom_attributes_resource'
manager:
type: object
properties:
data:
$ref: '#/components/schemas/users_resource'
stage:
type: object
properties:
data:
$ref: '#/components/schemas/stages_resource'
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'
questions:
description: Question attributes
type: object
properties:
title:
type: string
readOnly: true
additional_information:
type: string
readOnly: true
num_required_answer_options:
type: integer
readOnly: true
max_num_required_answer_options:
type: integer
readOnly: true
question_type:
type: string
enum:
- long_text
- boolean
- multiple_choice
- document
- date
- url
- short_text
readOnly: true
required:
type: boolean
readOnly: true
multiple_choice_options:
type: string
readOnly: true
questions_resource:
type: object
properties:
id:
type: string
example: '10'
type:
type: string
enum:
- questions
attributes:
$ref: '#/components/schemas/questions'
relationships:
$ref: '#/components/schemas/jsonapi_relationships'
requisitions:
description: Requisition attributes
type: object
properties:
requisition_template_id:
type: integer
readOnly: true
name:
type: string
identifier:
type: string
job_id:
type: integer
readOnly: true
creator_id:
type: integer
readOnly: true
status:
type: string
readOnly: true
enum:
- pending_approval
- approved
- archived
archive:
type: boolean
writeOnly: true
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
requisitions_attributes_post:
description: Requisition attributes
type: object
properties:
name:
type: string
identifier:
type: string
required:
- name
requisitions_attributes_put:
description: Requisition attributes
type: object
properties:
archive:
type: boolean
requisitions_sortable_attributes_list:
description: Requisitions sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- updated_at
- '-updated_at'
uniqueItems: true
requisitions_readable_attributes:
description: Requisition readable attributes
type: string
enum:
- id
- requisition_template_id
- name
- indentifier
- job_id
- creator_id
- status
- created_at
- updated_at
requisitions_resource:
type: object
properties:
id:
type: string
example: '31'
type:
type: string
enum:
- requisition_templates
attributes:
$ref: '#/components/schemas/requisitions'
relationships:
$ref: '#/components/schemas/requisitions_relationships'
requisitions_resource_post:
type: object
properties:
type:
type: string
enum:
- requisitions
attributes:
$ref: '#/components/schemas/requisitions_attributes_post'
relationships:
$ref: '#/components/schemas/requisitions_relationships_post'
requisitions_resource_put:
type: object
properties:
id:
type: string
type:
type: string
enum:
- requisitions
attributes:
$ref: '#/components/schemas/requisitions_attributes_put'
required:
- id
- type
requisitions_request_post:
type: object
properties:
data:
$ref: '#/components/schemas/requisitions_resource_post'
requisitions_request_put:
type: object
properties:
data:
$ref: '#/components/schemas/requisitions_resource_put'
requisitions_related:
description: Requisition relationships available for inclusion
type: array
items:
type: string
enum:
- requisition_template
- requisition_details
- creator
uniqueItems: true
requisitions_relationships:
type: object
properties:
offers:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/offers_resource'
requisition_template:
type: object
properties:
data:
type: object
items:
$ref: '#/components/schemas/requisition_templates_resource'
requisition_details:
type: object
properties:
data:
$ref: >-
#/components/schemas/jsonapi_relationship_to_many_requisition_details
meta:
$ref: '#/components/schemas/jsonapi_meta'
creator:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToOne'
requisitions_relationships_post:
type: object
properties:
requisition_template:
type: object
properties:
data:
$ref: >-
#/components/schemas/jsonapi_relationship_to_one_requisition_template
requisition_details:
type: object
properties:
data:
$ref: >-
#/components/schemas/jsonapi_relationship_to_many_requisition_details
required:
- requisition_template
- requisition_details
requisition_templates:
description: Requisition template attributes
type: object
properties:
name:
type: string
readOnly: true
enforced_maximum_headcount:
type: integer
readOnly: true
has_enforced_maximum_headcount:
type: boolean
readOnly: true
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
requisition_templates_sortable_attributes_list:
description: Requisition Templates sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- updated_at
- '-updated_at'
uniqueItems: true
requisition_templates_readable_attributes:
description: Requisition readable attributes
type: string
enum:
- id
- name
- enforced_maximum_headcount
- has_enforced_maximum_headcount
- created_at
- updated_at
requisition_templates_resource:
type: object
properties:
id:
type: string
example: '31'
type:
type: string
enum:
- requisition_templates
attributes:
$ref: '#/components/schemas/requisition_templates'
relationships:
$ref: '#/components/schemas/requisition_templates_relationships'
requisition_templates_related:
description: Requisition Template relationships available for inclusion
type: array
items:
type: string
enum:
- requisition_template_fields
- requisition_template_fields.template_custom_field
uniqueItems: true
requisition_templates_relationships:
type: object
properties:
requisition_template_fields:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToOne'
requisition_template_fields.template_custom_field:
type: object
properties:
data:
$ref: '#/components/schemas/jsonapi_relationshipToMany'
meta:
$ref: '#/components/schemas/jsonapi_meta'
stages:
description: Stage attributes
type: object
properties:
description:
type: string
readOnly: true
name:
type: string
readOnly: true
external_name:
type: string
readOnly: true
visible:
type: boolean
readOnly: true
position:
type: integer
readOnly: true
basic_type:
type: string
enum:
- applied
- rejected
- review
- interview
- hired
- offer
readOnly: true
stages_resource:
type: object
properties:
id:
type: string
example: '69'
type:
type: string
enum:
- stages
attributes:
$ref: '#/components/schemas/stages'
relationships:
$ref: '#/components/schemas/jsonapi_relationships'
structure_custom_group_ones:
description: Structure Custom Group One attributes
type: object
properties:
title:
type: string
readOnly: true
example: Sub Department
created_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
name:
type: string
readOnly: true
example: Quality Assurance
updated_at:
type: string
format: date-time
readOnly: true
example: '2021-01-01T01:01:01+00:00'
structure_custom_group_ones_collection:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/structure_custom_group_ones_resource'
meta:
$ref: '#/components/schemas/jsonapi_meta'
structure_custom_group_ones_readable_attributes:
description: Structure Custom Group Ones readable attributes
type: string
enum:
- id
- created_at
- name
- title
- updated_at
structure_custom_group_ones_resource:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
enum:
- structure_custom_group_ones
attributes:
$ref: '#/components/schemas/structure_custom_group_ones'
structure_custom_group_ones_single:
type: object
properties:
data:
$ref: '#/components/schemas/structure_custom_group_ones_resource'
meta:
$ref: '#/components/schemas/jsonapi_meta'
structure_custom_group_ones_sortable_attributes_list:
description: Structure Custom Group One sortable attributes
type: array
items:
type: string
enum:
- id
- '-id'
- created_at
- '-created_at'
- updated_at
- '-updated_at'
uniqueItems: true
structure_links_extra_fields:
description: Structure Link extra fields
type: string
enum:
- names
- in_use
structure_links_readable_attribute:
description: Structure Link readable attributes
type: string
enum:
- accepts_speculative_applications
- created_at
- department_id
- division_id
- hired_at
- id
- location_id
- structure_custom_group_one_id
- updated_at
structure_links_related:
description: Structure Link relationships available for inclusion
type: array
items:
type: string
enum:
- department
- division
- location
- structure_custom_group_one
uniqueItems: true
users:
description: User attributes
type: object
properties:
email:
type: string
readOnly: true
first_name:
type: string
readOnly: true
last_name:
type: string
readOnly: true
users_resource:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
enum:
- users
attributes:
$ref: '#/components/schemas/users'
tag_object:
description: Tag
type: object
properties:
context:
type: string
readOnly: true
name:
type: string
readOnly: true
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_info:
type: object
required:
- meta
properties:
meta:
$ref: '#/components/schemas/jsonapi_meta'
jsonapi_resource:
type: object
oneOf:
- $ref: '#/components/schemas/answer_options_resource'
- $ref: '#/components/schemas/answers_resource'
- $ref: '#/components/schemas/applications_resource'
- $ref: '#/components/schemas/departments_resource'
- $ref: '#/components/schemas/divisions_resource'
- $ref: '#/components/schemas/jobs_resource'
- $ref: '#/components/schemas/job_seekers_resource'
- $ref: '#/components/schemas/locations_resource'
- $ref: '#/components/schemas/questions_resource'
- $ref: '#/components/schemas/stages_resource'
- $ref: '#/components/schemas/structure_custom_group_ones_resource'
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_relationships:
description: >-
Members of the relationships object ("relationships") represent
references from the resource object in which it's defined to other
resource objects.
type: object
jsonapi_relationship_to_one_job:
type: object
required:
- type
- id
properties:
type:
type: string
enum:
- jobs
id:
type: string
jsonapi_relationship_to_one_stage:
type: object
required:
- type
- id
properties:
type:
type: string
enum:
- stages
id:
type: string
jsonapi_relationship_to_many_answers:
type: array
items:
type: object
required:
- type
- temp-id
- method
properties:
type:
type: string
enum:
- answers
temp-id:
type: string
method:
type: string
enum:
- create
uniqueItems: true
jsonapi_relationship_to_one_commentable:
type: object
required:
- type
- id
properties:
type:
type: string
enum:
- applications
- job_seekers
id:
type: string
jsonapi_relationship_to_one_requisition_template:
type: object
required:
- type
- id
properties:
type:
type: string
enum:
- requisition_templates
id:
type: string
jsonapi_relationship_to_many_requisition_details:
type: array
items:
type: object
required:
- type
- temp-id
- method
properties:
type:
type: string
enum:
- requisition_details
temp-id:
type: string
method:
type: string
enum:
- create
uniqueItems: true
jsonapi_relationshipToOne:
description: >-
References to other resource objects in a to-one ("relationship").
Relationships can be specified by including a member in a resource's
links object.
oneOf:
- $ref: '#/components/schemas/jsonapi_linkage'
- nullable: true
jsonapi_relationshipToMany:
description: >-
An array of objects each containing "type" and "id" members for to-many
relationships.
type: array
items:
$ref: '#/components/schemas/jsonapi_linkage'
uniqueItems: true
jsonapi_linkage:
description: The "type" and "id" to non-empty members.
type: object
required:
- type
- id
properties:
type:
$ref: '#/components/schemas/types'
id:
type: string
example: '98'
jsonapi_pagination:
type: object
properties:
first:
description: The first page of data
oneOf:
- $ref: '#/components/schemas/jsonapi_link'
- nullable: true
last:
description: The last page of data
oneOf:
- $ref: '#/components/schemas/jsonapi_link'
- nullable: true
prev:
description: The previous page of data
oneOf:
- $ref: '#/components/schemas/jsonapi_link'
- nullable: true
next:
description: The next page of data
oneOf:
- $ref: '#/components/schemas/jsonapi_link'
- nullable: true
jsonapi_error:
type: object
properties:
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
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
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'
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'
CustomFieldsCreateNewFieldRequest:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: custom_fields
attributes:
type: object
properties:
description:
type: string
example: Our internal code for the role
name:
type: string
example: Internal job code
resource_type:
type: string
example: job
field_type:
type: string
example: single_select
options:
type: array
items:
type: string
example: Option one
required:
type: boolean
example: true
sample_value:
type: string
example: Option one
example:
data:
type: custom_fields
attributes:
description: Our internal code for the role
name: Internal job code
resource_type: job
field_type: single_select
options:
- Option one
- Option two
required: true
sample_value: Option one
CustomFieldsUpdateFieldByIdRequest:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: custom_fields
attributes:
type: object
properties:
description:
type: string
example: Our internal code for the role
name:
type: string
example: Internal job code
options:
type: array
items:
type: string
example: Option one
required:
type: boolean
example: true
sample_value:
type: string
example: Option one
example:
data:
id: 1X
type: custom_fields
attributes:
description: Our internal code for the role
name: Internal job code
options:
- Option one
- Option two
required: true
sample_value: Option one
DepartmentsCreateNewDepartmentRequest:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: departments
attributes:
type: object
properties:
name:
type: string
example: Software Development
example:
data:
type: departments
attributes:
name: Software Development
DepartmentsUpdateByIdRequest:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: departments
attributes:
type: object
properties:
name:
type: string
example: Software Development
example:
data:
id: 1XX
type: departments
attributes:
name: Software Development
DivisionsCreateDivisionRequest:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: divisions
attributes:
type: object
properties:
name:
type: string
example: EU
example:
data:
type: divisions
attributes:
name: EU
DivisionsUpdateByIdRequest:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: divisions
attributes:
type: object
properties:
name:
type: string
example: EU
example:
data:
id: 1XX
type: divisions
attributes:
name: EU
JobsCreateJobRequest:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: jobs
attributes:
type: object
properties:
title:
type: string
example: Test Job
description:
type: string
example: This is a test job
ask_for_address:
type: boolean
example: true
ask_for_date_of_birth:
type: boolean
example: true
ask_for_linkedin_profile:
type: boolean
example: true
ask_for_middle_name:
type: boolean
example: true
blind_screening:
type: boolean
example: true
benefits:
type: string
example: All the benefits
created_at:
type: string
example: '2023-11-10T10:57:58+00:00'
updated_at:
type: string
example: '2023-11-10T10:57:58+00:00'
application_form_url:
type: string
example: https://acme.pinpointhq.com/en/jobs/1/applications/new
benefits_header:
type: string
example: External benefits header
compensation:
type: string
example: £25,000 - £50,000 / year
compensation_minimum:
type: string
example: '25000.0'
compensation_maximum:
type: string
example: '50000.0'
compensation_currency:
type: string
example: GBP
compensation_frequency:
type: string
example: year
cover_letter_requirement:
type: string
example: required
deadline_on:
type: string
example: '2025-01-01'
compensation_visible:
type: boolean
example: true
custom_town:
type: string
example: Dorking
custom_county:
type: string
example: Surrey
custom_country:
type: string
example: United Kingdom
company_name_override:
type: string
example: Company name override
deadline_at:
type: string
example: '2025-01-01T00:00:00+00:00'
diversity_monitoring:
type: boolean
example: true
diversity_monitoring_requirement:
type: string
example: optional
draft_job_additional_information:
type: string
example: Draft job additional information
employment_type:
type: string
example: full_time
employment_type_text:
type: string
example: Full Time
experience_level:
type: string
example: director
external_key_responsibilities_header:
type: string
example: External key responsibilities header
external_skills_knowledge_expertise_header:
type: string
example: External skills/knowledge/expertise header
external_benefits_header:
type: string
example: External benefits header
headcount_maximum_enabled:
type: boolean
example: true
headcount_maximum:
type: number
example: 10
include_in_linkedin_rss:
type: boolean
example: true
include_in_indeed:
type: boolean
example: true
key_responsibilities:
type: string
example: Key responsibilities
key_responsibilities_header:
type: string
example: External key responsibilities header
linkedin_company_id:
type: string
example: '12345'
notify:
type: boolean
example: true
opened_at:
type: string
example: '2023-11-10T10:57:58+00:00'
personal_summary_requirement:
type: string
example: required
referrals_enabled:
type: boolean
example: true
referral_amount:
type: number
example: 1000
referral_currency:
type: string
example: GBP
referral_details:
type: string
example: Tell us about your best co-workers
reporting_to:
type: string
example: CTO
require_phone:
type: boolean
example: true
resume_requirement:
type: string
example: required
remote:
type: boolean
example: false
is_compensation_visible:
type: boolean
example: true
is_remote_with_location_restrictions:
type: boolean
example: true
requisition_id:
type: string
example: '1'
skills_knowledge_expertise_header:
type: string
example: External skills/knowledge/expertise header
skills_knowledge_expertise:
type: string
example: Skills/knowledge/expertise
status:
type: string
example: draft
visibility:
type: string
example: external
url:
type: string
example: https://acme.pinpointhq.com/en/jobs/1
path:
type: string
example: /en/jobs/1
workplace_type:
type: string
example: hybrid
workplace_type_text:
type: string
example: Hybrid
company_id:
type: string
example: '1'
structure_link_id:
type: string
example: '1'
hiring_user_id:
type: string
example: '1'
recruitment_manager_user_id:
type: string
example: '1'
facebookjobs:
type: boolean
example: true
monster:
type: boolean
example: true
talentdotcom:
type: boolean
example: true
ziprecruiter:
type: boolean
example: true
selected_hiring_workflow_id:
type: string
example: '1'
relationships:
type: object
properties:
department:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
division:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
location:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
structure_custom_group_one:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
company:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: companies
id:
type: string
example: '1'
structure_link:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: structure_links
id:
type: string
example: '1'
hiring_manager_user:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
recruitment_manager_user:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
applications:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
questions:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
custom_attributes:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
stages:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
included:
type: array
items:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: companies
attributes:
type: object
properties:
created_at:
type: string
example: '2023-11-02T11:13:39+00:00'
updated_at:
type: string
example: '2023-11-02T11:19:02+00:00'
name:
type: string
example: ACME Corporation
industry:
type: string
example: Software
location:
type: string
example: Jersey
website:
type: string
example: https://www.pinpointhq.com
division_id:
type: string
nullable: true
x-konfig-null-placeholder: true
location_id:
type: string
example: '3'
department_id:
type: string
example: '5'
structure_custom_group_one_id:
type: string
nullable: true
x-konfig-null-placeholder: true
accepts_speculative_applications:
type: boolean
example: true
relationships:
type: object
properties:
location:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
department:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
division:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
structure_custom_group_one:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
meta:
type: object
properties: {}
example:
data:
id: 1XX
type: jobs
attributes:
title: Test Job
description: This is a test job
ask_for_address: true
ask_for_date_of_birth: true
ask_for_linkedin_profile: true
ask_for_middle_name: true
blind_screening: true
benefits: All the benefits
created_at: '2023-11-10T10:57:58+00:00'
updated_at: '2023-11-10T10:57:58+00:00'
application_form_url: https://acme.pinpointhq.com/en/jobs/1/applications/new
benefits_header: External benefits header
compensation: £25,000 - £50,000 / year
compensation_minimum: '25000.0'
compensation_maximum: '50000.0'
compensation_currency: GBP
compensation_frequency: year
cover_letter_requirement: required
deadline_on: '2025-01-01'
compensation_visible: true
custom_town: Dorking
custom_county: Surrey
custom_country: United Kingdom
company_name_override: Company name override
deadline_at: '2025-01-01T00:00:00+00:00'
diversity_monitoring: true
diversity_monitoring_requirement: optional
draft_job_additional_information: Draft job additional information
employment_type: full_time
employment_type_text: Full Time
experience_level: director
external_key_responsibilities_header: External key responsibilities header
external_skills_knowledge_expertise_header: External skills/knowledge/expertise header
external_benefits_header: External benefits header
headcount_maximum_enabled: true
headcount_maximum: 10
include_in_linkedin_rss: true
include_in_indeed: true
key_responsibilities: Key responsibilities
key_responsibilities_header: External key responsibilities header
linkedin_company_id: '12345'
notify: true
opened_at: '2023-11-10T10:57:58+00:00'
personal_summary_requirement: required
referrals_enabled: true
referral_amount: 1000
referral_currency: GBP
referral_details: Tell us about your best co-workers
reporting_to: CTO
require_phone: true
resume_requirement: required
remote: false
is_compensation_visible: true
is_remote_with_location_restrictions: true
requisition_id: '1'
skills_knowledge_expertise_header: External skills/knowledge/expertise header
skills_knowledge_expertise: Skills/knowledge/expertise
status: draft
visibility: external
url: https://acme.pinpointhq.com/en/jobs/1
path: /en/jobs/1
workplace_type: hybrid
workplace_type_text: Hybrid
company_id: '1'
structure_link_id: '1'
hiring_user_id: '1'
recruitment_manager_user_id: '1'
facebookjobs: true
monster: true
talentdotcom: true
ziprecruiter: true
selected_hiring_workflow_id: '1'
relationships:
department:
meta:
included: false
division:
meta:
included: false
location:
meta:
included: false
structure_custom_group_one:
meta:
included: false
company:
data:
type: companies
id: 1XX
structure_link:
data:
type: structure_links
id: 1XX
hiring_manager_user:
meta:
included: false
recruitment_manager_user:
meta:
included: false
applications:
meta:
included: false
questions:
meta:
included: false
custom_attributes:
meta:
included: false
stages:
meta:
included: false
included:
- id: 1XX
type: companies
attributes:
created_at: '2023-11-02T11:13:39+00:00'
updated_at: '2023-11-02T11:19:02+00:00'
name: ACME Corporation
industry: Software
location: Jersey
website: https://www.pinpointhq.com
- id: 1XX
type: structure_links
attributes:
created_at: '2023-11-02T11:13:55+00:00'
updated_at: '2023-11-02T11:13:55+00:00'
division_id: null
location_id: '3'
department_id: '5'
structure_custom_group_one_id: null
accepts_speculative_applications: true
relationships:
location:
meta:
included: false
department:
meta:
included: false
division:
meta:
included: false
structure_custom_group_one:
meta:
included: false
meta: {}
JobsUpdateJobByIdRequest:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: jobs
attributes:
type: object
properties:
title:
type: string
example: Test Job
description:
type: string
example: This is a test job
ask_for_address:
type: boolean
example: true
ask_for_date_of_birth:
type: boolean
example: true
ask_for_linkedin_profile:
type: boolean
example: true
ask_for_middle_name:
type: boolean
example: true
blind_screening:
type: boolean
example: true
benefits:
type: string
example: All the benefits
created_at:
type: string
example: '2023-11-10T10:57:58+00:00'
updated_at:
type: string
example: '2023-11-10T10:57:58+00:00'
application_form_url:
type: string
example: https://acme.pinpointhq.com/en/jobs/1/applications/new
benefits_header:
type: string
example: External benefits header
compensation:
type: string
example: £25,000 - £50,000 / year
compensation_minimum:
type: string
example: '25000.0'
compensation_maximum:
type: string
example: '50000.0'
compensation_currency:
type: string
example: GBP
compensation_frequency:
type: string
example: year
cover_letter_requirement:
type: string
example: required
deadline_on:
type: string
example: '2025-01-01'
compensation_visible:
type: boolean
example: true
custom_town:
type: string
example: Dorking
custom_county:
type: string
example: Surrey
custom_country:
type: string
example: United Kingdom
company_name_override:
type: string
example: Company name override
deadline_at:
type: string
example: '2025-01-01T00:00:00+00:00'
diversity_monitoring:
type: boolean
example: true
diversity_monitoring_requirement:
type: string
example: optional
draft_job_additional_information:
type: string
example: Draft job additional information
employment_type:
type: string
example: full_time
employment_type_text:
type: string
example: Full Time
experience_level:
type: string
example: director
external_key_responsibilities_header:
type: string
example: External key responsibilities header
external_skills_knowledge_expertise_header:
type: string
example: External skills/knowledge/expertise header
external_benefits_header:
type: string
example: External benefits header
headcount_maximum_enabled:
type: boolean
example: true
headcount_maximum:
type: number
example: 10
include_in_linkedin_rss:
type: boolean
example: true
include_in_indeed:
type: boolean
example: true
key_responsibilities:
type: string
example: Key responsibilities
key_responsibilities_header:
type: string
example: External key responsibilities header
linkedin_company_id:
type: string
example: '12345'
notify:
type: boolean
example: true
opened_at:
type: string
example: '2023-11-10T10:57:58+00:00'
personal_summary_requirement:
type: string
example: required
referrals_enabled:
type: boolean
example: true
referral_amount:
type: number
example: 1000
referral_currency:
type: string
example: GBP
referral_details:
type: string
example: Tell us about your best co-workers
reporting_to:
type: string
example: CTO
require_phone:
type: boolean
example: true
resume_requirement:
type: string
example: required
remote:
type: boolean
example: false
is_compensation_visible:
type: boolean
example: true
is_remote_with_location_restrictions:
type: boolean
example: true
requisition_id:
type: string
example: '1'
skills_knowledge_expertise_header:
type: string
example: External skills/knowledge/expertise header
skills_knowledge_expertise:
type: string
example: Skills/knowledge/expertise
status:
type: string
example: draft
visibility:
type: string
example: external
url:
type: string
example: https://acme.pinpointhq.com/en/jobs/1
path:
type: string
example: /en/jobs/1
workplace_type:
type: string
example: hybrid
workplace_type_text:
type: string
example: Hybrid
company_id:
type: string
example: '1'
structure_link_id:
type: string
example: '1'
hiring_user_id:
type: string
example: '1'
recruitment_manager_user_id:
type: string
example: '1'
facebookjobs:
type: boolean
example: true
monster:
type: boolean
example: true
talentdotcom:
type: boolean
example: true
ziprecruiter:
type: boolean
example: true
selected_hiring_workflow_id:
type: string
example: '1'
relationships:
type: object
properties:
department:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
division:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
location:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
structure_custom_group_one:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
company:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: companies
id:
type: string
example: '1'
structure_link:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: structure_links
id:
type: string
example: '1'
hiring_manager_user:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
recruitment_manager_user:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
applications:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
questions:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
custom_attributes:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
stages:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
included:
type: array
items:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: companies
attributes:
type: object
properties:
created_at:
type: string
example: '2023-11-02T11:13:39+00:00'
updated_at:
type: string
example: '2023-11-02T11:19:02+00:00'
name:
type: string
example: ACME Corporation
industry:
type: string
example: Software
location:
type: string
example: Jersey
website:
type: string
example: https://www.pinpointhq.com
division_id:
type: string
nullable: true
x-konfig-null-placeholder: true
location_id:
type: string
example: '3'
department_id:
type: string
example: '5'
structure_custom_group_one_id:
type: string
nullable: true
x-konfig-null-placeholder: true
accepts_speculative_applications:
type: boolean
example: true
relationships:
type: object
properties:
location:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
department:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
division:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
structure_custom_group_one:
type: object
properties:
meta:
type: object
properties:
included:
type: boolean
example: false
meta:
type: object
properties: {}
example:
data:
id: 1XX
type: jobs
attributes:
title: Test Job
description: This is a test job
ask_for_address: true
ask_for_date_of_birth: true
ask_for_linkedin_profile: true
ask_for_middle_name: true
blind_screening: true
benefits: All the benefits
created_at: '2023-11-10T10:57:58+00:00'
updated_at: '2023-11-10T10:57:58+00:00'
application_form_url: https://acme.pinpointhq.com/en/jobs/1/applications/new
benefits_header: External benefits header
compensation: £25,000 - £50,000 / year
compensation_minimum: '25000.0'
compensation_maximum: '50000.0'
compensation_currency: GBP
compensation_frequency: year
cover_letter_requirement: required
deadline_on: '2025-01-01'
compensation_visible: true
custom_town: Dorking
custom_county: Surrey
custom_country: United Kingdom
company_name_override: Company name override
deadline_at: '2025-01-01T00:00:00+00:00'
diversity_monitoring: true
diversity_monitoring_requirement: optional
draft_job_additional_information: Draft job additional information
employment_type: full_time
employment_type_text: Full Time
experience_level: director
external_key_responsibilities_header: External key responsibilities header
external_skills_knowledge_expertise_header: External skills/knowledge/expertise header
external_benefits_header: External benefits header
headcount_maximum_enabled: true
headcount_maximum: 10
include_in_linkedin_rss: true
include_in_indeed: true
key_responsibilities: Key responsibilities
key_responsibilities_header: External key responsibilities header
linkedin_company_id: '12345'
notify: true
opened_at: '2023-11-10T10:57:58+00:00'
personal_summary_requirement: required
referrals_enabled: true
referral_amount: 1000
referral_currency: GBP
referral_details: Tell us about your best co-workers
reporting_to: CTO
require_phone: true
resume_requirement: required
remote: false
is_compensation_visible: true
is_remote_with_location_restrictions: true
requisition_id: '1'
skills_knowledge_expertise_header: External skills/knowledge/expertise header
skills_knowledge_expertise: Skills/knowledge/expertise
status: draft
visibility: external
url: https://acme.pinpointhq.com/en/jobs/1
path: /en/jobs/1
workplace_type: hybrid
workplace_type_text: Hybrid
company_id: '1'
structure_link_id: '1'
hiring_user_id: '1'
recruitment_manager_user_id: '1'
facebookjobs: true
monster: true
talentdotcom: true
ziprecruiter: true
selected_hiring_workflow_id: '1'
relationships:
department:
meta:
included: false
division:
meta:
included: false
location:
meta:
included: false
structure_custom_group_one:
meta:
included: false
company:
data:
type: companies
id: 1XX
structure_link:
data:
type: structure_links
id: 1XX
hiring_manager_user:
meta:
included: false
recruitment_manager_user:
meta:
included: false
applications:
meta:
included: false
questions:
meta:
included: false
custom_attributes:
meta:
included: false
stages:
meta:
included: false
included:
- id: 1XX
type: companies
attributes:
created_at: '2023-11-02T11:13:39+00:00'
updated_at: '2023-11-02T11:19:02+00:00'
name: ACME Corporation
industry: Software
location: Jersey
website: https://www.pinpointhq.com
- id: 1XX
type: structure_links
attributes:
created_at: '2023-11-02T11:13:55+00:00'
updated_at: '2023-11-02T11:13:55+00:00'
division_id: null
location_id: '3'
department_id: '5'
structure_custom_group_one_id: null
accepts_speculative_applications: true
relationships:
location:
meta:
included: false
department:
meta:
included: false
division:
meta:
included: false
structure_custom_group_one:
meta:
included: false
meta: {}
LocationsCreateLocationRequest:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: locations
attributes:
type: object
properties:
name:
type: string
example: Jersey
city:
type: string
example: St Helier
country_code:
type: string
example: GB
province:
type: string
example: ''
street_address:
type: string
example: Union Street
postal_code:
type: string
example: JE1 2PP
example:
data:
type: locations
attributes:
name: Jersey
city: St Helier
country_code: GB
province: ''
street_address: Union Street
postal_code: JE1 2PP
LocationsUpdateLocationByIdRequest:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: locations
attributes:
type: object
properties:
name:
type: string
example: Jersey
city:
type: string
example: St Helier
country_code:
type: string
example: GB
province:
type: string
example: ''
street_address:
type: string
example: Union Street
postal_code:
type: string
example: JE1 2PP
example:
data:
id: 1XX
type: locations
attributes:
name: Jersey
city: St Helier
country_code: GB
province: ''
street_address: Union Street
postal_code: JE1 2PP
StructureCustomGroupOnesCreateNewGroupRequest:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: structure_custom_group_ones
attributes:
type: object
properties:
name:
type: string
example: DevOps
example:
data:
type: structure_custom_group_ones
attributes:
name: DevOps
StructureCustomGroupOnesUpdateOneRequest:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: structure_custom_group_ones
attributes:
type: object
properties:
name:
type: string
example: DevOps
example:
data:
id: 1XX
type: structure_custom_group_ones
attributes:
name: DevOps
StructureLinksCreateLinkRequest:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: structure_links
attributes:
type: object
properties:
accepts_speculative_applications:
type: boolean
example: true
relationships:
type: object
properties:
location:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: locations
id:
type: string
example: '1'
department:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: departments
id:
type: string
example: '1'
division:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: divisions
id:
type: string
example: '1'
structure_custom_group_one:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: structure_custom_group_ones
id:
type: string
example: '1'
example:
data:
type: structure_links
attributes:
accepts_speculative_applications: true
relationships:
location:
data:
type: locations
id: 1XX
department:
data:
type: departments
id: 1XX
division:
data:
type: divisions
id: 1XX
structure_custom_group_one:
data:
type: structure_custom_group_ones
id: 1XX
StructureLinksUpdateLinkByIdRequest:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: structure_links
attributes:
type: object
properties:
accepts_speculative_applications:
type: boolean
example: true
example:
data:
id: 1XX
type: structure_links
attributes:
accepts_speculative_applications: true
UsersCreateUserRequest:
type: object
properties:
data:
type: object
properties:
type:
type: string
example: users
attributes:
type: object
properties:
email:
type: string
example: joe.bloggs@pinpoint.dev
first_name:
type: string
example: Joe
last_name:
type: string
example: Bloggs
time_zone:
type: string
example: Europe/London
user_type:
type: string
example: employee
send_invitation:
type: boolean
example: true
example:
data:
type: users
attributes:
email: joe.bloggs@pinpoint.dev
first_name: Joe
last_name: Bloggs
time_zone: Europe/London
user_type: employee
send_invitation: true
requestBodies:
applications_post:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/applications_request_post'
examples:
with_answers:
$ref: '#/components/examples/jsonapi_applications_post'
applications_put:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/applications_request_put'
examples:
update_attributes_and_stage:
$ref: '#/components/examples/jsonapi_applications_put'
comments_post:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/comments_request_post'
examples:
basic:
$ref: '#/components/examples/jsonapi_comments_post'
custom_attributes_post:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/custom_attributes_request_post'
examples:
boolean:
$ref: '#/components/examples/jsonapi_custom_attributes_post_boolean'
date:
$ref: '#/components/examples/jsonapi_custom_attributes_post_date'
decimal:
$ref: '#/components/examples/jsonapi_custom_attributes_post_decimal'
integer:
$ref: '#/components/examples/jsonapi_custom_attributes_post_integer'
multi_select:
$ref: >-
#/components/examples/jsonapi_custom_attributes_post_multi_select
single_select:
$ref: >-
#/components/examples/jsonapi_custom_attributes_post_single_select
text:
$ref: '#/components/examples/jsonapi_custom_attributes_post_text'
varchar:
$ref: '#/components/examples/jsonapi_custom_attributes_post_varchar'
custom_attributes_put:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/custom_attributes_request_put'
examples:
boolean:
$ref: '#/components/examples/jsonapi_custom_attributes_put_boolean'
date:
$ref: '#/components/examples/jsonapi_custom_attributes_put_date'
decimal:
$ref: '#/components/examples/jsonapi_custom_attributes_put_decimal'
integer:
$ref: '#/components/examples/jsonapi_custom_attributes_put_integer'
multi_select:
$ref: '#/components/examples/jsonapi_custom_attributes_put_multi_select'
single_select:
$ref: >-
#/components/examples/jsonapi_custom_attributes_put_single_select
text:
$ref: '#/components/examples/jsonapi_custom_attributes_put_text'
varchar:
$ref: '#/components/examples/jsonapi_custom_attributes_put_varchar'
custom_fields_post:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/CustomFieldsCreateNewFieldRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_custom_fields_post'
custom_fields_put:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/CustomFieldsUpdateFieldByIdRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_custom_fields_put'
departments_post:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/DepartmentsCreateNewDepartmentRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_departments_post'
departments_put:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/DepartmentsUpdateByIdRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_departments_put'
divisions_post:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/DivisionsCreateDivisionRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_divisions_post'
divisions_put:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/DivisionsUpdateByIdRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_divisions_put'
locations_post:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/LocationsCreateLocationRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_locations_post'
locations_put:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/LocationsUpdateLocationByIdRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_locations_put'
jobs_post:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobsCreateJobRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_jobs_post'
jobs_put:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobsUpdateJobByIdRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_jobs_put'
requisitions_post:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/requisitions_request_post'
examples:
basic:
$ref: '#/components/examples/jsonapi_requisitions_post'
requisitions_put:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/requisitions_request_put'
examples:
basic:
$ref: '#/components/examples/jsonapi_requisitions_put'
structure_custom_group_ones_post:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/StructureCustomGroupOnesCreateNewGroupRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_structure_custom_group_ones_post'
structure_custom_group_ones_put:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/StructureCustomGroupOnesUpdateOneRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_structure_custom_group_ones_put'
structure_links_post:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/StructureLinksCreateLinkRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_structure_links_post'
structure_links_put:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/StructureLinksUpdateLinkByIdRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_structure_links_put'
users_post:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UsersCreateUserRequest'
examples:
basic:
$ref: '#/components/examples/jsonapi_users_post'
security:
- ApiKeyAuth: []
x-readme:
samples-languages:
- curl
- javascript
- node
- node-simple
- php
- python
- ruby
explorer-enabled: true
proxy-enabled: true
_id: 65f7fba394a8f700300fe0ce