Use this endpoint to retrieve a [paginated](https://developer.apiture.com/docs/concepts/pagination), [sortable](https://developer.apiture.com/docs/concepts/sorting), [filterable](https://developer.apiture.com/docs/concepts/filtering), [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of users. An authenticated user will have access only to their User resource. The [links](https://developer.apiture.com/docs/concepts/links) in the response include collecton pagination links. Each resource in the `_embedded.items` array is a summary representation of a user; use the `getUser` opertion on the summary's `self` link to get the full representation of the user and all available links.
curl -X GET -H "API-Key: [[apiKey]]" "http:///users/users?start=&limit=&sortBy=&filter=&q=&state=&customerId=&occupation="
import { UserApi } from "@apiture/users-client-sdk";
const userApi = new UserApi(configuration);
// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userApi.setAccessToken(accessToken)
// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userApi.setApiKey(apiKey);
var api = new Users.UserApi.getUsers()
var opts = {
'start': 789, // {Long} The zero-based index of the first user in this page. The default, 0, represents the first page of the collection.
'limit': 56, // {Integer} The maximum number of user representations to return in this page.
'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
'state': state_example, // {String} Subset the users collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'customerId': customerId_example, // {String} Subset the users collection to those whose `customerId` matches this value. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'occupation': occupation_example // {String} Subset the users collection to those with this name value. Use `|` to separate multiple values. For example, ?occupation=officeAndAdministrativeSupport will match only items whose occupation is officeAndAdministrativeSupport; ?occupation=officeAndAdministrativeSupport|transportationAndMaterialMoving will match items whose occupation is officeAndAdministrativeSupport or transportationAndMaterialMoving. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
userApi.getUsers(opts, callback);
profiles/read |
Read access to user and contact related resources. |
profiles/write |
Write (update) access to user and contact related resources. |
profiles/delete |
Delete access to user and contact related resources. |
profiles/readPii |
Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope. |
profiles/full |
Full access to user and contact related resources. |
admin/read |
Read access to system configuration. |
admin/write |
Write (update) access to user and contact related resources just for administrative roles. |
admin/delete |
Delete access to system configuration. |
admin/full |
Full access to system configuration. |
Name |
Description |
start |
Long
(int64)
The zero-based index of the first user in this page. The default, 0, represents the first page of the collection.
|
limit |
Integer
(int32)
The maximum number of user representations to return in this page.
|
sortBy |
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
|
filter |
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
q |
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
|
state |
String
Subset the users collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
customerId |
String
Subset the users collection to those whose `customerId` matches this value. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
occupation |
String
Subset the users collection to those with this name value. Use `|` to separate multiple values. For example, ?occupation=officeAndAdministrativeSupport will match only items whose occupation is officeAndAdministrativeSupport; ?occupation=officeAndAdministrativeSupport|transportationAndMaterialMoving will match items whose occupation is officeAndAdministrativeSupport or transportationAndMaterialMoving. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|