Call Later

List of call later and remind

Changed on

Get list of call later and remind

get/shops/{SHOP_ID}/order_call_laters

Request

  • Base URL
    https://pos.pages.fm/api/v1
  • URL
    https://pos.pages.fm/api/v1/shops/{SHOP_ID}/order_call_laters
  • Auth
    API key in query parameter api_key

Path parameters

SHOP_IDinteger required
Example:4

Shop ID

Query parameters

page_numberinteger

Page number

page_sizeinteger

Page size

key'today' | 'upcoming' | 'overdue' | 'completed'

Quick filter: today (scheduled today), upcoming (scheduled after today), overdue (scheduled before now), completed (successfully processed). Omit this parameter to filter only by the time range. If provided, it is combined with the time filters (AND).

filter_by_timestring

Time filter as a JSON-encoded object. Send as a single query parameter (URL-encode the JSON), not nested query parameters.

  • type: inserted_at (creation time, default), called_at (processed time; excludes unprocessed reminders), or appointment_time (scheduled call time, field needs_call_at).
  • start_time, end_time: integer Unix timestamps in seconds (UTC), both required for the filter to apply. Both bounds are inclusive. Convert the desired local date range to Unix timestamps before sending.
  • editor_ids: array of user IDs, required when filtering by time. Use ["-1"] for all staff. Filters by the last editor for called_at, otherwise by the creator. Examples below cover October 15, 2026, 00:00:00–23:59:59 in UTC+7.
start_needs_callinteger

Inclusive start of the scheduled call time range (needs_call_at), as a Unix timestamp in seconds. Must be sent with end_needs_call. Combined with other filters (AND).

end_needs_callinteger

Inclusive end of the scheduled call time range (needs_call_at), as a Unix timestamp in seconds. Must be sent with start_needs_call.

status-1 | 0 | 3 | 1 | 2 | 7
Example:-1

Status

Response

Success

keystring

Key

page_numberinteger

Page number

page_sizeinteger

Page size

successboolean

Success status

total_entriesinteger

Total entries

total_pagesinteger

Total pages

Changes

    • breaking

      the query request parameter key was restricted to a list of enum values

    • breaking

      for the query request parameter key, default value today was removed

    • info

      added the new optional query request parameter end_needs_call

    • info

      added the new optional query request parameter filter_by_time

    • info

      added the new optional query request parameter start_needs_call

    • info

      added the new enum value completed to the query request parameter key

    • info

      added the new enum value overdue to the query request parameter key

    • info

      added the new enum value today to the query request parameter key

    • info

      added the new enum value upcoming to the query request parameter key