JUjumpcloud
Bulk Job Requests

List Scheduled Userstate Change Jobs

The endpoint allows you to list scheduled statechange jobs.

Sample Request

curl -X GET "https://console.jumpcloud.com/api/v2/bulk/userstates" \
  -H 'x-api-key: {API_KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'
get/bulk/userstates

Request

Query parameters

limitinteger

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

filterstring[]

A filter to apply to the query.

Filter structure: <field>:<operator>:<value>.

field = Populate with a valid field from an endpoint response.

operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators.

value = Populate with the value you want to search for. Is case sensitive. Supports wild cards.

EX: GET /api/v2/groups?filter=name:eq:Test+Group

skipinteger

The offset into the records to return.

useridstring

The systemuser id to filter by.

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Response

OK

scheduledJobIdstring

The id of the scheduled job that scheduled the state change.

scheduledDatestring

The UTC date and time when the scheduled job will execute.

statestring

The state that the user will be in once the scheduled job executes.

systemUserIdstring

The id of the user that the scheduled job will update.

Changes

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