REST API Overview
The ECGrid REST API v2.6 is the active, recommended interface for all new ECGrid integrations. It provides full access to network, mailbox, trading partner, parcel, interchange, and reporting functions over HTTPS using JSON.
Base URL
https://rest.ecgrid.io
Authentication
All endpoints (except GET /v2/auth/version) require authentication via one of two methods:
| Method | Header | Notes |
|---|---|---|
| API Key | X-API-Key: <key> | Recommended for server-to-server integrations |
| Bearer JWT | Authorization: Bearer <token> | Obtained from POST /v2/auth/login |
See Authentication & Session Management for full details.
Request / Response Format
All requests and responses use application/json. Every response is wrapped in a standard envelope:
{
"success": true,
"data": { },
"errorCode": "",
"message": ""
}
| Field | Type | Description |
|---|---|---|
success | boolean | true if the call succeeded; false on error |
data | object | array | null | The response payload |
errorCode | string | Machine-readable error code when success is false |
message | string | Human-readable description of the result or error |
Endpoints by Resource Group
119 total endpoints across 16 resource groups.
| Tag | Count | Description |
|---|---|---|
| Auth | 6 | Login, logout, token refresh, session info, password change, version |
| Networks | 6 | Network profile, contact, configuration, X12 delimiters |
| Mailboxes | 7 | Mailbox CRUD, configuration, X12 delimiters |
| IDs | 13 | ECGrid ID management, trading partner CRUD, VAN routing |
| Partners | 7 | Interconnect (partner) management, notes |
| Parcels | 15 | Upload, download, inbox/outbox lists, confirmation, manifest |
| Interchanges | 8 | Interchange tracking, cancel, resend, manifest |
| Callbacks | 8 | Webhook registration, event queue, testing |
| Carbon Copies | 5 | CC routing rules CRUD |
| Certificates | 5 | AS2/SFTP certificate management |
| Comms | 8 | Communication channel configuration |
| Users | 16 | User CRUD, roles, API keys, password management |
| Keys | 4 | API key lifecycle management |
| Portals | 2 | Portal provisioning |
| Reports | 8 | Usage statistics and traffic reports |
| Status Lists | 1 | Reference lists for status codes and ENUMs |
OpenAPI Specification
The full OpenAPI 3 spec is available at:
- Swagger UI: https://rest.ecgrid.io/swagger/index.html
- Swagger JSON: https://rest.ecgrid.io/swagger/v2/swagger.json