TextKitDocs

List recurring schedules (at most 100 per account)

Scope: messages:read.

GET/v1/schedules

Responses

  • 200Page of Schedule

    Schedules, newest first

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429Error

    Rate limit or quota exceeded

Response Fields

The body is a page: data (the array), has_more, and next_cursor (null on the last page). Each item in data:

  • idstring

    Example: sch_a1B2c3D4e5F6g7H8.

  • objectschedule
  • tostring
  • fromstring
  • bodystring
  • repeatScheduleRepeat
  • start_datestring (date)

    Nullable.

  • end_datestring (date)

    Nullable.

  • max_occurrencesinteger

    Nullable.

  • categorymarketing, transactional, otp, null

    Nullable.

  • quiet_hoursblock, defer, null

    Nullable.

  • activeboolean
  • statusactive, paused, completed
  • paused_reasonmanual, recipient_opted_out, repeated_failures, sender_unavailable, null

    Nullable.

  • next_run_atstring (date-time)

    The next occurrence (UTC). Null unless active. Nullable.

  • last_run_atstring (date-time)

    Nullable.

  • last_statussent, skipped_opted_out, skipped_missed, deferred, failed, null

    Nullable.

  • last_errorstring

    Why the last occurrence was skipped or failed. Nullable.

  • last_message_idstring

    Nullable.

  • countsobject
  • counts.sentinteger
  • counts.skippedinteger
  • counts.failedinteger
  • testboolean

    Made with a test key: only ever sends in the sandbox.

  • created_atstring (date-time)
  • updated_atstring (date-time)
  • recent_occurrencesarray of object

    Only on GET /schedules/{id}: the last 10 occurrences, newest first.

  • recent_occurrences[].datestring (date)

    The local calendar date of the occurrence.

  • recent_occurrences[].due_atstring (date-time)

    Nullable.

  • recent_occurrences[].statussent, skipped_opted_out, skipped_missed, deferred, failed
  • recent_occurrences[].message_idstring

    Nullable.

  • recent_occurrences[].errorstring

    Nullable.

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429

    Rate limit or quota exceeded