Autional Autional
API Reference GitHub autional.com →

GET /communication/providers

Paginated query of provider configuration list for the current tenant. Supports filtering by channel (sms/email/push) and activation status. Configuration credentials are automatically masked in responses (displayed as ***REDACTED***). References: ePrivacy Directive 2002/58/EC, CAN-SPAM Act.

Communication Service `bearerAuth` application/json

Request Parameters

NameInTypeRequiredDefaultExampleConstraintsDescription
channel query string No Channel filter: sms/email/push
is_active query boolean No Activation status filter: true/false
page query integer No Page number, starting from 1 (default 1)
page_size query integer No Items per page (default 20)

Responses

StatusDescriptionSchema
200Query successful, returns configuration list (credentials masked)dto.ListResponse-dto_ProviderConfigResponse
400Invalid request parametersdto.SimpleResponse
401Unauthenticated or invalid tokendto.SimpleResponse
403Insufficient permissions to access this resourcedto.SimpleResponse
500Internal server errordto.SimpleResponse

Referenced Schemas

dto.ListResponse-dto_ProviderConfigResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
items array of

See dto.ProviderConfigResponse

No Unified use of items
message string No
pagination object No Pagination information (nested object)
timestamp string No
total integer No Total count (flattened for direct reading)

dto.PageInfo

FieldTypeRequiredExampleConstraintsDescription
has_next boolean No HasNext indicates whether there is a next page
has_prev boolean No HasPrev indicates whether there is a previous page
page integer No Page is the current page number (1-based)
page_size integer No PageSize is the number of items per page
total integer No Total is the total number of items across all pages
total_pages integer No TotalPages is the total number of pages

dto.ProviderConfigResponse

FieldTypeRequiredExampleConstraintsDescription
app_id string No
channel string No
config string No
created_at string No
id string No
is_active boolean No
priority integer No
provider string No
tenant_id string No
updated_at string No

dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No