cURL
curl --request GET \ --url https://api.sandbox.goteal.co/users/recurring \ --header 'X-API-KEY: <api-key>'
{ "pagination": { "offset": 75, "limit": 25, "count": 14, "total_count": 89, "ordered_by": "created_at" }, "users": [ { "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "created_at": "2019-05-17T00:00:00.000Z", "name": "John Smith", "email": "john.smith@company.com", "recurring_checks_enabled": true, "recurring_check_frequency": "WEEKLY", "recurring_check_end_date": "2019-05-17T00:00:00.000Z", "payroll_period_months": 123 } ] }
Filter on users that are eligible for recurring checks, and those that are not
The offset to start at
x >= 1
The number of items to return
1 <= x <= 500
OK
The response is of type object.
object