v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Get paperwork submissions

post/paperwork/submissions

Request body

companyIDstring required

Unique identifier for the company.

Example request

{
  "companyID": "603d0f8f1c4b2a4e28c8f0b4",
  "jurisdiction_filter": {
    "jurisdictions": [
      "CA",
      "TX",
      "NY"
    ]
  },
  "worker_filter": {
    "employeeIDs": [
      "603d0f8f1c4b2a4e28c8f0b4",
      "603d0f8f1c4b2a4e28c8f0b5"
    ]
  }
}

Response

Successful response

successboolean

Indicates if the operation was successful.

Example response

{
  "data": [
    {
      "templateID": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "submissionID": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "submission_date": "2023-06-01T12:00:00Z",
      "worker_type": "Employee",
      "companyID": "603d0f8f1c4b2a4e28c8f0b4",
      "employeeID": "603d0f8f1c4b2a4e28c8f0b4",
      "fields": {
        "field1": "value1",
        "field2": "value2"
      },
      "paperwork_type": "W4",
      "url": "https://zeal.com/submission/12345"
    }
  ]
}