GoCo Public API (1.0.0)

Download OpenAPI specification:Download

Introduction

Welcome to the GoCo API documentation. GoCo is a platform to Level-Up your HR with Flexible Employee Management Software. With our API, you can access and manipulate data related to your company, such as employees, documents, reports, notifications, time off, time tracking and more.

Our API is designed for IT professionals who want to build their own solutions, integrate with other systems, and manage their data in ways they couldn't before. You can use our API to create custom workflows, automate tasks, generate reports, and more.

Getting Started

To get started with our API, you need to generate an API key in the GoCo Marketplace, and then use that API key to authenticate your requests. You can find more details on how to do that in the Authentication section.

Our API follows the OpenAPI Specification standard, which means you can use any compatible tool or library to interact with it. You can also explore our API using the interactive documentation below, which allows you to try out different endpoints and parameters.

If you have any questions, feedback, issues, or support requests related to our API, please contact us at https://help.goco.io. We are always happy to hear from you and help you with your integration.

We hope you enjoy using our API and find it useful for your HR needs.

Authentication

To use our API, you need to authenticate your requests with a valid API key that will grant you full permissions to access and manipulate data related to your company.

You can manage your API key in the GoCo Marketplace, under the API Credentials section. You can regenerate or revoke it at any time. Only users with Full Access Admin permissions can manage the API Credentials.

To authenticate your requests, you need to use the Bearer Authentication scheme, which means you need to send an HTTP header like this:

  Authorization: Bearer <YOUR_TOKEN_HERE>

where <YOUR_TOKEN_HERE> is your API key.

For example, if your API key is 1234567890abcdef, you would send a header like this:

  Authorization: Bearer 1234567890abcdef

You need to send this header with every request you make to our API. If you don’t send it, or if you send an invalid or revoked token, you will get an error response with a 401 Unauthorized status code.

Please keep your API key secret and secure. Do not share it with anyone or expose it in public. If you suspect that your API key has been compromised, please revoke it immediately and generate a new one.

Companies

Endpoints related to Companies

Retrieve a list of companies

get/companies

Retrieve a list of companies

SecurityApiKeyAuth
Responses
200

Success

Response Schema: application/json
Array of objects (CompanySchema)
Array
id
string

Unique ID of this object

name
string

Name

urlName
string

URL Name

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of custom fields for a company

get/companies/{companyUrlName}/custom_fields

Retrieve a list of custom fields for a company

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

Responses
200

Success

Response Schema: application/json
Array of objects (CompanyCustomFieldsSchema)
Array
Array of objects (CustomFieldDefinitionSchema)

Custom Fields

name
string

Section Name

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of departments

get/companies/{companyUrlName}/departments

Retrieve a list of departments

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

Responses
200

Success

Response Schema: application/json
Array of objects (DepartmentSchema)
Array
code
string

Work Group code

id
string

Unique ID of this object

name
string

Name

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of job titles

get/companies/{companyUrlName}/job_titles

Retrieve a list of job titles

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

Responses
200

Success

Response Schema: application/json
Array of objects (JobTitleSchema)
Array
code
string

Work Group code

id
string

Unique ID of this object

name
string

Name

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of locations

get/companies/{companyUrlName}/locations

Retrieve a list of locations

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

Responses
200

Success

Response Schema: application/json
Array of objects (LocationSchema)
Array
id
string

Unique ID of this object

name
string

Name

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Documents

Endpoints related to Documents

Retrieve a list of document templates

get/companies/{companyUrlName}/document_templates

Retrieve a list of document templates

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

Responses
200

Success

Response Schema: application/json
Array of objects (DocumentTemplateSchema)
Array
description
string

Description for this template

id
string

Unique ID of this object

kind
string

Type of document that this template uses

Enum: "ATTACHED" "EMPLOYEE_PROVIDED" "I9_SUPPORTING" "I_9" "JOB_OFFER" "PERFORMANCE_REVIEW" "PERSONALIZED_AGREEMENT" "STATE_TAX" "W_4" "W_9"
name
string

Name of this template

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Start a document for an employee

post/companies/{companyUrlName}/employees/{employeeId}/documents

Start a document for an employee

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

employeeId
required
string

Employee ID

Request Body schema: application/json
required
documentTemplateId
required
string

Document Template ID

Responses
200

Success

Response Schema: application/json
object (EmployeeDocumentSchema)
completed
boolean

True if this document has been completed

object (EmployeeBasicFieldsSchema)
object (EmployeeBasicFieldsSchema)
expirationDate
string <date>

Date that this document expires

object

Most recently completed version of this document

id
string

Unique ID of this object

name
string

Name of this document

Array of objects (EmployeeDocumentStepSchema)

Document steps

object

Template that was used to create this document

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
application/json
{
  • "documentTemplateId": "string"
}
Response samples
application/json
{
  • "data": {
    }
}

Upload a document to an employee's profile

post/companies/{companyUrlName}/employees/{employeeId}/documents/one_off_upload

Upload a document to an employee's profile

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

employeeId
required
string

Employee ID

Request Body schema: application/json
required
name
required
string

Document Name

fileUrl
required
string <uri>

Document URL

employeeCanView
boolean

Employee Can View Document?

managerCanView
boolean

Manager Can View Document?

Responses
200

Success

Response Schema: application/json
object (EmployeeDocumentSchema)
completed
boolean

True if this document has been completed

object (EmployeeBasicFieldsSchema)
object (EmployeeBasicFieldsSchema)
expirationDate
string <date>

Date that this document expires

object

Most recently completed version of this document

id
string

Unique ID of this object

name
string

Name of this document

Array of objects (EmployeeDocumentStepSchema)

Document steps

object

Template that was used to create this document

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
application/json
{
  • "employeeCanView": true,
  • "fileUrl": "http://example.com",
  • "managerCanView": true,
  • "name": "string"
}
Response samples
application/json
{
  • "data": {
    }
}

Employees

Endpoints related to Employees

Bulk update custom fields for an employee

patch/companies/{companyUrlName}/employees/{employeeId}/custom_fields/bulk_update

Bulk update custom fields for an employee

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

employeeId
required
string

Employee ID

Request Body schema: application/json
required
required
Array of objects
Array
identifier
required
string

Custom Field Identifier

object

Custom Field Currency Value. Valid when Custom Field Type in [CURRENCY]

dateValue
string <date>

Custom Field Date Value. Valid when Custom Field Type in [DATE]

intValue
integer

Custom Field Integer Value. Valid when Custom Field Type in [DROPDOWN, RADIO_LIST]

intValues
Array of integers

Custom Field Integer Values. Valid for custom field types in [CHECKBOX_LIST]

numberValue
number

Custom Field Number Value. Valid when Custom Field Type in [NUMBER]

stringValue
string

Custom Field String Value. Valid when Custom Field Type in [SHORT_TEXT, LONG_TEXT]

Responses
200

Success

Response Schema: application/json
object

Employee Custom Fields Updated

Array of objects
Array
displayValue
string

Custom Field Display Value

identifier
string

Custom Field Identifier

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
application/json
{
  • "fields": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}

Create an employee

post/companies/{companyUrlName}/employees

Create an employee

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

Request Body schema: application/json
required
firstName
required
string

First Name

lastName
required
string

Last Name

insertionSource
string

Insertion Source

Enum: "GREENHOUSE" "JAZZ_HR" "LEVER" "PUBLIC_API" "WORKABLE"
personalEmail
string <email>

Personal Email

workflowTemplateId
string

Hiring Workflow Template ID

object

Employee's address information

companyClassId
string

Company class ID

compensationNote
string

Compensation note for this employee

departmentId
string

Department ID

dob
string <date>

Date of birth

employmentType
string

Employment type

Enum: "CONTRACTOR" "FULL_TIME" "PART_TIME" "TEMPORARY"
jobTitleId
string

Job Title ID

legalSex
string

Legal Sex

Enum: "FEMALE" "MALE"
locationId
string

Work location ID

managerId
string

Manager ID

payrollScheduleId
string

Payroll Schedule ID

ssn
string

Social Security Number

startDate
string <date>

Start date

object

Wage rate

wageType
string

Wage type

Enum: "FIXED_AMOUNT" "HOURLY" "MONTHLY" "QUARTERLY" "SALARY" "WEEKLY"
workEmail
string

Work Email

workPhone
string

Work Phone

Responses
200

Success

Response Schema: application/json
object (EmployeeSchema)
object

Address

object

Department

object

Division

dob
string <date>

Date of Birth

efmlaBalance
number <double>

Emergency Family and Medical Leave Hours Balance

Array of objects

Emergency Contacts

employmentStatus
string

Employment Status

Enum: "ACTIVE" "ON_LEAVE" "PENDING" "TERMINATED"
employmentType
string

Employment Type

Enum: "CONTRACTOR" "FULL_TIME" "PART_TIME" "TEMPORARY"
epslBalance
number <double>

Emergency Paid Sick Leave Hours Balance

extraWithholding
number <double>

Extra Withholding

firstName
string

First Name

genderIdentity
string

Gender Identity

id
string

Unique ID of this object

insertionSource
string

Insertion Source

Enum: "ADP_WORKFORCE" "GREENHOUSE" "HIRING_WIZARD" "IMPORT" "JAZZ_HR" "LEVER" "PAYCHEX" "PUBLIC_API" "QUICK_ADD" "UNKNOWN" "WORKABLE"
isManager
boolean

Is Manager?

object

Job Title

lastName
string

Last Name

legalSex
string

Legal Sex

Enum: "FEMALE" "MALE"
object

Location

object (EmployeeBasicFieldsSchema)
middleInitial
string

Middle Initial Name

object

Non Work State Withholding

object

Payroll Schedule

personalBalance
number <double>

Personal Leave Hours Balance

personalEmail
string <email>

Personal Email

object

Photo

preferredFirstName
string

Preferred First Name

preferredPronoun
string

Preferred Pronoun

Enum: "EY_EM_EIRS" "HE_HIM_HIS" "NAME_NAME_NAMES" "PER_PER_PERS" "SHE_HER_HERS" "SIE_HIR_HIRS" "THEY_THEM_THEIRS" "ZEE_HERE_HERES" "ZE_HIR_HIRS" "ZE_ZIM_ZIMS" "ZE_ZIR_ZIRS"
rehire
boolean

Rehire?

residentState
string

Resident State

sickBalance
number <double>

Sick Leave Hours Balance

ssn
string

Social Security Number

startDate
string <date>

Start date of the employee

taxFilingStatus
string

Tax Filing Status

Enum: "exempt" "head_of_household" "married" "married_withhold_as_single" "single"
terminationDay
string <date>

Termination date

terminationNote
string

Termination Note

terminationStatus
string

Termination Status

Enum: "OFF" "ON" "PENDING" "TERMINATING"
terminationType
string

Termination Type

Enum: "DECEASED" "GROSS_MISCONDUCT" "INVOLUNTARY" "UNKNOWN" "VOLUNTARY_NOT_REGRETTED" "VOLUNTARY_REGRETTED"
object

Time Off Policy

object

Time Tracking Policy

uniqueOnboardingLink
string

Onboarding Link

vacationBalance
number <double>

Vacation Hours Balance

w420202MultipleJobs
boolean

w4 2020 - Multiple Jobs

w420203DependentWithholding
number <double>

w4 2020 - Dependent Withholding

w420204aOtherIncome
number <double>

w4 2020 - Other Income

w420204bDeductions
number <double>

w4 2020 - Deductions

w42020IncomeBelow200k
boolean

w4 2020 - Income Below 200k

w42020OtherDependents
integer <int64>

