Skip to main content




Retrieve a schedule.

Rate limit

Please be aware of the rate limit for this API endpoint:

  • Total limit: Each unique API user is limited to to 60 requests per 60-second window.
  • Per scheduleId limit: Each unique scheduleId is limited to 10 request per 60-second window.

If these limits are exceeded, the server will respond with a HTTP 429 status code, indicating too many requests. Please ensure to manage your requests within these limits to maintain uninterrupted service.


Path Parameters

    apiKey stringrequired

    Possible values: <= 50 characters

    API Key of Connector

    scheduleId stringrequired

    Possible values: <= 32 characters

    ID of the schedule


Schedule response





    Possible values: [false, true]

    errorMessage string

    Error message.

    While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage.

    errorCode int32

    Error code.

    For a complete list of error codes and their meanings, please see the appendix on Error codes.

    adapterMessage stringnullable

    Adapter specific error message, passed verbatim from the upstream Adapter.

    adapterCode stringnullable

    Adapter specific error code, passed verbatim from the upstream Adapter.

    property name* any