Events (Schedules)
Enterprise

List events

Gets all client scheduled events.

get/api/v2/events

Query parameters

sort_bystring

Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

Sortable columns are next_scheduled_at, id, created_at, updated_at, deleted_at.

idstring

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

rrulestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

next_scheduled_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

client_idstring

Filter results by column string-formatted uuid value. Valid filter predicates are eq, neq.

session_collectionstring

Filter results by column boolean value. Valid filter predicates are eq, neq.

local_group_collectionstring

Filter results by column boolean value. Valid filter predicates are eq, neq.

ad_structure_collectionstring

Filter results by column boolean value. Valid filter predicates are eq, neq.

cert_services_collectionstring

Filter results by column boolean value. Valid filter predicates are eq, neq.

ca_registry_collectionstring

Filter results by column boolean value. Valid filter predicates are eq, neq.

dc_registry_collectionstring

Filter results by column boolean value. Valid filter predicates are eq, neq.

hydrate_domainsboolean

When a value of true is passed, any Domains associated with scheduled and finished jobs for each client will have expanded properties including name and type. When a value of false is passed, these same Domains will only return as a list of objectids.

hydrate_ousboolean

When a value of true is passed, any OUs associated with scheduled and finished jobs for each client will have expanded properties including name and type. When a value of false is passed, these same OUs will only return as a list of objectids.

created_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by created_at value. See filter schema details for valid predicates.

updated_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by updated_at value. See filter schema details for valid predicates.

deleted_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by deleted_at value. See filter schema details for valid predicates.

skipinteger

The number of items to skip in a paginated response.

This query parameter is used for determining the number of objects to skip in pagination.

limitinteger

The limit of results requested by the client.

This query parameter is used for setting an upper limit of objects returned in paginated responses.

Response

OK

countinteger

The total number of results.

skipinteger

The number of items to skip in a paginated response.

limitinteger

The limit of results requested by the client.

Changes

Changed in 5 of the 66 revisions of this API.4747

    • added the pattern ^((eq|neq):)?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ to the query request parameter client_id

      request-parameter-pattern-added

    • for the query request parameter client_id, the type/format was generalized from string/uuid to string/

      request-parameter-type-generalized

  • 40bf219eced61211See the full diff
    • added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter ad_structure_collection

      request-parameter-pattern-added

    • added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter ca_registry_collection

      request-parameter-pattern-added

    • added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter cert_services_collection

      request-parameter-pattern-added

    • added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter dc_registry_collection

      request-parameter-pattern-added

    • added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter local_group_collection

      request-parameter-pattern-added

    • added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter session_collection

      request-parameter-pattern-added

    • added the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ to the query request parameter id

      request-parameter-pattern-added

    • added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter created_at

      request-parameter-pattern-added

    • added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter deleted_at

      request-parameter-pattern-added

    • added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter next_scheduled_at

      request-parameter-pattern-added

    • added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter updated_at

      request-parameter-pattern-added

    • added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter rrule

      request-parameter-pattern-added

    • for the query request parameter ad_structure_collection, the type/format was generalized from boolean/ to string/

      request-parameter-type-generalized

    • for the query request parameter ca_registry_collection, the type/format was generalized from boolean/ to string/

      request-parameter-type-generalized

    • for the query request parameter cert_services_collection, the type/format was generalized from boolean/ to string/

      request-parameter-type-generalized

    • for the query request parameter created_at, the type/format was generalized from string/date-time to string/

      request-parameter-type-generalized

    • for the query request parameter dc_registry_collection, the type/format was generalized from boolean/ to string/

      request-parameter-type-generalized

    • for the query request parameter deleted_at, the type/format was generalized from string/date-time to string/

      request-parameter-type-generalized

    • for the query request parameter id, the type/format was generalized from integer/ to string/

      request-parameter-type-generalized

    • for the query request parameter local_group_collection, the type/format was generalized from boolean/ to string/

      request-parameter-type-generalized

    • for the query request parameter next_scheduled_at, the type/format was generalized from string/date-time to string/

      request-parameter-type-generalized

    • for the query request parameter session_collection, the type/format was generalized from boolean/ to string/

      request-parameter-type-generalized

    • for the query request parameter updated_at, the type/format was generalized from string/date-time to string/

      request-parameter-type-generalized

  • 6aaeba6ecdc51112See the full diff
    • for the query request parameter ad_structure_collection, the type/format was changed from string/ to boolean/

      request-parameter-type-changed

    • for the query request parameter ca_registry_collection, the type/format was changed from string/ to boolean/

      request-parameter-type-changed

    • for the query request parameter cert_services_collection, the type/format was changed from string/ to boolean/

      request-parameter-type-changed

    • for the query request parameter created_at, the type/format was changed from string/ to string/date-time

      request-parameter-type-changed

    • for the query request parameter dc_registry_collection, the type/format was changed from string/ to boolean/

      request-parameter-type-changed

    • for the query request parameter deleted_at, the type/format was changed from string/ to string/date-time

      request-parameter-type-changed

    • for the query request parameter id, the type/format was changed from string/ to integer/

      request-parameter-type-changed

    • for the query request parameter local_group_collection, the type/format was changed from string/ to boolean/

      request-parameter-type-changed

    • for the query request parameter next_scheduled_at, the type/format was changed from string/ to string/date-time

      request-parameter-type-changed

    • for the query request parameter session_collection, the type/format was changed from string/ to boolean/

      request-parameter-type-changed

    • for the query request parameter updated_at, the type/format was changed from string/ to string/date-time

      request-parameter-type-changed

    • removed the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ from the query request parameter ad_structure_collection

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ from the query request parameter ca_registry_collection

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ from the query request parameter cert_services_collection

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ from the query request parameter dc_registry_collection

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ from the query request parameter local_group_collection

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ from the query request parameter session_collection

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ from the query request parameter id

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter created_at

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter deleted_at

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter next_scheduled_at

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter updated_at

      request-parameter-pattern-removed

    • removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter rrule

      request-parameter-pattern-removed

  • 674e0a229e8a1211See the full diff
    • added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter ad_structure_collection

      request-parameter-pattern-added

    • added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter ca_registry_collection

      request-parameter-pattern-added

    • added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter cert_services_collection

      request-parameter-pattern-added

    • added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter dc_registry_collection

      request-parameter-pattern-added

    • added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter local_group_collection

      request-parameter-pattern-added

    • added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter session_collection

      request-parameter-pattern-added

    • added the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ to the query request parameter id

      request-parameter-pattern-added

    • added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter created_at

      request-parameter-pattern-added

    • added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter deleted_at

      request-parameter-pattern-added

    • added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter next_scheduled_at

      request-parameter-pattern-added

    • added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter updated_at

      request-parameter-pattern-added

    • added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter rrule

      request-parameter-pattern-added

    • for the query request parameter ad_structure_collection, the type/format was generalized from boolean/ to string/

      request-parameter-type-generalized

    • for the query request parameter ca_registry_collection, the type/format was generalized from boolean/ to string/

      request-parameter-type-generalized

    • for the query request parameter cert_services_collection, the type/format was generalized from boolean/ to string/

      request-parameter-type-generalized

    • for the query request parameter created_at, the type/format was generalized from string/date-time to string/

      request-parameter-type-generalized

    • for the query request parameter dc_registry_collection, the type/format was generalized from boolean/ to string/

      request-parameter-type-generalized

    • for the query request parameter deleted_at, the type/format was generalized from string/date-time to string/

      request-parameter-type-generalized

    • for the query request parameter id, the type/format was generalized from integer/ to string/

      request-parameter-type-generalized

    • for the query request parameter local_group_collection, the type/format was generalized from boolean/ to string/

      request-parameter-type-generalized

    • for the query request parameter next_scheduled_at, the type/format was generalized from string/date-time to string/

      request-parameter-type-generalized

    • for the query request parameter session_collection, the type/format was generalized from boolean/ to string/

      request-parameter-type-generalized

    • for the query request parameter updated_at, the type/format was generalized from string/date-time to string/

      request-parameter-type-generalized

  • a426ff0abf8f1112See the full diff
    • for the query request parameter ad_structure_collection, the type/format was changed from string/ to boolean/

      request-parameter-type-changed

    • for the query request parameter ca_registry_collection, the type/format was changed from string/ to boolean/

      request-parameter-type-changed

    • for the query request parameter cert_services_collection, the type/format was changed from string/ to boolean/

      request-parameter-type-changed

    • for the query request parameter created_at, the type/format was changed from string/ to string/date-time

      request-parameter-type-changed

    • for the query request parameter dc_registry_collection, the type/format was changed from string/ to boolean/

      request-parameter-type-changed

    • for the query request parameter deleted_at, the type/format was changed from string/ to string/date-time

      request-parameter-type-changed

    • for the query request parameter id, the type/format was changed from string/ to integer/

      request-parameter-type-changed

    • for the query request parameter local_group_collection, the type/format was changed from string/ to boolean/

      request-parameter-type-changed

    • for the query request parameter next_scheduled_at, the type/format was changed from string/ to string/date-time

      request-parameter-type-changed

    • for the query request parameter session_collection, the type/format was changed from string/ to boolean/

      request-parameter-type-changed

    • for the query request parameter updated_at, the type/format was changed from string/ to string/date-time

      request-parameter-type-changed

    • removed the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ from the query request parameter ad_structure_collection

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ from the query request parameter ca_registry_collection

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ from the query request parameter cert_services_collection

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ from the query request parameter dc_registry_collection

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ from the query request parameter local_group_collection

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ from the query request parameter session_collection

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ from the query request parameter id

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter created_at

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter deleted_at

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter next_scheduled_at

      request-parameter-pattern-removed

    • removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter updated_at

      request-parameter-pattern-removed

    • removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter rrule

      request-parameter-pattern-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog