Bulk Job Requests

Get the next scheduled state change for a list of users

This endpoint is used to lookup the next upcoming scheduled state change for each user in the given list. The users parameter is limited to 100 items per request. The results are also limited to 100 items. This endpoint returns a max of 1 event per state per user. For example, if a user has 3 ACTIVATED events scheduled it will return the next upcoming activation event. However, if a user also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next upcoming activation event and the next upcoming suspension event.

get/api/v2/bulk/userstates/eventlist/next

Request

Query parameters

usersstring[] required

A list of system user IDs, limited to 100 items.

limitinteger

The number of records to return at once. Limited to 100.

skipinteger

The offset into the records to return.

Response

OK

events_countinteger

The total number of ACTIVATED and SUSPENDED events to a max depth of 1 for all of the users in the query. A value larger than the limit specified on the query indicates that additional calls are needed, using a skip greater than 0, to retrieve the full set of results.

Changes

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