Skip to main content

Get Email provider by its id

GET 
https://$CUSTOM-DOMAIN/admin/v1/email/:id

Get a specific Email provider by its ID.

Request​

Path Parameters

    id stringrequired

Responses​

A successful response.

Schema

    config

    object

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
    id string
    state string

    Possible values: [EMAIL_PROVIDER_STATE_UNSPECIFIED, EMAIL_PROVIDER_ACTIVE, EMAIL_PROVIDER_INACTIVE]

    Default value: EMAIL_PROVIDER_STATE_UNSPECIFIED

    description string

    smtp

    object

    senderAddress string
    senderName string
    tls boolean
    host string
    user string
    replyToAddress string

    http

    object

    endpoint string
curl -L 'https://$CUSTOM-DOMAIN/admin/v1/email/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Parameters
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!