Search the docs

Find a page, a section, or an endpoint.

Sign inGet started

app-passwords

Every app-passwords endpoint, generated from the API's own schemas.

List the devices that reach one address

get/api/v1/app-passwords

Parameters

  • identity_iduuidrequired

Responses

  • 200A page of passwords.
  • 401No API key, or one that is not valid.
  • 404No such resource, **or** one belonging to another account. The two are deliberately indistinguishable: a different answer would enumerate what exists.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
bash
curl https://pidgeon.ai/api/v1/app-passwords \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json

Issue IMAP and SMTP credentials for one address

post/api/v1/app-passwords

What lets you hand a customer a mailbox they can open in a mail client. Only for an address this key can already **send** from — the credential reads the inbox and sends as the address, so issuing one is handing over exactly that. `username` and `password` are returned together and are useless apart.

Body

  • identity_iduuidrequired
  • namestringrequired

Responses

  • 201The credentials, once.
  • 401No API key, or one that is not valid.
  • 404No such resource, **or** one belonging to another account. The two are deliberately indistinguishable: a different answer would enumerate what exists.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
bash
curl https://pidgeon.ai/api/v1/app-passwords \
  -X POST \
  -H "Authorization: Bearer $PIDGEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Generated · public/openapi.json

Revoke an app password

delete/api/v1/app-passwords/{id}

Parameters

  • idstringrequired

Responses

  • 200Revoked.
  • 401No API key, or one that is not valid.
  • 404No such resource, **or** one belonging to another account. The two are deliberately indistinguishable: a different answer would enumerate what exists.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
bash
curl https://pidgeon.ai/api/v1/app-passwords/{id} \
  -X DELETE \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json