Zur Dokumentation springen
API

API-Schlüssel

Jede Operation in dieser Gruppe: was sie annimmt, was sie zurückgibt und mit welchen Fehlern sie antworten kann.

Operationen

The keys of the workspace, their request log and their activity: the Settings, API keys page of the app. Reading needs keys:read; creating, changing, rotating, switching, revoking and deleting need keys:manage, a scope no key holds unless somebody gave it one. Step-up verification, which the app asks for before it mints or rotates a key, cannot apply to a call made with a key, so treat keys:manage as a credential that can make credentials: give it only to automation that provisions keys, narrow that key to the send scope and role it needs, and give it an expiry. A key never makes or reaches a key wider than itself.

GET/keys

List API keys

Geltungsbereichekeys:readLiest

Every key in the workspace, newest first, a page at a time, with its status, scopes, role, send scope, when it was last used and who made and last changed it. Revoked and expired keys stay listed until somebody deletes them. No secret is ever returned here.

A key never makes or reaches a key wider than itself. What it creates, changes, rotates, switches, revokes or deletes has to sit inside it on every axis: scopes the caller holds (after its own role has narrowed them), the same role when the caller has one, an expiry no later than the caller's when the caller expires, the caller's mode, and a send scope inside the caller's own, where holding one address never covers its whole domain. A key narrowed to some domains or addresses also only SEES the keys whose send scope sits inside its own; any other is a 404. Over OAuth only the workspace owner reaches these calls, and a member's token is refused with owner_only.

Requires the keys:read scope.

Query-Parameter

limitinteger

Rows per page, 1 to 100.

Mindestens 1Höchstens 100Standard25
cursorstring

The previous page's nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400 invalid_cursor.

Rückgabe

A page of keys.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
keys.list()keys.listAll()keys.iterate()
CLI
openemail keys list
MCP
listApiKeys

POST/keys

Create an API key

Geltungsbereichekeys:manageÄndert Daten

Mints a live key and returns its secret in token, once. Nothing recovers it afterwards, so store it before doing anything else.

Left out, scopes is emails:send, the role is the caller's own (or none), the send scope is the caller's own (or none, which means every address the workspace owns), and the expiry is the caller's (or none). The workspace cap on live keys applies, as a 422 workspace_limit_reached. The new key is attributed to the key that made it in the activity log, and it can make keys of its own only if it was given keys:manage.

A key never makes or reaches a key wider than itself. What it creates, changes, rotates, switches, revokes or deletes has to sit inside it on every axis: scopes the caller holds (after its own role has narrowed them), the same role when the caller has one, an expiry no later than the caller's when the caller expires, the caller's mode, and a send scope inside the caller's own, where holding one address never covers its whole domain. A key narrowed to some domains or addresses also only SEES the keys whose send scope sits inside its own; any other is a 404. Over OAuth only the workspace owner reaches these calls, and a member's token is refused with owner_only.

Requires the keys:manage scope.

Request-Body

namestringErforderlich

A name, 1 to 60 characters.

1 bis 60 Zeichen
scopesstring[]

The scopes the key holds. Left out, emails:send. Each one has to be held by the caller.

Mindestens ein EintragEiner von"emails:send""emails:read""drafts:read""drafts:write""threads:read""threads:write""files:read""files:write""labels:read""labels:write""contacts:read""contacts:write""audiences:read""audiences:write""calendar:read""calendar:write""templates:read""templates:write""domains:read""domains:write""webhooks:read""webhooks:write""rules:read""rules:write""connections:read""members:read""members:write""roles:read""roles:write""settings:read""settings:write""keys:write""keys:read""keys:manage""forms:read""forms:write""billing:read""billing:write""account:read""account:write"Standard["emails:send"]
roleIdstring

A role to cap the key. Left out, the caller's own role, or none. A caller with a role can only give its own.

Kann null sein1 bis 64 Zeichen
addressAllowliststring[]

Single addresses the key may send as. Left out together with domainAllowlist, the caller's own send scope.

Bis zu 50 Einträge
domainAllowliststring[]

Whole domains the key may send as, including addresses added to them later.

Bis zu 25 Einträge
expiresInMinutesinteger

Minutes until the key expires, 5 to 5,256,000 (ten years). Left out, the caller's own expiry, or none.

Mindestens 5Höchstens 5256000

