List Users

Required permissions: users.read.*

GET /users

List Users

cURL

curl --request GET \
  --url https://{primary_domain}/api/public/v2.0/users \
  --header 'X-Access-Key-Id: <api-key>' \
  --header 'X-Access-Key-Secret: <api-key>'

import requests

url = "https://{primary_domain}/api/public/v2.0/users"

headers = {
    "X-Access-Key-Id": "<api-key>",
    "X-Access-Key-Secret": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Access-Key-Id': '<api-key>', 'X-Access-Key-Secret': '<api-key>'}
};

fetch('https://{primary_domain}/api/public/v2.0/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://{primary_domain}/api/public/v2.0/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-Access-Key-Id: <api-key>",
    "X-Access-Key-Secret: <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://{primary_domain}/api/public/v2.0/users"

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

	req.Header.Add("X-Access-Key-Id", "<api-key>")
	req.Header.Add("X-Access-Key-Secret", "<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://{primary_domain}/api/public/v2.0/users")
  .header("X-Access-Key-Id", "<api-key>")
  .header("X-Access-Key-Secret", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{primary_domain}/api/public/v2.0/users")

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

request = Net::HTTP::Get.new(url)
request["X-Access-Key-Id"] = '<api-key>'
request["X-Access-Key-Secret"] = '<api-key>'

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

200

{
  "message": "<string>",
  "data": [
    {
      "id": 123,
      "department_id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "[e-mail]",
      "timezone": "<string>",
      "work_hours": {
        "sunday": [
          {
            "start": {
              "hour": 12,
              "minute": 30,
              "second": 30
            },
            "end": {
              "hour": 12,
              "minute": 30,
              "second": 30
            }
          }
        ],
        "monday": [
          {
            "start": {
              "hour": 12,
              "minute": 30,
              "second": 30
            },
            "end": {
              "hour": 12,
              "minute": 30,
              "second": 30
            }
          }
        ],
        "tuesday": [
          {
            "start": {
              "hour": 12,
              "minute": 30,
              "second": 30
            },
            "end": {
              "hour": 12,
              "minute": 30,
              "second": 30
            }
          }
        ],
        "wednesday": [
          {
            "start": {
              "hour": 12,
              "minute": 30,
              "second": 30
            },
            "end": {
              "hour": 12,
              "minute": 30,
              "second": 30
            }
          }
        ],
        "thursday": [
          {
            "start": {
              "hour": 12,
              "minute": 30,
              "second": 30
            },
            "end": {
              "hour": 12,
              "minute": 30,
              "second": 30
            }
          }
        ],
        "friday": [
          {
            "start": {
              "hour": 12,
              "minute": 30,
              "second": 30
            },
            "end": {
              "hour": 12,
              "minute": 30,
              "second": 30
            }
          }
        ],
        "saturday": [
          {
            "start": {
              "hour": 12,
              "minute": 30,
              "second": 30
            },
            "end": {
              "hour": 12,
              "minute": 30,
              "second": 30
            }
          }
        ]
      },
      "role": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "avatar_url": "<string>",
      "name": "<string>",
      "department_name": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "current_page": 123,
  "first_page_url": "<string>",
  "from": 123,
  "last_page": 123,
  "last_page_url": "<string>",
  "next_page_url": "<string>",
  "path": "<string>",
  "per_page": 123,
  "prev_page_url": "<string>",
  "to": 123,
  "total": 123
}

{
  "message": "<string>",
  "errors": {
    "attribute": [
      "The {attribute} field is required."
    ]
  }
}

"Invalid or missing access key."

"Too many requests."

"An unexpected error occurred."

Authorizations

X-Access-Key-Id · string · header · required

X-Access-Key-Secret · string · header · required

Query Parameters

page_size · integer

Maximum number of items in a page.

page · integer

Page number of query.

with_trashed · boolean

Whether or not deleted items are included.

order_by · enum<string>

Attribute to order query by.

Available options: id, first_name, last_name, email, status, timezone, role, created_at, updated_at, deleted_at

order_direction · enum<string>

Direction to order query by.

Available options: asc, desc

value · string

Value of attribute to filter query by.

operator · enum<string>

Comparison operator to filter query by.

Available options: Equal, NotEqual, Contains, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, IsNull, NotNull

on · enum<string>

Attribute to filter query by

Available options: id, first_name, last_name, email, status, timezone, role, department, department_id, created_at, updated_at, deleted_at

Response

200

application/json

message · string · required

data · object[] · required

A list of User resource objects.

Show child attributes

current_page · integer · required

Current page number.

first_page_url · string · required

URL to fetch the first page.

from · integer | null · required

last_page · integer · required

Last page number.

last_page_url · string · required

URL to fetch the last page.

next_page_url · string | null · required

URL to fetch the next page.

path · string · required

Current URL.

per_page · integer · required

Number of items per page.

prev_page_url · string | null · required

URL to fetch the next page.

to · integer | null · required

total · integer · required

Total number of items.