Skip to main content

Get ID

Retrieves a single ECGrid ID (Trading Partner ID) by its numeric identifier.

Endpoint

GET /v2/ids/{id}

Path Parameters

ParameterTypeRequiredDescription
idintegerYesThe 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

ValueDescription
DevelopmentID is in development/testing phase
ActiveID is live and routing EDI traffic
PreproductionID is staged but not yet live
SuspendedID is temporarily disabled
TerminatedID has been permanently deactivated

See Enums reference for full details on RoutingGroup and EDIStandard.

Code Examples

curl -X GET "https://rest.ecgrid.io/v2/ids/$ID" \
-H "X-API-Key: $ECGRID_API_KEY"

See Also