Lists directory users.
In addition to the directory table fields, the following user attributes are returned:
- _status – user status: 'Active', 'Inactive', 'ActivationPending', 'ActivationExpired', 'Locked', 'Suspended', or 'PasswordExpired'.
- _sign_in_method – authentication provider: e.g. 'Caspio' (native) or an external SAML provider name.
- _2fa_status – two-factor authentication state: 'Enabled', 'Disabled', or 'Unavailable'.
These system attributes can be used in SELECT, WHERE, ORDER BY, and GROUP BY clauses. The underlying table may contain additional fields (e.g., photo, date of birth) that are only accessible through the table records endpoint using the same table name.
Request
- Base URL: https://demo.caspio.com/integrations/rest
- URL: https://demo.caspio.com/integrations/rest/v4/directories/{directoryId}/users
- Auth: API key in header Authorization
Path parameters
The directory identifier (6-character alphanumeric code).
Query parameters
Comma-separated list of field names to return, or "*" for all fields. Supports T-SQL expressions.
SQL Server WHERE clause (omit the WHERE keyword). Prefix string literals with N (e.g., Status=N'Active'). Escape single quotes by doubling: N'O''Brien'.
GROUP BY clause for use with aggregate functions in select.
Sort order clause. Example: "LastName ASC, FirstName DESC".
Maximum number of records to return. Ignored when pageNumber or pageSize is set. Range: 1–1000. Default: 100.
Page number. Default: 1 (when pageSize is set).
Number of records per page. Range: 1–1000. Default: 25 (when pageNumber is set).
Simple field name to sort by (e.g. "LastName"). Converted to an ORDER BY clause. Use orderBy for multi-column or expression-based sorting.
When true, sort in descending order. Default: false.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.