Rückgabe

201object

The key, with its secret.

objectstring
Einer von"api_key"
idstring

24 hex characters, the part of the token after oe_live_.

namestring
modestring
Einer von"live""test"
maskedKeystring

Enough of the token to tell two keys apart, such as oe_live_4c1b…kX7a.

keyLast4string
statusstring
Einer von"revoked""expired""inactive""active"
scopesstring[]
Einer von"emails:send""emails:read""drafts:read""drafts:write""threads:read""threads:write""files:read""files:write""labels:read""labels:write""contacts:read""contacts:write""audiences:read""audiences:write""calendar:read""calendar:write""templates:read""templates:write""domains:read""domains:write""webhooks:read""webhooks:write""rules:read""rules:write""connections:read""members:read""members:write""roles:read""roles:write""settings:read""settings:write""keys:write""keys:read""keys:manage""forms:read""forms:write""billing:read""billing:write""account:read""account:write"
roleIdstring

The role that caps the key, if any.

Kann null sein
roleNamestring
Kann null sein
addressAllowliststring[]
Kann null sein
domainAllowliststring[]
Kann null sein
expiresAtstring
Kann null seinFormatdate-time
lastUsedAtstring
Kann null seinFormatdate-time
totalUsesinteger

Calls the key has made, leaving out the ones refused before it authenticated.

rotatedAtstring
Kann null seinFormatdate-time
rotationCountinteger
deactivatedAtstring
Kann null seinFormatdate-time
revokedAtstring
Kann null seinFormatdate-time
revokedReasonstring
Kann null sein
createdAtstring
Formatdate-time
createdByAuditActor
updatedAtstring
Formatdate-time
updatedByAuditActor
lastChangeAtstring
Kann null seinFormatdate-time
lastChangeTypestring
Kann null sein
tokenstring

The whole secret, oe_live_…, shown this once.

Fehler

403

insufficient_scope: the caller lacks keys:manage. beyond_caller_authority: the key asked for would be wider than the caller, and param names the axis (scopes, roleId, mode, expiresInMinutes or addressAllowlist). owner_only: a member's OAuth token.

422

invalid_parameter or unknown_parameter on a field, role_not_found on roleId, a domain or address the workspace does not own, or workspace_limit_reached.

Die Fehler, die jede Operation zurückgeben kann400401404500Fehlerkatalog

Auch verfügbar über

SDK
keys.create()
CLI
openemail keys create

GET/keys/requests

List the request log

Geltungsbereichekeys:readLiest

Every authenticated call the workspace's keys made, newest first, the Requests tab of the app: method, path, status, error code, duration, IP and user agent, never a body or a query string. Calls refused before a key could be identified are not in it, and neither are calls made with an OAuth access token. Nothing is pruned. keyIds, failedOnly, since and until are the filters the app offers.

A narrowed key reads only the log of the keys it can see.

Requires the keys:read scope.

Query-Parameter

keyIdsstring

Comma-separated key ids, at most 50. Left out, every key in the workspace.

failedOnlyboolean

Only calls answered with a status of 400 or more.

Standardfalse
sincestring

Only rows at or after this instant, ISO 8601. One that does not parse is a 400 invalid_parameter.

Formatdate-time
untilstring

Only rows before this instant. It has to be later than since.

Formatdate-time
limitinteger

Rows per page, 1 to 100.

Mindestens 1Höchstens 100Standard25
cursorstring

The previous page's nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400 invalid_cursor.

Rückgabe

A page of calls, newest first.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
keys.listWorkspaceRequests()keys.listAllWorkspaceRequests()keys.iterateWorkspaceRequests()
CLI
openemail keys list-workspace-requests
MCP
listApiKeyRequests

GET/keys/activity

List API key activity

Geltungsbereichekeys:readLiest

What happened to the workspace's keys, newest first, the Activity tab of the app: created, updated, rotated, deactivated, reactivated, revoked, deleted, and every attempt to authenticate with a key that was refused. actor says who, a person as @username or a key as API key <name>, and detail.source where from. A deleted key keeps its history. keyIds, since and until narrow it.

A narrowed key reads only the activity of the keys it can see.

Requires the keys:read scope.

Query-Parameter

keyIdsstring

Comma-separated key ids, at most 50. Left out, every key in the workspace.

