Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Company Punch Details

Get Punch Detail Operation

Summary Description

The Get Punch Detail Operation endpoint returns the status of an operation initiated in Step 1 of the punch details retrieval process. It indicates whether the operation is in progress, completed, or failed. This endpoint represents Step 2 in the process for retrieving punch details for all employees within a specified company ID. When the operation completes successfully, punch details can be retrieved in Step 3 using the resourceId from the final segment of the Location URL.

For information about the complete sequence, see the Punch Detail Overview or the Getting Started with Company Punch Details API recipe.

Use Cases

  • Determine whether the operation is in progress, completed, or failed.
  • Retrieve the resourceId after the successful completion of the operation by capturing the end of the location URL.
get/apiHub/time/v2/companies/{companyId}/punchDetailOperations/{operationId}

Path parameters

companyIdstring required

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

operationIdstring uuid required

The operation ID. This is a unique value attached to each company punch detail data job.

Query parameters

testFlagboolean

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

Headers

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Success

status'succeeded' | 'failed' | 'running' | 'pending'

The current status of the operation.

createdstring date-time

The date and time when the operation was created.

lastUpdatedstring date-time

The date and time when the operation was last updated.

locationstring nullable

The URL location where the punch detail data can be retrieved once the operation succeeds.