Directories

Returns a list of users in the specified directory

In addition to the directory table fields, the following user attributes are returned:

  • _status – a string that indicates the user’s status:
    • "Active"
    • "Inactive"
    • "ActivationPending"
    • "ActivationExpired"
    • "Locked"
    • "Suspended"
    • "PasswordExpired"
  • _sign_in_method – a string that indicates the user's method of signing in (for example, "Caspio" or an external SAML identity provider).
  • _2fa_status – a string that indicates the two‑factor authentication state:
    • "Enabled" when the user's 2FA is configured
    • "Disabled" when the user's 2FA is not configured
    • "Unavailable" when 2FA is turned off for the directory

These attributes are available in q.select, q.where, q.groupBy, and q.orderBy.

get/v3/directories/{directoryId}/users

Request

  • Base URL: https://demo.caspio.com/integrations/rest
  • URL: https://demo.caspio.com/integrations/rest/v3/directories/{directoryId}/users
  • Auth: API key in header Authorization

Path parameters

directoryIdstring required

Query parameters

q.selectstring

List of fields separated by comma

q.wherestring

WHERE clause

q.groupBystring

GROUP BY clause

q.orderBystring

ORDER BY clause

q.limitinteger

Maximum number of records returned (skipped when q.pageNumber or q.pageSize is not empty, max = 1000, default = 100)

q.pageNumberinteger

Page number (if q.pageSize is not empty then default = 1)

q.pageSizeinteger

Number of records per page (possible values from 1 to 1000, if q.pageNumber is not empty then default = 25)

q.getPaginationInfoboolean

Return pagination info (default is false)

q.sortFieldstring

Simple field name to sort by (e.g. "LastName"). Converted to an ORDER BY clause. Use orderBy for multi-column or expression-based sorting.

q.sortDescendingboolean

When true, sort in descending order. Default: false.

Response

OK

Resultobject[] nullable

Response result

Changes

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