List IDs

Returns a paginated list of ECGrid IDs filtered by mailbox, network, and/or status.

Endpoint

POST /v2/ids/list

Request Body

Field	Type	Required	Constraints	Description
mailboxId	integer	No	—	Filter by mailbox ID
networkId	integer	No	—	Filter by network ID
status	string	No	See Status enum	Filter by lifecycle status
pageNo	integer	No	Starts at 1	Page number for pagination
recordsPerPage	integer	No	—	Number of records per page

{
  "mailboxId": 1001,
  "status": "Active",
  "pageNo": 1,
  "recordsPerPage": 25
}

Response

Returns a paginated array of ECGridIDInfo objects.

{
  "success": true,
  "data": [
    {
      "ecGridId": 123456,
      "mailboxId": 1001,
      "networkId": 42,
      "qualifier": "01",
      "id": "PARTNER001",
      "description": "Acme Corp Production",
      "status": "Active",
      "routingGroup": "ProductionA",
      "ediStandard": "X12"
    },
    {
      "ecGridId": 123457,
      "mailboxId": 1001,
      "networkId": 42,
      "qualifier": "ZZ",
      "id": "PARTNER002",
      "description": "Beta Logistics",
      "status": "Active",
      "routingGroup": "ProductionA",
      "ediStandard": "X12"
    }
  ]
}

ENUMs

Status

Value	Description
Development	ID is in development/testing phase
Active	ID is live and routing EDI traffic
Preproduction	ID is staged but not yet live
Suspended	ID is temporarily disabled
Terminated	ID has been permanently deactivated

See Enums reference for complete enum definitions.

Code Examples

cURL

curl -X POST "https://rest.ecgrid.io/v2/ids/list" \
  -H "X-API-Key: $ECGRID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "mailboxId": 1001, "status": "Active", "pageNo": 1, "recordsPerPage": 25 }'

C#

// .NET 10 — list all active ECGrid IDs for a given mailbox, paged
using var client = httpClientFactory.CreateClient("ECGrid");

var request = new
{
    mailboxId = 1001,
    status = "Active",
    pageNo = 1,
    recordsPerPage = 25
};

var response = await client.PostAsJsonAsync(
    "https://rest.ecgrid.io/v2/ids/list", request);
response.EnsureSuccessStatusCode();

var result = await response.Content.ReadFromJsonAsync<ApiResponse<List<ECGridIDInfo>>>();
Console.WriteLine($"Found {result!.Data.Count} ECGrid IDs");

Java

import java.net.URI;
import java.net.http.*;

String apiKey = System.getenv("ECGRID_API_KEY");

String body = "{ \"mailboxId\": 1001, \"status\": \"Active\", \"pageNo\": 1, \"recordsPerPage\": 25 }";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://rest.ecgrid.io/v2/ids/list"))
    .header("X-API-Key", apiKey)
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Node.js

const apiKey = process.env.ECGRID_API_KEY;
const url = 'https://rest.ecgrid.io/v2/ids/list';

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'X-API-Key': apiKey,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ "mailboxId": 1001, "status": "Active", "pageNo": 1, "recordsPerPage": 25 }),
});

const data = await response.json();
console.log(data);

Python

import os, requests

api_key = os.environ["ECGRID_API_KEY"]
headers = {"X-API-Key": api_key}
url = "https://rest.ecgrid.io/v2/ids/list"

response = requests.post(
    url,
    json={ "mailboxId": 1001, "status": "Active", "pageNo": 1, "recordsPerPage": 25 },
    headers=headers,
)

response.raise_for_status()
print(response.json())

See Also

• Get ID
• Find ID
• Create ID