LIlight
v1 - Users

List users

Returns a paginated list of users

get/v1/users

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Query parameters

sortstring

Sort string in the format field:direction. To provide multiple sort fields, separate them with commas.

Available directions: asc, desc.

Available fields: firstName, lastName, status, createdAt, updatedAt.

Example:amount:desc,createdAt:asc
filterstring

Filter string in the format field:operator:value. To provide multiple filters, separate them with commas.

Available operators: eq, ne, in, not_in, gt, gte, lt, lte.

  • For in and not_in operators, provide multiple values separated by the pipe character (|).

Available fields: id, userGroupId, companyEntityId, status, email, createdAt, updatedAt, role, assignedRole, accessibleCompanyEntityId.

These fields accept only a subset of the operators: accessibleCompanyEntityId (eq, in).

Example:state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500,vendorId:ne:null
limitinteger
offsetinteger

Number of items to skip before starting to collect the result set. Deprecated, use 'cursor' instead.

cursorstring

The cursor position to start returning results from. To opt-in into cursor-based pagination, provide 0 for the initial request. For subsequent requests, use nextCursor and prevCursor from the previous response to navigate. Cursor values are opaque and should not be constructed manually.

includeRolesboolean

Include each user's roles. When not set, roles is omitted from the response.

includeGroupsboolean

Include each user's groups. When not set, groups is omitted from the response.

includeManagersboolean

Include each user's manager ids. When not set, managerIds is omitted from the response.

Response

default response

hasMoreboolean

Boolean flag indicating if there are more records available

totalinteger nullable

Total number of records (only for offset pagination). This field is not guaranteed to be returned and only available for offset pagination, please do not rely on it and migrate to cursor pagination.

nextCursorstring nullable

Cursor for fetching the next page (only for cursor pagination)

prevCursorstring nullable

Cursor for fetching the previous page (only for cursor pagination)

Changes

No recorded changes to this operation across all 1 revision of this API.