PrimeBrickPrimeBrick
  • Docs
  • Contact
  • MIT License
  • Documentation
  • MCP Server
  • API Catalog
  • Services
  • Libraries
PrimeBrickPrimeBrick

© 2026 PrimeBrick. MIT License. v3.8.0

github
Information
providers
    Get providers entity metadatagetList all email providersgetGet a single email provider by UUIDgetUpdate an email provider by UUIDputDelete an email provider (soft-delete)deleteCreate a new email providerpost
config_entries
    Get config_entries entity metadatagetList all configuration entriesgetGet a single config entry by UUIDgetUpdate a config entry value by UUIDput
webhook
    Receive an inbound webhook from an email providerpost
powered by Zudoku
EmailSender Catalog
EmailSender Catalog

config_entries

Download schema

Module configuration key-value entries


Get config_entries entity metadata

GET
http://localhost:3002
/api/v1/entities/config_entries/meta
Bearer (JWT)
or
X-API-Key (header)

Returns the field schema and supported operations for the config_entries entity.

Get config_entries entity metadata › Responses

200

Entity metadata

No data returned
GET/api/v1/entities/config_entries/meta
fetch('http://localhost:3002/api/v1/entities/config_entries/meta', { headers: { Authorization: 'Bearer <token>' } })
Example Responses
No example specified for this content type

List all configuration entries

GET
http://localhost:3002
/api/v1/entities/config_entries/list
Bearer (JWT)
or
X-API-Key (header)

Returns all non-deleted configuration key-value entries for the emailsender module.

List all configuration entries › Responses

200

List of config entries

​object[]
GET/api/v1/entities/config_entries/list
fetch('http://localhost:3002/api/v1/entities/config_entries/list', { headers: { Authorization: 'Bearer <token>' } })
Example Responses
{ "config_entries": [ { "uuid": "00000000-0000-0000-0000-000000000000", "key": "key", "value": "value", "label_key": "label_key", "description_key": "description_key" } ] }
json
application/json

Get a single config entry by UUID

GET
http://localhost:3002
/api/v1/entities/config_entries/{uuid}
Bearer (JWT)
or
X-API-Key (header)

Returns a single configuration entry by its UUID.

Get a single config entry by UUID › path Parameters

uuid
​string · uuid · required

Config entry UUID

Get a single config entry by UUID › Responses

Config entry details

No data returned
GET/api/v1/entities/config_entries/{uuid}
fetch('http://localhost:3002/api/v1/entities/config_entries/:uuid', { headers: { Authorization: 'Bearer <token>' } })
Example Responses
No example specified for this content type

Update a config entry value by UUID

PUT
http://localhost:3002
/api/v1/entities/config_entries/{uuid}
Bearer (JWT)
or
X-API-Key (header)

Updates the value of a configuration entry. Only the 'value' field is updated.

Update a config entry value by UUID › path Parameters

uuid
​string · uuid · required

Config entry UUID

Update a config entry value by UUID › Request Body

value
​string · required

Update a config entry value by UUID › Responses

Config entry updated

No data returned
PUT/api/v1/entities/config_entries/{uuid}
fetch('http://localhost:3002/api/v1/entities/config_entries/:uuid', { method: 'PUT', headers: { 'Content-Type': 'application/json', Authorization: 'Bearer <token>' }, body: JSON.stringify({ value: 'value' }) })
Example Request Body
{ "value": "value" }
json
Example Responses
No example specified for this content type

providerswebhook