File Schema

Every backup holds these files. Each one is gzipped JSON lines: one record per line, using the fields below. A linked record such as company is { id, name }, so you never need a join. Fields can be null, except id.

Each file also has a machine-readable JSON Schema, linked under its heading.

System users

system_users.jsonl.gz

The people in your Recruitly account. Passwords, sign-in codes and calendar connections are never included.

JSON Schema

Field	Type
id	string
tenantId	string
firstName	string
surname	string
nickname	string
email	string
mobile	string
workPhone	string
headline	string
role	string
office
team
disabled	boolean
disabledOn	date-time
bot	boolean
aiAgent	boolean
createdOn	date-time
modifiedOn	date-time

Candidates

candidates.jsonl.gz

Your candidates, with contact details, work history, education, skills and custom fields. CV text and National Insurance numbers are not in this file.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
title	string
firstName	string
surname	string
headline	string
email	string
alternateEmail	string
mobile	string
homePhone	string
workPhone	string
linkedIn	string
doNotContact	boolean
optoutEmails	boolean
optoutSMS	boolean
address
gender	string
nationalities	array of strings
status	string
source	string
rating	number
hot	boolean
skills	array of strings
yearsOfExperience	number
overview	string
currentEmployer
employmentHistory	array of
educationHistory	array of
placed	boolean
customFields	array of

Contacts

contacts.jsonl.gz

The people at your clients. Client portal passwords are never included.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
title	string
firstName	string
surname	string
headline	string
email	string
alternateEmail	string
mobile	string
homePhone	string
workPhone	string
linkedIn	string
doNotContact	boolean
optoutEmails	boolean
optoutSMS	boolean
address
company
status	string
source	string
sectors	array of strings
industries	array of strings
customFields	array of

Companies

companies.jsonl.gz

Your clients and prospects.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
name	string
description	string
website	string
email	string
phone	string
linkedIn	string
client	boolean
status	string
source	string
companyType	string
employeeCount	number
annualRevenue	number
foundedYear	number
sectors	array of strings
industries	array of strings
headOffice
rating	number
doNotContact	boolean
parent
customFields	array of

Leads

leads.jsonl.gz

Your sales leads.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
title	string
firstName	string
surname	string
headline	string
email	string
alternateEmail	string
mobile	string
homePhone	string
workPhone	string
linkedIn	string
doNotContact	boolean
optoutEmails	boolean
optoutSMS	boolean
address
companyName	string
description	string
website	string
status	string
source	string
rating	number
linkedCompany
customFields	array of

Deals

deals.jsonl.gz

Your sales opportunities and their stage.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
name	string
description	string
company
contact
stage	string
type	string
employmentType	string
source	string
probability	number
bid
forecastedClosingDate	date-time
startDate	date-time
actualClosingDate	date-time
closedByName	string
assignedTo
customFields	array of

Jobs

jobs.jsonl.gz

Your job orders.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
title	string
company
contact
status	string
jobType	string
employmentType	string
experience	string
sectors	array of strings
industries	array of strings
openings	number
description	string
shortDescription	string
skills	array of strings
location
remoteWorking	boolean
pay
commissionValue
closingDate	date-time
hot	boolean
customFields	array of

Job pipeline

job_pipeline.jsonl.gz

Each candidate on each job, with their stage and the key dates.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
job
candidate
company
status	string
stage	string
candidateSource	string
rejected	boolean
rejectReason	string
hot	boolean
rating	number
sourcedDate	date-time
appliedDate	date-time
shortlistDate	date-time
cvSentDate	date-time
interviewDate	date-time
offeredDate	date-time
placementDate	date-time

Interviews

interviews.jsonl.gz

Interviews linked to a job pipeline. Other calendar appointments are not included.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
title	string
job
pipeline
organiser
attendees	array of
start	date-time
end	date-time
timeZone	string
locationName	string
cancelled	boolean

Placements

placements.jsonl.gz

Your placements and their fees.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
job
candidate
company
contact
status	string
type	string
employmentType	string
source	string
placementDate	date-time
startDate	date-time
candidateLeftDate	date-time
placementValue	number
placementCost	number
permDetails
contractDetails
customFields	array of

Invoices

invoices.jsonl.gz

Your invoices and what has been paid.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
number	string
status	string
contact
currency	string
totalAmount	number
totalTax	number
amountDue	number
amountPaid	number
invoiceDate	date-time
dueDate	date-time
paymentDate	date-time
notes	string
links	array of

Notes

notes.jsonl.gz

Notes and activity recorded against your records.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
type	string
from
notes	string
systemActivity	boolean
inbound	boolean
links	array of

Tasks

tasks.jsonl.gz

Tasks and who they are assigned to.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
subject	string
notes	string
status	string
completed	boolean
type	string
assignedBy
assignedTo	array of
linkedRecords	array of
dueDate	date-time
reminderDate	date-time

Files

files.jsonl.gz

Your stored files: name, type, size, its path inside the documents parts and which records it belongs to.

JSON Schema

Field	Type
id	string
tenantId	string
reference	string
owner
createdOn	date-time
modifiedOn	date-time
archived	boolean
name	string
contentType	string
fileSize	number
path	string
links	array of