List Users - Serval Documentation

GET

/

v2

/

users

List Users

curl --request GET \
  --url https://public.api.serval.com/v2/users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/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://public.api.serval.com/v2/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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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://public.api.serval.com/v2/users"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/users")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "name": "<string>",
      "role": "USER_ROLE_UNSPECIFIED",
      "avatarUrl": "<string>",
      "createdAt": "2025-01-15T01:30:15.000Z",
      "deactivatedAt": "2025-01-15T01:30:15.000Z",
      "timezone": "<string>",
      "authMethod": "USER_AUTH_METHOD_UNSPECIFIED",
      "locale": "<string>",
      "department": "<string>",
      "jobTitle": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

includeDeactivated

boolean

Whether to include deactivated users in the response.

pageSize

integer<int32>

Maximum number of results to return. Default is 10000, maximum is 10000.

pageToken

string

Token for pagination. Leave empty for the first request.

emails

string[]

Return only the users with these email addresses, matched exactly and case-insensitively. Repeat the parameter to resolve a batch (?emails=a@corp.com&emails=b@corp.com), up to 1000 per request. Addresses that match no user are simply absent from the response. Combines with include_deactivated: a deactivated user matches only when include_deactivated is true.

Response

200 - application/json

Success

data

User · object[]

The list of users.

Show child attributes

nextPageToken

string | null

Token for retrieving the next page of results. Empty if no more results.

List Users

curl --request GET \
  --url https://public.api.serval.com/v2/users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/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://public.api.serval.com/v2/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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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://public.api.serval.com/v2/users"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/users")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "name": "<string>",
      "role": "USER_ROLE_UNSPECIFIED",
      "avatarUrl": "<string>",
      "createdAt": "2025-01-15T01:30:15.000Z",
      "deactivatedAt": "2025-01-15T01:30:15.000Z",
      "timezone": "<string>",
      "authMethod": "USER_AUTH_METHOD_UNSPECIFIED",
      "locale": "<string>",
      "department": "<string>",
      "jobTitle": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}