openemail.keys
Cada método de este espacio de nombres: su firma, sus parámetros, lo que devuelve y un ejemplo.
Métodos
Every key in the workspace: list, create, change, rotate, switch off and revoke them, never wider than the calling key, and read their request log and activity.
keys.list()
List one page of the workspace's API keys
list(options?: ListOptions): Promise<Page<ApiKeyResource>>Returns one page of the workspace's keys, newest first, with what the Settings, API keys page shows: status, scopes, role, send scope, when each was last used, how often, and who made and last changed it. Revoked and expired keys stay listed until somebody deletes them. No secret is ever returned; maskedKey is enough to tell two keys apart.
A key narrowed to some domains or addresses only sees the keys whose send scope sits inside its own, so any other is a 404 rather than a refusal. Over OAuth only the workspace owner reaches it, and a member's token is 403 owner_only.
Parámetros
options.limitnumberRows per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorfrom the previous page, passed back unchanged. Never build one yourself.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Devuelve
Page<ApiKeyResource> with items, hasMore and nextCursor. Each item is an ApiKeyResource: id, name, mode, maskedKey, keyLast4, status, scopes, roleId, roleName, addressAllowlist, domainAllowlist, expiresAt, lastUsedAt, totalUses, rotatedAt, rotationCount, deactivatedAt, revokedAt, revokedReason, createdAt, createdBy, updatedAt, updatedBy, lastChangeAt and lastChangeType. Never a secret.
Ejemplo
const page = await openemail.keys.list() for (const key of page.items) { console.log(key.maskedKey, key.name, key.status, key.lastUsedAt)}Notas
It needs
keys:read, which no key holds unless somebody gave it one.The cursor is opaque: pass
nextCursorback as it came.
También disponible en
keys.listAll()
Collect every API key into one array
listAll(options?: ListOptions): Promise<Array<ApiKeyResource>>Walks every page of list and resolves with every key the caller can see, newest first.
Parámetros
options.limitnumberPage size for each request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest row.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Devuelve
Array<ApiKeyResource>, newest first.
Ejemplo
const keys = await openemail.keys.listAll() const idle = keys.filter((key) => key.status === 'active' && key.lastUsedAt === null) console.log(idle.map((key) => key.name))También disponible en
- API
GET /keys
keys.iterate()
Stream the workspace's API keys one at a time
iterate(options?: ListOptions): AsyncGenerator<ApiKeyResource, void, undefined>An async generator over list, fetching a page only when the one before is drained.
Parámetros
options.limitnumberPage size per request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest row.
options.signalAbortSignalCancels the request in flight and ends the iteration.
options.apiKeystringOverrides the client API key for every page of this walk.
Devuelve
AsyncGenerator<ApiKeyResource, void, undefined> yielding one key per step.
Ejemplo
for await (const key of openemail.keys.iterate()) { if (key.expiresAt && Date.parse(key.expiresAt) < Date.now() + 7 * 24 * 60 * 60 * 1000) console.log(key.name, 'expires soon')}También disponible en
- API
GET /keys
keys.get()
Read one API key, without its secret
get(id: string, options?: RequestScope): Promise<ApiKeyResource>Resolves with one key as list shows it. A key narrowed to some domains or addresses only sees the keys whose send scope sits inside its own, so any other is a 404 rather than a refusal. Over OAuth only the workspace owner reaches it, and a member's token is 403 owner_only.
openemail.me.get() describes the calling key itself and needs no scope; this reads any key the caller can see.
Parámetros
idstringObligatorioKey id, the 24 hex characters after
oe_live_.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Devuelve
ApiKeyResource: id, name, mode, maskedKey, keyLast4, status, scopes, roleId, roleName, addressAllowlist, domainAllowlist, expiresAt, lastUsedAt, totalUses, rotatedAt, rotationCount, deactivatedAt, revokedAt, revokedReason, createdAt, createdBy, updatedAt, updatedBy, lastChangeAt and lastChangeType. Never a secret.
Ejemplo
const key = await openemail.keys.get('4c1b257a66287fd113bd89d0') console.log(key.status, key.scopes, key.domainAllowlist)También disponible en
keys.create()
Mint a new API key and receive its secret once
create(body: ApiKeyCreate, options?: RequestScope): Promise<CreatedApiKeyResource>Creates a live key and resolves with it plus token, the whole secret. That is the only time it appears, 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 (none means every address the workspace owns), and the expiry is the caller's own or none. The workspace cap on live keys applies, as a 422 workspace_limit_reached.
A key never makes or reaches a key wider than itself. The target has to sit inside the caller 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 one address never covers its whole domain. Anything wider is 403 beyond_caller_authority, and param names the axis.
Step-up verification, which the app asks for before it mints a key, cannot apply to a call made with a key, so keys:manage is a credential that makes credentials. Give it only to automation that provisions keys, narrow that key to the role and send scope it needs, and give it an expiry.
Parámetros
body.namestringObligatorioA name, 1 to 60 characters.
body.scopesArray<ApiScope>The scopes the key holds, at least one, each held by the caller. Defaults to
['emails:send'].body.roleIdstring | nullA role to cap the key. Left out, the caller's own role. A caller with a role can only give its own, and
nullis refused for it.body.addressAllowlistArray<string>Single addresses the key may send as, at most 50, each owned by the workspace.
body.domainAllowlistArray<string>Whole domains the key may send as, at most 25, including addresses added to them later. Leave both lists out to inherit the caller's own; send both empty for none.
body.expiresInMinutesnumberMinutes until the key expires, 5 to 5,256,000 (ten years). Left out, the caller's own expiry.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Devuelve
CreatedApiKeyResource: the ApiKeyResource: id, name, mode, maskedKey, keyLast4, status, scopes, roleId, roleName, addressAllowlist, domainAllowlist, expiresAt, lastUsedAt, totalUses, rotatedAt, rotationCount, deactivatedAt, revokedAt, revokedReason, createdAt, createdBy, updatedAt, updatedBy, lastChangeAt and lastChangeType. Never a secret. Plus token, oe_live_ followed by the id, an underscore and the secret.
Ejemplo
const key = await openemail.keys.create({ name: 'Billing sender', scopes: ['emails:send', 'emails:read'], domainAllowlist: ['billing.acme.com'], expiresInMinutes: 60 * 24 * 90}) await secrets.put('OPENEMAIL_BILLING_KEY', key.token)Notas
Not retried automatically: a retry after a lost response would mint a second key.
The new key is recorded in the activity log as made by the calling key,
source: 'api'.The success status is 201.
También disponible en
keys.update()
Rename a key, change its scopes or send scope, or switch it off and on
update(id: string, patch: ApiKeyPatch, options?: RequestScope): Promise<ApiKeyResource>Applies a partial change and resolves with the key as it now stands. scopes, addressAllowlist and domainAllowlist REPLACE what the key had, and a field left out stays as it was. enabled: false switches the key off: every call with it is refused with inactive_api_key and it keeps its secret, scopes, role and send scope, so enabled: true restores it exactly. That is the reversible alternative to revoke. A revoked key cannot be changed, and answers 409 revoked.
A key never makes or reaches a key wider than itself. The target has to sit inside the caller 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 one address never covers its whole domain. Anything wider is 403 beyond_caller_authority, and param names the axis. A key changing itself may only narrow itself.
A key narrowed to some domains or addresses only sees the keys whose send scope sits inside its own, so any other is a 404 rather than a refusal. Over OAuth only the workspace owner reaches it, and a member's token is 403 owner_only.
Parámetros
idstringObligatorioKey id, the 24 hex characters after
oe_live_.patch.namestringA new name, 1 to 60 characters.
patch.scopesArray<ApiScope>The whole new list of scopes, at least one.
patch.addressAllowlistArray<string>The whole new list of single addresses.
patch.domainAllowlistArray<string>The whole new list of whole domains.
patch.enabledbooleanFalse switches the key off, true switches it back on.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Devuelve
ApiKeyResource: id, name, mode, maskedKey, keyLast4, status, scopes, roleId, roleName, addressAllowlist, domainAllowlist, expiresAt, lastUsedAt, totalUses, rotatedAt, rotationCount, deactivatedAt, revokedAt, revokedReason, createdAt, createdBy, updatedAt, updatedBy, lastChangeAt and lastChangeType. Never a secret.
Ejemplo
await openemail.keys.update('4c1b257a66287fd113bd89d0', { enabled: false }) const key = await openemail.keys.update('4c1b257a66287fd113bd89d0', { name: 'Billing sender (paused)' }) console.log(key.status)Notas
An empty patch is a 422. A PATCH is retried on network failure because applying the same patch twice leaves the same key.
También disponible en
keys.delete()
Remove a revoked key from the list
delete(id: string, options?: RequestScope): Promise<DeletedApiKeyResource>Deletes a key that has already been revoked. Its request log and activity stay, under Deleted key, so the history of what it did is not lost with it. A key that has not been revoked is refused with 409 not_revoked, so nothing still calling with it loses its credential without somebody deciding that first.
A key never makes or reaches a key wider than itself. The target has to sit inside the caller 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 one address never covers its whole domain. Anything wider is 403 beyond_caller_authority, and param names the axis.
Parámetros
idstringObligatorioKey id, the 24 hex characters after
oe_live_.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Devuelve
DeletedApiKeyResource: { object: 'api_key', id, deleted: true }.
Ejemplo
await openemail.keys.revoke('4c1b257a66287fd113bd89d0', { reason: 'Leaked in a build log' })await openemail.keys.delete('4c1b257a66287fd113bd89d0')También disponible en
keys.rotate()
Give a key a new secret and receive it once
rotate(id: string, options?: RequestScope): Promise<RotatedApiKeyResource>Mints a new secret for a key and resolves with the key plus token, rotationCount and rotatedAt. The id, name, scopes, role, send scope, expiry and request history all carry on; only the secret and keyLast4 change. There is no overlap window: the old secret stops working the instant this returns.
Rotating the calling key itself is what openemail.me.rotate() does, and here it is allowed with keys:write as well as keys:manage. A revoked or expired key cannot be rotated, and answers 409 revoked or expired.
A key never makes or reaches a key wider than itself. The target has to sit inside the caller 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 one address never covers its whole domain. Anything wider is 403 beyond_caller_authority, and param names the axis. Rotation hands the caller a working secret for the key, which is why the ceiling is checked against the key as it stands.
A key narrowed to some domains or addresses only sees the keys whose send scope sits inside its own, so any other is a 404 rather than a refusal. Over OAuth only the workspace owner reaches it, and a member's token is 403 owner_only.
Parámetros
idstringObligatorioKey id, the 24 hex characters after
oe_live_.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Devuelve
RotatedApiKeyResource: the ApiKeyResource: id, name, mode, maskedKey, keyLast4, status, scopes, roleId, roleName, addressAllowlist, domainAllowlist, expiresAt, lastUsedAt, totalUses, rotatedAt, rotationCount, deactivatedAt, revokedAt, revokedReason, createdAt, createdBy, updatedAt, updatedBy, lastChangeAt and lastChangeType. Never a secret. Plus token, rotationCount and rotatedAt.
Ejemplo
const rotated = await openemail.keys.rotate('4c1b257a66287fd113bd89d0') await secrets.put('OPENEMAIL_BILLING_KEY', rotated.token) console.log(rotated.rotationCount, rotated.rotatedAt)Notas
Not retried automatically. Repeating a rotation would invalidate the secret the first attempt returned.
También disponible en
keys.revoke()
Revoke a key for good
revoke(id: string, body?: ApiKeyRevoke, options?: RequestScope): Promise<ApiKeyResource>Revokes a key: every later call with it is refused with revoked_api_key, and it can never be switched back on, rotated or changed. reason is kept on the key and in the activity log. Revoking a key that is already revoked changes nothing and resolves with it as it is. A key may revoke itself, which is how an integration that believes its secret leaked retires it at once.
A key never makes or reaches a key wider than itself. The target has to sit inside the caller 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 one address never covers its whole domain. Anything wider is 403 beyond_caller_authority, and param names the axis.
A key narrowed to some domains or addresses only sees the keys whose send scope sits inside its own, so any other is a 404 rather than a refusal. Over OAuth only the workspace owner reaches it, and a member's token is 403 owner_only.
Parámetros
idstringObligatorioKey id, the 24 hex characters after
oe_live_.body.reasonstringWhy, at most 200 characters.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Devuelve
ApiKeyResource: id, name, mode, maskedKey, keyLast4, status, scopes, roleId, roleName, addressAllowlist, domainAllowlist, expiresAt, lastUsedAt, totalUses, rotatedAt, rotationCount, deactivatedAt, revokedAt, revokedReason, createdAt, createdBy, updatedAt, updatedBy, lastChangeAt and lastChangeType. Never a secret. status is revoked.
Ejemplo
const key = await openemail.keys.revoke('4c1b257a66287fd113bd89d0', { reason: 'Contractor offboarded' }) console.log(key.status, key.revokedAt)Notas
Retried on network failure, because revoking twice leaves the same key. Prefer
update(id, { enabled: false })while you find out whether anything still depends on a key.
También disponible en
keys.listRequests()
List one page of one key's request log
listRequests(id: string, options?: ApiKeyRequestListOptions): Promise<Page<ApiKeyRequestResource>>Returns one page of the calls one key made, newest first, the Requests tab of the key in the app. The request log records every authenticated call a key made: method, path, status, error code, duration, IP and user agent, and never a body or a query string. A call refused before a key could be identified is not in it, and neither is a call made with an OAuth access token. Nothing is pruned, so the log reaches back to a key's first call. failedOnly, since and until are the filters the app offers.
A deleted key's log stays readable to a key that is not narrowed. A key narrowed to some domains or addresses only sees the keys whose send scope sits inside its own, so any other is a 404 rather than a refusal. Over OAuth only the workspace owner reaches it, and a member's token is 403 owner_only.
Parámetros
idstringObligatorioKey id, the 24 hex characters after
oe_live_.options.failedOnlybooleanOnly calls answered with a status of 400 or more.
options.sinceDate | stringOnly rows at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly rows before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberRows per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorfrom the previous page, passed back unchanged. Never build one yourself.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Devuelve
Page<ApiKeyRequestResource> with items, hasMore and nextCursor. Each item has id, keyId, keyName, requestId, method, path, status, errorCode, durationMs, ip, userAgent and createdAt.
Ejemplo
const page = await openemail.keys.listRequests('4c1b257a66287fd113bd89d0', { failedOnly: true, limit: 50 }) for (const call of page.items) console.log(call.createdAt, call.method, call.path, call.status, call.errorCode)Notas
The cursor is opaque and stays valid under the same filters. One this log did not hand out is a 400
invalid_cursor.
También disponible en
keys.listAllRequests()
Collect one key's whole request log into one array
listAllRequests(id: string, options?: ApiKeyRequestListOptions): Promise<Array<ApiKeyRequestResource>>Walks every page of listRequests under the same filters. The log is never pruned, so give it a window unless you mean to read a busy key's whole history, or use iterateRequests to stop early.
Parámetros
idstringObligatorioKey id, the 24 hex characters after
oe_live_.options.failedOnlybooleanOnly calls answered with a status of 400 or more.
options.sinceDate | stringOnly rows at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly rows before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberPage size for each request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest row.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Devuelve
Array<ApiKeyRequestResource>, newest first.
Ejemplo
const today = await openemail.keys.listAllRequests('4c1b257a66287fd113bd89d0', { since: new Date(Date.now() - 24 * 60 * 60 * 1000), limit: 100 }) console.log(today.length, 'calls today')Notas
If any page fails the promise rejects and the rows already fetched are discarded.
También disponible en
keys.iterateRequests()
Stream one key's request log one call at a time
iterateRequests(id: string, options?: ApiKeyRequestListOptions): AsyncGenerator<ApiKeyRequestResource, void, undefined>An async generator over listRequests under the same filters, fetching a page only when the one before is drained.
Parámetros
idstringObligatorioKey id, the 24 hex characters after
oe_live_.options.failedOnlybooleanOnly calls answered with a status of 400 or more.
options.sinceDate | stringOnly rows at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly rows before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberPage size per request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest row.
options.signalAbortSignalCancels the request in flight and ends the iteration.
options.apiKeystringOverrides the client API key for every page of this walk.
Devuelve
AsyncGenerator<ApiKeyRequestResource, void, undefined> yielding one call per step.
Ejemplo
for await (const call of openemail.keys.iterateRequests('4c1b257a66287fd113bd89d0', { failedOnly: true })) { if (call.errorCode === 'from_address_forbidden') { console.log('first refused send at', call.createdAt) break }}También disponible en
keys.listActivity()
List one page of what happened to one key
listActivity(id: string, options?: ApiKeyActivityListOptions): Promise<Page<ApiKeyActivityResource>>Returns one page of one key's audit log, newest first, the Activity tab of the key in the app. Every change to a key is a row: created, updated, rotated, deactivated, reactivated, revoked and deleted, plus auth_failed for every call that presented the key and was refused. actor names who made the change, a person as @username or a key as API key <name> in label, and detail.source says where it came from: console, api, mcp or documentation.
A deleted key keeps its history, readable to a key that is not narrowed. A key narrowed to some domains or addresses only sees the keys whose send scope sits inside its own, so any other is a 404 rather than a refusal. Over OAuth only the workspace owner reaches it, and a member's token is 403 owner_only.
Parámetros
idstringObligatorioKey id, the 24 hex characters after
oe_live_.options.sinceDate | stringOnly rows at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly rows before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberRows per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorfrom the previous page, passed back unchanged. Never build one yourself.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Devuelve
Page<ApiKeyActivityResource> with items, hasMore and nextCursor. Each item has id, keyId, keyName, type, createdAt, actor and detail.
Ejemplo
const page = await openemail.keys.listActivity('4c1b257a66287fd113bd89d0') for (const change of page.items) console.log(change.createdAt, change.type, change.actor?.label, change.detail.source)También disponible en
keys.listAllActivity()
Collect one key's whole audit log into one array
listAllActivity(id: string, options?: ApiKeyActivityListOptions): Promise<Array<ApiKeyActivityResource>>Walks every page of listActivity under the same window and resolves with every change, newest first.
Parámetros
idstringObligatorioKey id, the 24 hex characters after
oe_live_.options.sinceDate | stringOnly rows at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly rows before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberPage size for each request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest row.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Devuelve
Array<ApiKeyActivityResource>, newest first.
Ejemplo
const history = await openemail.keys.listAllActivity('4c1b257a66287fd113bd89d0') console.log(history.filter((change) => change.type === 'auth_failed').length, 'refused attempts')Notas
If any page fails the promise rejects and the rows already fetched are discarded.
También disponible en
keys.iterateActivity()
Stream one key's audit log one change at a time
iterateActivity(id: string, options?: ApiKeyActivityListOptions): AsyncGenerator<ApiKeyActivityResource, void, undefined>An async generator over listActivity under the same window, fetching a page only when the one before is drained.
Parámetros
idstringObligatorioKey id, the 24 hex characters after
oe_live_.options.sinceDate | stringOnly rows at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly rows before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberPage size per request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest row.
options.signalAbortSignalCancels the request in flight and ends the iteration.
options.apiKeystringOverrides the client API key for every page of this walk.
Devuelve
AsyncGenerator<ApiKeyActivityResource, void, undefined> yielding one change per step.
Ejemplo
for await (const change of openemail.keys.iterateActivity('4c1b257a66287fd113bd89d0')) { if (change.type === 'rotated') { console.log('last rotated by', change.actor?.label, 'at', change.createdAt) break }}También disponible en
keys.listWorkspaceRequests()
List one page of the request log of every key
listWorkspaceRequests(options?: ApiKeyWorkspaceRequestListOptions): Promise<Page<ApiKeyRequestResource>>Returns one page of every call the workspace's keys made, newest first, the Requests tab of Settings, API keys. The request log records every authenticated call a key made: method, path, status, error code, duration, IP and user agent, and never a body or a query string. A call refused before a key could be identified is not in it, and neither is a call made with an OAuth access token. Nothing is pruned, so the log reaches back to a key's first call. keyIds, failedOnly, since and until are the filters the app offers, and keyIds may name a deleted key.
A narrowed key reads only the log of the keys it can see, so naming another key in keyIds matches nothing.
Parámetros
options.keyIdsArray<string>Key ids to read, at most 50, sent comma-separated. Left out, every key the caller can see.
options.failedOnlybooleanOnly calls answered with a status of 400 or more.
options.sinceDate | stringOnly rows at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly rows before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberRows per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorfrom the previous page, passed back unchanged. Never build one yourself.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Devuelve
Page<ApiKeyRequestResource> with items, hasMore and nextCursor. Each item has id, keyId, keyName, requestId, method, path, status, errorCode, durationMs, ip, userAgent and createdAt.
Ejemplo
const page = await openemail.keys.listWorkspaceRequests({ failedOnly: true, since: '2026-09-22T00:00:00Z' }) for (const call of page.items) console.log(call.keyName, call.method, call.path, call.status)También disponible en
keys.listAllWorkspaceRequests()
Collect the request log of every key into one array
listAllWorkspaceRequests(options?: ApiKeyWorkspaceRequestListOptions): Promise<Array<ApiKeyRequestResource>>Walks every page of listWorkspaceRequests under the same filters. The log is never pruned, so give it a window, or use iterateWorkspaceRequests to stop early.
Parámetros
options.keyIdsArray<string>Key ids to read, at most 50, sent comma-separated. Left out, every key the caller can see.
options.failedOnlybooleanOnly calls answered with a status of 400 or more.
options.sinceDate | stringOnly rows at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly rows before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberPage size for each request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest row.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Devuelve
Array<ApiKeyRequestResource>, newest first.
Ejemplo
const failures = await openemail.keys.listAllWorkspaceRequests({ failedOnly: true, since: new Date(Date.now() - 60 * 60 * 1000), limit: 100 }) console.log(failures.length, 'failed calls in the last hour')Notas
If any page fails the promise rejects and the rows already fetched are discarded.
También disponible en
keys.iterateWorkspaceRequests()
Stream the request log of every key one call at a time
iterateWorkspaceRequests(options?: ApiKeyWorkspaceRequestListOptions): AsyncGenerator<ApiKeyRequestResource, void, undefined>An async generator over listWorkspaceRequests under the same filters, fetching a page only when the one before is drained.
Parámetros
options.keyIdsArray<string>Key ids to read, at most 50, sent comma-separated. Left out, every key the caller can see.
options.failedOnlybooleanOnly calls answered with a status of 400 or more.
options.sinceDate | stringOnly rows at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly rows before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberPage size per request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest row.
options.signalAbortSignalCancels the request in flight and ends the iteration.
options.apiKeystringOverrides the client API key for every page of this walk.
Devuelve
AsyncGenerator<ApiKeyRequestResource, void, undefined> yielding one call per step.
Ejemplo
for await (const call of openemail.keys.iterateWorkspaceRequests({ failedOnly: true })) { if (call.status >= 500) console.log(call.requestId, call.path)}También disponible en
keys.listWorkspaceActivity()
List one page of what happened to every key
listWorkspaceActivity(options?: ApiKeyWorkspaceActivityListOptions): Promise<Page<ApiKeyActivityResource>>Returns one page of the audit log of every key in the workspace, newest first, the Activity tab of Settings, API keys. Every change to a key is a row: created, updated, rotated, deactivated, reactivated, revoked and deleted, plus auth_failed for every call that presented the key and was refused. actor names who made the change, a person as @username or a key as API key <name> in label, and detail.source says where it came from: console, api, mcp or documentation.
keyIds narrows it, deleted keys included, and since and until keep a window. A narrowed key reads only the activity of the keys it can see.
Parámetros
options.keyIdsArray<string>Key ids to read, at most 50, sent comma-separated. Left out, every key the caller can see.
options.sinceDate | stringOnly rows at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly rows before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberRows per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorfrom the previous page, passed back unchanged. Never build one yourself.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Devuelve
Page<ApiKeyActivityResource> with items, hasMore and nextCursor. Each item has id, keyId, keyName, type, createdAt, actor and detail.
Ejemplo
const page = await openemail.keys.listWorkspaceActivity({ since: '2026-09-01T00:00:00Z' }) for (const change of page.items) console.log(change.keyName, change.type, change.actor?.label)También disponible en
keys.listAllWorkspaceActivity()
Collect the audit log of every key into one array
listAllWorkspaceActivity(options?: ApiKeyWorkspaceActivityListOptions): Promise<Array<ApiKeyActivityResource>>Walks every page of listWorkspaceActivity under the same filters and resolves with every change, newest first.
Parámetros
options.keyIdsArray<string>Key ids to read, at most 50, sent comma-separated. Left out, every key the caller can see.
options.sinceDate | stringOnly rows at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly rows before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberPage size for each request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest row.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Devuelve
Array<ApiKeyActivityResource>, newest first.
Ejemplo
const changes = await openemail.keys.listAllWorkspaceActivity({ since: new Date('2026-09-01T00:00:00Z') }) console.log(changes.filter((change) => change.detail.source === 'api').length, 'changes made over the API')Notas
If any page fails the promise rejects and the rows already fetched are discarded.
También disponible en
keys.iterateWorkspaceActivity()
Stream the audit log of every key one change at a time
iterateWorkspaceActivity(options?: ApiKeyWorkspaceActivityListOptions): AsyncGenerator<ApiKeyActivityResource, void, undefined>An async generator over listWorkspaceActivity under the same filters, fetching a page only when the one before is drained.
Parámetros
options.keyIdsArray<string>Key ids to read, at most 50, sent comma-separated. Left out, every key the caller can see.
options.sinceDate | stringOnly rows at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly rows before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberPage size per request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest row.
options.signalAbortSignalCancels the request in flight and ends the iteration.
options.apiKeystringOverrides the client API key for every page of this walk.
Devuelve
AsyncGenerator<ApiKeyActivityResource, void, undefined> yielding one change per step.
Ejemplo
for await (const change of openemail.keys.iterateWorkspaceActivity()) { if (change.type === 'auth_failed') console.log(change.keyName, change.detail.reason, change.createdAt)}También disponible en
keys.stats()
Read what the keys did inside a window
stats(options?: ApiKeyStatsOptions): Promise<ApiKeyStatsResource>Returns the numbers behind the Analytics tab of the API keys page: the mail the keys sent and what became of it, the calls refused because a secret was wrong, revoked or expired, the requests they made and how many failed, the routes they called most with the median time each took, and the status codes they got back.
It covers every key you can see, or the ones keyIds names. The window runs from since to until, and left out it is the 30 days before now. grain sets the bucket width of the series and offsetMinutes shifts the boundaries so days break where the reader's day does.
Parámetros
options.keyIdsArray<string>Only these keys, at most 50. Left out, every key you can see.
options.sinceDate | stringThe start of the window, a
Dateor an ISO 8601 instant. Defaults to 30 days beforeuntil.options.untilDate | stringThe end of the window, not included. Defaults to now.
options.grainTrackingGrainBucket width:
minute,hourorday, defaulting today.options.offsetMinutesnumberMinutes east of UTC to bucket in, from -840 to 840, defaulting to 0.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Devuelve
ApiKeyStatsResource with the window it covered, sends, rejected, requests, routes and codes.
Ejemplo
const stats = await openemail.keys.stats({ grain: 'day' }) console.log(stats.sends.totals.sends, 'sent')console.log(stats.routes.slice(0, 3))Notas
A key narrowed to some domains or addresses only counts the keys whose send scope sits inside its own, and an access token is refused with 403
owner_onlyunless it acts for the owner of the workspace.The series are sparse: a bucket with nothing in it has no entry, so a chart must fill the gaps.
Retried automatically on network failure, since it only reads.