Skip to main content
GET /api/v2/storefront/agents/{agentId} Returns detailed information about a single registered agent: capabilities, authentication type, master/customer account flags, account counts, and — for owner PENDING OAUTH agents without tokens — an oauth block with the authorization URL. Use it to decide which authorization flow an agent needs before you call it.

​
Request

curl "https://api.interchange.io/api/v2/storefront/agents/agt_premium_ctv" \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​
Parameters

ParamTypeRequiredNotes
agentIdstringYesAgent identifier (path parameter)

​
Response

{
  "agentId": "agt_premium_ctv",
  "type": "SALES",
  "name": "Premium CTV — Direct",
  "description": "Direct CTV inventory for premium sports and news.",
  "endpointUrl": "https://agent.premium-ctv.example.com/mcp",
  "protocol": "MCP",
  "authenticationType": "OAUTH",
  "requiresOperatorAuth": true,
  "status": "ACTIVE",
  "relationship": "SELF",
  "customerId": 4821,
  "reportingType": "WEBHOOK",
  "reportingPollingCadence": null,
  "customerAccountCount": 2,
  "hasCustomerAccount": true,
  "hasMasterAccount": false,
  "customerAccount": {
    "id": "acct_55",
    "accountIdentifier": "acme-brand-account",
    "status": "ACTIVE",
    "registeredBy": "seller@acme-media.example.com",
    "createdAt": "2026-05-02T09:00:00Z"
  },
  "createdAt": "2026-05-01T12:00:00Z",
  "updatedAt": "2026-05-02T09:00:00Z",
  "oauth": null
}
authenticationType is API_KEY, NO_AUTH, JWT, OAUTH, or BASIC_AUTH. When it is OAUTH and the agent is an owner PENDING agent without tokens, the oauth block carries an authorizationUrl; otherwise start a flow with Start agent OAuth.

​
Errors

  • 404 NOT_FOUND — no agent with that agentId is visible to the authenticated seller.
See Errors for the full error contract.

Agent tasks

All agent operations

List agents

Find the agent ID

Start agent OAuth

Agent-level token flow

Start account OAuth

Per-account token flow