logo
API docs by Redocly

People Analytics Data Orchestration API (0.1.0)

This page covers all the ways in which you can access People Analytics’s MetaModel information through our API.

Authentication

Each call to this API is authenticated via the API key.

ApiKey

Example: Authorization: ApiKey <identifier>:<token>

Security Scheme Type: API Key
Header parameter name: Authorization

API Versioning

The API version can be set using X-Api-Version. If the header is not set, the latest version will be used.

Pagination

All API calls that are returning lists are paginated. The default size of returned results is 1000, and this can be changed by using the page_size parameter. After the initial call, the response will contain the pagination key, which will contain the continuation_token. This token could be passed as the GET param in the request to fetch the next page. If the next page does not exist, this value will be empty.

Fetching data by date

Some of the data entities in API calls can be fetched by date fields. For this purpose, you can use either a fixed value or provide a range of values a field can be in with the YYYYMMDD-YYYYMMDD syntax. If a range is used, the values are inclusive.

Examples:

  • employees?start_date=20220203 will fetch all employees that started working on 3 February
  • employees?start_date=20220101-20221231 will fetch all employees that started working in 2022.

Changelog

2023-01-31

Released 0.1.0 version of the API.

HRIS

HRIS metamodel access.

Get the list of employees

Get the list of employees

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

start_date
string
Example: start_date=20200101-20221231

Fetch employees by start date. Can be a single or a range value.

end_date
string
Example: end_date=20200101-20221231

Fetch employees by end date. Can be a single or a range value.

location
string
Example: location=London

Fetch employees by location.

department
string
Example: department=Marketing

Fetch employees by department.

role
string
Example: role=Senior Manager

Fetch employees by role.

team
string
Example: team=Customer Service

Fetch employees by team.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch a single employee

Fetch a single employee

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "employee_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "full_name": "string",
  • "email": "string",
  • "location": "string",
  • "department": "string",
  • "role": "string",
  • "team": "string",
  • "gender": "string",
  • "age": 0,
  • "nationality": "string",
  • "ethnicity": "string",
  • "compensation": {
    },
  • "status": {
    },
  • "reports_to": {
    },
  • "division": "string",
  • "branch": "string",
  • "avatar": "string",
  • "functional_level": "string",
  • "tenure": 0,
  • "custom_fields": { },
  • "grade": "string",
  • "generation": "string",
  • "previous_company": "string",
  • "performance_rating": "string"
}

Fetch employment history details

Fetch employment history details

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

start_date
string
Example: start_date=20200101-20221231

Get employment history by start date. Can be a single or a range value.

end_date
string
Example: end_date=20200101-20221231

Get employment history by end date. Can be a single or a range value.

employee_id
string
Example: employee_id=123

Get employment history for employee.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch salary history details

Fetch salary history details

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

effective_from
string
Example: effective_from=20200101-20221231

Fetch salary history by start date. Can be a single or a range value.

effective_to
string
Example: effective_to=20200101-20221231

Fetch salary history by end date. Can be a single or a range value.

employee_id
string
Example: employee_id=123

Fetch salary history for employee.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch bonus details

Fetch bonus details

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

effective_date
string
Example: effective_date=20200101-20221231

Fetch bonus history by date. Can be a single or a range value.

employee_id
string
Example: employee_id=123

Fetch an employee’s bonus history.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch job history details

Fetch job history details

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

start_date
string
Example: start_date=20200101-20221231

Fetch employment history by start date. Can be a single or a range value.

employee_id
string
Example: employee_id=123

Fetch an employee’s job history.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

ATS

ATS metamodel access.

Fetch a list of all applications

Fetch a list of all applications

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

created_at
string
Example: created_at=20200101-20221231

Fetch applications by creation date. Can be a single or a range value.

hired_at
string
Example: hired_at=20200101-20221231

Fetch applications by date when they were hired. Can be a single value or range.

rejected_at
string
Example: rejected_at=20200101-20221231

Fetch applications by their reject date. Can be a single or a range value.

