Discussions
Become a Partner

Discussions

Ask a Question
Back to All

Is it a defined behavior when "limit" is not included in the API GET endpoints?

almost 3 years ago by [email protected]

I notice each of the endpoints to GET data (such as "/company/employees", "/company/attendances", and "/company/time-offs") supports the query parameter "limit" and in the reference pages, these have a default of "200".

Experimentation has also demonstrated:

  1. The request will fail if this value is over 200.
  2. The request will succeed if the parameter is omitted.

Moreover, when the parameter is omitted, not only does the request succeed, but the response can include more than 700 records.

Is it the defined behaviour to provide all records when this is not included (I'm assuming that is what this is doing)? Can we rely on this behaviour not to change or break later? Or should we always include this parameter for both performance and future proofing?