Get an Action Attempt

Returns a specified action attempt.

POST /action_attempts/get

JavaScript

Seam SDK

await seam.actionAttempts.get({
  action_attempt_id: "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f",
});

/*
{
  "action_attempt_id": "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f",
  "action_type": "UNLOCK_DOOR",
  "error": null,
  "result": {
    "was_confirmed_by_device": false
  },
  "status": "success"
}
*/

200

{
  "action_attempt": {
    "action_attempt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "action_type": "<string>",
    "result": {},
    "error": {
      "type": "<string>",
      "message": "<string>"
    }
  },
  "ok": true
}

Authorizations

client_sessionpat_with_workspaceconsole_session_with_workspaceapi_keyclient_session_with_customer

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

action_attempt_id · string<uuid> · required

ID of the action attempt that you want to get.

Response

200

application/json

OK

action_attempt · object · required

Represents an asynchronous action. Poll until status is success or error.

Show child attributes

ok · boolean · required