Users

Gets a list of all Users

get/api/v1/users/

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/usnistgov/apis/dioptra-rest-api/docs/api/v1/users/get.ts
A function with typed inputs. Its response is checked against the schema.

searchstring

Search terms for the query (* and ? wildcards).

indexinteger

Starting index of the current page.

pageLengthinteger

Number of results to return per page.

X-Fieldsstring mask

An optional fields mask

Success

indexinteger

Starting index of the current page.

isCompleteboolean

Boolean indicating if more data is available.

totalNumResultsinteger

Total number of results.

firststring

URL to first page in results set.

nextstring

URL to next page in results set.

prevstring

URL to last page in results set.

Oct 28, 2026e1a0ec3a40b2 Revision changes
- breaking
  removed the required property ////// from the response with the status
Sep 30, 20267615a76631a4 Revision changes
- breaking
  the / response's property type changed from object to no type for status
- info
  the response property ////// became required for the status
- info
  the response property ////// became required for the status