Get Documents List by EmployeeID & Company

get

https://dc1demogwext.paylocity.com/documents/v1/companies/{companyId}/employeeDocuments

Summary Description

This resource allows for looking up documents with additional filters such as employee, upload date, and max number of records to return.

Path Params

companyId

string

required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.
Allowable Values:
9 char max

Query Params

employeeId

string

Allows for an equals comparison to the employeeId field.

uploadedDate

date-time

Allows for an equals comparison to the uploadedDate field. Time portion of the input is ignored.

uploadedDate.lessThanOrEqualTo

date-time

Allows for a Less Than Or Equal (<=) comparison to the uploadedDate field. Time portion of the input is ignored.

uploadedDate.greaterThanOrEqualTo

date-time

Allows for a Greater Than Or Equal (>=) comparison to the uploadedDate field. Time portion of the input is ignored.

includeTotalCount

boolean

Requests that the response include the Pcty-Total-Count header containing the total number of objects that match the request. This may be useful if requesting a small [limit].

limit

int32

Defines the maximum number of items to be returned in the response.

offset

int32

Defines the start location to return. Ex. offset=100 means starting at item 100, return the next [limit] items.

Headers

Authorization

string

required

Authorization token. Ex. Bearer ...

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

Language

Loading…

Response

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

application/json

text/json

200Success

400Bad Request

500Server Error