w4 2020 - Other Dependents

w42020QualifiedChildren
integer <int64>

w4 2020 - Qualified Children

w4Version
string

How and which W-4 fields are available on this employee

Enum: "PRE2020" "REVISION2020"
object

Wage Rate

wageType
string

Wage Type

Enum: "FIXED_AMOUNT" "HOURLY" "MONTHLY" "QUARTERLY" "SALARY" "WEEKLY"
withholdingAllowances
integer <int64>

Withholding Allowances

workEmail
string <email>

Work Email

workPhone
string

Work Phone

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
application/json
{
  • "address": {
    },
  • "companyClassId": "string",
  • "compensationNote": "string",
  • "departmentId": "string",
  • "dob": "2019-08-24",
  • "employmentType": "CONTRACTOR",
  • "jobTitleId": "string",
  • "legalSex": "FEMALE",
  • "locationId": "string",
  • "managerId": "string",
  • "payrollScheduleId": "string",
  • "ssn": "string",
  • "startDate": "2019-08-24",
  • "wageRate": {
    },
  • "wageType": "FIXED_AMOUNT",
  • "workEmail": "string",
  • "workPhone": "string"
}
Response samples
application/json
{
  • "data": {
    }
}

Retrieve a list of compensation methods for an employee

get/companies/{companyUrlName}/employees/{employeeId}/compensation_methods

Retrieve a list of compensation methods for an employee

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

employeeId
required
string

Employee ID

Responses
200

Success

Response Schema: application/json
Array of objects (EmployeeCompensationMethodsSchema)
Array
accountNickname
string

Employee created label for account

amount
number <double>

Either a flat dollar amount or percentage to be deposited to this account

amountType
string

Indicate if the amount is fixed or a percentage of gross pay

Enum: "DOLLARS" "PERCENT"
object

Details for bank account

currency
string

Currency used

Enum: "AED" "ARS" "AUD" "BGN" "BHD" "CAD" "CHF" "CLP" "CNH" "CNY" "CZK" "DKK" "EUR" "FJD" "GBP" "HKD" "HUF" "IDR" "ILS" "INR" "ISK" "JPY" "KES" "KWD" "MAD" "MXN" "MYR" "NOK" "NZD" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SEK" "SGD" "TRY" "TWD" "UAH" "USD" "VND" "ZAR"
formattedDepositAmount
string

Formatted amount, including the currency or percent symbol.

id
string

Unique identifier for the compensation method

paymentMethod
string

Direct deposit or paper check

Enum: "DIRECT_DEPOSIT" "PAPER_CHECK"
priority
integer <int64>

Order in which funds from gross pay will be allocated to account

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of custom fields for an employee

get/companies/{companyUrlName}/employees/{employeeId}/custom_fields

Retrieve a list of custom fields for an employee

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

employeeId
required
string

Employee ID

Responses
200

Success

Response Schema: application/json
Array of objects (EmployeeCustomFieldsSchema)
Array
Array of objects

Custom Fields

name
string

Section Name

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of employees

get/companies/{companyUrlName}/employees

Retrieve a list of employees

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

query Parameters
page
integer <int64>

Page

Example: page=1
maxPerPage
integer <int64>

Max per page

Example: maxPerPage=10
employmentStatus
Array of strings

Filter by employment statuses

Items Enum: "ACTIVE" "ON_LEAVE" "PENDING" "TERMINATED"
Example: employmentStatus=ACTIVE,PENDING,TERMINATED,ON_LEAVE
Responses
200

Success

Response Schema: application/json
Array of objects (EmployeeSchema)
maxPerPage
integer

Max per page

page
integer

Current page

total
integer

Total count

totalPages
integer

Total pages

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "maxPerPage": 25,
  • "page": 2,
  • "total": 2,
  • "totalPages": 1
}

Retrieve a list of state withholdings for an employee

get/companies/{companyUrlName}/employees/{employeeId}/state_withholdings

Retrieve a list of state withholdings for an employee

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

employeeId
required
string

Employee ID

Responses
200

Success

Response Schema: application/json
Array of objects (EmployeeStateWithholdingsSchema)
Array
allowNonResidentExemption
boolean

Allow Non Resident Exemption

allowances
string

Allowances

exempt
boolean

Exempt

exemptReason
string

Exempt Reason

Enum: "NON_RESIDENT" "OTHER"
object

Exception Form

exemptionOptions
string

Exemption Options

Enum: "NONE" "SIMPLE" "UPLOAD"
Array of objects

Fields

filingStatus
string

Filing Status

object

Form

id
string

Unique ID of this object

isWorkState
boolean

Is Work State

signedAt
string <date-time>

Signed At

state
string

State

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve an employee

get/companies/{companyUrlName}/employees/{employeeId}

Retrieve an employee

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

employeeId
required
string

Employee ID

Responses
200

Success

Response Schema: application/json
object (EmployeeSchema)
object

Address

object

Department

object

Division

dob
string <date>

Date of Birth

efmlaBalance
number <double>

Emergency Family and Medical Leave Hours Balance

Array of objects

Emergency Contacts

employmentStatus
string

Employment Status

Enum: "ACTIVE" "ON_LEAVE" "PENDING" "TERMINATED"
employmentType
string

Employment Type

Enum: "CONTRACTOR" "FULL_TIME" "PART_TIME" "TEMPORARY"
epslBalance
number <double>

Emergency Paid Sick Leave Hours Balance

extraWithholding
number <double>

Extra Withholding

firstName
string

First Name

genderIdentity
string

Gender Identity

id
string

Unique ID of this object

insertionSource
string

Insertion Source

Enum: "ADP_WORKFORCE" "GREENHOUSE" "HIRING_WIZARD" "IMPORT" "JAZZ_HR" "LEVER" "PAYCHEX" "PUBLIC_API" "QUICK_ADD" "UNKNOWN" "WORKABLE"
isManager
boolean

Is Manager?

object

Job Title

lastName
string

Last Name

legalSex
string

Legal Sex

Enum: "FEMALE" "MALE"
object

Location

object (EmployeeBasicFieldsSchema)
middleInitial
string

Middle Initial Name

object

Non Work State Withholding

object

Payroll Schedule

personalBalance
number <double>

Personal Leave Hours Balance

personalEmail
string <email>

Personal Email

object

Photo

preferredFirstName
string

Preferred First Name

preferredPronoun
string

Preferred Pronoun

Enum: "EY_EM_EIRS" "HE_HIM_HIS" "NAME_NAME_NAMES" "PER_PER_PERS" "SHE_HER_HERS" "SIE_HIR_HIRS" "THEY_THEM_THEIRS" "ZEE_HERE_HERES" "ZE_HIR_HIRS" "ZE_ZIM_ZIMS" "ZE_ZIR_ZIRS"
rehire
boolean

Rehire?

residentState
string

Resident State

sickBalance
number <double>

Sick Leave Hours Balance

ssn
string

Social Security Number

startDate
string <date>

Start date of the employee

taxFilingStatus
string

Tax Filing Status

Enum: "exempt" "head_of_household" "married" "married_withhold_as_single" "single"
terminationDay
string <date>

Termination date

terminationNote
string

Termination Note

terminationStatus
string

Termination Status

Enum: "OFF" "ON" "PENDING" "TERMINATING"
terminationType
string

Termination Type

Enum: "DECEASED" "GROSS_MISCONDUCT" "INVOLUNTARY" "UNKNOWN" "VOLUNTARY_NOT_REGRETTED" "VOLUNTARY_REGRETTED"
object

Time Off Policy

object

Time Tracking Policy

uniqueOnboardingLink
string

Onboarding Link

vacationBalance
number <double>

Vacation Hours Balance

w420202MultipleJobs
boolean

w4 2020 - Multiple Jobs

w420203DependentWithholding
number <double>

w4 2020 - Dependent Withholding

w420204aOtherIncome
number <double>

w4 2020 - Other Income

w420204bDeductions
number <double>

w4 2020 - Deductions

w42020IncomeBelow200k
boolean

w4 2020 - Income Below 200k

w42020OtherDependents
integer <int64>

w4 2020 - Other Dependents

w42020QualifiedChildren
integer <int64>

w4 2020 - Qualified Children

w4Version
string

How and which W-4 fields are available on this employee

Enum: "PRE2020" "REVISION2020"
object

Wage Rate

wageType
string

Wage Type

Enum: "FIXED_AMOUNT" "HOURLY" "MONTHLY" "QUARTERLY" "SALARY" "WEEKLY"
withholdingAllowances
integer <int64>

Withholding Allowances

workEmail
string <email>

Work Email

workPhone
string

Work Phone

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": {
    }
}

Update an employee

patch/companies/{companyUrlName}/employees/{employeeId}

The effective date will be set as follows: For incomplete hires, we prioritize the employee's start date; if unavailable, we consider the creation date, defaulting to today's date if neither is provided. For completed hires, we use the start date if it's in the future; otherwise, we default to today's date

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

employeeId
required
string

Employee ID

Request Body schema: application/json
required
firstName
string

First Name

lastName
string

Last Name

object

Employee's address information

companyClassId
string

Company class ID

compensationNote
string

Compensation note for this employee

departmentId
string

Department ID

dob
string <date>

Date of birth

employmentType
string

Employment type

Enum: "CONTRACTOR" "FULL_TIME" "PART_TIME" "TEMPORARY"
jobTitleId
string

Job Title ID

legalSex
string

Legal Sex

Enum: "FEMALE" "MALE"
locationId
string

Work location ID

managerId
string

Manager ID

payrollScheduleId
string

Payroll Schedule ID

ssn
string

Social Security Number

startDate
string <date>

Start date

object

Wage rate

wageType
string

Wage type

Enum: "FIXED_AMOUNT" "HOURLY" "MONTHLY" "QUARTERLY" "SALARY" "WEEKLY"
workEmail
string

Work Email

workPhone
string

Work Phone

Responses
200

Success

Response Schema: application/json
object (EmployeeSchema)
object

Address

object

Department

object

Division

dob
string <date>

Date of Birth

efmlaBalance
number <double>

Emergency Family and Medical Leave Hours Balance

Array of objects

Emergency Contacts

employmentStatus
string

Employment Status

Enum: "ACTIVE" "ON_LEAVE" "PENDING" "TERMINATED"
employmentType
string

Employment Type

Enum: "CONTRACTOR" "FULL_TIME" "PART_TIME" "TEMPORARY"
epslBalance
number <double>

Emergency Paid Sick Leave Hours Balance

extraWithholding
number <double>

Extra Withholding

firstName
string

First Name

genderIdentity
string

Gender Identity

id
string

Unique ID of this object

insertionSource
string

Insertion Source

Enum: "ADP_WORKFORCE" "GREENHOUSE" "HIRING_WIZARD" "IMPORT" "JAZZ_HR" "LEVER" "PAYCHEX" "PUBLIC_API" "QUICK_ADD" "UNKNOWN" "WORKABLE"
isManager
boolean

Is Manager?

object

Job Title

lastName
string

Last Name

legalSex
string

Legal Sex

Enum: "FEMALE" "MALE"
object

Location

object (EmployeeBasicFieldsSchema)
middleInitial
string

Middle Initial Name

object

Non Work State Withholding

object

Payroll Schedule

personalBalance
number <double>

Personal Leave Hours Balance

personalEmail
string <email>

Personal Email

object

Photo

preferredFirstName
string

Preferred First Name

preferredPronoun
string

Preferred Pronoun

