McMain icon

McMain

Interact with McMain API

Hour Type → Get List

AI-generated

Summary

Fetch a list of hour types with optional filtering, pagination, and request settings.

Inputs

  • returnAll — Whether to ignore the Limit and return all results.
  • limit — Maximum number of results to return; ignored if returnAll is true.
  • filters — Collection of filter definitions such as Hour Type ID or Description.
  • requestOptions — Additional request configuration including batching, SSL verification, proxy, and timeout.

Output shape

an array of hour type objects

Results may be paginated and include only fields defined by the API; errors are returned in the response body.

Examples

Example 1: Get all hour types without any limit

Set Return All to true; omit Limit.

Example 2: Retrieve a limited list filtered by hour type ID

Set Limit to 10 and add a filter with name htNmr and value "123".

Example 3: Use custom request options such as a longer timeout

Configure Timeout to 30000 and enable batching with batchSize 50.

Discussion