posting_id
string
Example: posting_id=123

Fetch applications by posting id.

recruiter_id
string
Example: recruiter_id=123

Fetch applications by recruiter.

location
string
Example: location=London

Fetch applications by location.

department
string
Example: department=Marketing

Fetch applications by department.

role
string
Example: role=Senior Manager

Fetch applications by role.

team
string
Example: team=Customer Service

Fetch applications by team.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch a list of offers

Fetch a list of offers

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

sent_at
string
Example: sent_at=20200101-20221231

Fetch offers by date sent. Can be a single or a range value.

signed_at
string
Example: signed_at=20200101-20221231

Fetch offers by sign date. Can be a single or a range value.

rejected_at
string
Example: rejected_at=20200101-20221231

Fetch offers by reject date. Can be a single or a range value.

application_id
string
Example: application_id=123

Fetch offers by their application id.

location
string
Example: location=London

Fetch offers by location.

department
string
Example: department=Marketing

Fetch offers by department.

role
string
Example: role=Senior Manager

Fetch offers by role.

team
string
Example: team=Customer Service

Fetch offers by team.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch the list of postings

Fetch the list of postings

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

created_at
string
Example: created_at=20200101-20221231

Fetch postings by sent date. Can be a single or a range value.

published_at
string
Example: published_at=20200101-20221231

Fetch postings by publish date. Can be a single or a range value.

closed_at
string
Example: closed_at=20200101-20221231

Fetch postings by close date. Can be a single or a range value.

recruiter_id
string
Example: recruiter_id=123

Fetch postings by their recruiter id.

location
string
Example: location=London

Fetch postings by location.

department
string
Example: department=Marketing

Fetch postings by department.

role
string
Example: role=Senior Manager

Fetch postings by role.

team
string
Example: team=Customer Service

Fetch postings by team.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch the candidate list

Fetch the candidate list

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch interview list

Fetch interview list

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

location
string
Example: location=London

Fetch interviews by location.

department
string
Example: department=Marketing

Fetch interviews by department.

role
string
Example: role=Senior Manager

Fetch interviews by role.

team
string
Example: team=Customer Service

Fetch interviews by team.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch list of requisitions

Fetch list of requisitions

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

location
string
Example: location=London

Fetch requisitions by location.

department
string
Example: department=Marketing

Fetch requisitions by department.

role
string
Example: role=Senior Manager

Fetch requisitions by role.

team
string
Example: team=Customer Service

Fetch requisitions by team.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch the list of recruiters

Fetch the list of recruiters

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch the list of interview stages

Fetch the list of interview stages

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch the list of stage pipelines

Fetch the list of stage pipelines

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch the feedback list

Fetch the feedback list

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

created_at
string
Example: created_at=20200101-20221231

Fetch feedback by the dates created. Can be a single or a range value.

posting_id
string
Example: posting_id=123

Fetch feedback by posting id.

application_id
string
Example: application_id=123

Fetch feedback by application id.

candidate_id
string
Example: candidate_id=123

Fetch feedback by candidate id.

location
string
Example: location=London

Fetch feedback by location.

department
string
Example: department=Marketing

Fetch feedback by department.

role
string
Example: role=Senior Manager

Fetch feedback by role.

team
string
Example: team=Customer Service

Fetch feedback by team.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

PTO

PTO metamodel access.

Fetch personal time off details

Fetch personal time off details

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

start_date
string
Example: start_date=20200101-20221231

Fetch PTO by start date. Can be a single or a range value.

end_date
string
Example: end_date=20200101-20221231

Fetch PTO by end date. Can be a single or a range value.

employee_id
string
Example: employee_id=123

Fetch an employee’s PTO history.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch all available PTO types

Fetch all available PTO types

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

PMS

PMS metamodel access.

Fetch a list of PMS users

Fetch a list of PMS users

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch the list of PMS Feedback Sessions

Fetch the list of PMS Feedback Sessions

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch the list of PMS Peer Recognitions

