Skip to main content
GET
/
users
List all users.
curl --request GET \
  --url https://api.sandbox.goteal.co/users \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.sandbox.goteal.co/users"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.sandbox.goteal.co/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.goteal.co/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.sandbox.goteal.co/users"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-KEY", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.sandbox.goteal.co/users")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.goteal.co/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "pagination": {
    "offset": 75,
    "limit": 25,
    "count": 14,
    "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,
      "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
    }
  ]
}
{
"errors": [
"The request is missing the required field `name`"
]
}
{
"errors": [
"No X-API-KEY header provided or wrong value"
]
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

offset
integer<int32>
default:0

The offset to start at

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

The number of items to return

Required range: 1 <= x <= 100

Response

OK

pagination
object
users
object[]