Enum: "EY_EM_EIRS" "HE_HIM_HIS" "NAME_NAME_NAMES" "PER_PER_PERS" "SHE_HER_HERS" "SIE_HIR_HIRS" "THEY_THEM_THEIRS" "ZEE_HERE_HERES" "ZE_HIR_HIRS" "ZE_ZIM_ZIMS" "ZE_ZIR_ZIRS"
rehire
boolean

Rehire?

residentState
string

Resident State

sickBalance
number <double>

Sick Leave Hours Balance

ssn
string

Social Security Number

startDate
string <date>

Start date of the employee

taxFilingStatus
string

Tax Filing Status

Enum: "exempt" "head_of_household" "married" "married_withhold_as_single" "single"
terminationDay
string <date>

Termination date

terminationNote
string

Termination Note

terminationStatus
string

Termination Status

Enum: "OFF" "ON" "PENDING" "TERMINATING"
terminationType
string

Termination Type

Enum: "DECEASED" "GROSS_MISCONDUCT" "INVOLUNTARY" "UNKNOWN" "VOLUNTARY_NOT_REGRETTED" "VOLUNTARY_REGRETTED"
object

Time Off Policy

object

Time Tracking Policy

uniqueOnboardingLink
string

Onboarding Link

vacationBalance
number <double>

Vacation Hours Balance

w420202MultipleJobs
boolean

w4 2020 - Multiple Jobs

w420203DependentWithholding
number <double>

w4 2020 - Dependent Withholding

w420204aOtherIncome
number <double>

w4 2020 - Other Income

w420204bDeductions
number <double>

w4 2020 - Deductions

w42020IncomeBelow200k
boolean

w4 2020 - Income Below 200k

w42020OtherDependents
integer <int64>

w4 2020 - Other Dependents

w42020QualifiedChildren
integer <int64>

w4 2020 - Qualified Children

w4Version
string

How and which W-4 fields are available on this employee

Enum: "PRE2020" "REVISION2020"
object

Wage Rate

wageType
string

Wage Type

Enum: "FIXED_AMOUNT" "HOURLY" "MONTHLY" "QUARTERLY" "SALARY" "WEEKLY"
withholdingAllowances
integer <int64>

Withholding Allowances

workEmail
string <email>

Work Email

workPhone
string

Work Phone

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
application/json
{
  • "address": {
    },
  • "companyClassId": "string",
  • "compensationNote": "string",
  • "departmentId": "string",
  • "dob": "2019-08-24",
  • "employmentType": "CONTRACTOR",
  • "jobTitleId": "string",
  • "legalSex": "FEMALE",
  • "locationId": "string",
  • "managerId": "string",
  • "payrollScheduleId": "string",
  • "ssn": "string",
  • "startDate": "2019-08-24",
  • "wageRate": {
    },
  • "wageType": "FIXED_AMOUNT",
  • "workEmail": "string",
  • "workPhone": "string"
}
Response samples
application/json
{
  • "data": {
    }
}

Notifications

Endpoints related to Notifications

Retrieve a list of notifications

get/companies/{companyUrlName}/notifications

Retrieve a list of notifications

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

query Parameters
required
object

Filter by statuses

Example: statuses=ACTIVE,AUTO_ARCHIVED,BLOCKED
object

Filter by types

Example: types=ACA_BENEFIT_COVERAGE_CHANGES_REQUIRED,ACA_UPLOAD_HOURS,ANNOUNCEMENT
page
integer <int64>

Page

Example: page=1
maxPerPage
integer <int64>

Max per page

Example: maxPerPage=10
Responses
200

Success

Response Schema: application/json
Array of objects (NotificationSchema)
maxPerPage
integer

Max per page

page
integer

Current page

total
integer

Total count

totalPages
integer

Total pages

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "maxPerPage": 1,
  • "page": 1,
  • "total": 712,
  • "totalPages": 712
}

Payroll

Endpoints related to Payroll

Retrieve a list of additional deductions

get/companies/{companyUrlName}/additional_deductions

Retrieve a list of additional deductions

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

Responses
200

Success

Response Schema: application/json
Array of objects (AdditionalDeductionSchema)
Array
id
string

Unique ID of this object

name
string

Name

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of additional earnings

get/companies/{companyUrlName}/additional_earnings

Retrieve a list of additional earnings

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

Responses
200

Success

Response Schema: application/json
Array of objects (AdditionalEarningsSchema)
Array
id
string

Unique ID of this object

name
string

Name of this earning type

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of company classes

get/companies/{companyUrlName}/company_classes

Retrieve a list of company classes

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

Responses
200

Success

Response Schema: application/json
Array of objects (CompanyClassSchema)
Array
id
string

Unique ID of this object

name
string

Name

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of payroll schedules

get/companies/{companyUrlName}/payroll_schedules

Retrieve a list of payroll schedules

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

Responses
200

Success

Response Schema: application/json
Array of objects (PayrollScheduleSchema)
Array
id
string

Unique ID of this object

name
string

Name

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Time Off Requests

Endpoints related to Time Off Requests

Create a time off request

post/companies/{companyUrlName}/time_off_requests

Create a time off request

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

Request Body schema: application/json
required
employeeId
required
string

the employee ID, used when creating a new request

bucketType
required
string

the bucket type for the request

Enum: "BEREAVEMENT" "CUSTOM1" "CUSTOM2" "CUSTOM3" "EFMLA" "EPSL" "FLOATING_HOLIDAY" "JURY_DUTY" "LEARNING_AND_DEVELOPMENT" "LEAVE" "NOT_COUNTED" "PERSONAL" "SICK" "VACATION" "VOLUNTEER" "WEATHER"
firstDayHours
required
number <double>

number of hours for the first day, if it's a partial day

lastDayHours
required
number <double>

number of hours for the last day, if it's a partial day

reason
required
string

the reason for the request (pre-defined at the policy level

startDate
required
string

Start date

endDate
required
string

End date

accrualStatus
string

accrual status for the request(required when bucket type is leave)

Enum: "CONTINUE" "PAUSE"
paid
boolean

toggle that says if the EE should be paid or not while on time off(required and used only for leave)

requestNote
string

the employee free form note for the request

Responses
200

Success

Response Schema: application/json
object (TimeOffRequestSchema)
accrualStatus
string

Accrual Status

Enum: "CONTINUE" "PAUSE"
bucketName
string

Bucket name

bucketType
string

Bucket Type

Enum: "BEREAVEMENT" "CUSTOM1" "CUSTOM2" "CUSTOM3" "EFMLA" "EPSL" "FLOATING_HOLIDAY" "JURY_DUTY" "LEARNING_AND_DEVELOPMENT" "LEAVE" "NOT_COUNTED" "PERSONAL" "SICK" "VACATION" "VOLUNTEER" "WEATHER"
createdAt
string <date-time>

When the request was created

decidedAt
string <date-time>

Decided At

object (EmployeeBasicFieldsSchema)
decisionNote
string

Decision Note

decisionStatus
string

Decision Status

Enum: "APPROVED" "CANCELLED" "DENIED" "PENDING"
object (EmployeeBasicFieldsSchema)
endDate
string <date>

End Date

endTime
string

End Time

id
string

Unique ID of this object

paid
boolean

Indicates if the employee will be paid or not while on time off, cannot be null after request is approved

reason
string

Reason

requestNote
string

Request Note

requestedAt
string <date-time>

Requested At

object (EmployeeBasicFieldsSchema)
startDate
string <date>

Start Date

startTime
string

Start Time

object

Time Off Bucket

Array of objects

Hours Per Day

timeZone
string

Time Zone

totalHours
number <double>

Total Hours

updatedAt
string <date-time>

The last time the request was updated

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
application/json
{
  • "accrualStatus": "CONTINUE",
  • "bucketType": "BEREAVEMENT",
  • "employeeId": "string",
  • "endDate": "string",
  • "firstDayHours": 0,
  • "lastDayHours": 0,
  • "paid": true,
  • "reason": "string",
  • "requestNote": "string",
  • "startDate": "string"
}
Response samples
application/json
{
  • "data": {
    }
}

Decide on a time off request

patch/companies/{companyUrlName}/time_off_requests/{timeOffRequestId}/decide

Decide on a time off request

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

timeOffRequestId
required
string

Time Off Request ID

Request Body schema: application/json
required
approve
required
boolean

Approve time off request?

note
string

Note

Responses
200

Success

Response Schema: application/json
object (TimeOffRequestSchema)
accrualStatus
string

Accrual Status

Enum: "CONTINUE" "PAUSE"
bucketName
string

Bucket name

bucketType
string

Bucket Type

Enum: "BEREAVEMENT" "CUSTOM1" "CUSTOM2" "CUSTOM3" "EFMLA" "EPSL" "FLOATING_HOLIDAY" "JURY_DUTY" "LEARNING_AND_DEVELOPMENT" "LEAVE" "NOT_COUNTED" "PERSONAL" "SICK" "VACATION" "VOLUNTEER" "WEATHER"
createdAt
string <date-time>

When the request was created

decidedAt
string <date-time>

Decided At

object (EmployeeBasicFieldsSchema)
decisionNote
string

Decision Note

decisionStatus
string

Decision Status

Enum: "APPROVED" "CANCELLED" "DENIED" "PENDING"
object (EmployeeBasicFieldsSchema)
endDate
string <date>

End Date

endTime
string

End Time

id
string

Unique ID of this object

paid
boolean

Indicates if the employee will be paid or not while on time off, cannot be null after request is approved

reason
string

Reason

requestNote
string

Request Note

requestedAt
string <date-time>

Requested At

object (EmployeeBasicFieldsSchema)
startDate
string <date>

Start Date

startTime
string

Start Time

object

Time Off Bucket

Array of objects

Hours Per Day

timeZone
string

Time Zone

totalHours
number <double>

Total Hours

updatedAt
string <date-time>

The last time the request was updated

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
application/json
{
  • "approve": true,
  • "note": "string"
}
Response samples
application/json
{
  • "data": {
    }
}

Retrieve a list of time off policies

get/companies/{companyUrlName}/time_off_policies

Retrieve a list of time off policies

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

query Parameters
policyName
string

Policy Name

Responses
200

Success

Response Schema: application/json
Array of objects (TimeOffPolicySchema)
Array
Array of objects

List buckets for this policy

name
string

Name

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of time off requests

get/companies/{companyUrlName}/time_off_requests

Retrieve a list of time off requests

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

query Parameters
page
integer <int64>

Page

Example: page=1
maxPerPage
integer <int64>

Max per page

Example: maxPerPage=10
startDate
string <date>

Start Date

Example: startDate=2020-01-15
endDate
string <date>

End Date

Example: endDate=2020-01-30
requestedAfter
string <date>

Requested After

Example: requestedAfter=2020-01-15
requestedBefore
string <date>

Requested Before

Example: requestedBefore=2020-01-30
decisionStatus
string

Decision Status

Enum: "APPROVED" "CANCELLED" "DENIED" "PENDING"
bucketType
string

Bucket Type

Enum: "BEREAVEMENT" "CUSTOM1" "CUSTOM2" "CUSTOM3" "EFMLA" "EPSL" "FLOATING_HOLIDAY" "JURY_DUTY" "LEARNING_AND_DEVELOPMENT" "LEAVE" "NOT_COUNTED" "PERSONAL" "SICK" "VACATION" "VOLUNTEER" "WEATHER"
Responses
200

Success

Response Schema: application/json
Array of objects (TimeOffRequestSchema)
maxPerPage
integer

Max per page

page
integer

Current page

total
integer

Total count

totalPages
integer

Total pages

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "maxPerPage": 25,
  • "page": 2,
  • "total": 2,
  • "totalPages": 1
}

