Semaphor

List tenant users

Returns tenant users across your organization. Filter by tenant, active status, or search by name and email. The response includes a userContext object describing the caller's own permissions.

Two pagination modes are supported — use either limit/offset or page/pageSize, but not both.

GET
/api/management/v1/tenant-users

Authorization

BearerAuth
AuthorizationBearer <token>

A project-scoped access token. Generate one via the Token API with your project ID and project secret.

In: header

Query Parameters

search?string

Case-insensitive filter applied to user name or email.

active?boolean

When true, return only active users. When false, return only deactivated users. Omit to return all.

tenantId?string

Restrict results to users in a specific tenant.

limit?integer

Maximum number of users to return (limit/offset mode).

Default50
Range1 <= value <= 1000
offset?integer

Number of users to skip (limit/offset mode).

Default0
Range0 <= value
page?integer

Zero-based page index. Must be used together with pageSize.

Range0 <= value
pageSize?integer

Number of users per page. Must be used together with page.

Range1 <= value <= 1000

Response Body

application/json

application/json

application/json

application/json

curl -X get "https://semaphor.cloud/api/management/v1/tenant-users"
{
  "users": [
    {
      "id": "string",
      "email": "user@example.com",
      "name": "string",
      "role": "VIEWER",
      "department": "string",
      "isActive": true,
      "tenantId": "string",
      "tenantName": "string",
      "organizationName": "string",
      "type": "tenant",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "userContext": {
    "type": "string",
    "userId": "string",
    "tenantId": "string",
    "organizationId": "string",
    "role": "string",
    "isSuperAdmin": true,
    "permissions": {
      "canShareWithTenants": true,
      "canShareWithOrgUsers": true,
      "canShareWithOtherTenants": true
    }
  }
}
{
  "error": "string",
  "details": "string",
  "code": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string",
  "code": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string",
  "code": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}