sincestring

Only rows at or after this instant, ISO 8601. One that does not parse is a 400 invalid_parameter.

Formatdate-time
untilstring

Only rows before this instant. It has to be later than since.

Formatdate-time
limitinteger

Rows per page, 1 to 100.

Mindestens 1Höchstens 100Standard25
cursorstring

The previous page's nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400 invalid_cursor.

Rückgabe

A page of changes, newest first.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
keys.listWorkspaceActivity()keys.listAllWorkspaceActivity()keys.iterateWorkspaceActivity()
CLI
openemail keys list-workspace-activity
MCP
listApiKeyActivity

GET/keys/{id}

Retrieve an API key

Geltungsbereichekeys:readLiest

One key, without its secret. A key the caller cannot see is a 404.

Requires the keys:read scope.

Pfadparameter

idstringErforderlich

The key id, 24 hex characters.

Rückgabe

The key.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
keys.get()
CLI
openemail keys get
MCP
listApiKeys

PATCH/keys/{id}

Update an API key

Geltungsbereichekeys:manageÄndert Daten

Renames a key, replaces its scopes or its send scope, or switches it off and on with enabled. A switched-off key is refused on every call with inactive_api_key and keeps everything it had, so switching it back on restores it exactly; that is the reversible alternative to revoking. scopes, addressAllowlist and domainAllowlist REPLACE what the key had, and a list left out stays as it was. A revoked key cannot be changed.

A key never makes or reaches a key wider than itself. What it creates, changes, rotates, switches, revokes or deletes has to sit inside it on every axis: scopes the caller holds (after its own role has narrowed them), the same role when the caller has one, an expiry no later than the caller's when the caller expires, the caller's mode, and a send scope inside the caller's own, where holding one address never covers its whole domain. A key narrowed to some domains or addresses also only SEES the keys whose send scope sits inside its own; any other is a 404. Over OAuth only the workspace owner reaches these calls, and a member's token is refused with owner_only. A key changing itself may only narrow itself.

Requires the keys:manage scope.

Pfadparameter

idstringErforderlich

The key id, 24 hex characters.

Request-Body

namestring

A new name, 1 to 60 characters.

1 bis 60 Zeichen
scopesstring[]

The whole new list of scopes, at least one.

Mindestens ein EintragEiner von"emails:send""emails:read""drafts:read""drafts:write""threads:read""threads:write""files:read""files:write""labels:read""labels:write""contacts:read""contacts:write""audiences:read""audiences:write""calendar:read""calendar:write""templates:read""templates:write""domains:read""domains:write""webhooks:read""webhooks:write""rules:read""rules:write""connections:read""members:read""members:write""roles:read""roles:write""settings:read""settings:write""keys:write""keys:read""keys:manage""forms:read""forms:write""billing:read""billing:write""account:read""account:write"
addressAllowliststring[]

The whole new list of single addresses.

Bis zu 50 Einträge
domainAllowliststring[]

The whole new list of whole domains.

Bis zu 25 Einträge
enabledboolean

False switches the key off, true switches it back on. Reversible, unlike revoking.

Rückgabe

The key as it now stands.

Fehler

409

revoked: a revoked key cannot be changed.

Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog

Auch verfügbar über

SDK
keys.update()
CLI
openemail keys update
MCP
setApiKeyEnabledsetApiKeySendScope

DELETE/keys/{id}

Delete an API key

Geltungsbereichekeys:manageLöscht

Removes a revoked key from the list. Its request log and its activity stay, under Deleted key. A key that has not been revoked is refused, so nothing still calling with it can lose its credential without somebody deciding to first.

Requires the keys:manage scope.

Pfadparameter

idstringErforderlich

The key id, 24 hex characters.

Rückgabe

200

{ object: "api_key", id, deleted: true }.

Fehler

409

not_revoked: revoke the key first.

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
keys.delete()
CLI
openemail keys delete

POST/keys/{id}/rotate

Rotate an API key

Geltungsbereichekeys:manageLöscht

Gives a key a new secret and returns it in token, once. The id, name, scopes, role, send scope, expiry and request history all carry on, and the old secret stops working the instant this returns, with no overlap window. Rotating the calling key itself follows POST /keys/self/rotate and is allowed with keys:write as well as keys:manage. A revoked or expired key cannot be rotated.