Time Tracking

Endpoints related to Time Tracking

Create a timesheet entry

post/companies/{companyUrlName}/timesheets/{timesheetId}/entries

Create a timesheet entry

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

timesheetId
required
string

Timesheet ID

Request Body schema: application/json
required
startedAt
required
string <date-time>

Time entry start time

entryCategory
required
string

Type of hour entered

Enum: "HOLIDAY" "MEAL_BREAK" "MEAL_BREAK_OVERAGE" "MEAL_BREAK_PENALTY" "REST_BREAK" "REST_BREAK_OVERAGE" "REST_BREAK_PENALTY" "WORK"
employeeNote
string

Employee note

enteredDuration
string <duration>

Length of time entry

jobTitleId
string

ID of job title work was done under

managerNote
string

Manager note

Responses
200

Success

Response Schema: application/json
object (TimesheetEntrySchema)
object (EmployeeBasicFieldsSchema)
object

The department the employee was in when the entry was created

object

The division the employee was in when the entry was created

duration
string <duration>

Duration of entry (regardless of entry method)

employeeNote
string

Employee note for this entry

endedAt
string <date-time>

Entry end time

entryCategory
string

Entry classification

Enum: "HOLIDAY" "MEAL_BREAK" "MEAL_BREAK_OVERAGE" "MEAL_BREAK_PENALTY" "REST_BREAK" "REST_BREAK_OVERAGE" "REST_BREAK_PENALTY" "WORK"
entryDate
string <date>

Entry date

id
string

Unique ID of this object

object (JobTitleSchema)
object

The location the employee was in when the entry was created

managerNote
string

Manager note for this entry

startedAt
string <date-time>

Entry start time

timeEntryMethod
string

Time entry method

Enum: "CLOCK_IN_OUT" "MANUALLY_ENTERED"
timeEntryType
string

Time entry type

Enum: "DURATION" "START_STOP"
object (TimesheetSchema)
updatedAt
string <date-time>

The last time the time entry was updated

object (EmployeeBasicFieldsSchema)
401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
application/json
{
  • "employeeNote": "string",
  • "enteredDuration": "string",
  • "entryCategory": "HOLIDAY",
  • "jobTitleId": "string",
  • "managerNote": "string",
  • "startedAt": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "data": {
    }
}

Report timesheet entries

get/companies/{companyUrlName}/reports/time_tracking_entries

Report timesheet entries

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

query Parameters
startDate
required
string <date>

Start Date

Example: startDate=2020-01-15
endDate
required
string <date>

End Date

Example: endDate=2020-01-30
Responses
200

Success

Response Schema: application/json
object (ReportTimeTrackingEntries)
url
string

Report for time tracking entries

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples

Retrieve a list of timesheet entries

get/companies/{companyUrlName}/timesheet_entries

Retrieve a list of timesheet entries

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

query Parameters
timesheetId
string

Timesheet ID

employeeId
string

Employee ID

page
integer <int64>

Page

Example: page=1
maxPerPage
integer <int64>

Max per page

Example: maxPerPage=10
Responses
200

Success

Response Schema: application/json
Array of objects (TimesheetEntrySchema)
maxPerPage
integer

Max per page

page
integer

Current page

total
integer

Total count

totalPages
integer

Total pages

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "maxPerPage": 25,
  • "page": 1,
  • "total": 1,
  • "totalPages": 1
}

Retrieve a list of timesheets

get/companies/{companyUrlName}/timesheets

Retrieve a list of timesheets

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

query Parameters
startDate
required
string <date>

Start Date

Example: startDate=2020-01-15
endDate
required
string <date>

End Date

Example: endDate=2020-01-30
employeeId
string

Employee ID

page
integer <int64>

Page

Example: page=1
maxPerPage
integer <int64>

Max per page

Example: maxPerPage=10
Responses
200

Success

Response Schema: application/json
Array of objects (TimesheetSchema)
maxPerPage
integer

Max per page

page
integer

Current page

total
integer

Total count

totalPages
integer

Total pages

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "maxPerPage": 25,
  • "page": 1,
  • "total": 1,
  • "totalPages": 1
}

Workflows

Endpoints related to Workflows

Bulk update fields for a workflow

patch/companies/{companyUrlName}/workflows/{workflowId}/fields/bulk_update

Bulk update fields for a workflow

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

workflowId
required
string

Workflow ID

Request Body schema: application/json
required
required
Array of objects
Array
identifier
required
string

Workflow Field Identifier

object

Workflow Field Currency Value. Valid when workflow Field Type in [CURRENCY]

dateValue
string <date>

Workflow Field Date Value. Valid when workflow Field Type in [DATE]

numberValue
number

Workflow Field Number Value. Valid when workflow Field Type in [NUMBER, OPINION_SCALE]

stringValue
Array of strings

Workflow Field String Value. Valid when workflow Field Type in [SHORT_TEXT, LONG_TEXT, DROPDOWN, RADIO_LIST, CHECKBOX_LIST]

Responses
200

Success

Response Schema: application/json
object (WorkflowFieldBulkUpdateSchema)
id
string

Unique ID of this object

Array of objects

All workflow fields

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
application/json
{
  • "workflowFields": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}

Create a workflow template field

post/companies/{companyUrlName}/workflow_templates/{workflowTemplateId}/fields

Create a workflow template field

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

workflowTemplateId
required
string

Workflow Template ID

Request Body schema: application/json
required
name
required
string

Name of the workflow field

fieldType
required
string

Type of the workflow field

Enum: "AUTOMATIC_CALCULATION" "CHECKBOX_LIST" "CURRENCY" "DATE" "DROPDOWN" "LONG_TEXT" "NUMBER" "OPINION_SCALE" "RADIO_LIST" "SHORT_TEXT" "UPLOAD" "USER"
possibleValues
Array of strings
Responses
200

Success

Response Schema: application/json
object
id
string

Field ID

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
application/json
{
  • "fieldType": "AUTOMATIC_CALCULATION",
  • "name": "string",
  • "possibleValues": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}

Publish the workflow template

put/companies/{companyUrlName}/workflow_templates/{workflowTemplateId}/publish

Publish the workflow template

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

workflowTemplateId
required
string

Workflow Template ID

Responses
200

Success

Response Schema: application/json
object (WorkflowTemplateSchema)
createdAt
string <date-time>

Time the template was created

description
string

Describes the workflow purpose

id
string

Unique ID of this object

name
string

Workflow name

Array of objects (WorkflowScheduleSchema)

Schedules to start a workflow

templateType
string

The type of the workflow

Enum: "BACKGROUND_CHECK_CHECKR" "DEFAULT" "HIRING_CONTRACTOR" "HIRING_EMPLOYEE" "ONBOARDING_EMPLOYEE" "PERFORMANCE" "PUBLIC" "SURVEY" "SURVEY_PULSE"
Array of objects (WorkflowTemplateFieldSchema)

All workflow fields

Array of objects (WorkflowStepSchema)

List of task/group instances that are the children to this workflow instance, without the groups

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": {
    }
}

Retrieve a list of workflow templates

get/companies/{companyUrlName}/workflow_templates

Retrieve a list of workflow templates

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

query Parameters
published
required
boolean

Published Workflow Templates

Example: published=true
Responses
200

Success

Response Schema: application/json
Array of objects (WorkflowTemplateSchema)
Array
createdAt
string <date-time>

Time the template was created

description
string

Describes the workflow purpose

id
string

Unique ID of this object

name
string

Workflow name

Array of objects (WorkflowScheduleSchema)

Schedules to start a workflow

templateType
string

The type of the workflow

Enum: "BACKGROUND_CHECK_CHECKR" "DEFAULT" "HIRING_CONTRACTOR" "HIRING_EMPLOYEE" "ONBOARDING_EMPLOYEE" "PERFORMANCE" "PUBLIC" "SURVEY" "SURVEY_PULSE"
Array of objects (WorkflowTemplateFieldSchema)

All workflow fields

Array of objects (WorkflowStepSchema)

List of task/group instances that are the children to this workflow instance, without the groups

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a workflow

get/companies/{companyUrlName}/workflows/{id}

Retrieve a workflow

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

id
required
string

Workflow ID

Responses
200

Success

Response Schema: application/json
object (WorkflowSchema)
id
string

Unique ID of this object

name
string

Workflow name

object (EmployeeBasicFieldsSchema)
templateType
string

The type of the workflow

Enum: "BACKGROUND_CHECK_CHECKR" "DEFAULT" "HIRING_CONTRACTOR" "HIRING_EMPLOYEE" "ONBOARDING_EMPLOYEE" "PERFORMANCE" "PUBLIC" "SURVEY" "SURVEY_PULSE"
Array of objects (WorkflowFieldSchema)

All workflow fields

Array of objects (WorkflowTaskSchema)

List of task/group instances that are the children to this workflow instance, without the groups

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": {
    }
}

Update a workflow task

patch/companies/{companyUrlName}/workflows/{workflowId}/tasks/{id}

Update a workflow task

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

workflowId
required
string

Workflow ID

id
required
string

Task ID

Request Body schema: application/json
required
status
required
string
Enum: "BLOCKED" "CANCELLED" "COMPLETED" "INCOMPLETE" "IN_PROGRESS"
Responses
200

Success

Response Schema: application/json
object (WorkflowTaskSchema)
Array of objects (ObjectCommentSchema)

The task comments

createdAt
string <date-time>

Time the task was created

dueDate
string <date-time>

Date when this task will be due

id
string

The node interface

name
string

Task name

order
integer <int64>

Ordered index of this step relative to its parent

status
string

Task current status

Enum: "ARCHIVED" "BLOCKED" "CANCELLED" "COMPLETED" "DELETED" "INCOMPLETE" "IN_PROGRESS" "PENDING" "SKIPPED"
object (EmployeeBasicFieldsSchema)
401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
application/json
{
  • "status": "INCOMPLETE"
}
Response samples
application/json
{
  • "data": {
    }
}

Update a workflow template field

patch/companies/{companyUrlName}/workflow_templates/{workflowTemplateId}/fields/{id}

Update a workflow template field

SecurityApiKeyAuth
Request
path Parameters
companyUrlName
required
string

Company URL Name

workflowTemplateId
required
string

Workflow Template ID

id
required
string

Field ID

Example: AF4CT0nTHFVqawpAkuStgfQAFUN1c3RvbUZpZ
Request Body schema: application/json
required
possibleValues
required
Array of strings
Responses
200

Success

Response Schema: application/json
object
id
string

Field ID

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
application/json
{
  • "possibleValues": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}

Data Pills

Endpoints related to Data Pills

Retrieve a list of currencies

get/data_pills/currencies

Retrieve a list of currencies

SecurityApiKeyAuth
Responses
200

Success

Response Schema: application/json
Array of objects (CurrencySchema)
Array
code
string

Unique 3 digit currency code

Enum: "AED" "ARS" "AUD" "BGN" "BHD" "CAD" "CHF" "CLP" "CNH" "CNY" "CZK" "DKK" "EUR" "FJD" "GBP" "HKD" "HUF" "IDR" "ILS" "INR" "ISK" "JPY" "KES" "KWD" "MAD" "MXN" "MYR" "NOK" "NZD" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SEK" "SGD" "TRY" "TWD" "UAH" "USD" "VND" "ZAR"
description
string

Full name of the currency

precision
integer <int64>

Number of precision decimal digits

symbol
string

Non-unique one character symbol

401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of notification statuses

get/data_pills/notification_statuses

Retrieve a list of notification statuses

SecurityApiKeyAuth
Responses
200

