Skip to main content
Source: equa-server/modules/api/src/endpoints/color-endpoints.ts

Color Endpoints

Endpoints for managing user-specific color preferences used for UI theming. Colors are scoped per user and target (e.g., a specific entity or UI element). All color endpoints require authentication. Endpoint count: 4

Create/Update Color

PUT /v1/user/:user/color/:target
FieldValue
AuthRequired
Request TypeNewColorRequest
Create or update a color preference for the specified target. Path Parameters:
ParameterTypeDescription
useruuidUser ID
targetstringTarget identifier for the color preference
Request Body (NewColorRequest):
{
  "user": "uuid",
  "target": "entity-or-element-id",
  "color": "#33AA40"
}

List Colors

GET /v1/user/:user/color
FieldValue
AuthRequired
Request TypeUserRequest
Get all color preferences for a user. Path Parameters:
ParameterTypeDescription
useruuidUser ID

Get Color

GET /v1/user/:user/color/:target
FieldValue
AuthRequired
Request TypeUserRequest
Get a specific color preference by target. Path Parameters:
ParameterTypeDescription
useruuidUser ID
targetstringTarget identifier

Delete Color

DELETE /v1/user/:user/color/:target
FieldValue
AuthRequired
Request TypeUserRequest
Delete a color preference for the specified target. Path Parameters:
ParameterTypeDescription
useruuidUser ID
targetstringTarget identifier