Search terminal actionsBeta

POST

/v2/terminals/actions/search

Retrieves a filtered list of Terminal action requests created by the account making the request.

Terminal action requests are available for 30 days.

Permissions:PAYMENTS_READ

Guide

Search for Terminal action requests

Try in API Explorer

Link to section

Request body

Example code

Link to section

query

Queries terminal actions based on given conditions and sort order. Leaving this unset will return all actions with the default sort order.

Link to section

cursor

string

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See Pagination for more information.

Link to section

limit

integer(32-bit)

Limit the number of results returned for a single request.

Min

Max

100

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Link to section

action

The requested search result of TerminalActions.

Link to section

cursor

string

The pagination cursor to be used in a subsequent request. If empty, this is the final response.

See Pagination for more information.

Link to section

Examples

POST /v2/terminals/actions/search

curl https://connect.squareup.com/v2/terminals/actions/search \
  -X POST \
  -H 'Square-Version: 2023-11-15' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "limit": 2,
    "query": {
      "sort": {
        "sort_order": "DESC"
      },
      "filter": {
        "created_at": {
          "start_at": "2022-04-01T00:00:00.000Z"
        }
      }
    }
  }'

Response JSON

{
  "action": [
    {
      "id": "termapia:oBGWlAats8xWCiCE",
      "device_id": "DEVICE_ID",
      "deadline_duration": "PT5M",
      "status": "IN_PROGRESS",
      "created_at": "2022-04-08T15:14:04.895Z",
      "updated_at": "2022-04-08T15:14:05.446Z",
      "location_id": "LOCATION_ID",
      "type": "SAVE_CARD",
      "app_id": "APP_ID",
      "save_card_options": {
        "customer_id": "CUSTOMER_ID",
        "reference_id": "user-id-1"
      }
    },
    {
      "id": "termapia:K2NY2YSSml3lTiCE",
      "device_id": "DEVICE_ID",
      "deadline_duration": "PT5M",
      "status": "COMPLETED",
      "created_at": "2022-04-08T15:14:01.210Z",
      "updated_at": "2022-04-08T15:14:09.861Z",
      "location_id": "LOCATION_ID",
      "type": "SAVE_CARD",
      "app_id": "APP_ID",
      "save_card_options": {
        "customer_id": "CUSTOMER_ID",
        "card_id": "ccof:CARD_ID",
        "reference_id": "user-id-1"
      }
    }
  ],
  "cursor": "CURSOR"
}