Success

Response Schema: application/json
Array of objects (NotificationStatusSchema)
Array
description
string

Description

name
string

Name

Enum: "ACTIVE" "AUTO_ARCHIVED" "BLOCKED" "CANCELLED" "COMPLETED" "DELETED" "INCOMPLETE" "IN_PROGRESS" "PAYROLL_BLOCKED" "PENDING" "SKIPPED"
401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of notification types

get/data_pills/notification_types

Retrieve a list of notification types

SecurityApiKeyAuth
Responses
200

Success

Response Schema: application/json
Array of objects (NotificationTypeSchema)
Array
description
string

Description

name
string

Name

Enum: "ACA_BENEFIT_COVERAGE_CHANGES_REQUIRED" "ACA_UPLOAD_HOURS" "ANNOUNCEMENT" "BENEFITS_SYNC" "BENEFIT_CHANGE" "BENEFIT_DEPENDENT_CHANGE" "BENEFIT_ELIGIBILITY_CHANGED" "CARRIER_FORM_TEMPLATE_REQUEST" "CLOSED_PAYROLL_CHANGE" "COLONIAL_HARMONY_IMPORT_ERROR" "COMPANY_CHANGE" "CONTRIBUTION_CHANGE" "DISENROLL_DELETED_EMPLOYEE" "DISENROLL_DELETED_ENROLLMENT" "DISENROLL_EMPLOYEE" "DISENROLL_GENERIC_ENROLLMENT" "DOCUMENT_EXPIRED" "DOCUMENT_EXPIRING" "DOCUMENT_RECEIVED" "DOCUMENT_RECEIVED_MANAGER" "DOCUMENT_VERIFICATION" "DOCUMENT_VERIFICATION_MANAGER" "EDI_ERROR" "EMPLOYEE_DELETED" "EMPLOYEE_DOCUMENT" "EMPLOYEE_DOCUMENT_RECEIVES_COPY" "EMPLOYEE_DOCUMENT_RESET" "EMPLOYEE_LATE" "EMPLOYEE_ONBOARD_TASK" "ENROLLMENT_CHANGE" "ENROLLMENT_ENDING" "ENROLLMENT_ENDING_ADMIN" "ENROLLMENT_ERROR_CORRECTION" "ENROLLMENT_EXTENDED" "ENROLLMENT_MISSED_ADMIN" "ENROLLMENT_REMINDER" "EXPENSE_REIMBURSEMENT_DECISION" "EXPENSE_REIMBURSEMENT_REQUEST" "FEEDBACK_ACTIVITY" "FINAL_PAYCHECK" "FINAL_PAYCHECK_ISSUE_METHOD" "FINISH_HIRING" "FINISH_HIRING_IN_REMOTE" "GENERIC_ENROLLMENT_REQUEST" "GENERIC_INDIVIDUAL_ENROLLMENT_PAYROLL_DEDUCTION" "GENERIC_OPEN_ENROLLMENT_PAYROLL_DEDUCTION" "GOAL_COMMENT" "GOAL_COMPLETED" "GOAL_CREATED" "GOAL_MISSED" "GOAL_PROGRESS" "GUSTO_CRITICAL" "GUSTO_NON_CRITICAL" "HSA_DEDUCTION_CHANGE" "HUMAN_INTEREST_INTEGRATION_ERROR" "I9_CERTIFICATION" "INDIVIDUAL_ENROLLMENT_COMPLETED" "LIFE_EVENT_ADMIN_APPROVAL" "LIFE_EVENT_APPROVED" "LIFE_EVENT_CARRIER_APPROVAL" "LIFE_EVENT_REJECTED" "MAGIC_DOC_REQUESTED" "NEW_COBRA" "NEW_PAYROLL_STATE" "OFFER_ACCEPTED" "OFFER_CONTINUED_COVERAGE_DEPENDENT" "OFFER_CONTINUED_COVERAGE_EMPLOYEE" "ONBOARD_STARTED" "OPEN_ENROLLMENT_COMPLETED" "PAYROLL_ADDITION" "PAYROLL_CHANGE" "PAYROLL_DEDUCTION_CHANGE" "PAYROLL_SYNC" "PERFORMANCE_TASK" "REQUESTED_DOCUMENT_EXPIRED" "REQUESTED_DOCUMENT_EXPIRING" "TEAM_SURVEY_TASK" "TEAM_SURVEY_TASK_REMINDER" "TIMESHEET_APPROVE" "TIME_OFF_CANCELLED" "TIME_OFF_REQUEST" "TIME_OFF_REQUEST_DECISION" "UNUM_LIMRA_API_FAILURE" "VERICRED_API_FAILURE" "VIDIX_INTEGRATION_ERROR" "VOLUNTARY_COVERAGE_CHANGE" "VOLUNTARY_EOI_SYNC" "WORKFLOW_COMPLETED" "WORKFLOW_TASK" "WORK_SCHEDULE_PUBLISHED"
401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of time off bucket types

get/data_pills/time_off_bucket_types

Retrieve a list of time off bucket types

SecurityApiKeyAuth
Responses
200

Success

Response Schema: application/json
Array of objects (TimeOffBucketTypeSchema)
Array
description
string

Description

name
string

Name

Enum: "BEREAVEMENT" "CUSTOM1" "CUSTOM2" "CUSTOM3" "EFMLA" "EPSL" "FLOATING_HOLIDAY" "JURY_DUTY" "LEARNING_AND_DEVELOPMENT" "LEAVE" "NOT_COUNTED" "PERSONAL" "SICK" "VACATION" "VOLUNTEER" "WEATHER"
401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a list of time off request statuses

get/data_pills/time_off_request_statuses

Retrieve a list of time off request statuses

SecurityApiKeyAuth
Responses
200

Success

Response Schema: application/json
Array of objects (TimeOffRequestStatusSchema)
Array
description
string

Description

name
string

Name

Enum: "APPROVED" "CANCELLED" "DENIED" "PENDING"
401

Not Authorized

404

Not Found

422

Unprocessable Content

429

Too Many Requests

Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Schemas

AdditionalDeductionSchema

id
string

Unique ID of this object

name
string

Name

{
  • "id": "string",
  • "name": "string"
}

AdditionalEarningsSchema

id
string

Unique ID of this object

name
string

Name of this earning type

{
  • "id": "string",
  • "name": "string"
}

CompanyClassSchema

id
string

Unique ID of this object

name
string

Name

{
  • "id": "string",
  • "name": "string"
}

CompanyCustomFieldsSchema

Array of objects (CustomFieldDefinitionSchema)

Custom Fields

name
string

Section Name

{
  • "fields": [
    ],
  • "name": "string"
}

CompanySchema

id
string

Unique ID of this object

name
string

Name

urlName
string

URL Name

{
  • "id": "string",
  • "name": "string",
  • "urlName": "string"
}

CurrencySchema

code
string

Unique 3 digit currency code

Enum: "AED" "ARS" "AUD" "BGN" "BHD" "CAD" "CHF" "CLP" "CNH" "CNY" "CZK" "DKK" "EUR" "FJD" "GBP" "HKD" "HUF" "IDR" "ILS" "INR" "ISK" "JPY" "KES" "KWD" "MAD" "MXN" "MYR" "NOK" "NZD" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SEK" "SGD" "TRY" "TWD" "UAH" "USD" "VND" "ZAR"
description
string

Full name of the currency

precision
integer <int64>

Number of precision decimal digits

symbol
string

Non-unique one character symbol

{
  • "code": "AED",
  • "description": "string",
  • "precision": 0,
  • "symbol": "string"
}

CustomFieldDefinitionSchema

description
string

Description

id
string

Unique ID of this object

identifier
string

Identifier of this field for magic documents

name
string

Name

Array of objects

Possible Values

type
string

Field Type

Enum: "CHECKBOX_LIST" "CURRENCY" "DATE" "DROPDOWN" "LONG_TEXT" "NUMBER" "OPINION_SCALE" "RADIO_LIST" "SHORT_TEXT" "UPLOAD"
{
  • "description": "string",
  • "id": "string",
  • "identifier": "string",
  • "name": "string",
  • "possibleValues": [
    ],
  • "type": "CHECKBOX_LIST"
}

DepartmentSchema

code
string

Work Group code

id
string

Unique ID of this object

name
string

Name

{
  • "code": "string",
  • "id": "string",
  • "name": "string"
}

DocumentTemplateSchema

description
string

Description for this template

id
string

Unique ID of this object

kind
string

Type of document that this template uses

Enum: "ATTACHED" "EMPLOYEE_PROVIDED" "I9_SUPPORTING" "I_9" "JOB_OFFER" "PERFORMANCE_REVIEW" "PERSONALIZED_AGREEMENT" "STATE_TAX" "W_4" "W_9"
name
string

Name of this template

{
  • "description": "string",
  • "id": "string",
  • "kind": "ATTACHED",
  • "name": "string"
}

EmployeeBasicFieldsSchema

firstName
string

First Name

id
string

Unique ID of this object

lastName
string

Last Name

middleInitial
string

Middle Initial Name

personalEmail
string <email>

Personal Email

preferredFirstName
string

Preferred First Name

preferredPronoun
string

Preferred Pronoun

Enum: "EY_EM_EIRS" "HE_HIM_HIS" "NAME_NAME_NAMES" "PER_PER_PERS" "SHE_HER_HERS" "SIE_HIR_HIRS" "THEY_THEM_THEIRS" "ZEE_HERE_HERES" "ZE_HIR_HIRS" "ZE_ZIM_ZIMS" "ZE_ZIR_ZIRS"
workEmail
string <email>

Work Email

workPhone
string

Work Phone

{
  • "firstName": "string",
  • "id": "string",
  • "lastName": "string",
  • "middleInitial": "string",
  • "personalEmail": "[email protected]",
  • "preferredFirstName": "string",
  • "preferredPronoun": "EY_EM_EIRS",
  • "workEmail": "[email protected]",
  • "workPhone": "string"
}

EmployeeCompensationMethodsSchema

accountNickname
string

Employee created label for account

amount
number <double>

Either a flat dollar amount or percentage to be deposited to this account

amountType
string

Indicate if the amount is fixed or a percentage of gross pay

Enum: "DOLLARS" "PERCENT"
object

Details for bank account

currency
string

Currency used

Enum: "AED" "ARS" "AUD" "BGN" "BHD" "CAD" "CHF" "CLP" "CNH" "CNY" "CZK" "DKK" "EUR" "FJD" "GBP" "HKD" "HUF" "IDR" "ILS" "INR" "ISK" "JPY" "KES" "KWD" "MAD" "MXN" "MYR" "NOK" "NZD" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SEK" "SGD" "TRY" "TWD" "UAH" "USD" "VND" "ZAR"
formattedDepositAmount
string

Formatted amount, including the currency or percent symbol.

id
string

Unique identifier for the compensation method

paymentMethod
string

Direct deposit or paper check

Enum: "DIRECT_DEPOSIT" "PAPER_CHECK"
priority
integer <int64>

Order in which funds from gross pay will be allocated to account

{
  • "accountNickname": "string",
  • "amount": 0,
  • "amountType": "DOLLARS",
  • "bankAccount": {
    },
  • "currency": "AED",
  • "formattedDepositAmount": "string",
  • "id": "string",
  • "paymentMethod": "DIRECT_DEPOSIT",
  • "priority": 0
}

EmployeeCustomFieldsSchema

Array of objects

Custom Fields

name
string

Section Name

{
  • "fields": [
    ],
  • "name": "string"
}

EmployeeDocumentSchema

completed
boolean

True if this document has been completed