A key never makes or reaches a key wider than itself. What it creates, changes, rotates, switches, revokes or deletes has to sit inside it on every axis: scopes the caller holds (after its own role has narrowed them), the same role when the caller has one, an expiry no later than the caller's when the caller expires, the caller's mode, and a send scope inside the caller's own, where holding one address never covers its whole domain. A key narrowed to some domains or addresses also only SEES the keys whose send scope sits inside its own; any other is a 404. Over OAuth only the workspace owner reaches these calls, and a member's token is refused with owner_only. Rotation hands the caller a working secret for the key, which is why a key that is wider than the caller in any way is refused.

Requires the keys:manage scope.

Pfadparameter

idstringErforderlich

The key id, 24 hex characters.

Rückgabe

200object

The key, with its new secret.

objectstring
Einer von"api_key"
idstring

24 hex characters, the part of the token after oe_live_.

namestring
modestring
Einer von"live""test"
maskedKeystring

Enough of the token to tell two keys apart, such as oe_live_4c1b…kX7a.

keyLast4string
statusstring
Einer von"revoked""expired""inactive""active"
scopesstring[]
Einer von"emails:send""emails:read""drafts:read""drafts:write""threads:read""threads:write""files:read""files:write""labels:read""labels:write""contacts:read""contacts:write""audiences:read""audiences:write""calendar:read""calendar:write""templates:read""templates:write""domains:read""domains:write""webhooks:read""webhooks:write""rules:read""rules:write""connections:read""members:read""members:write""roles:read""roles:write""settings:read""settings:write""keys:write""keys:read""keys:manage""forms:read""forms:write""billing:read""billing:write""account:read""account:write"
roleIdstring

The role that caps the key, if any.

Kann null sein
roleNamestring
Kann null sein
addressAllowliststring[]
Kann null sein
domainAllowliststring[]
Kann null sein
expiresAtstring
Kann null seinFormatdate-time
lastUsedAtstring
Kann null seinFormatdate-time
totalUsesinteger

Calls the key has made, leaving out the ones refused before it authenticated.

rotatedAtstring
Formatdate-time
rotationCountinteger
deactivatedAtstring
Kann null seinFormatdate-time
revokedAtstring
Kann null seinFormatdate-time
revokedReasonstring
Kann null sein
createdAtstring
Formatdate-time
createdByAuditActor
updatedAtstring
Formatdate-time
updatedByAuditActor
lastChangeAtstring
Kann null seinFormatdate-time
lastChangeTypestring
Kann null sein
tokenstring

The new secret, shown this once.

Fehler

409

revoked or expired: create a new key instead.

Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog

Auch verfügbar über

SDK
keys.rotate()
CLI
openemail keys rotate
MCP
rotateApiKey

POST/keys/{id}/revoke

Revoke an API key

Geltungsbereichekeys:manageLöscht

Revokes a key for good: every later call with it is refused with revoked_api_key, and it can never be switched back on, rotated or changed. The body is optional and may carry a reason, kept on the key. Revoking a key that is already revoked changes nothing and answers the same. A key may revoke itself, which is how an integration that suspects its secret has leaked retires it at once.

A key never makes or reaches a key wider than itself. What it creates, changes, rotates, switches, revokes or deletes has to sit inside it on every axis: scopes the caller holds (after its own role has narrowed them), the same role when the caller has one, an expiry no later than the caller's when the caller expires, the caller's mode, and a send scope inside the caller's own, where holding one address never covers its whole domain. A key narrowed to some domains or addresses also only SEES the keys whose send scope sits inside its own; any other is a 404. Over OAuth only the workspace owner reaches these calls, and a member's token is refused with owner_only.

Requires the keys:manage scope.

Pfadparameter

idstringErforderlich

The key id, 24 hex characters.

Request-Body

reasonstring

Why, at most 200 characters.

Bis zu 200 Zeichen

Rückgabe

The key, now revoked.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog

Auch verfügbar über

SDK
keys.revoke()
CLI
openemail keys revoke
MCP
revokeApiKey

GET/keys/{id}/requests

List one key's requests

Geltungsbereichekeys:readLiest

The request log of one key, newest first. A deleted key's log is still readable by a key that is not narrowed.

Requires the keys:read scope.

Pfadparameter

idstringErforderlich