Fetch the list of PMS Peer Recognitions

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch the list of PMS Objectives

Fetch the list of PMS Objectives

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Fetch the list of PMS Reviews

Fetch the list of PMS Reviews

Authorizations:
ApiKey
query Parameters
page_size
integer [ 1 .. 1000 ]
Default: 1000

Sets the page size for pagination.

continuation_token
string

Used to provide the paging continuation token returned in the previous request.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Employee

employee_id
string

Employee's ID from HRIS.

first_name
string

Employee's first name.

last_name
string

Employee's last name.

full_name
string

Employee's full name.

email
string

Employee's email.

location
string

Employee's location.

department
string

Employee's department.

role
string

Employee's role.

team
string

Employee's team.

gender
string

Employee's gender.

age
integer

Employee's age in years.

nationality
string

Employee's nationality.

ethnicity
string

Employee's ethnicity.

object

Employee's compensation information.

object

Current employment status for an employee.

object

Employee’s current supervisor.

division
string

Employee's division.

branch
string

Employee's branch.

avatar
string or null

Employee's avatar url.

functional_level
string or null

Employee’s functional level in the organization.

tenure
integer

Employee's tenure in years.

custom_fields
object

All custom fields for the organization.

grade
string

Employee's grade.

generation
string

Employee's generation.

previous_company
string

Employee's previous company.

performance_rating
string

Employee's performance rating.

{
  • "employee_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "full_name": "string",
  • "email": "string",
  • "location": "string",
  • "department": "string",
  • "role": "string",
  • "team": "string",
  • "gender": "string",
  • "age": 0,
  • "nationality": "string",
  • "ethnicity": "string",
  • "compensation": {
    },
  • "status": {
    },
  • "reports_to": {
    },
  • "division": "string",
  • "branch": "string",
  • "avatar": "string",
  • "functional_level": "string",
  • "tenure": 0,
  • "custom_fields": { },
  • "grade": "string",
  • "generation": "string",
  • "previous_company": "string",
  • "performance_rating": "string"
}

Employment History

employee_id
string

Employee ID from HRIS.

start_date
string <date-time>

Employment history effective start date.

end_date
string or null <date-time>

Employment history effective end date.

employment_type
string or null

Type of employment.

object
{
  • "employee_id": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "employment_type": "string",
  • "termination": {
    }
}

Job History

employee_id
string

Employee's ID from HRIS.

start_date
string <date-time>

Job change effective date.

location
string or null

Employee's location.

department
string or null

Employee's department.

team
string or null

Employee's team.

role
string or null

Employee's role.

{
  • "employee_id": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "location": "string",
  • "department": "string",
  • "team": "string",
  • "role": "string"
}

Salary History

employee_id
string

Employee ID from HRIS.

effective_from
string or null <date-time>

Salary history effective start date.

effective_to
string or null <date-time>

Salary history effective end date.

pay_period
string
Enum: "UNKNOWN" "HOUR" "DAY" "WEEK" "TWO_WEEKS" "MONTH" "HALF_A_MONTH" "QUARTER" "YEAR" "PAY_PERIOD" "PIECE" "TWICE_A_MONTH" "HALF_YEAR"

Payment period.

amount
number or null

Salary amount.

currency
string or null

Salary currency.

{
  • "employee_id": "string",
  • "effective_from": "2019-08-24T14:15:22Z",
  • "effective_to": "2019-08-24T14:15:22Z",
  • "pay_period": "UNKNOWN",
  • "amount": 0,
  • "currency": "string"
}

Bonus

employee_id
string

Employee ID from HRIS.

effective_date
string <date-time>

Bonus effective date.

amount
number or null

Bonus amount.

currency
string or null

Bonus currency.

{
  • "employee_id": "string",
  • "effective_date": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "currency": "string"
}

Application

application_id
string

Application ID from ATS.

candidate_id
string or null

Candidate ID from ATS.

posting_id
string or null

Posting ID from ATS.

name
string or null

