McMain icon

McMain

Interact with McMain API

Hours → Get List

AI-generated

Summary

Retrieve a list of hour records

Inputs

  • returnAll — Whether to return all results or only up to a given limit
  • limit — Maximum number of results to return
  • filters — Collection of filter criteria (e.g., week, employee, hrStatus)
  • requestOptions — Advanced request configuration such as batching, SSL verification, proxy, and timeout

Output shape

a list of hour records

The response is an array; pagination may be handled by the API and optional fields may be omitted.

Examples

Example 1: Get the first 50 hours for a specific employee

limit=50, filters[0].employee='John Doe', returnAll=false

Example 2: Retrieve all available hour records

returnAll=true

Example 3: Process hours in batches of 100 with a 500 ms interval

batchSize=100, batchInterval=500, requestOptions.batchSize=100, requestOptions.batchInterval=500

Discussion