List all recurring accounts

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": "[email protected]",
      "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"
    }
  ]
}

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": "[email protected]",
      "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

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

Show child attributes

pagination.offset

integer<int32>

default:0

required

The offset to start at - zero based

Required range: x >= 1

Example:

75

pagination.limit

integer<int32>

default:20

required

Required range: 1 <= x <= 100

Example:

25

pagination.count

integer<int32>

required

Required range: x >= 0

Example:

14

pagination.total_count

integer<int32>

Example:

89

accounts

object[]

Show child attributes

accounts.account_id

string

required

The id of the account

Example:

"95a0e70b-fe02-4f47-aef9-2efff279df71"

accounts.payroll_provider

string

required

The payroll provider to use

Example:

"quickbooks"

accounts.user_name

string

required

The login of the user

Example:

"[email protected]"

accounts.created_at

string<date-time>

required

Example:

"2019-05-17T00:00:00.000Z"

accounts.mfa_enabled

boolean

required

Is mfa enabled for this account

accounts.latest_pay_date

string<date-time>

The latest pay date of the payroll under this account

Example:

"2019-05-17T00:00:00.000Z"

accounts.next_recurring_check

string<date-time>

Date of the next recurring check for this account

Example:

"2019-05-17T00:00:00.000Z"

accounts.recurring_check_end_date

string<date-time>

End date of the recurring schedule for this account

Example:

"2019-05-17T00:00:00.000Z"

accounts.recurring_check_frequency

string

Frequency of the recurring check for this account. Available frequencies [WEEKLY, MONTHLY]

Example:

"WEEKLY"

accounts.employee_name

string

Employee name for which this account is linked to

Example:

"Amazon"

List all accounts Get an account

⌘I

API Documentation

Users

User Token

API Keys

Accounts

Entries

Payroll

Documents

Configuration

Webhooks

Members

List all recurring accounts

Authorizations

Query Parameters

Response