v51

OpenAPI 3.0.3Apache-2.0raw.githubusercontent.com2026-08-01276140748.5 KB
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.