object (EmployeeBasicFieldsSchema)
object (EmployeeBasicFieldsSchema)
expirationDate
string <date>

Date that this document expires

object

Most recently completed version of this document

id
string

Unique ID of this object

name
string

Name of this document

Array of objects (EmployeeDocumentStepSchema)

Document steps

object

Template that was used to create this document

{
  • "completed": true,
  • "createdBy": {
    },
  • "employee": {
    },
  • "expirationDate": "2019-08-24",
  • "file": {},
  • "id": "string",
  • "name": "string",
  • "steps": [
    ],
  • "template": {
    }
}

EmployeeDocumentStepSchema

object (EmployeeBasicFieldsSchema)
completed
boolean

True if this step is completed

completedAt
string <date-time>

Time when this step was completed

object (EmployeeBasicFieldsSchema)
object

Document Template Step

{
  • "assignedTo": {
    },
  • "completed": true,
  • "completedAt": "2019-08-24T14:15:22Z",
  • "completedBy": {
    },
  • "templateStep": {
    }
}

EmployeeSchema

object

Address

object

Department

object

Division

dob
string <date>

Date of Birth

efmlaBalance
number <double>

Emergency Family and Medical Leave Hours Balance

Array of objects

Emergency Contacts

employmentStatus
string

Employment Status

Enum: "ACTIVE" "ON_LEAVE" "PENDING" "TERMINATED"
employmentType
string

Employment Type

Enum: "CONTRACTOR" "FULL_TIME" "PART_TIME" "TEMPORARY"
epslBalance
number <double>

Emergency Paid Sick Leave Hours Balance

extraWithholding
number <double>

Extra Withholding

firstName
string

First Name

genderIdentity
string

Gender Identity

id
string

Unique ID of this object

insertionSource
string

Insertion Source

Enum: "ADP_WORKFORCE" "GREENHOUSE" "HIRING_WIZARD" "IMPORT" "JAZZ_HR" "LEVER" "PAYCHEX" "PUBLIC_API" "QUICK_ADD" "UNKNOWN" "WORKABLE"
isManager
boolean

Is Manager?

object

Job Title

lastName
string

Last Name

legalSex
string

Legal Sex

Enum: "FEMALE" "MALE"
object

Location

object (EmployeeBasicFieldsSchema)
middleInitial
string

Middle Initial Name

object

Non Work State Withholding

object

Payroll Schedule

personalBalance
number <double>

Personal Leave Hours Balance

personalEmail
string <email>

Personal Email

object

Photo

preferredFirstName
string

Preferred First Name

preferredPronoun
string

Preferred Pronoun

Enum: "EY_EM_EIRS" "HE_HIM_HIS" "NAME_NAME_NAMES" "PER_PER_PERS" "SHE_HER_HERS" "SIE_HIR_HIRS" "THEY_THEM_THEIRS" "ZEE_HERE_HERES" "ZE_HIR_HIRS" "ZE_ZIM_ZIMS" "ZE_ZIR_ZIRS"
rehire
boolean

Rehire?

residentState
string

Resident State

sickBalance
number <double>

Sick Leave Hours Balance

ssn
string

Social Security Number

startDate
string <date>

Start date of the employee

taxFilingStatus
string

Tax Filing Status

Enum: "exempt" "head_of_household" "married" "married_withhold_as_single" "single"
terminationDay
string <date>

Termination date

terminationNote
string

Termination Note

terminationStatus
string

Termination Status

Enum: "OFF" "ON" "PENDING" "TERMINATING"
terminationType
string

Termination Type

Enum: "DECEASED" "GROSS_MISCONDUCT" "INVOLUNTARY" "UNKNOWN" "VOLUNTARY_NOT_REGRETTED" "VOLUNTARY_REGRETTED"
object

Time Off Policy

object

Time Tracking Policy

uniqueOnboardingLink
string

Onboarding Link

vacationBalance
number <double>

Vacation Hours Balance

w420202MultipleJobs
boolean

w4 2020 - Multiple Jobs

w420203DependentWithholding
number <double>

w4 2020 - Dependent Withholding

w420204aOtherIncome
number <double>

w4 2020 - Other Income

w420204bDeductions
number <double>

w4 2020 - Deductions

w42020IncomeBelow200k
boolean

w4 2020 - Income Below 200k

w42020OtherDependents
integer <int64>

w4 2020 - Other Dependents

w42020QualifiedChildren
integer <int64>

w4 2020 - Qualified Children

w4Version
string

How and which W-4 fields are available on this employee

Enum: "PRE2020" "REVISION2020"
object

Wage Rate

wageType
string

Wage Type

Enum: "FIXED_AMOUNT" "HOURLY" "MONTHLY" "QUARTERLY" "SALARY" "WEEKLY"
withholdingAllowances
integer <int64>

Withholding Allowances

workEmail
string <email>

Work Email

workPhone
string

Work Phone

{
  • "address": {
    },
  • "department": {
    },
  • "division": {
    },
  • "dob": "2019-08-24",
  • "efmlaBalance": 0,
  • "emergencyContacts": [
    ],
  • "employmentStatus": "ACTIVE",
  • "employmentType": "CONTRACTOR",
  • "epslBalance": 0,
  • "extraWithholding": 0,
  • "firstName": "string",
  • "genderIdentity": "string",
  • "id": "string",
  • "insertionSource": "ADP_WORKFORCE",
  • "isManager": true,
  • "jobTitle": {
    },
  • "lastName": "string",
  • "legalSex": "FEMALE",
  • "location": {
    },
  • "manager": {
    },
  • "middleInitial": "string",
  • "nonWorkStateWithholding": {
    },
  • "payrollSchedule": {
    },
  • "personalBalance": 0,
  • "personalEmail": "[email protected]",
  • "photo": {},
  • "preferredFirstName": "string",
  • "preferredPronoun": "EY_EM_EIRS",
  • "rehire": true,
  • "residentState": "string",
  • "sickBalance": 0,
  • "ssn": "string",
  • "startDate": "2019-08-24",
  • "taxFilingStatus": "exempt",
  • "terminationDay": "2019-08-24",
  • "terminationNote": "string",
  • "terminationStatus": "OFF",
  • "terminationType": "DECEASED",
  • "timeOffPolicy": {
    },
  • "timeTrackingPolicy": {
    },
  • "uniqueOnboardingLink": "string",
  • "vacationBalance": 0,
  • "w420202MultipleJobs": true,
  • "w420203DependentWithholding": 0,
  • "w420204aOtherIncome": 0,
  • "w420204bDeductions": 0,
  • "w42020IncomeBelow200k": true,
  • "w42020OtherDependents": 0,
  • "w42020QualifiedChildren": 0,
  • "w4Version": "PRE2020",
  • "wageRate": {
    },
  • "wageType": "FIXED_AMOUNT",
  • "withholdingAllowances": 0,
  • "workEmail": "[email protected]",
  • "workPhone": "string"
}

EmployeeSharedInputSchema

object

Employee's address information

companyClassId
string

Company class ID

compensationNote
string

Compensation note for this employee

departmentId
string

Department ID

dob
string <date>

Date of birth

employmentType
string

Employment type

Enum: "CONTRACTOR" "FULL_TIME" "PART_TIME" "TEMPORARY"
jobTitleId
string

Job Title ID

legalSex
string

Legal Sex

Enum: "FEMALE" "MALE"
locationId
string

Work location ID

managerId
string

Manager ID

payrollScheduleId
string

Payroll Schedule ID

ssn
string

Social Security Number

startDate
string <date>

Start date

object

Wage rate

wageType
string

Wage type

Enum: "FIXED_AMOUNT" "HOURLY" "MONTHLY" "QUARTERLY" "SALARY" "WEEKLY"
workEmail
string

Work Email

workPhone
string

Work Phone

{
  • "address": {
    },
  • "companyClassId": "string",
  • "compensationNote": "string",
  • "departmentId": "string",
  • "dob": "2019-08-24",
  • "employmentType": "CONTRACTOR",
  • "jobTitleId": "string",
  • "legalSex": "FEMALE",
  • "locationId": "string",
  • "managerId": "string",
  • "payrollScheduleId": "string",
  • "ssn": "string",
  • "startDate": "2019-08-24",
  • "wageRate": {
    },
  • "wageType": "FIXED_AMOUNT",
  • "workEmail": "string",
  • "workPhone": "string"
}

EmployeeStateWithholdingsSchema

allowNonResidentExemption
boolean

Allow Non Resident Exemption

allowances
string

Allowances

exempt
boolean

Exempt

exemptReason
string

Exempt Reason

Enum: "NON_RESIDENT" "OTHER"
object

Exception Form

exemptionOptions
string

Exemption Options

Enum: "NONE" "SIMPLE" "UPLOAD"
Array of objects

Fields

filingStatus
string

Filing Status

object

Form

id
string

Unique ID of this object

isWorkState
boolean

Is Work State

signedAt
string <date-time>

Signed At

state
string

State

{
  • "allowNonResidentExemption": true,
  • "allowances": "string",
  • "exempt": true,
  • "exemptReason": "NON_RESIDENT",
  • "exemptionForm": {
    },
  • "exemptionOptions": "NONE",
  • "fields": [
    ],
  • "filingStatus": "string",
  • "form": {
    },
  • "id": "string",
  • "isWorkState": true,
  • "signedAt": "2019-08-24T14:15:22Z",
  • "state": "string"
}

JobTitleSchema

code
string

Work Group code

id
string

Unique ID of this object

name
string

Name

{
  • "code": "string",
  • "id": "string",
  • "name": "string"
}

LocationSchema

id
string

Unique ID of this object

name
string

Name

{
  • "id": "string",
  • "name": "string"
}

NotificationSchema

createdAt
string <date-time>

Created At

description
string

Description

dueDate
string <date-time>

Due Date

id
string

Unique ID of this object

Array of objects (EmployeeBasicFieldsSchema)

List of employees that were notified

notifiedPersonalEmails
Array of strings

List of personal emails that were notified

notifiedWorkEmails
Array of strings

List of work emails that were notified

notifiedWorkPhones
Array of strings

List of work phones that were notified

status
string

Status

Enum: "ACTIVE" "AUTO_ARCHIVED" "BLOCKED" "CANCELLED" "COMPLETED" "DELETED" "INCOMPLETE" "IN_PROGRESS" "PAYROLL_BLOCKED" "PENDING" "SKIPPED"
object (EmployeeBasicFieldsSchema)
type
string

Type

