Get member future scheduled actions

GET /api/members/{memberId}/scheduled-actions

Success: 200 OK

Products: Operator (FOH)
Features: Front of House Generic Access (FOHGENERIC)

Overview

Lists the changes already diarised against a member that have not happened yet — a move to a different price level, a change of status, or a transfer to another site. Use it to show a member what is about to change, or to find the id of an action you want to cancel with Delete member scheduled action.

"Future" means from tomorrow onwards: the cut-off is the start of tomorrow in UTC, so an action dated today has already dropped out of this list even if the change has not been applied yet. There is no way to widen the window and no way to see past actions through this endpoint.

A member with nothing scheduled returns 200 and an empty array. An unknown member returns 404.

Endpoint

GET {base_url}/api/members/{memberId}/scheduled-actions

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Name	Type	Required	Description
`memberId`	integer (int32)	Yes	The member whose upcoming changes you want. Must be greater than `0`; `0` and `-999` are rejected with `400`. With a member-scoped token this must be the token's own member.

Sample request

cURL

curl -X GET '{base_url}/api/members/{memberId}/scheduled-actions' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Response fields

Field	Type	Description
`[].id`	integer (int32)	The scheduled action's own id. This is the value you pass as the final path segment to Delete member scheduled action to cancel it.
`[].actionDate`	string (date-time)	The UTC datetime that the action is scheduled for.
`[].actionType`	string	Specifies what will be changed when this Scheduled Action occurs. Either 'PriceLevel', 'Status' or 'Site'.
`[].actionTypeSelection`	string	The id of the price level, status or site the member will be moved to. Which of the three it refers to depends entirely on `actionType`, so read that field first — the same numeric value means different things for different action types. Resolve it against the corresponding configuration endpoint to get a name.
`[].associationType`	string	Specifies the type of any associated details set up for this Scheduled Action. Can only be 'Freeze', or null to indicate no association.

Sample response

200 OK

[
  {
    "id": 12345,
    "actionDate": "2026-08-14T19:00:00Z",
    "actionType": "string",
    "actionTypeSelection": "string",
    "associationType": "string"
  }
]

Errors

Status	Meaning	When
`400`	Bad request	`memberId` is `0` or negative. The body is `{memberId} is an invalid member ID`.
`403`	Forbidden	The token identifies a specific member and `memberId` is not that member. The body is `The given member ID of {memberId} does not belong to the logged in member`.
`404`	Not found	`memberId` does not exist. The body is `MemberId : {memberId} could not be found`. A member with no scheduled actions returns `200` and `[]` instead.
`500`	Internal server error	An unexpected server-side failure. This also covers corrupt reference data — an action whose recorded type is not one of price level, status or site, or an association that is not a freeze, fails the whole call rather than being skipped.

This page as markdown · All pages · llms.txt