Catalogues

Full CRUD on catalogues. Needs the Catalogues feature enabled for the company on top of External API; when it is off every verb returns 403, rather than the empty list the in-app endpoint returns; an empty list cannot be told apart from a company with no catalogues.

This API is also the first place a scoped API key can manage catalogues. departments and assignedDepartmentsNotAllowed decide which people see a catalogue and are read-only; the flag inverts the gate. Not exposed: favorite, oldName, and the superseded singular legalEntity.

Operations

Reads need master-data:read, writes master-data:write.

• GET/api/v2/{companyId}/catalogues/: Paginated by name.
• POST/api/v2/{companyId}/catalogues/: names is required; only names, description, emoji and legalEntities can be set.
• GET/api/v2/{companyId}/catalogues/{id}/: One catalogue. Soft-deleted rows are returned here too.
• PUT/api/v2/{companyId}/catalogues/{id}/: Replaces the four writable fields.
• PATCH/api/v2/{companyId}/catalogues/{id}/: Changes only the fields you send.
• DELETE/api/v2/{companyId}/catalogues/{id}/: Soft delete; the row stays retrievable by id.