Enum: "ACA_BENEFIT_COVERAGE_CHANGES_REQUIRED" "ACA_UPLOAD_HOURS" "ANNOUNCEMENT" "BENEFITS_SYNC" "BENEFIT_CHANGE" "BENEFIT_DEPENDENT_CHANGE" "BENEFIT_ELIGIBILITY_CHANGED" "CARRIER_FORM_TEMPLATE_REQUEST" "CLOSED_PAYROLL_CHANGE" "COLONIAL_HARMONY_IMPORT_ERROR" "COMPANY_CHANGE" "CONTRIBUTION_CHANGE" "DISENROLL_DELETED_EMPLOYEE" "DISENROLL_DELETED_ENROLLMENT" "DISENROLL_EMPLOYEE" "DISENROLL_GENERIC_ENROLLMENT" "DOCUMENT_EXPIRED" "DOCUMENT_EXPIRING" "DOCUMENT_RECEIVED" "DOCUMENT_RECEIVED_MANAGER" "DOCUMENT_VERIFICATION" "DOCUMENT_VERIFICATION_MANAGER" "EDI_ERROR" "EMPLOYEE_DELETED" "EMPLOYEE_DOCUMENT" "EMPLOYEE_DOCUMENT_RECEIVES_COPY" "EMPLOYEE_DOCUMENT_RESET" "EMPLOYEE_LATE" "EMPLOYEE_ONBOARD_TASK" "ENROLLMENT_CHANGE" "ENROLLMENT_ENDING" "ENROLLMENT_ENDING_ADMIN" "ENROLLMENT_ERROR_CORRECTION" "ENROLLMENT_EXTENDED" "ENROLLMENT_MISSED_ADMIN" "ENROLLMENT_REMINDER" "EXPENSE_REIMBURSEMENT_DECISION" "EXPENSE_REIMBURSEMENT_REQUEST" "FEEDBACK_ACTIVITY" "FINAL_PAYCHECK" "FINAL_PAYCHECK_ISSUE_METHOD" "FINISH_HIRING" "FINISH_HIRING_IN_REMOTE" "GENERIC_ENROLLMENT_REQUEST" "GENERIC_INDIVIDUAL_ENROLLMENT_PAYROLL_DEDUCTION" "GENERIC_OPEN_ENROLLMENT_PAYROLL_DEDUCTION" "GOAL_COMMENT" "GOAL_COMPLETED" "GOAL_CREATED" "GOAL_MISSED" "GOAL_PROGRESS" "GUSTO_CRITICAL" "GUSTO_NON_CRITICAL" "HSA_DEDUCTION_CHANGE" "HUMAN_INTEREST_INTEGRATION_ERROR" "I9_CERTIFICATION" "INDIVIDUAL_ENROLLMENT_COMPLETED" "LIFE_EVENT_ADMIN_APPROVAL" "LIFE_EVENT_APPROVED" "LIFE_EVENT_CARRIER_APPROVAL" "LIFE_EVENT_REJECTED" "MAGIC_DOC_REQUESTED" "NEW_COBRA" "NEW_PAYROLL_STATE" "OFFER_ACCEPTED" "OFFER_CONTINUED_COVERAGE_DEPENDENT" "OFFER_CONTINUED_COVERAGE_EMPLOYEE" "ONBOARD_STARTED" "OPEN_ENROLLMENT_COMPLETED" "PAYROLL_ADDITION" "PAYROLL_CHANGE" "PAYROLL_DEDUCTION_CHANGE" "PAYROLL_SYNC" "PERFORMANCE_TASK" "REQUESTED_DOCUMENT_EXPIRED" "REQUESTED_DOCUMENT_EXPIRING" "TEAM_SURVEY_TASK" "TEAM_SURVEY_TASK_REMINDER" "TIMESHEET_APPROVE" "TIME_OFF_CANCELLED" "TIME_OFF_REQUEST" "TIME_OFF_REQUEST_DECISION" "UNUM_LIMRA_API_FAILURE" "VERICRED_API_FAILURE" "VIDIX_INTEGRATION_ERROR" "VOLUNTARY_COVERAGE_CHANGE" "VOLUNTARY_EOI_SYNC" "WORKFLOW_COMPLETED" "WORKFLOW_TASK" "WORK_SCHEDULE_PUBLISHED"
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "notifiedEmployees": [
    ],
  • "notifiedPersonalEmails": [
    ],
  • "notifiedWorkEmails": [
    ],
  • "notifiedWorkPhones": [
    ],
  • "status": "ACTIVE",
  • "targetEmployee": {
    },
  • "type": "ACA_BENEFIT_COVERAGE_CHANGES_REQUIRED"
}

NotificationStatusSchema

description
string

Description

name
string

Name

Enum: "ACTIVE" "AUTO_ARCHIVED" "BLOCKED" "CANCELLED" "COMPLETED" "DELETED" "INCOMPLETE" "IN_PROGRESS" "PAYROLL_BLOCKED" "PENDING" "SKIPPED"
{
  • "description": "string",
  • "name": "ACTIVE"
}

NotificationTypeSchema

description
string

Description

name
string

Name

Enum: "ACA_BENEFIT_COVERAGE_CHANGES_REQUIRED" "ACA_UPLOAD_HOURS" "ANNOUNCEMENT" "BENEFITS_SYNC" "BENEFIT_CHANGE" "BENEFIT_DEPENDENT_CHANGE" "BENEFIT_ELIGIBILITY_CHANGED" "CARRIER_FORM_TEMPLATE_REQUEST" "CLOSED_PAYROLL_CHANGE" "COLONIAL_HARMONY_IMPORT_ERROR" "COMPANY_CHANGE" "CONTRIBUTION_CHANGE" "DISENROLL_DELETED_EMPLOYEE" "DISENROLL_DELETED_ENROLLMENT" "DISENROLL_EMPLOYEE" "DISENROLL_GENERIC_ENROLLMENT" "DOCUMENT_EXPIRED" "DOCUMENT_EXPIRING" "DOCUMENT_RECEIVED" "DOCUMENT_RECEIVED_MANAGER" "DOCUMENT_VERIFICATION" "DOCUMENT_VERIFICATION_MANAGER" "EDI_ERROR" "EMPLOYEE_DELETED" "EMPLOYEE_DOCUMENT" "EMPLOYEE_DOCUMENT_RECEIVES_COPY" "EMPLOYEE_DOCUMENT_RESET" "EMPLOYEE_LATE" "EMPLOYEE_ONBOARD_TASK" "ENROLLMENT_CHANGE" "ENROLLMENT_ENDING" "ENROLLMENT_ENDING_ADMIN" "ENROLLMENT_ERROR_CORRECTION" "ENROLLMENT_EXTENDED" "ENROLLMENT_MISSED_ADMIN" "ENROLLMENT_REMINDER" "EXPENSE_REIMBURSEMENT_DECISION" "EXPENSE_REIMBURSEMENT_REQUEST" "FEEDBACK_ACTIVITY" "FINAL_PAYCHECK" "FINAL_PAYCHECK_ISSUE_METHOD" "FINISH_HIRING" "FINISH_HIRING_IN_REMOTE" "GENERIC_ENROLLMENT_REQUEST" "GENERIC_INDIVIDUAL_ENROLLMENT_PAYROLL_DEDUCTION" "GENERIC_OPEN_ENROLLMENT_PAYROLL_DEDUCTION" "GOAL_COMMENT" "GOAL_COMPLETED" "GOAL_CREATED" "GOAL_MISSED" "GOAL_PROGRESS" "GUSTO_CRITICAL" "GUSTO_NON_CRITICAL" "HSA_DEDUCTION_CHANGE" "HUMAN_INTEREST_INTEGRATION_ERROR" "I9_CERTIFICATION" "INDIVIDUAL_ENROLLMENT_COMPLETED" "LIFE_EVENT_ADMIN_APPROVAL" "LIFE_EVENT_APPROVED" "LIFE_EVENT_CARRIER_APPROVAL" "LIFE_EVENT_REJECTED" "MAGIC_DOC_REQUESTED" "NEW_COBRA" "NEW_PAYROLL_STATE" "OFFER_ACCEPTED" "OFFER_CONTINUED_COVERAGE_DEPENDENT" "OFFER_CONTINUED_COVERAGE_EMPLOYEE" "ONBOARD_STARTED" "OPEN_ENROLLMENT_COMPLETED" "PAYROLL_ADDITION" "PAYROLL_CHANGE" "PAYROLL_DEDUCTION_CHANGE" "PAYROLL_SYNC" "PERFORMANCE_TASK" "REQUESTED_DOCUMENT_EXPIRED" "REQUESTED_DOCUMENT_EXPIRING" "TEAM_SURVEY_TASK" "TEAM_SURVEY_TASK_REMINDER" "TIMESHEET_APPROVE" "TIME_OFF_CANCELLED" "TIME_OFF_REQUEST" "TIME_OFF_REQUEST_DECISION" "UNUM_LIMRA_API_FAILURE" "VERICRED_API_FAILURE" "VIDIX_INTEGRATION_ERROR" "VOLUNTARY_COVERAGE_CHANGE" "VOLUNTARY_EOI_SYNC" "WORKFLOW_COMPLETED" "WORKFLOW_TASK" "WORK_SCHEDULE_PUBLISHED"
{
  • "description": "string",
  • "name": "ACA_BENEFIT_COVERAGE_CHANGES_REQUIRED"
}

ObjectCommentSchema

commentText
string

Comment Text

createdAt
string <date-time>

Time when the event occurred or comment was created

updatedAt
string <date-time>

Time of last change for this comment

object (EmployeeBasicFieldsSchema)
{
  • "commentText": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    }
}

PaginationSchema

maxPerPage
integer

Max per page

page
integer

Current page

total
integer

Total count

totalPages
integer

Total pages

{
  • "maxPerPage": 0,
  • "page": 0,
  • "total": 0,
  • "totalPages": 0
}

PayrollScheduleSchema

id
string

Unique ID of this object

name
string

Name

{
  • "id": "string",
  • "name": "string"
}

ReportTimeTrackingEntries

url
string

Report for time tracking entries

{
  • "url": "string"
}

TimeOffBucketTypeSchema

description
string

Description

name
string

Name

Enum: "BEREAVEMENT" "CUSTOM1" "CUSTOM2" "CUSTOM3" "EFMLA" "EPSL" "FLOATING_HOLIDAY" "JURY_DUTY" "LEARNING_AND_DEVELOPMENT" "LEAVE" "NOT_COUNTED" "PERSONAL" "SICK" "VACATION" "VOLUNTEER" "WEATHER"
{
  • "description": "string",
  • "name": "BEREAVEMENT"
}

TimeOffPolicySchema

Array of objects

List buckets for this policy

name
string

Name

{
  • "buckets": [
    ],
  • "name": "string"
}

TimeOffRequestCreateInputSchema

employeeId
required
string

the employee ID, used when creating a new request

bucketType
required
string

the bucket type for the request

Enum: "BEREAVEMENT" "CUSTOM1" "CUSTOM2" "CUSTOM3" "EFMLA" "EPSL" "FLOATING_HOLIDAY" "JURY_DUTY" "LEARNING_AND_DEVELOPMENT" "LEAVE" "NOT_COUNTED" "PERSONAL" "SICK" "VACATION" "VOLUNTEER" "WEATHER"
firstDayHours
required
number <double>

number of hours for the first day, if it's a partial day

lastDayHours
required
number <double>

number of hours for the last day, if it's a partial day

reason
required
string