The key id, 24 hex characters.

Query-Parameter

failedOnlyboolean

Only calls answered with a status of 400 or more.

Standardfalse
sincestring

Only rows at or after this instant, ISO 8601. One that does not parse is a 400 invalid_parameter.

Formatdate-time
untilstring

Only rows before this instant. It has to be later than since.

Formatdate-time
limitinteger

Rows per page, 1 to 100.

Mindestens 1Höchstens 100Standard25
cursorstring

The previous page's nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400 invalid_cursor.

Rückgabe

A page of calls, newest first.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
keys.listRequests()keys.listAllRequests()keys.iterateRequests()
CLI
openemail keys list-requests
MCP
listApiKeyRequests

GET/keys/{id}/activity

List one key's activity

Geltungsbereichekeys:readLiest

What happened to one key, newest first. A deleted key's history is still readable by a key that is not narrowed.

Requires the keys:read scope.

Pfadparameter

idstringErforderlich

The key id, 24 hex characters.

Query-Parameter

sincestring

Only rows at or after this instant, ISO 8601. One that does not parse is a 400 invalid_parameter.

Formatdate-time
untilstring

Only rows before this instant. It has to be later than since.

Formatdate-time
limitinteger

Rows per page, 1 to 100.

Mindestens 1Höchstens 100Standard25
cursorstring

The previous page's nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400 invalid_cursor.

Rückgabe

A page of changes, newest first.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
keys.listActivity()keys.listAllActivity()keys.iterateActivity()
CLI
openemail keys list-activity
MCP
listApiKeyActivity

GET/keys/stats

Read API key stats

Geltungsbereichekeys:reademails:readLiest

What the keys of the workspace did inside a window, the Analytics tab of the API keys page: the mail they sent and what became of it, the calls refused for a bad or revoked secret, the requests they made and how many failed, the 8 routes they called most with the median time each took, and the status codes they got back. Every key you can see, or the ones keyIds names. A key limited to some addresses sees only the keys whose send scope sits inside its own, and over OAuth only the owner of the workspace reaches it.

Requires the keys:read and emails:read scopes.

Query-Parameter

keyIdsstring

Comma-separated key ids, at most 50. Left out, every key you can see.

sincestring

The start of the window, an ISO 8601 instant. Left out, 30 days before until.

Formatdate-time
untilstring

The end of the window, an ISO 8601 instant, not included. Left out, now.

Formatdate-time
grainstring

How wide one bucket of the series is. The bucket keys change shape with it: YYYY-MM-DD for a day, YYYY-MM-DDTHH for an hour, YYYY-MM-DDTHH:MM for a minute.

Einer von"minute""hour""day"Standard"day"
offsetMinutesinteger

Minutes to add to UTC before cutting the buckets, so a day starts at midnight where the reader is. 120 for UTC+2.

Mindestens -840Höchstens 840Standard0

Rückgabe

The figures for the window.

Fehler

Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog

Auch verfügbar über

SDK
keys.stats()
CLI
openemail keys stats
MCP
getApiKeyStats

Objekte

ApiKeyobject

An API key without its secret. The secret is returned once, by the call that made or rotated it, and never again.

objectstring
Einer von"api_key"
idstring

24 hex characters, the part of the token after oe_live_.

namestring
modestring
Einer von"live""test"
maskedKeystring

Enough of the token to tell two keys apart, such as oe_live_4c1b…kX7a.

keyLast4string
statusstring
Einer von"revoked""expired""inactive""active"
scopesstring[]
Einer von"emails:send""emails:read""drafts:read""drafts:write""threads:read""threads:write""files:read""files:write""labels:read""labels:write""contacts:read""contacts:write""audiences:read""audiences:write""calendar:read""calendar:write""templates:read""templates:write""domains:read""domains:write""webhooks:read""webhooks:write""rules:read""rules:write""connections:read""members:read""members:write""roles:read""roles:write""settings:read""settings:write""keys:write""keys:read""keys:manage""forms:read""forms:write""billing:read""billing:write""account:read""account:write"
roleIdstring

The role that caps the key, if any.

Kann null sein
roleNamestring
Kann null sein
addressAllowliststring[]
Kann null sein
domainAllowliststring[]
Kann null sein
expiresAtstring
Kann null seinFormatdate-time
lastUsedAtstring
Kann null seinFormatdate-time
totalUsesinteger

