---
title: "Read what is planned for a customer or a payment request"
method: GET
path: "/scheduled_activities"
tags: ["Scheduled Activities"]
---

# Read what is planned for a customer or a payment request

`GET /scheduled_activities`

The plan is a forecast rather than a record. It is recalculated as other activity changes what is needed, so a row is only true as at the moment it is read. While a recalculation is outstanding the plan is a single REASSESS row and nothing else.

## Query parameters

- `entityType` 'INVOICE' | 'PAYMENT_REQUEST' | 'CUSTOMER' | 'SCHEDULE' — The kind of record an activity belongs to.
- `entityId` string — The record to read the plan for, as a UUID. Required, together with entityType.
- `page` integer — Which page to return, counting from one.
- `size` integer — How many rows to return per page. A request for more than the maximum is refused.
- `sort` 'scheduledAt,asc' | 'scheduledAt,desc' | 'scheduledAt' — How to order the page. The direction is optional and defaults to soonest first.

## Response `200`

A page of the plan, soonest first unless another order was asked for. An empty list means nothing is planned.

- ScheduledActivityFeedResponse — A page of the plan. A plan is a sequence of events meant to happen, and it can change.
  - `activities` ScheduledActivityResponse[], required — What is planned, soonest first unless another order was asked for.
    - `id` string, required — This row, for reading the message it would send. Opaque, and only good for as long as the plan is unchanged.
    - `scheduledAt` string, date-time, required — When it is expected to happen.
    - `entityType` 'INVOICE' | 'PAYMENT_REQUEST' | 'CUSTOMER' | 'SCHEDULE', required — The kind of record it is planned against.
    - `entityId` string, uuid, required — The record it is planned against.
    - `type` 'SEND_NOTIFICATION' | 'SEND_CUSTOMER_STATEMENT' | 'SEND_DIRECT_DEBIT_COLLECTION_NOTICE' | 'SEND_CARD_COLLECTION_NOTICE' | 'SEND_MANDATE_REQUEST' | 'SEND_MANDATE_REMINDER' | 'SEND_CARD_REQUEST' | 'SEND_CARD_REMINDER' | 'MAKE_PAYMENT' | 'COLLECT_DIRECT_DEBIT_PAYMENT' | 'COLLECT_CARD_PAYMENT' | 'APPLY_LATE_FEES' | 'PREVIEW_CHARGE_DATE' | 'PREVIEW_PAYOUT_DATE' | 'REASSESS' | 'ACTIVITY_SCHEDULED', required — What is planned.
    - `display` ActivityDisplay, required — The activity as a finished sentence, ready to render.
      - `title` string, required — What happened, in a few words.
      - `summary` string — The detail beneath the title. Absent where the title says everything.
    - `actions` ActivityAction[], required — What can be done about it. Empty where there is nothing to offer.
      - `action` 'PREVIEW_NOTIFICATION', required — What the action does.
      - `method` string, required — The HTTP method to call it with.
      - `href` string, required — The path to call it on.
  - `pagination` Pagination, required — Contains pagination information for a set of results
    - `page` integer — The current page number One-based page index (1..N).
    - `size` integer — The size of the page, i.e., the number of elements per page.
    - `totalPages` integer — The total number of pages available.
    - `totalElements` integer — The total number of elements across all pages.
    - `numberOfElements` integer — The number of elements in the current page.
    - `sort` string — Sorting criteria in the format: property,(asc|desc).

## Other responses

- `400` — The request was refused. errors[].type is SCOPE_REQUIRED when either entityType or entityId is missing, UNSUPPORTED_SCOPE when the kind of record asked for has no plan, INVALID_UUID when entityId is not a UUID, and UNSUPPORTED_SORT when the order names any field but scheduledAt, or a direction other than asc or desc.
- `401` — The request carries no valid credentials.
- `403` — The credentials do not grant permission to read activity.
- `500` — The plan could not be read.

---

[API](https://skmtc.dev/adfin/apis/adfin-api.md) · [All operations](https://skmtc.dev/adfin/apis/adfin-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/adfin/adfin-api/revisions/53d29f0850e0/schema)