Get current agent

Retrieve the authenticated agent’s own profile, policy, and current usage. This endpoint is called by the agent software itself using its own credentials (obtained via device code redemption) rather than platform credentials.

GET /agents/me

cURL

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/agents/me \
  --header 'Authorization: Bearer <token>'

import LightsparkGrid from '@lightsparkdev/grid';

const client = new LightsparkGrid({
  agentAccessToken: process.env['GRID_AGENT_ACCESS_TOKEN'], // This is the default and can be omitted
});

const agent = await client.agents.me.retrieve();

console.log(agent.id);

package com.lightspark.grid.example

import com.lightspark.grid.client.LightsparkGridClient
import com.lightspark.grid.client.okhttp.LightsparkGridOkHttpClient
import com.lightspark.grid.models.agents.Agent
import com.lightspark.grid.models.agents.me.MeRetrieveParams

fun main() {
    val client: LightsparkGridClient = LightsparkGridOkHttpClient.fromEnv()

    val agent: Agent = client.agents().me().retrieve()
}

200

{
  "id": "Agent:019542f5-b3e7-1d02-0000-000000000001",
  "name": "Payroll Automation Agent",
  "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
  "isPaused": false,
  "isConnected": true,
  "policy": {
    "permissions": [],
    "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,
    "monthlySpend": 750000,
    "dailyResetDate": "2025-07-22",
    "monthlyResetMonth": "2025-08"
  },
  "createdAt": "2025-07-21T17:32:28Z",
  "updatedAt": "2025-07-21T17:32:28Z"
}

{
  "status": 401,
  "message": "<string>",
  "details": {}
}

{
  "status": 500,
  "message": "<string>",
  "details": {}
}

Authorizations

Authorization · string · header · required

Bearer token authentication for agent-scoped endpoints. The token is the accessToken returned when redeeming a device code via POST /agents/device-codes/{code}/redeem. Agent credentials are user-scoped: all requests are automatically bound to the agent's associated customer and subject to the agent's policy.

Response

200

application/json

Successful operation

A programmatic agent with scoped permissions and a spending policy, used to automate payment workflows.

id · string · required

System-generated unique identifier for the agent.

Example:

"Agent:019542f5-b3e7-1d02-0000-000000000001"

name · string · required

Human-readable name for the agent.

Example:

"Payroll Automation Agent"

customerId · string · required

The ID of the customer this agent operates on behalf of.

Example:

"Customer:019542f5-b3e7-1d02-0000-000000000001"

isPaused · boolean · required

Whether the agent is currently paused. Paused agents cannot initiate any actions.

Example:

false

isConnected · boolean · required

Whether the agent has been installed and connected (i.e., its device code has been redeemed).

Example:

true

policy · object · required

Policy governing what an agent can do, how it executes actions, and its spending boundaries.

Show child attributes

usage · object · required

Real-time counters tracking the agent's spending and transaction activity against its policy limits.

Show child attributes

createdAt · string<date-time> · required

Creation timestamp.

Example:

"2025-07-21T17:32:28Z"

updatedAt · string<date-time> · required

Last update timestamp.

Example:

"2025-07-21T17:32:28Z"