List all scheduled events

Request

query Parameters

eventTypeName	string The name of the scheduled event. Should be specified in the pattern: ^[A-Za-z]{1,}[\w\-]*$
apiObject	string The base object that the scheduled event is defined upon. Should be specified in the pattern: ^[A-Z][\w\-]*$
apiField	string The base field of the base object in the `apiObject` field. Should be specified in the pattern: ^[A-Z][\w\-]*$
active	boolean Indicate whether the scheduled event is active or inactive.
start	integer >= 0 Default: 0 The first index of the query result. Default to 0 if absent, and the minimum is 0.
limit	integer >= 1 Default: 10 The maximum number of data records to be returned. Default to 10 if absent.

header Parameters

Accept-Encoding	string Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
Content-Encoding	string Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
Authorization required	string The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
Zuora-Entity-Ids	string An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.
Zuora-Org-Ids	string Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
Zuora-Track-Id	string <= 64 characters A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).

Responses

200

400

Bad Request

500

Server Error

get/events/scheduled-events

Request samples

cURL

Response samples

application/json

{"data": [{"active": true,
"apiField": "TermEndDate",
"apiObject": "Subscription",
"condition": "Subscription.Status == _SUBSCRIPTION_STATUS",
"cronExpression": "0 30 10 ? * *",
"description": "Trigger a scheduled event at 10:30 AM based on TermEndDate of subscription objects.",
"displayName": "Term End Date Scheduled Event",
"id": "d306545b74e445e4bffcf1c7609804be",
"name": "TermEndDateScheduledEvent",
"namespace": "user.notification",
"parameters": {"_SUBSCRIPTION_STATUS": {"description": "The status of the subscription",
"displayName": "Subscription Status",
"options": ["Draft",
"Active",
"Pending",
"Expired",
"Cancelled"
],
"valueType": "STRING"
}
}
}
],
"next": "/events/scheduled-events?start=10&limit=10"
}