API Documentation
Users
User Token
Accounts
Entries
Payroll
curl --request GET \
--url https://api.sandbox.goteal.co/users \
--header 'X-API-KEY: <api-key>'{
"pagination": {
"offset": 75,
"limit": 25,
"count": 14,
"ordered_by": "created_at",
"total_count": 89
},
"users": [
{
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2019-05-17T00:00:00.000Z",
"name": "John Smith",
"email": "[email protected]",
"recurring_checks_enabled": true,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2019-05-17T00:00:00.000Z",
"payroll_period_months": 123
}
]
}List all users
curl --request GET \
--url https://api.sandbox.goteal.co/users \
--header 'X-API-KEY: <api-key>'{
"pagination": {
"offset": 75,
"limit": 25,
"count": 14,
"ordered_by": "created_at",
"total_count": 89
},
"users": [
{
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2019-05-17T00:00:00.000Z",
"name": "John Smith",
"email": "[email protected]",
"recurring_checks_enabled": true,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2019-05-17T00:00:00.000Z",
"payroll_period_months": 123
}
]
}Authorizations
Query Parameters
The field of the user to order by
name, email, created_at "name"
The offset to start at
x >= 1The number of items to return
1 <= x <= 100Response
OK
Show child attributes
Show child attributes
The offset to start at - zero based
x >= 175
1 <= x <= 10025
x >= 014
"created_at"
89
Show child attributes
Show child attributes
Unique identifier for user
Creation time in UTC of the user
"2019-05-17T00:00:00.000Z"
The full name of the user. It doesn't have to be unique for the client.
"John Smith"
The email of the user. The field does not have to be a real email address. It can be the user's identifier in your system.
Determines if recurring checks are enabled for this user. Overrides the same setting if present in client level configuration.
Frequency of the recurring check for this user. Overrides the same setting if present in client level configuration. Available frequencies in production are [WEEKLY, DAILY]. Sandbox allows HOURLY frequency in addition.
"WEEKLY"
End date of the recurring check schedule. Overrides the same setting if present in client level configuration.
"2019-05-17T00:00:00.000Z"
Lookback period of the payroll to search on account creation. Overrides the same setting if present in client level configuration.