Search the docs

Find a page, a section, or an endpoint.

Sign inGet started

workspace

Every workspace endpoint, generated from the API's own schemas.

List the people in this workspace

get/api/v1/workspace/members

Read-only, and workspace-level: a key with no mailbox grants can still read it, for the same reason it can list domains. Assigning a conversation needs an id from here. Inviting and removing people stay in the dashboard — an invitation is mail to a person, and removing somebody hands on their mailboxes.

Responses

  • 200Everyone in the workspace.
  • 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/workspace/members \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json