List Email Configs

GET /tenants/{tenant}/email-configs

Returns a paginated list of email configurations the current user can access (owned or shared). EmailConnections admins see all configurations including other users' private ones.

Requires: ViewAll on EmailConnections.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

sortBy query enum

Field to sort by. Valid values depend on the resource.

FromEmail CreatedDate

Field to sort by. Valid values depend on the resource.

FromEmail CreatedDate

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

isDefault query boolean

Filter by default status

Filter by default status

isSendShared query boolean

Filter by send-shared status

Filter by send-shared status

readSharing query string

Filter by read-sharing mode (Private, Everyone, Selected)

Filter by read-sharing mode (Private, Everyone, Selected)

status query string

Filter by configuration lifecycle status

Filter by configuration lifecycle status

search query string

Search term to filter results

Search term to filter results

Responses

401 Unauthorized – Invalid or missing API key
403 Forbidden – the caller lacks the permissions this endpoint requires; the detail lists every one missing
application/problem+json