List Commando Mode transitions set - Marqeta Docs

GET///

Retrieve a list of Commando Mode transitions for a specific control set. This endpoint supports field filtering and pagination.

URL path parameters

Fields	Description
commandomode_token string Required	Unique identifier of the Commando Mode control set. Allowable Values: Existing Commando Mode control set token

URL query parameters

Fields	Description
count integer Optional	Number of Commando Mode control set transitions to retrieve. Allowable Values: 1-10 Default value: 5
start_index integer Optional	Sort order index of the first resource in the returned array. Allowable Values: Any integer Default value: 0
sort_by string Optional	Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. Allowable Values: `createdTime`, `lastModifiedTime`, or any field in the resource model Default value: `-createdTime`

Response body

Fields	Description
count integer Conditionally returned	Number of Commando Mode control set transition objects to retrieve. Allowable Values: 1-10
data array of objects Conditionally returned	Array of Commando Mode control set transition objects. Allowable Values: Valid array of one or more Commando Mode control set transition objects
data[].commando_mode_token string Conditionally returned	Unique identifier of the Commando Mode control set. Allowable Values: Existing Commando Mode control set token
data[].created_time datetime Returned	Date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].name string Conditionally returned	Identifies the user who changed the Commando Mode control set’s state. Allowable Values: 255 char max
data[].token string Conditionally returned	Unique identifier of the Command Mode control set transition object. Allowable Values: Existing Commando Mode control set transition object token
data[].transition object Conditionally returned	Describes the Commando Mode control set’s `current_state` object. Allowable Values: Existing `current_state` object
data[].transition.channel string Returned	Mechanism that changed the Commando Mode control set’s state. Allowable Values: `API`, `SYSTEM`
data[].transition.commando_enabled boolean Returned	Indicates whether Commando Mode is enabled. - If `commando_enabled` is `true` and `COMMANDO_MANUAL` is configured, all transactions are processed via Commando Mode. - If `commando_enabled` is `true` and `COMMANDO_AUTO` is configured, Commando Mode is ready to intervene only when a transaction times out or encounters an error. Allowable Values: `true`, `false`
data[].transition.reason string Conditionally returned	Describes the reason why the current state of the Commando Mode control set was last changed. Allowable Values: 255 char max
data[].transition.username string Conditionally returned	Identifies the user who last changed the Commando Mode control set’s state. Allowable Values: 255 char max
data[].type string Conditionally returned	Specifies the type of event that triggered the Commando Mode transition, such as a `connection_error` or `response_timeout`. Allowable Values: 255 char max
end_index integer Conditionally returned	Sort order index of the last resource in the returned array. Allowable Values: Any integer
is_more boolean Conditionally returned	Value of `true` indicates that more unreturned resources exist. Allowable Values: `true`, `false`
start_index integer Conditionally returned	Sort order index of the first resource in the returned array. Allowable Values: Any integer

Sample response body

JSON

{
  "count": 1,
  "start_index": 0,
  "end_index": 0,
  "is_more": false,
  "data": [
    {
      "token": "commando_mode_1_transition",
      "commando_mode_token": "commando_mode_1",
      "transition": {
        "commando_enabled": true,
        "reason": "Lost connection",
        "channel": "API"
      },
      "user_name": "rhowse",
      "created_time": "2023-02-14T18:48:10Z"
    }
  ]
}