Agent Management

List agents

Changed on

Retrieve a paginated list of agents for the authenticated platform.

get/agents

Request

  • Base URL: https://api.lightspark.com/grid/2025-10-13
  • URL: https://api.lightspark.com/grid/2025-10-13/agents
  • Auth: HTTP basic

Query parameters

customerIdstring

Filter by customer ID

isPausedboolean

Filter by paused status

isConnectedboolean

Filter by connection status (whether the device code has been redeemed)

createdAfterstring date-time

Filter agents created after this timestamp (inclusive)

createdBeforestring date-time

Filter agents created before this timestamp (inclusive)

updatedAfterstring date-time

Filter agents updated after this timestamp (inclusive)

updatedBeforestring date-time

Filter agents updated before this timestamp (inclusive)

limitinteger

Maximum number of results to return (default 20, max 100)

cursorstring

Cursor for pagination (returned from previous request)

Response

Successful operation

hasMoreboolean required

Indicates if more results are available beyond this page.

nextCursorstring

Cursor to retrieve the next page of results (only present if hasMore is true).

totalCountinteger

Total number of agents matching the criteria (excluding pagination).

Example response

{
  "data": [
    {
      "id": "Agent:019542f5-b3e7-1d02-0000-000000000001",
      "name": "Payroll Automation Agent",
      "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "isConnected": true,
      "policy": {
        "spendingLimits": {
          "currency": "USD",
          "perTransactionLimit": 50000,
          "dailyLimit": 500000,
          "dailyTransactionLimit": 10,
          "monthlyLimit": 5000000
        },
        "accountRestrictions": {
          "allowedAccountIds": [
            "Account:019542f5-b3e7-1d02-0000-000000000001"
          ],
          "accountRules": [
            {
              "accountId": "Account:019542f5-b3e7-1d02-0000-000000000001",
              "perTransactionLimit": 10000
            }
          ]
        },
        "approvalThresholds": {
          "currency": "USD",
          "amount": 100000
        }
      },
      "usage": {
        "dailyTransactionCount": 3,
        "dailySpend": 150000,
        "dailyResetDate": "2025-07-22",
        "monthlySpend": 750000,
        "monthlyResetMonth": "2025-08"
      },
      "createdAt": "2025-07-21T17:32:28Z",
      "updatedAt": "2025-07-21T17:32:28Z"
    }
  ]
}

Changes

  • 3966e5d38aadRevision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      added the new INSUFFICIENT_FUNDS enum value to the response property for the response status

    • warning

      added the new QUOTE_EXPIRED enum value to the response property for the response status

    • warning

      added the new QUOTE_RATE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new STABLECOIN_AMOUNT_NOT_REPRESENTABLE enum value to the response property for the response status

    • warning

      added the new STABLECOIN_BURN_SOURCE_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_EXTERNAL_ACCOUNT_LINK_FAILED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_EXTERNAL_ACCOUNT_LINK_METHOD_REQUIRED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_EXTERNAL_ACCOUNT_NOT_LINKED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_EXTERNAL_ACCOUNT_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_EXTERNAL_ACCOUNT_PROVIDER_LINK_FAILED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_EXTERNAL_ACCOUNT_PROVIDER_LINK_REQUIRED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_GRID_OPERATIONS_NOT_ENABLED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_NOT_PROVISIONED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_OPERATION_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_PROVIDER_ERROR enum value to the response property for the response status

    • warning

      added the new STABLECOIN_PROVIDER_SOURCE_NOT_LINKED enum value to the response property for the response status

    • warning

      added the new STABLECOIN_VERIFICATION_FAILED enum value to the response property for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 8964d9c7b6f9Revision changes
    • info

      removed the CREATE_TRANSFERS enum value from the //// response property for the response status