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",
"forename": "John",
"surname": "Smith",
"date_of_birth": "2019-05-17T00:00:00.000Z",
"post_codes": [
"SW1A 1AA",
"SW1A 1AB"
],
"payroll_period_months": 123,
"middle_names": "Smith",
"ni_number": "QQ123456C",
"ext_id": "ext-12345",
"recurring_checks_enabled": true,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2019-05-17T00:00:00.000Z",
"payslip_upload_enabled": true,
"payroll_connections_enabled": true
}
]
}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",
"forename": "John",
"surname": "Smith",
"date_of_birth": "2019-05-17T00:00:00.000Z",
"post_codes": [
"SW1A 1AA",
"SW1A 1AB"
],
"payroll_period_months": 123,
"middle_names": "Smith",
"ni_number": "QQ123456C",
"ext_id": "ext-12345",
"recurring_checks_enabled": true,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2019-05-17T00:00:00.000Z",
"payslip_upload_enabled": true,
"payroll_connections_enabled": true
}
]
}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 <= 100