Calls the key has made, leaving out the ones refused before it authenticated.

rotatedAtstring
Kann null seinFormatdate-time
rotationCountinteger
deactivatedAtstring
Kann null seinFormatdate-time
revokedAtstring
Kann null seinFormatdate-time
revokedReasonstring
Kann null sein
createdAtstring
Formatdate-time
createdByAuditActor
updatedAtstring
Formatdate-time
updatedByAuditActor
lastChangeAtstring
Kann null seinFormatdate-time
lastChangeTypestring
Kann null sein

ApiKeyActivityEntryobject

objectstring
Einer von"api_key_event"
idstring
keyIdstring
keyNamestring

Deleted key once the key itself is gone.

typestring
Einer von"created""updated""rotated""revoked""deactivated""reactivated""auth_failed""deleted"
createdAtstring
Formatdate-time
detailobject

What changed and where it was changed from (source: console, api, mcp or documentation). A refused authentication carries reason.

ApiKeyActivityListobject

objectstring
Einer von"list"
hasMoreboolean

True when another page follows. Pass nextCursor back as cursor to read it.

nextCursorstring

An opaque cursor for the next page, or null on the last page. Pass it back unchanged.

Kann null sein

ApiKeyListobject

objectstring
Einer von"list"
hasMoreboolean

True when another page follows. Pass nextCursor back as cursor to read it.

nextCursorstring

An opaque cursor for the next page, or null on the last page. Pass it back unchanged.

Kann null sein

ApiKeyRequestobject

One authenticated call a key made. Never a body or a query string.

objectstring
Einer von"api_key_request"
idstring
keyIdstring
keyNamestring

Deleted key once the key itself is gone.

requestIdstring

The X-Request-Id the call was answered with.

Kann null sein
methodstring
pathstring
statusinteger
errorCodestring
Kann null sein
durationMsinteger
ipstring
Kann null sein
userAgentstring
Kann null sein
createdAtstring
Formatdate-time

ApiKeyRequestListobject

objectstring
Einer von"list"
hasMoreboolean

True when another page follows. Pass nextCursor back as cursor to read it.

nextCursorstring

An opaque cursor for the next page, or null on the last page. Pass it back unchanged.

Kann null sein

ApiKeyStatsobject

objectstringErforderlich
Einer von"api_key_stats"
sincestringErforderlich
Formatdate-time
untilstringErforderlich
Formatdate-time
grainstringErforderlich
Einer von"minute""hour""day"
keyIdsstring[]Erforderlich

The keys asked for. Empty means every key you can see.

sendsobjectErforderlich

The mail the keys sent, with what became of it.

daysobject[]
daystring

The bucket, shaped by grain.

sentinteger
deliveredinteger
failedinteger
bouncedinteger
complainedinteger
totalsobject
sendsinteger
testSendsinteger
recipientsinteger
deliveredinteger
failedinteger
bouncedinteger
complainedinteger
uncertaininteger
pendinginteger
statusesobject[]

Sends by status.

labelstring
countinteger
sourcesobject[]

Sends by where they came from.

labelstring
countinteger
sendersobject[]

Sends by the address they went out as.

labelstring
countinteger
suppressedobject[]

Recipients skipped because they were suppressed, by reason.

labelstring
countinteger
rejectedobject[]Erforderlich

Calls refused because the secret was wrong, revoked or expired, per bucket.

bucketstring
countinteger
requestsobject[]Erforderlich

Requests made and how many of them failed with a 4xx or 5xx, per bucket.

bucketstring
countinteger
failedinteger
routesobject[]Erforderlich

The routes called most, with how many failed and the median time in milliseconds.

labelstring
countinteger
failedinteger
medianMsinteger
codesobject[]Erforderlich

Requests by the HTTP status they got back.

labelstring
countinteger

AuditActorobject

Who made the change: a person, or a key acting over the API. Null when OpenEmail made it on its own, such as switching a webhook off after 100 failed events in a row, and when the person or key has since been deleted.

Kann null sein
kindstring
Einer von"user""apiKey"
idstring

The account id of the person, or the id of the key.

namestring

The name of the person, or API key <name> for a key.

usernamestring
Kann null sein
labelstring

What the app shows: @username for a person who has a username, otherwise name.