providers

Email provider configuration entities

Get providers entity metadata

GET

http://localhost:3002

/api/v1/entities/providers/meta

Bearer (JWT)

X-API-Key (header)

Returns the field schema, supported operations, and metadata for the providers entity. Used by MCP get_entity_meta tool and FE dynamic form generation.

Get providers entity metadata › Responses

200

Entity metadata

entity

string

module

string

object[]

supported_operations

string[]

List all email providers

GET

http://localhost:3002

/api/v1/entities/providers/list

Bearer (JWT)

X-API-Key (header)

Returns a list of all non-deleted email provider configurations. Each provider includes connection details (API key, endpoint, sender settings).

List all email providers › Responses

200

List of providers

object[]

Get a single email provider by UUID

GET

http://localhost:3002

/api/v1/entities/providers/{uuid}

Bearer (JWT)

X-API-Key (header)

Returns the full details of a single email provider configuration, including the API key.

Get a single email provider by UUID › path Parameters

uuid

string · uuid · required

Provider UUID

Get a single email provider by UUID › Responses

Provider details

uuid

string · uuid

provider

string

api_key

string

api_endpoint

string

from_email

string

from_name

string

reply_to

string

version

integer

Update an email provider by UUID

PUT

http://localhost:3002

/api/v1/entities/providers/{uuid}

Bearer (JWT)

X-API-Key (header)

Updates the configuration of an existing email provider. All fields are replaced.

Update an email provider by UUID › path Parameters

uuid

string · uuid · required

Provider UUID

Update an email provider by UUID › Request Body

provider

string

api_key

string

api_endpoint

string

from_email

string

from_name

string

reply_to

string

Update an email provider by UUID › Responses

Provider updated

No data returned

Delete an email provider (soft-delete)

DELETE

http://localhost:3002

/api/v1/entities/providers/{uuid}

Bearer (JWT)

X-API-Key (header)

Soft-deletes an email provider configuration. The record is marked as deleted but remains in the database.

Delete an email provider (soft-delete) › path Parameters

uuid

string · uuid · required

Provider UUID

Delete an email provider (soft-delete) › Responses

Provider deleted

No data returned

Create a new email provider

POST

http://localhost:3002

/api/v1/entities/providers

Bearer (JWT)

X-API-Key (header)

Creates a new email provider configuration with API key, endpoint, and sender settings.

Create a new email provider › Request Body

provider

string · required

api_key

string · required

api_endpoint

string

from_email

string

from_name

string

reply_to

string

Create a new email provider › Responses

Provider created

No data returned

config_entries

Get providers entity metadata

GET

http://localhost:3002

/api/v1/entities/providers/meta

Bearer (JWT)

X-API-Key (header)

Returns the field schema, supported operations, and metadata for the providers entity. Used by MCP get_entity_meta tool and FE dynamic form generation.

Get providers entity metadata › Responses

200

Entity metadata

entity

string

module

string

object[]

supported_operations

string[]

List all email providers

GET

http://localhost:3002

/api/v1/entities/providers/list

Bearer (JWT)

X-API-Key (header)

Returns a list of all non-deleted email provider configurations. Each provider includes connection details (API key, endpoint, sender settings).

List all email providers › Responses

200

List of providers

object[]

Get a single email provider by UUID

GET

http://localhost:3002

/api/v1/entities/providers/{uuid}

Bearer (JWT)

X-API-Key (header)

Returns the full details of a single email provider configuration, including the API key.

Get a single email provider by UUID › path Parameters

uuid

string · uuid · required

Provider UUID

Get a single email provider by UUID › Responses

Provider details

uuid

string · uuid

provider

string

api_key

string

api_endpoint

string

from_email

string

from_name

string

reply_to

string

version

integer

Update an email provider by UUID

PUT

http://localhost:3002

/api/v1/entities/providers/{uuid}

Bearer (JWT)

X-API-Key (header)

Updates the configuration of an existing email provider. All fields are replaced.

Update an email provider by UUID › path Parameters

uuid

string · uuid · required

Provider UUID

Update an email provider by UUID › Request Body

provider

string

api_key

string

api_endpoint

string

from_email

string

from_name

string

reply_to

string

Update an email provider by UUID › Responses

Provider updated

No data returned

Delete an email provider (soft-delete)

DELETE

http://localhost:3002

/api/v1/entities/providers/{uuid}

Bearer (JWT)

X-API-Key (header)

Soft-deletes an email provider configuration. The record is marked as deleted but remains in the database.

Delete an email provider (soft-delete) › path Parameters

uuid

string · uuid · required

Provider UUID

Delete an email provider (soft-delete) › Responses

Provider deleted

No data returned

Create a new email provider

POST

http://localhost:3002

/api/v1/entities/providers

Bearer (JWT)

X-API-Key (header)

Creates a new email provider configuration with API key, endpoint, and sender settings.

Create a new email provider › Request Body

provider

string · required

api_key

string · required

api_endpoint

string

from_email

string

from_name

string

reply_to

string

Create a new email provider › Responses

Provider created

No data returned