Skip to main content

GET /agents/v1/{mpid}/list

Returns all agent records available to the authenticated supplier context.

Request​

Method and path:

  • GET /agents/v1/{mpid}/list

Headers:

  • X-API-KEY (required): string, API key used for tenant authorization.

Path parameters:

  • mpid (required): string supplier MPID.

Request body:

  • None.

Response​

Success:

  • 200 OK
  • Body type: array of AgentSchema
[
  {
    "id": "4d85b3de-3e9c-430b-81d7-d1bb5b552f0a",
    "name": "Example Metering Services Ltd",
    "mpid": "MOP1",
    "dip_id": "DIP-MOP-001",
    "role": "MSA",
    "effective_from": "2026-01-01T00:00:00+00:00"
  }
]

Notes:

  • If no agents exist, the API returns 200 with an empty array.

Full field definitions: