pods

Get pod

Retrieve a single pod by its OpenMail ID or your own clientId.

get/v1/pods/{id}

Request

  • Base URL: https://api.openmail.sh
  • URL: https://api.openmail.sh/v1/pods/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Pod ID or your own clientId

Response

Pod details

idstring

OpenMail pod ID

clientIdstring nullable

Your own identifier for the pod, if set.

namestring nullable

Human-readable label, if set.

isDefaultboolean

Whether this is the account's default pod. Every account has exactly one; it is created automatically and cannot be deleted.

createdAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.