GET https://api.usecommune.com/newsletters/{newsletter}/api-keys Production. There is no separate sandbox host.

List this newsletter's API keys

Every API key that can reach this newsletter, newest first, revoked ones included. Needs settings: write, not read.

"Can reach" rather than "was issued for": a key can be granted every newsletter its owner runs rather than a named list, and such a key appears here too.

No response from this API ever contains a key's secret. A secret exists in plaintext for one moment, in the reply to the person who minted it in Commune's settings, and Commune keeps only a digest. An entry carries key_prefix instead, the leading fifteen characters, which tells keys apart and cannot be used as one.

self marks the entry this request was made with, which is otherwise impossible to work out: a caller holds a secret and the rows carry ids. It is false on every row when the request was made with an OAuth token, since an OAuth token is not an API key and is not listed here.

Revoked keys stay in the list, so "when was that turned off, and what was it called" stays answerable. Read live to tell the keys that still work from the ones that do not.

There is no filter. A newsletter holds at most twenty live keys, so the collection fits in a page or two.

Path parameters

  • string Required

Query parameters

  • string
  • integer
  • string
  • string

Request Headers

  • string
GET /newsletters/{newsletter}/api-keys
Loading...

Share your request

Use this link to easily share a pre-filled request of this operation. Everything you filled will be shared apart from the authentication fields.

Request URL

https://api-reference.usecommune.dev/explorer/operation/operation-listnewsletterapikeys

Send a delete request

It looks like you’re about to send a DELETE request to this API. This type of request carries a risk of permanent and irreversible data loss.

Are you sure you want to continue?
Response
Waiting for a request to be sent.