GoDaddy
Support
API ReferenceEmailEmail APIGet a single mailbox by ID GET

Get a single mailbox by ID

View as Markdown

Returns the current state of a single mailbox.

Full description

| Returns the current state of a single mailbox. Poll this endpoint after POST /mailboxes until status reaches COMPLETED or FAILED.

GET
/mailboxes/{mailboxId}

Authorization

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer <token>.

In: header

Path Parameters

mailboxId*string

The mailbox identifier returned from POST /mailboxes.

Formatuuid

Header Parameters

X-Request-Id?string

Optional client-generated request correlation identifier. Propagated across services and echoed in the X-Request-Id response header.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/mailboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "mailboxId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",  "emailAddress": "jane.smith@example.com",  "mailboxType": "TITAN",  "firstName": "Jane",  "lastName": "Smith",  "displayName": "Jane Smith",  "status": "COMPLETED",  "createdAt": "2024-03-15T10:30:00Z",  "updatedAt": "2024-06-01T08:00:00Z",  "links": [    {      "rel": "self",      "href": "/mailboxes/a1b2c3d4-e5f6-7890-abcd-ef1234567890"    }  ]}

Last updated on

How is this guide?