Accounts
List all recurring accounts
Accounts
List all recurring accounts
GET
/
accounts
/
recurring
curl --request GET \
--url https://api.sandbox.goteal.co/accounts/recurring \
--header 'X-API-KEY: <api-key>'{
"pagination": {
"offset": 75,
"limit": 25,
"count": 14,
"total_count": 89
},
"accounts": [
{
"account_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
"payroll_provider": "quickbooks",
"user_name": "john.smith@company.com",
"created_at": "2019-05-17T00:00:00.000Z",
"mfa_enabled": true,
"latest_pay_date": "2019-05-17T00:00:00.000Z",
"next_recurring_check": "2019-05-17T00:00:00.000Z",
"recurring_check_end_date": "2019-05-17T00:00:00.000Z",
"recurring_check_frequency": "WEEKLY",
"employee_name": "Amazon"
}
]
}Authorizations
Query Parameters
ID of the user to get accounts for
The offset to start at
Required range:
x > 1The number of items to return
Required range:
1 < x < 1000Response
200
application/json
Successfully retrieved accounts
The id of the account
The payroll provider to use
The login of the user
Is mfa enabled for this account
The latest pay date of the payroll under this account
Date of the next recurring check for this account
End date of the recurring schedule for this account
Frequency of the recurring check for this account. Available frequencies [WEEKLY, MONTHLY]
Employee name for which this account is linked to
curl --request GET \
--url https://api.sandbox.goteal.co/accounts/recurring \
--header 'X-API-KEY: <api-key>'{
"pagination": {
"offset": 75,
"limit": 25,
"count": 14,
"total_count": 89
},
"accounts": [
{
"account_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
"payroll_provider": "quickbooks",
"user_name": "john.smith@company.com",
"created_at": "2019-05-17T00:00:00.000Z",
"mfa_enabled": true,
"latest_pay_date": "2019-05-17T00:00:00.000Z",
"next_recurring_check": "2019-05-17T00:00:00.000Z",
"recurring_check_end_date": "2019-05-17T00:00:00.000Z",
"recurring_check_frequency": "WEEKLY",
"employee_name": "Amazon"
}
]
}