API ReferenceOrganizationsOrganizationid
Update an organization by ID
Updates the details of a specific organization by its ID.
Middlewares: authMiddleware, validateOrganization, validateOrganizationUpdate
x-api-key<token>
API key for authentication
In: header
Path Parameters
organizationIdstring
A valid MongoDB ObjectId
name?string
The name of the organization
organizationstring
A valid MongoDB ObjectId
kind?string
The type or category of the organization
meta?
Additional metadata for the entry
Response Body
application/json
curl -X PATCH "https://api.paperlesspaper.de/v1/organizations/682fd0d7d4a6325d9d45b86e" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Inc.", "organization": "682fd0d7d4a6325d9d45b86d", "kind": "private", "meta": { "billingId": "cus_123", "region": "eu" } }'{
"id": "682fd0d7d4a6325d9d45b86e",
"name": "Acme Inc.",
"email": "[email protected]",
"kind": "private"
}Get an organization by ID GET
Retrieves the details of a specific organization by its ID. Middlewares: `authMiddleware`, `validateOrganization`
Query papers by device or organization GET
Retrieves paper entries (screens) filtered by device or by organization when no device is provided. Middlewares: `authMiddleware`, `validateDeviceOrOrganizationQuery`