Get a list of documents for a company

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

Summary Description

The GET company documents resource will return a list of documents for a specified company ID.

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

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 ...

Responses

401

Unauthorized

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://dc1demogwext.paylocity.com/documents/v1/companies/companyId/companyDocuments \
3
     --header 'accept: application/json'


xxxxxxxxxx
 
1
[
2
  {
3
    "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4
    "companyId": "string",
5
    "displayName": "string",
6
    "receivedDate": "2025-04-01T18:08:22.194Z",
7
    "uploadedDate": "2025-04-01T18:08:22.194Z"
8
  }
9
]

200Success

400Bad Request

500Server Error