Get Punch Detail Data

Summary Description

The Get Punch Detail Data endpoint represents the final step in the process to retrieve punch details for all employees within a company. This endpoint retrieves punch detail results for all employees in a company using the resourceId generated in the previous step of the process. The endpoint returns completed results and supports filtering by relative start and end dates. Responses are paginated and require iteration through all pages to access the full data set.

Use Cases

  • Retrieve all employee punch details for a company after the asynchronous process has finished.
  • Filter punch detail records by relative start and end dates to limit results to a specific time range.
  • Iterate through paginated responses using offset-based pagination to obtain the complete set of punch detail records.
Path Params
string
required

The Paylocity Company ID. This is the unique value provided by Paylocity to each specific Payroll Entity.

uuid
required

The resource ID. This is a unique value attached to each generated company punch detail data set.

Query Params
boolean

When provided and set to true will cause the API to return the X-Pcty-Total-Count header in the response which will be set to the total number of resources available even if only a subset of those were returned. The default is false.

int32
0 to 100

The maximum number of resources to include in the response. The default is 25.

int32
0 to 2147483647

The number of resources to skip when returning paginated results. The default is 0.

string
enum

A comma-separated, xpath-like formatting string that identifies the fields that you want the API to use for sorting the resources when they are returned. Supported sort fields are relativeStart and relativeEnd.

Allowed:
boolean
Defaults to false

A Boolean value that, when set to "true", returns mock data.

Headers
string
required
Defaults to Bearer JWT_GOES_HERE

Authorization token. Ex. Bearer ...

Responses

401

Unauthorized

403

Forbidden

Language
Credentials
Bearer
JWT
Response
Choose an example:
application/json