Get ID
Retrieves a single ECGrid ID (Trading Partner ID) by its numeric identifier.
Endpoint
GET /v2/ids/{id}
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The numeric ECGrid ID to retrieve |
Response
Returns an ECGridIDInfo object for the requested ECGrid ID.
{
"success": true,
"data": {
"ecGridId": 123456,
"mailboxId": 1001,
"networkId": 42,
"qualifier": "01",
"id": "PARTNER001",
"description": "Acme Corp Production",
"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 full details on RoutingGroup and EDIStandard.
Code Examples
- cURL
- C#
- Java
- Node.js
- Python
curl -X GET "https://rest.ecgrid.io/v2/ids/$ID" \
-H "X-API-Key: $ECGRID_API_KEY"
// .NET 10 — retrieve an ECGrid ID record by its numeric ID
using var client = httpClientFactory.CreateClient("ECGrid");
var response = await client.GetAsync($"https://rest.ecgrid.io/v2/ids/{ecGridId}");
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadFromJsonAsync<ApiResponse<ECGridIDInfo>>();
Console.WriteLine($"Qualifier: {result!.Data.Qualifier}, ID: {result.Data.Id}");
import java.net.URI;
import java.net.http.*;
String apiKey = System.getenv("ECGRID_API_KEY");
String id = "0"; // replace with actual id
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(String.format("https://rest.ecgrid.io/v2/ids/%s", id)))
.header("X-API-Key", apiKey)
.GET()
.build();
HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
const apiKey = process.env.ECGRID_API_KEY;
const url = `https://rest.ecgrid.io/v2/ids/${id}`;
const response = await fetch(url, {
method: 'GET',
headers: { 'X-API-Key': apiKey },
});
const data = await response.json();
console.log(data);
import os, requests
api_key = os.environ["ECGRID_API_KEY"]
headers = {"X-API-Key": api_key}
id = 0 # replace with actual id
url = f"https://rest.ecgrid.io/v2/ids/{id}"
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.json())