Candidate name.

object or null

Application referral information.

stage_id
string or null

Current Stage ID.

stage_changed_at
string or null <date-time>

Last time the stage was changed.

hired
boolean

Whether the candidate has been hired or not.

hired_at
string or null <date-time>

Candidate hire time.

object or null

Reason this application was archived.

archived_at
string or null <date-time>

Application archive time.

created_at
string or null <date-time>

Application create time.

rejected_at
string or null <date-time>

Application reject time.

location
string or null

Application location.

department
string or null

Application department.

role
string or null

Application role.

team
string or null

Application team.

gender
string or null

Applicant gender.

race
string or null

Applicant gender.

origin
string or null

Application origin.

sources
Array of strings

Application source.

recruiter_id
string or null

Application recruiter ID.

Array of objects

List of all application stage changes.

last_activity_at
string or null

Application last activity time.

candidate_location
string or null

Application candidate location.

{
  • "application_id": "string",
  • "candidate_id": "string",
  • "posting_id": "string",
  • "name": "string",
  • "application_referral": {
    },
  • "stage_id": "string",
  • "stage_changed_at": "2019-08-24T14:15:22Z",
  • "hired": true,
  • "hired_at": "2019-08-24T14:15:22Z",
  • "archive_reason": {
    },
  • "archived_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "rejected_at": "2019-08-24T14:15:22Z",
  • "location": "string",
  • "department": "string",
  • "role": "string",
  • "team": "string",
  • "gender": "string",
  • "race": "string",
  • "origin": "string",
  • "sources": [
    ],
  • "recruiter_id": "string",
  • "stage_changes": [
    ],
  • "last_activity_at": "string",
  • "candidate_location": "string"
}

Offer

offer_id
string or null

Offer ID from ATS.

application_id
string

Application ID from ATS.

sent_at
string or null <date-time>

Sent time.

signed
boolean or null

Whether the offer has been signed.

signed_at
string or null <date-time>

Offer signed time.

rejected
boolean or null

Whether the offer has been rejected.

rejected_at
string or null <date-time>

Offer rejection time.

location
string or null

Offer location.

department
string or null

Offer department.

role
string or null

Offer role.

team
string or null

Offer team.

{
  • "offer_id": "string",
  • "application_id": "string",
  • "sent_at": "2019-08-24T14:15:22Z",
  • "signed": true,
  • "signed_at": "2019-08-24T14:15:22Z",
  • "rejected": true,
  • "rejected_at": "2019-08-24T14:15:22Z",
  • "location": "string",
  • "department": "string",
  • "role": "string",
  • "team": "string"
}

Posting

posting_id
string or null

Posting ID from the ATS.

recruiter_id
string

Recruiter ID from the ATS.

pipeline_id
string

Recruiter ID from the ATS.

title
string or null

Posting title.

created
string or null <date-time>

Time the posting was created.

published
string or null <date-time>

Time the posting was published.

closed_at
string or null <date-time>

Time the posting was closed.

location
string or null

Posting location.

department
string or null

Posting department.

role
string or null

Posting role.

team
string or null

Posting team.

{
  • "posting_id": "string",
  • "recruiter_id": "string",
  • "pipeline_id": "string",
  • "title": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "published": "2019-08-24T14:15:22Z",
  • "closed_at": "2019-08-24T14:15:22Z",
  • "location": "string",
  • "department": "string",
  • "role": "string",
  • "team": "string"
}

Candidate

candidate_id
string

Candidate ID from the ATS.

name
string or null

Candidate name.

referred
boolean or null

Whether the candidate has been referred.

sourced
boolean or null

Whether the candidate has been sourced.

{
  • "candidate_id": "string",
  • "name": "string",
  • "referred": true,
  • "sourced": true
}

Interview

interview_id
string

Interview ID from the ATS.

stage
string or null

Interview stage.

candidate_id
string

Candidate ID from the ATS.

candidate_name
string

Candidate name.

interview_date
string or null <date-time>

Interview date.

Array of objects

Interviewers.

location
string or null

Interview location.

department
string or null

Interview department.

role
string or null

Interview role.

team
string or null

Interview team.

{
  • "interview_id": "string",
  • "stage": "string",
  • "candidate_id": "string",
  • "candidate_name": "string",
  • "interview_date": "2019-08-24T14:15:22Z",
  • "interviewers": [
    ],
  • "location": "string",
  • "department": "string",
  • "role": "string",
  • "team": "string"
}

Requisition

requisition_id
string

Requisition ID from the ATS.

created_at
string or null <date-time>

Time the requisition was created.

closed_at
string or null <date-time>

Requisition close time and date.

status
string or null

Requisition status.

name
string or null

Requisition name.

headcount_total
integer or null

Total required headcount.

headcount_hired
integer or null

Total hired.

headcount_infinite
boolean or null

Indicates whether this requisition is for hiring an undefined or unknown number of candidates.

location
string or null

Requisition location.

department
string or null

Requisition department.

role
string or null

Requisition role.

team
string or null

Requisition team.

posting_ids
Array of strings

Postings connected with this requisition.

object

Salary range for this requisition.

{
  • "requisition_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "closed_at": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "name": "string",
  • "headcount_total": 0,
  • "headcount_hired": 0,
  • "headcount_infinite": true,
  • "location": "string",
  • "department": "string",
  • "role": "string",
  • "team": "string",
  • "posting_ids": [
    ],
  • "salary_range": {
    }
}

Recruiter

recruiter_id
string

Recruiter ID.

recruiter_name
string

Recruiter name.

{
  • "recruiter_id": "string",
  • "recruiter_name": "string"
}

Interview Stage

stage_id
string

Interview Stage ID.

name
string or null

Interview Stage name.

stage_type
string
Enum: "UNKNOWN" "INBOX" "IN_PROCESS" "TERMINAL"

Interview Stage type.

stage_phase
string
Enum: "UNKNOWN" "APPLICATION" "SCREENING" "INTERVIEWING" "OFFER" "HIRED"

Application Stage phase

{
  • "stage_id": "string",
  • "name": "string",
  • "stage_type": "UNKNOWN",
  • "stage_phase": "UNKNOWN"
}

Pipeline

pipeline_id
string

Pipeline ID.

Array of objects
{
  • "pipeline_id": "string",
  • "stages": [
    ]
}

Feedback

feedback_id
string or null

Feedback ID from the ATS.

posting_id
string

Posting ID from the ATS.

application_id
string

Application ID from the ATS.

candidate_id
string

Candidate ID from the ATS.

stage
string or null

Feedback stage.

created_at
string or null <date-time>

Time feedback was created.

rating
string or null

Candidate rating.

object or null

Candidate reviewer.

location
string or null

Feedback location.

department
string or null

Feedback department.

role
string or null

Feedback role.

team
string or null

Feedback team.

{
  • "feedback_id": "string",
  • "posting_id": "string",
  • "application_id": "string",
  • "candidate_id": "string",
  • "stage": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "rating": "string",
  • "reviewer": {
    },
  • "location": "string",
  • "department": "string",
  • "role": "string",
  • "team": "string"
}

PMS User

user_id
string or null

User’s ID from the PMS.

email
string or null

User's email.

first_name
string or null

User's first name.

last_name
string or null

User's last name.

{
  • "user_id": "string",
  • "email": "string",
  • "first_name": "string",
  • "last_name": "string"
}

PMS Feedback Session

feedback_session_id
string or null

Feedback Session ID.

scheduled_at
string or null <date-time>

Feedback session time.

object or null

Feedback session participants.

session_type
string or null
Enum: "UNKNOWN" "PEER" "MANAGER_EMPLOYEE" "MANAGER_MANAGER"

Feedback session type.

{
  • "feedback_session_id": "string",
  • "scheduled_at": "2019-08-24T14:15:22Z",
  • "participants": {
    },
  • "session_type": "UNKNOWN"
}

