api-keys

Returns metadata about the API key that authenticated the request.

get/api/keys/me

Request

  • Base URL: https://api.pricklymails.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pricklymails.com/api/keys/me
  • Auth: HTTP bearer

Response

Metadata for the authenticating key.

enabled_checksstring[] required

Verification checks enabled for the key, for example "syntax", "mx" or "smtp".

environmentstring required

Environment of the key, matching its prefix: "live" or "test".

is_activeboolean required

Whether the key is currently active (not revoked, not expired).

namestring required

Display name of the key.

prefixstring required

Visible prefix (for example pm_live_abc12345).

scopesstring[] required

Scopes granted to the key, for example "email:verify:single".

uuidstring required

Public UUID of the API key.

Changes

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