Employees icon

Employees

1.0.x
(0 reviews)

Use the Payworks Employee API to create, read, or update employees in your organization.

API Information

Employees

  • Version: v1
  • API Base path: /api
  • Protocol: HTTPS

Description

The Payworks Employee API is available to :

  • GET a single employee or list of employees including related details
  • POST to create an employee
  • PUT to update one employee identified by URI parameter completely
  • PATCH to update one employee identified by URI parameter partially

Change Log

VersionEndpointDescription of ChangeDate
1.1employeesAdded homeDepartmentNumber to employment object09-20-2024

Code Examples

Sample cURL snippets for the get list of Employee from the mock server

curl --location --request GET 'https://anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/6f344111-e38f-41ec-a3b6-25455816329d/ca-pw-api-employee-exp/1.0.1/m/employees' \
--header 'payworksApiSession: 98af44d0-f2cd-4a22-9bfc-5966df9c2010' \
--header 'Authorization: Basic ABC123'

Reviews