Skip to main content
GET
/
automations
Get all automations
curl --request GET \
  --url https://{host}/automations \
  --header 'Authorization: Bearer <token>' \
  --header 'x-user-id: <x-user-id>'
{
  "data": [
    {
      "id": "7501d8537fb3fc001234abcd",
      "category": "TopUpAutomation",
      "status": "Active",
      "frequency": "monthly",
      "dayOfMonth": 15,
      "currency": "EUR",
      "amount": 100,
      "allocationMethod": "holdings",
      "mandate": {
        "id": "7501d8537fb3fc001234efgh",
        "status": "Active",
        "bankAccountId": "7501d8537fb3fc001234ijkl"
      }
    },
    {
      "id": "7501d8537fb3fc001234mnop",
      "category": "SavingsTopUpAutomation",
      "status": "Active",
      "frequency": "monthly",
      "dayOfMonth": 1,
      "currency": "EUR",
      "amount": 50,
      "savingsProduct": "mmf_dist_eur",
      "mandate": {
        "id": "7501d8537fb3fc001234qrst",
        "status": "Active",
        "bankAccountId": "7501d8537fb3fc001234ijkl"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Auth0-issued access token that includes the scopes listed for the endpoint.

Headers

​
x-user-id
string
required

User identifier for the M2M client to specify which user's data to access.

Pattern: ^[a-f0-9]{24}$

Response

List of automations retrieved successfully

​
data
object[]