Users list

GET /v1/users

Operation id: v1Users

Description

Paged list of users in the resolved domain. At least one of unit_id (from query or the token's current unit), profile_id, or dept_id must resolve to a value — otherwise 400.

Closed units are excluded from results. Record order follows the domain's userSortOrder configuration.

Tags: Kernel NextGen APIs

Parameters

Query parameters

Name	Type	Required	Description
`auth_token`	string	No	Authentication token (alternative to `x-reflexis-auth-token-x` header).
`dept_id`	string	No	Comma-separated department identifiers; a user matches when at least one of its departments is in the list.
`include_line_of_sight`	string	No	When on and `unit_id` is supplied, includes users in the unit's line-of-sight hierarchy (the unit and all its descendants). When off, only users whose primary unit equals `unit_id` are included. Accepted on values (case-insensitive): `true`, `1`, `y`, `yes`, `enabled`. Any other non-empty value is treated as off.
`limit`	integer	No	Page size; values below 1 are treated as 1. No upper cap.
`page`	integer	No	Zero-based page index.
`profile_id`	string	No	Comma-separated profile identifiers; a user matches when at least one of its profiles is in the list.
`unit_id`	string	No	Restrict results to this unit. When omitted, the authenticated caller's current unit is used if available.
`user_name`	string	No	Case-insensitive substring / regex match on `userName`.

Header parameters

Name	Type	Required	Description
`x-reflexis-auth-token-x`	string	No	Authentication token (or use auth_token query param)
`x-reflexis-domain-x`	string	No	Domain id string; optional — defaults to token domain

Responses

`200` — OK — list envelope; user rows matching the filter. Paged at the data source; `has_more` is true when another row exists after this page.

Content type: application/json

`400` — Neither `unit_id` (from query or token), `profile_id`, nor `dept_id` resolves to a value — flat error body (not list envelope).

Content type: application/json

`401` — Authentication failed. The request is missing a token, the token is invalid, or the token has expired.

Content type: application/json

Response models

`200` — OK — list envelope; user rows matching the filter. Paged at the data source; `has_more` is true when another row exists after this page.

Content type: application/json

Schema

List envelope — object list, url, data array, has_more, optional next_cursor, fetched_at

Property	Type	Required	Description
`object`	string	No
`url`	string	No
`data`	array	No
`has_more`	boolean	No
`next_cursor`	string, nullable	No
`fetched_at`	string (date-time)	No

{
  "type": "object",
  "description": "List envelope — `object` list, `url`, `data` array, `has_more`, optional `next_cursor`, `fetched_at`",
  "properties": {
    "object": {
      "type": "string",
      "example": "list"
    },
    "url": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {}
    },
    "has_more": {
      "type": "boolean"
    },
    "next_cursor": {
      "type": "string",
      "nullable": true
    },
    "fetched_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

`400` — Neither `unit_id` (from query or token), `profile_id`, nor `dept_id` resolves to a value — flat error body (not list envelope).

Content type: application/json

Schema

Validation / client error returned for some 400 responses (not wrapped in the list/single envelope).

Property	Type	Required	Description
`type`	string	No
`code`	string	No
`message`	string	No
`param`	string, nullable	No

{
  "type": "object",
  "description": "Validation / client error returned for some 400 responses (not wrapped in the list/single envelope).\n",
  "properties": {
    "type": {
      "type": "string",
      "example": "invalid_request"
    },
    "code": {
      "type": "string",
      "example": "unit_id_required"
    },
    "message": {
      "type": "string"
    },
    "param": {
      "type": "string",
      "nullable": true
    }
  }
}

`401` — Authentication failed. The request is missing a token, the token is invalid, or the token has expired.

Content type: application/json

Schema

Structured error envelope returned by external gateway endpoints (/v1/api/*). Wraps a single error object with type, code, human-readable message, the offending param (when applicable), and an optional documentation URL.

Property	Type	Required	Description
`error`	object	No

{
  "type": "object",
  "description": "Structured error envelope returned by external gateway endpoints (`/v1/api/*`).\nWraps a single `error` object with `type`, `code`, human-readable `message`, the offending\n`param` (when applicable), and an optional documentation URL.\n",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "High-level error category (for example `unauthorized`, `invalid_parameter`, `validation_error`).",
          "example": "invalid_parameter"
        },
        "code": {
          "type": "string",
          "description": "Machine-readable error code; clients should branch on this rather than `message`.",
          "example": "invalid_parameter"
        },
        "message": {
          "type": "string",
          "description": "Human-readable description of the error.",
          "example": "One or more request parameters are invalid."
        },
        "param": {
          "type": "string",
          "description": "Name of the request parameter or field that caused the error, when applicable.",
          "example": "page_number",
          "nullable": true
        },
        "doc_url": {
          "type": "string",
          "description": "Optional URL to documentation describing the error.",
          "example": "https://{APP_URL}/kernel/errors/invalid_parameter",
          "nullable": true
        }
      }
    }
  }
}