ScheduledEventConfigurations

List ScheduledEventConfigurations

Changed on

Retrieve a list of ScheduledEventConfiguration entities

get/organizations/{orgId}/scheduledevents/configurations

Request

Path parameters

orgIdstring required

UUID of the organization

Query parameters

pageSizeinteger

Number of ScheduledEventConfigurations to retrieve per page

nextTokenstring

nextToken for multi page retrievals

idsobject[]

list of UUIDs to retrieve

Response

ListScheduledEventConfigurations 200 response

nextTokenstring

Example response

{
  "data": [
    {
      "name": "10 days after bill due date",
      "entity": "Bill",
      "field": "dueDate",
      "offset": 10
    }
  ]
}

Changes

    • breaking

      for the query request parameter ids, the type of property items/ was specialized from string to object

    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status