the reason for the request (pre-defined at the policy level

startDate
required
string

Start date

endDate
required
string

End date

accrualStatus
string

accrual status for the request(required when bucket type is leave)

Enum: "CONTINUE" "PAUSE"
paid
boolean

toggle that says if the EE should be paid or not while on time off(required and used only for leave)

requestNote
string

the employee free form note for the request

{
  • "accrualStatus": "CONTINUE",
  • "bucketType": "BEREAVEMENT",
  • "employeeId": "string",
  • "endDate": "string",
  • "firstDayHours": 0,
  • "lastDayHours": 0,
  • "paid": true,
  • "reason": "string",
  • "requestNote": "string",
  • "startDate": "string"
}

TimeOffRequestDecideInputSchema

approve
required
boolean

Approve time off request?

note
string

Note

{
  • "approve": true,
  • "note": "string"
}

TimeOffRequestSchema

accrualStatus
string

Accrual Status

Enum: "CONTINUE" "PAUSE"
bucketName
string

Bucket name

bucketType
string

Bucket Type

Enum: "BEREAVEMENT" "CUSTOM1" "CUSTOM2" "CUSTOM3" "EFMLA" "EPSL" "FLOATING_HOLIDAY" "JURY_DUTY" "LEARNING_AND_DEVELOPMENT" "LEAVE" "NOT_COUNTED" "PERSONAL" "SICK" "VACATION" "VOLUNTEER" "WEATHER"
createdAt
string <date-time>

When the request was created

decidedAt
string <date-time>

Decided At

object (EmployeeBasicFieldsSchema)
decisionNote
string

Decision Note

decisionStatus
string

Decision Status

Enum: "APPROVED" "CANCELLED" "DENIED" "PENDING"
object (EmployeeBasicFieldsSchema)
endDate
string <date>

End Date

endTime
string

End Time

id
string

Unique ID of this object

paid
boolean

Indicates if the employee will be paid or not while on time off, cannot be null after request is approved

reason
string

Reason

requestNote
string

Request Note

requestedAt
string <date-time>

Requested At

object (EmployeeBasicFieldsSchema)
startDate
string <date>

Start Date

startTime
string

Start Time

object

Time Off Bucket

Array of objects

Hours Per Day

timeZone
string

Time Zone

totalHours
number <double>

Total Hours

updatedAt
string <date-time>

The last time the request was updated

{
  • "accrualStatus": "CONTINUE",
  • "bucketName": "string",
  • "bucketType": "BEREAVEMENT",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "decidedAt": "2019-08-24T14:15:22Z",
  • "decidedBy": {
    },
  • "decisionNote": "string",
  • "decisionStatus": "APPROVED",
  • "employee": {
    },
  • "endDate": "2019-08-24",
  • "endTime": "string",
  • "id": "string",
  • "paid": true,
  • "reason": "string",
  • "requestNote": "string",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "requestedBy": {
    },
  • "startDate": "2019-08-24",
  • "startTime": "string",
  • "timeOffBucket": {
    },
  • "timeOffDays": [
    ],
  • "timeZone": "string",
  • "totalHours": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

TimeOffRequestStatusSchema

description
string

Description

name
string

Name

Enum: "APPROVED" "CANCELLED" "DENIED" "PENDING"
{
  • "description": "string",
  • "name": "APPROVED"
}

TimesheetEntriesCreateInputSchema

startedAt
required
string <date-time>

Time entry start time

entryCategory
required
string

Type of hour entered

Enum: "HOLIDAY" "MEAL_BREAK" "MEAL_BREAK_OVERAGE" "MEAL_BREAK_PENALTY" "REST_BREAK" "REST_BREAK_OVERAGE" "REST_BREAK_PENALTY" "WORK"
employeeNote
string

Employee note

enteredDuration
string <duration>

Length of time entry

jobTitleId
string

ID of job title work was done under

managerNote
string

Manager note

{
  • "employeeNote": "string",
  • "enteredDuration": "string",
  • "entryCategory": "HOLIDAY",
  • "jobTitleId": "string",
  • "managerNote": "string",
  • "startedAt": "2019-08-24T14:15:22Z"
}

TimesheetEntrySchema

object (EmployeeBasicFieldsSchema)
object

The department the employee was in when the entry was created

object

The division the employee was in when the entry was created

duration
string <duration>

Duration of entry (regardless of entry method)

employeeNote
string

Employee note for this entry

endedAt
string <date-time>

Entry end time

entryCategory
string

Entry classification

Enum: "HOLIDAY" "MEAL_BREAK" "MEAL_BREAK_OVERAGE" "MEAL_BREAK_PENALTY" "REST_BREAK" "REST_BREAK_OVERAGE" "REST_BREAK_PENALTY" "WORK"
entryDate
string <date>

Entry date

id
string

Unique ID of this object

object (JobTitleSchema)
object

The location the employee was in when the entry was created

managerNote
string

Manager note for this entry

startedAt
string <date-time>

Entry start time

timeEntryMethod
string

Time entry method

Enum: "CLOCK_IN_OUT" "MANUALLY_ENTERED"
timeEntryType
string

Time entry type

Enum: "DURATION" "START_STOP"
object (TimesheetSchema)
updatedAt
string <date-time>

The last time the time entry was updated

object (EmployeeBasicFieldsSchema)
{
  • "createdBy": {
    },
  • "department": {
    },
  • "division": {
    },
  • "duration": "string",
  • "employeeNote": "string",
  • "endedAt": "2019-08-24T14:15:22Z",
  • "entryCategory": "HOLIDAY",
  • "entryDate": "2019-08-24",
  • "id": "string",
  • "jobTitle": {
    },
  • "location": {
    },
  • "managerNote": "string",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "timeEntryMethod": "CLOCK_IN_OUT",
  • "timeEntryType": "DURATION",
  • "timesheet": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": {
    }
}

TimesheetSchema

approved
boolean

True if the timesheet was approved

approvedAt
string <date-time>

When the timesheet was approved

object (EmployeeBasicFieldsSchema)
createdAt
string <date-time>

The time when the timesheet was created

doubleOvertimeHours
number <double>

Double overtime hours accrued for this timesheet

object (EmployeeBasicFieldsSchema)
holidayHours
number <double>

Holiday hours for this timesheet

id
string

Unique ID of this object

mealBreakHours
number <double>

Meal break hours for this timesheet

overtimeHours
number <double>

Overtime hours accrued for this timesheet

regularHours
number <double>

Regular hours accrued for this timesheet

timeZone
string

The time zone used to calculate overtime for this timesheet

object

The pay period this work occurred in

totalHours
number <double>

Total hours accrued for this timesheet

updatedAt
string <date-time>

The last time the timesheet was updated

{
  • "approved": true,
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "approvedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "doubleOvertimeHours": 0,
  • "employee": {
    },
  • "holidayHours": 0,
  • "id": "string",
  • "mealBreakHours": 0,
  • "overtimeHours": 0,
  • "regularHours": 0,
  • "timeZone": "string",
  • "timesheetPayPeriod": {
    },
  • "totalHours": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

WorkflowFieldBulkUpdateSchema

id
string

Unique ID of this object

Array of objects

All workflow fields

{
  • "id": "string",
  • "workflowFields": [
    ]
}

WorkflowFieldSchema

object

The currency value of field

dateValue
string <date>

The date value of field

displayValue
string

The display value of field

fieldType
string

The type of the field

Enum: "AUTOMATIC_CALCULATION" "CHECKBOX_LIST" "CURRENCY" "DATE" "DROPDOWN" "LONG_TEXT" "NUMBER" "OPINION_SCALE" "RADIO_LIST" "SHORT_TEXT" "UPLOAD" "USER"
identifier
string

The identifier for the field

name
string

The name for the field

numberValue
number <double>

The number value of field

possibleValues
Array of arrays

Possible options for field

object

The section the field is in

stringValues
Array of arrays

The string value of field

textValue
string

The first string value of the array

object

The uploaded file attachment

{
  • "currencyValue": {
    },
  • "dateValue": "2019-08-24",
  • "displayValue": "string",
  • "fieldType": "AUTOMATIC_CALCULATION",
  • "identifier": "string",
  • "name": "string",
  • "numberValue": 0,
  • "possibleValues": [ ],
  • "section": {
    },
  • "stringValues": [ ],
  • "textValue": "string",
  • "uploadValue": {}
}

WorkflowScheduleSchema

frequency
string

Frequency

Enum: "ANNIVERSARY" "BI_WEEKLY" "DAILY" "MONTHLY" "SPECIFIC" "WEEKLY" "YEARLY"
scheduledDate
string <date>

Scheduled date

scheduledDayOfMonth
integer <int64>

Scheduled day of month

scheduledHour
integer <int64>

Scheduled hour

scheduledMinute
integer <int64>

Scheduled minute

scheduledMonth
Array of arrays

Scheduled month

scheduledWeekday
Array of strings

Scheduled weekday

Items Enum: "FRIDAY" "MONDAY" "SATURDAY" "SUNDAY" "THURSDAY" "TUESDAY" "WEDNESDAY"
{
  • "frequency": "ANNIVERSARY",
  • "scheduledDate": "2019-08-24",
  • "scheduledDayOfMonth": 0,
  • "scheduledHour": 0,
  • "scheduledMinute": 0,
  • "scheduledMonth": [ ],
  • "scheduledWeekday": [
    ]
}

WorkflowSchema

id
string

Unique ID of this object

name
string

Workflow name

object (EmployeeBasicFieldsSchema)
templateType
string

The type of the workflow

Enum: "BACKGROUND_CHECK_CHECKR" "DEFAULT" "HIRING_CONTRACTOR" "HIRING_EMPLOYEE" "ONBOARDING_EMPLOYEE" "PERFORMANCE" "PUBLIC" "SURVEY" "SURVEY_PULSE"
Array of objects (WorkflowFieldSchema)

All workflow fields

Array of objects (WorkflowTaskSchema)

List of task/group instances that are the children to this workflow instance, without the groups

{
  • "id": "string",
  • "name": "string",
  • "target": {
    },
  • "templateType": "BACKGROUND_CHECK_CHECKR",
  • "workflowFields": [
    ],
  • "workflowTasks": [
    ]
}

WorkflowStepSchema

id
string

The node interface

name
string

Name of workflow step

order
integer <int64>

Ordered index of this step relative to its parent

{
  • "id": "string",
  • "name": "string",
  • "order": 0
}

WorkflowTaskSchema

Array of objects (ObjectCommentSchema)

The task comments

createdAt
string <date-time>

Time the task was created

dueDate
string <date-time>

Date when this task will be due

id
string

The node interface

name
string

Task name

order
integer <int64>

Ordered index of this step relative to its parent

status
string

Task current status

Enum: "ARCHIVED" "BLOCKED" "CANCELLED" "COMPLETED" "DELETED" "INCOMPLETE" "IN_PROGRESS" "PENDING" "SKIPPED"
object (EmployeeBasicFieldsSchema)
{
  • "comments": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string",
  • "order": 0,
  • "status": "ARCHIVED",
  • "statusUpdatedBy": {
    }
}

WorkflowTemplateFieldSchema

fieldType
string

The type of the field

Enum: "AUTOMATIC_CALCULATION" "CHECKBOX_LIST" "CURRENCY" "DATE" "DROPDOWN" "LONG_TEXT" "NUMBER" "OPINION_SCALE" "RADIO_LIST" "SHORT_TEXT" "UPLOAD" "USER"
id
string

Unique ID of this object

identifier
string

The identifier for the field

name
string

The name for the field

possibleValues
Array of arrays

Possible options for field

object

The section the field is in

{
  • "fieldType": "AUTOMATIC_CALCULATION",
  • "id": "string",
  • "identifier": "string",
  • "name": "string",
  • "possibleValues": [ ],
  • "section": {
    }
}

WorkflowTemplateSchema

createdAt
string <date-time>

Time the template was created

description
string

Describes the workflow purpose

id
string

Unique ID of this object

name
string

Workflow name

Array of objects (WorkflowScheduleSchema)

Schedules to start a workflow

templateType
string

The type of the workflow

Enum: "BACKGROUND_CHECK_CHECKR" "DEFAULT" "HIRING_CONTRACTOR" "HIRING_EMPLOYEE" "ONBOARDING_EMPLOYEE" "PERFORMANCE" "PUBLIC" "SURVEY" "SURVEY_PULSE"
Array of objects (WorkflowTemplateFieldSchema)

All workflow fields

Array of objects (WorkflowStepSchema)

List of task/group instances that are the children to this workflow instance, without the groups

{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "schedules": [
    ],
  • "templateType": "BACKGROUND_CHECK_CHECKR",
  • "workflowFields": [
    ],
  • "workflowTasks": [
    ]
}