Retrieve an action

import requests
url = "https://api.middesk.com/v1/actions/id"
querystring = {"object_type":"businesses","object_id":"object_id"}
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "type": "add_sources",
  "object_type": "Business",
  "object_id": "b1c2d3e4-5678-90ab-cdef-1234567890ab",
  "created_at": "2026-01-15T12:00:00Z",
  "effects": [
    {
      "operation": "created",
      "diff": null,
      "target": {
        "object": "faa_airmen_certificate",
        "id": "c1d2e3f4-5678-90ab-cdef-1234567890ab"
      }
    }
  ],
  "actors": [
    {
      "actor_type": "account",
      "data": {
        "id": "d1e2f3a4-5678-90ab-cdef-1234567890ab",
        "name": "Example Account"
      }
    }
  ],
  "note": "Adding government verification source",
  "metadata": {
    "key": "value"
  }
}

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Action ID

Query parameters

object_typeenumRequired

Type of object the action belongs to

Allowed values:

object_idstringRequired

ID of the object the action belongs to

Response

action found

idstringformat: "uuid"

typeenum

The action type that was performed

Allowed values:

object_typeenum

The type of object the action was performed on

Allowed values:

object_idstringformat: "uuid"

The ID of the object the action was performed on

created_atdatetime

effectslist of objects

List of effects describing what changed

actorslist of objects

List of actors describing who initiated the action

notestring or null

Optional text note describing the reason for the action

metadatamap from strings to any or null

Additional metadata associated with the action

Authentication

Path parameters

Query parameters

Response

Errors