Get Mailbox

Retrieves detailed information for a single ECGrid mailbox by its numeric ID.

Endpoint

GET /v2/mailboxes/{id}

Path Parameters

Parameter	Type	Required	Description
id	integer	Yes	Unique numeric identifier of the mailbox

Response

Returns a MailboxIDInfo object for the requested mailbox.

{
  "success": true,
  "data": {
    "mailboxId": 5001,
    "networkId": 1001,
    "uniqueId": "ACMEMBOX01",
    "companyName": "Acme Mailbox One",
    "status": "Active",
    "created": "2021-06-10T09:00:00Z",
    "modified": "2025-02-14T11:30:00Z"
  },
  "errorCode": null,
  "message": null
}

ENUMs

Status

The status field uses the Status enum. See the full value table in Appendix: ENUMs.

Value	Description
Development	Mailbox is in development/testing
Active	Mailbox is live and operational
Preproduction	Staging state before go-live
Suspended	Temporarily disabled
Terminated	Permanently closed

Code Examples

cURL

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

C#

// .NET 10 — retrieve a mailbox by ID
var mailboxId = 5001;
var request = new HttpRequestMessage(HttpMethod.Get, $"https://rest.ecgrid.io/v2/mailboxes/{mailboxId}");
request.Headers.Add("X-API-Key", configuration["ECGrid:ApiKey"]);

var response = await httpClient.SendAsync(request);
response.EnsureSuccessStatusCode();

var result = await response.Content.ReadFromJsonAsync<ApiResponse<MailboxIdInfo>>();
Console.WriteLine($"Mailbox: {result?.Data?.CompanyName} — Status: {result?.Data?.Status}");

Java

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/mailboxes/%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());

Node.js

const apiKey = process.env.ECGRID_API_KEY;
const url = `https://rest.ecgrid.io/v2/mailboxes/${id}`;

const response = await fetch(url, {
  method: 'GET',
  headers: { 'X-API-Key': apiKey },
});

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}
id = 0  # replace with actual id
url = f"https://rest.ecgrid.io/v2/mailboxes/{id}"

response = requests.get(url, headers=headers)

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

See Also

• List Mailboxes
• Create Mailbox
• Update Mailbox
• Delete Mailbox
• Appendix: ENUMs