Skip to main content
GET
List users

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Query Parameters

includeDeactivated
boolean
default:false

Include deactivated users in the response. Defaults to false.

teamIds
string[]

Only return users who are a member of at least one of the given teams. Comma-separated list of team IDs. Combined with roleIds, both conditions must match.

Required array length: 1 - 100 elements
Minimum string length: 1
roleIds
string[]

Only return users who hold at least one of the given organization-wide roles. Team-scoped role assignments are not matched. Comma-separated list of role IDs. Combined with teamIds, both conditions must match.

Required array length: 1 - 100 elements
Minimum string length: 1

Response

Successfully retrieved the list of users.

users
object[]
required