Apideck Employees API is one of 54 APIs that Apideck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Employees. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
10 operations
across 4 paths,
and defines 96 schemas.
It is described by OpenAPI 3.2.0, at version 10.24.12.
Requests are made against a single base URL, https://unify.apideck.com.
The identity and technical contract details declared by the specification.
Employees 10
An Employee represents an individual within the organization for accounting purposes, including name, department, hire date, and employment status.
GET
/accounting/employees
Apideck List Employees
employeesAll
8 params
→ 200400401402404422default
POST
/accounting/employees
Apideck Create Employee
employeesAdd
4 params
body
→ 201400401402404422default
GET
/accounting/employees/{id}
Apideck Get Employee
employeesOne
6 params
→ 200400401402404422default
PATCH
/accounting/employees/{id}
Apideck Update Employee
employeesUpdate
5 params
body
→ 200400401402404422default
DELETE
/accounting/employees/{id}
Apideck Delete Employee
employeesDelete
5 params
→ 200400401402404422default
GET
/hris/employees
Apideck List Employees
employeesAll
10 params
→ 200400401402404422default
POST
/hris/employees
Apideck Create Employee
employeesAdd
4 params
body
→ 201400401402404422default
GET
/hris/employees/{id}
Apideck Get Employee
employeesOne
8 params
→ 200400401402404422default
PATCH
/hris/employees/{id}
Apideck Update Employee
employeesUpdate
5 params
body
→ 200400401402404422default
DELETE
/hris/employees/{id}
Apideck Delete Employee
employeesDelete
5 params
→ 200400401402404422default
BankCode
stringnull
Bank code assigned by central bank
DeleteAccountingEmployeeResponse
object
7 properties
6 required
UnauthorizedResponse
object
6 properties
DownstreamId
stringnull
The third-party API ID of original entity
Address
object
25 properties
NotFoundResponse
object
6 properties
CreateAccountingEmployeeResponse
object
7 properties
6 required
BankAccount
object
12 properties
UpdateEmployeeResponse
object
7 properties
6 required
DeceasedOn
stringnull
The date the person deceased.
EmployeesFilter
object
11 properties
CompanyId
stringnull
The unique identifier of the company.
Nationality
stringnull
The nationality of the person, represented as a two-letter country code according to ISO 3166-1 alpha-2.
IdOrNull
stringnull
A unique identifier for an object.
PaymentUnit
stringnull
Unit of measurement for employee compensation.
Timezone
stringnull
The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London.
PaymentFrequency
stringnull
Frequency of employee compensation.
FirstName
stringnull
The first name of the person.
LinkedSubsidiary
objectnull
3 properties
GetAccountingEmployeeResponse
object
7 properties
6 required
BankName
stringnull
The name of the bank or financial institution
BankAccountName
stringnull
The name of the bank account
EmploymentStatus
stringnull
The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.
Language
stringnull
language code according to ISO 639-1. For the United States - EN
PhotoUrl
stringnull
The URL of the photo of a person.
WritableId
stringnull
A unique identifier for an object.
AccountingEmployee
object
31 properties
CompanyName
stringnull
The name of the company.
RoutingNumber
stringnull
Bank routing number (US)
SocialLink
object
3 properties
1 required
UnexpectedErrorResponse
object
6 properties
GetEmployeesResponse
object
9 properties
6 required
UpdatedAt
stringnull
The date and time when the object was last updated.
CreateEmployeeResponse
object
7 properties
6 required
SortDirection
string
The direction in which to sort the results
Birthday
stringnull
The date of birth of the person.
Team
objectnull
The team the person is currently in.
2 properties
LinkedLocation
objectnull
4 properties
Pronouns
stringnull
The preferred pronouns of the person.
GetEmployeeResponse
object
7 properties
6 required
Id
string
A unique identifier for an object.
Title
stringnull
The job title of the person.
BankAccountNumber
stringnull
The bank account number
EmployeesSort
object
2 properties
Links
object
Links to navigate to previous or next pages through the API
3 properties
EmployeeCompensation
object
8 properties
Meta
object
Response metadata
2 properties
Country
stringnull
Country code according to ISO 3166-1 alpha-2.
EmployeesOneFilter
object
1 property
CreatedAt
stringnull
The date and time when the object was created.
SocialSecurityNumber
stringnull
A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.
BIC
stringnull
Bank Identifier Code / SWIFT Code
EmployeeNumber
stringnull
An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.
BSBNumber
stringnull
Bank State Branch number (Australia/New Zealand)
PassThroughBody
array
The passthrough property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
DisplayId
stringnull
Id to be displayed.
PaymentRequiredResponse
object
6 properties
Person
object
9 properties
Salutation
stringnull
A formal salutation for the person. For example, 'Mr', 'Mrs'
Gender
stringnull
The gender represents the gender identity of a person.
BranchIdentifier
stringnull
Bank branch identifier
IBAN
stringnull
International Bank Account Number
PassThroughQuery
object
1 property
UpdateAccountingEmployeeResponse
object
7 properties
6 required
UnprocessableResponse
object
6 properties
Currency
stringnull
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO4217).
RowVersion
stringnull
A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
Initials
stringnull
The initials of the person, usually derived from their first, middle, and last names.
CustomMappings
objectnull
When custom mappings are configured on the resource, the result is included here.
BankAccount_2
object
12 properties
LinkedDepartment
objectnull
4 properties
Name
stringnull
The name of the resource.
JobRole
stringnull
The position and responsibilities of the person within the organization.
LinkedTrackingCategories
arraynull
A list of linked tracking categories.
Raw
objectnull
Raw response from the integration when raw=true query param is provided
DeleteEmployeeResponse
object
7 properties
6 required
CustomField
object
4 properties
CreatedBy
stringnull
The user who created the object.
Description
stringnull
A description of the object.
GetAccountingEmployeesResponse
object
9 properties
6 required
LinkedTrackingCategory
objectnull
5 properties
PhoneNumber
object
6 properties
1 required
MiddleName
stringnull
Middle name of the person.
Employee
object
67 properties
EmployeeJob
object
14 properties
Division
stringnull
The division the person is currently in. Usually a collection of departments or teams or regions.
AccountingEmployeesFilter
object
2 properties
UnifiedId
object
A object containing a unique identifier for the resource that was created, updated, or deleted.
1 property
1 required
DeprecatedDepartment
stringnull
The department the person is currently in. [Deprecated](https://developers.apideck.com/changelog) in favor of the dedicated departmentid and departmentname fie…
BadRequestResponse
object
7 properties
UpdatedBy
stringnull
The user who last updated the object.
Email
object
3 properties
1 required
Deleted
booleannull
Flag to indicate if the object is deleted.
LastName
stringnull
The last name of the person.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Apideck publishes across the network.