Files
dashback/docs/api/routes/entity/list.md
2026-09-30 21:56:35 +02:00

51 lines
1.1 KiB
Markdown

# `GET /entity`
Protected. Requires a valid session cookie (`credentials: 'include'`).
List entities
Lists entities for the selected company. Optional `customergroupId`
filters to one group. Optional `role=customer` excludes Lieferanten
group (for quote/order pickers). `role` wins when both are set.
## Query parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `customergroupId` | no | integer | |
| `role` | no | string | |
## Response `200`
Entity list
```json
{
"entities": [
{
"id": 1,
"customergroupId": 1,
"firstName": "…",
"name": "…",
"number": "…",
"createdAt": "2026-08-10T00:00:00.000Z",
"updatedAt": "2026-08-10T00:00:00.000Z"
}
]
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | No company selected, invalid customergroupId, or invalid role — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Company or customer group not found — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._