Skip to main content
GET
/
accounts
/
recurring
Returns all recurring accounts for the user
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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.goteal.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
user_id
string
required

ID of the user to get accounts for

​
offset
integer<int32>
default:0

The offset to start at

Required range: x >= 1
​
limit
integer<int32>
default:500

The number of items to return

Required range: 1 <= x <= 1000

Response

Successfully retrieved accounts

​
pagination
object
​
accounts
object[]