PMS Peer Recognition

peer_recognition_id
string or null

Peer Recognition ID from the PMS.

created_at
string or null <date-time>

Peer Recognition created time.

content
string or null

Peer Recognition content.

giver
string or null

Peer Recognition giver.

receiver
string or null

Peer Recognition recipient.

{
  • "peer_recognition_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "content": "string",
  • "giver": "string",
  • "receiver": "string"
}

PMS Objective

objective_id
string or null

Objective ID from the PMS.

parent_id
string or null

Objective Parent ID from the PMS.

user_id
string or null

Objective User ID from the PMS.

team
string or null

PMS Objective team.

description
string or null

PMS Objective description.

scope
string or null
Enum: "UNKNOWN" "COMPANY_WIDE" "DEPARTMENT" "INDIVIDUAL" "SELF_DEVELOPMENT"

PMS Objective scope.

start_date
string or null <date-time>

PMS Objective start date.

end_date
string or null <date-time>

PMS Objective end time.

completion_progress
number or null

PMS Objective completion progress.

Array of objects or null

PMS Objective key results.

tags
Array of strings

PMS Objective tags.

is_archived
boolean

Whether the PMS Objective is archived.

is_closed
boolean

Whether the PMS Objective is closed.

is_future
boolean

Whether the PMS Objective is in the future.

is_active
boolean

Whether the PMS Objective is active.

is_past_due
boolean

Whether the PMS Objective is past due.

{
  • "objective_id": "string",
  • "parent_id": "string",
  • "user_id": "string",
  • "team": "string",
  • "description": "string",
  • "scope": "UNKNOWN",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "completion_progress": 0,
  • "key_results": [
    ],
  • "tags": [
    ],
  • "is_archived": true,
  • "is_closed": true,
  • "is_future": true,
  • "is_active": true,
  • "is_past_due": true
}

PMS Review

review_id
string

Review ID.

reviewer_id
string or null

Review ID.

reviewee_id
string or null

Review ID.

review_type
string
Enum: "UNKNOWN" "SELF_REVIEW" "PEER_REVIEW" "DOWNWARD_REVIEW" "UPWARD_REVIEW"

Type of review.

transparency
string or null
Enum: "UNKNOWN" "ANONYMOUS" "ANONYMOUS_TO_MANAGER" "ANONYMOUS_TO_REVIEWEE" "TRANSPARENT"

Transparency of review.

theme
string or null

Review theme.

Array of objects
due_date
string or null <date-time>

Review due date.

completed_on
string or null <date-time>

Review completed date.

{
  • "review_id": "string",
  • "reviewer_id": "string",
  • "reviewee_id": "string",
  • "review_type": "UNKNOWN",
  • "transparency": "UNKNOWN",
  • "theme": "string",
  • "questions": [
    ],
  • "due_date": "2019-08-24T14:15:22Z",
  • "completed_on": "2019-08-24T14:15:22Z"
}

Data Health

id
string

Attribute Data Health unique identifier.

run_id
string

Unique identifier of a particular Data Health run. Data Health runs periodically and in one run each available attribute is checked for health.

capability_id
string

The unique identifier of the attribute.

sample_size
number

Number of checked data samples for a given attribute.

healthy_samples
number

Number of healthy data samples for a given attribute (ex. The value is considered valid).

unhealthy_samples
number

Number of unhealthy data samples for a given attribute (ex. The value is considered invalid or not set).

created_at
string <date-time>

Date and time when the attribute data health was calculated.

capability_supported
boolean

Whether capability is supported by HR tool used.

Array of objects or null

Context about attribute health, e.g. list of primary identifiers for unhealthy entities.

object

Some basic information about the data attribute (name, description etc.).

{
  • "id": "string",
  • "run_id": "string",
  • "capability_id": "string",
  • "sample_size": 0,
  • "healthy_samples": 0,
  • "unhealthy_samples": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "capability_supported": true,
  • "unhealthy_samples_context": [
    ],
  • "capability": {
    }
}