Skip to main content

GET /agents/v1/{mpid}?dip_id=...

Returns one agent record by dip_id.

Request

Method and path:

  • GET /agents/v1/{mpid}?dip_id=DIP-MOP-001

Headers:

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

Path parameters:

  • mpid (required): string supplier MPID.

Query parameters:

  • dip_id (required): string agent DIP ID.

Request body:

  • None.

Response

Success:

  • 200 OK
  • Body type: 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"
}

Behavior note:

  • If no record matches dip_id, the response is 200 OK with an empty array ([]).

Full field definitions: