Events (Schedules)
Enterprise

List events

Changed on

Gets all client scheduled events.

get/api/v2/events

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/events
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

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

  • f87a90d5a2d0Revision changes
    • breaking

      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

    • info

      for the query request parameter client_id, the format was generalized from uuid to no format

  • 40bf219eced6Revision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      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

    • breaking

      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

    • breaking

      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

    • breaking

      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

    • breaking

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

    • info

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

    • info

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

    • info

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

    • info

      for the query request parameter created_at, the format was generalized from date-time to no format

    • info

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

    • info

      for the query request parameter deleted_at, the format was generalized from date-time to no format

    • info

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

    • info

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

    • info

      for the query request parameter next_scheduled_at, the format was generalized from date-time to no format

    • info

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

    • info

      for the query request parameter updated_at, the format was generalized from date-time to no format