Skip to content

Overview

Read and write your Facteur workspaces, inboxes and messages from a script or a test suite, without a browser.

Every request carries an API key in the Authorization header: Authorization: Bearer fk_.... A person creates the key in the Facteur app and sees it once. A key holds one or more of the permissions ws:read and ws:write (the content of a workspace: its inboxes and its messages) and org:read and org:write (the structure of the organization: its workspaces). Writing includes reading inside a family, and the two families never imply each other. A key reaches only the workspaces it was given: any other answers 404, as if it did not exist.

Each operation below names the permission it needs and the refusals it can answer, each with its code. The guides are in the developer portal, whose address GET /.well-known/oauth-protected-resource gives as resource_documentation.

Information

  • OpenAPI version: 3.1.0

An API key: Authorization: Bearer fk_....

Security scheme type: http