List users

List users in the same workspace. Administrators & operators with legacyViewAll set to true can see the full list, other users can only see themselves.

GET

/users

Query parameters

Name	Type	Description	Required
page	number	Which page to fetch min: 1, max: 9007199254740991
pageSize	number	Page size to use min: 1, max: 30
role	"ADMIN" | "OPERATOR" | "READ_ONLY_API_KEY"	User role
deviceType	"PSD" | "SOFT_PSD" | "API"	User's device type
status	"ACTIVE" | "INACTIVE"	User status
sortBy	| "name" | "role" | "status" | "createdAt" | "updatedAt"	Sort by attribute
sortOrder	"asc" | "desc"	Sort order
ids	Array<string>	List of user IDs to filter by

Response schema

{

// Current page

page: number;

// Next page or null if there is none

next: number | null;

// Previous page or null if there is none

prev: number | null;

// Max count of items per page

pageSize: number;

// Total count of items

total: number;

// Array of results

results: Array<{

// Internal unique identifier

id: string;

// Legacy internal unique identifier (for retro-compatibility)

legacyId: number;

// If true, user can read all resources on the workspace

legacyViewAll: boolean;

// User's workspace name

workspaceName: string;

// User name

name: string;

// User's device ID (for non-API users)

deviceUserId: string | null;

// User's device type

deviceType: "PSD" | "SOFT_PSD" | "API";

// User role

role: "ADMIN" | "OPERATOR" | "READ_ONLY_API_KEY";

// User public key

pubKey: string;

// User status

status: "ACTIVE" | "INACTIVE";

// Whether the user is suspended

isSuspended: boolean;

// Creation timestamp

createdAt: string;

// Last modification timestamp

updatedAt: string;

}>;

}

Examples

Bash

curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {jwt}" \
  "$API_BASE_URL/users"

Typescript

const url = "<base-url>/users";

const headers = {
  "Content-Type": "application/json",
  Authorization: "Bearer <jwt>"
};

fetch(url, { headers }).then(res => {
  console.log(res)
});

Python

import requests

url = "<base-url>/users"

headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer <jwt>"
}

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