List Email providers
POST/email/_search
Returns a list of Email providers.
Request​
- application/json
- application/grpc
- application/grpc-web+proto
Body
required
query
object
Object unspecific list filters like offset, limit and asc/desc.
Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
default is descending
Body
required
query
object
Object unspecific list filters like offset, limit and asc/desc.
Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
default is descending
Body
required
query
object
Object unspecific list filters like offset, limit and asc/desc.
Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
default is descending
Responses​
- 200
- 403
- 404
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
result
object[]
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [EMAIL_PROVIDER_STATE_UNSPECIFIED
, EMAIL_PROVIDER_ACTIVE
, EMAIL_PROVIDER_INACTIVE
]
Default value: EMAIL_PROVIDER_STATE_UNSPECIFIED
smtp
object
http
object
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-10-11T09:02:47.252Z"
},
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2024-10-11T09:02:47.252Z",
"changeDate": "2024-10-11T09:02:47.252Z",
"resourceOwner": "69629023906488334"
},
"id": "string",
"state": "EMAIL_PROVIDER_STATE_UNSPECIFIED",
"description": "string",
"smtp": {
"senderAddress": "noreply@m.zitadel.cloud",
"senderName": "ZITADEL",
"tls": true,
"host": "smtp.postmarkapp.com:587",
"user": "197f0117-529e-443d-bf6c-0292dd9a02b7",
"replyToAddress": "replyto@m.zitadel.cloud"
},
"http": {
"endpoint": "string"
}
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
result
object[]
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [EMAIL_PROVIDER_STATE_UNSPECIFIED
, EMAIL_PROVIDER_ACTIVE
, EMAIL_PROVIDER_INACTIVE
]
Default value: EMAIL_PROVIDER_STATE_UNSPECIFIED
smtp
object
http
object
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-10-11T09:02:47.253Z"
},
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2024-10-11T09:02:47.253Z",
"changeDate": "2024-10-11T09:02:47.253Z",
"resourceOwner": "69629023906488334"
},
"id": "string",
"state": "EMAIL_PROVIDER_STATE_UNSPECIFIED",
"description": "string",
"smtp": {
"senderAddress": "noreply@m.zitadel.cloud",
"senderName": "ZITADEL",
"tls": true,
"host": "smtp.postmarkapp.com:587",
"user": "197f0117-529e-443d-bf6c-0292dd9a02b7",
"replyToAddress": "replyto@m.zitadel.cloud"
},
"http": {
"endpoint": "string"
}
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
result
object[]
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [EMAIL_PROVIDER_STATE_UNSPECIFIED
, EMAIL_PROVIDER_ACTIVE
, EMAIL_PROVIDER_INACTIVE
]
Default value: EMAIL_PROVIDER_STATE_UNSPECIFIED
smtp
object
http
object
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-10-11T09:02:47.254Z"
},
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2024-10-11T09:02:47.254Z",
"changeDate": "2024-10-11T09:02:47.254Z",
"resourceOwner": "69629023906488334"
},
"id": "string",
"state": "EMAIL_PROVIDER_STATE_UNSPECIFIED",
"description": "string",
"smtp": {
"senderAddress": "noreply@m.zitadel.cloud",
"senderName": "ZITADEL",
"tls": true,
"host": "smtp.postmarkapp.com:587",
"user": "197f0117-529e-443d-bf6c-0292dd9a02b7",
"replyToAddress": "replyto@m.zitadel.cloud"
},
"http": {
"endpoint": "string"
}
}
]
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}