Units list

GET /v1/units

Operation id: v1Units

Description

Paged list of units in the resolved domain. All filters are optional and combinable; when multiple filters are supplied, only units matching all conditions are returned.

Sort order: ascending by unitId or unitName, depending on the domain's unit label format (name first or id first in its primary segment).

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).
`limit`	integer	No	Page size; values below 1 are treated as 1. No upper cap.
`org_level`	integer	No	When present and ≥ 0, returns only units at that org level.
`page`	integer	No	Zero-based page index.
`parent_unit_id`	string	No	Comma-separated parent unit identifiers; a unit matches when its `parentUnitId` is in the list (direct children).
`status`	string	No	Single character only — `O` (open) or `C` (closed). Case-insensitive. Any other value yields 400 with `invalid_status`.
`unit_id`	string	No	Comma-separated unit identifiers; a unit matches when its `unitId` is in the list.

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; each unit object includes at least `unitId`, `orgLevel`, `deptId`, `unitName`, and `unitLevel` (other fields may be present as stored). Paged at the data source; `has_more` is true when another row exists after this page.

Content type: application/json

`400` — Invalid `status` 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; each unit object includes at least `unitId`, `orgLevel`, `deptId`, `unitName`, and `unitLevel` (other fields may be present as stored). 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` — Invalid `status` 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
        }
      }
    }
  }
}