Get Paperwork Templates

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Gets one or more Paperwork Template(s) by companyID or various filters. This endpoint will return an array of Paperwork Template object(s).

Returns

attribute type description
success boolean Response status
data object Filtered array of Paperwork Template object(s).
errors array Contains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes

paperwork_type

string

enum

Type of paperwork form.

W4W4I9W9CustomPaperwork

Allowed:

W4``I9``W9``CustomPaperwork

worker_type

string

enum

Type of worker the form is applicable to.

EmployeeEmployeeContractorAll

Allowed:

Employee``Contractor``All

jurisdictions

object

Filter for jurisdictions where the form is applicable.

jurisdictionsobject

jurisdiction_type

string

enum

Type of jurisdiction for the form.

WorkLocationWorkLocationResidencyAll

Allowed:

WorkLocation``Residency``All

effective_date

date

Effective date for template retrieval.

archive_date

date

Archive date for template retrieval.

companyID

string

required

Unique identifier for Zeal company

``200 Successful response

``400 Bad Request

Updated 11 months ago


ShellNodeRubyPHPPython


xxxxxxxxxx

curl --request POST \

--url https://api.zeal.com/paperwork/templates \

--header 'accept: application/json' \

--header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200400

Updated 11 months ago