v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Providers API

Retrieve a Provider

Use this endpoint to get detailed information about a specific provider using its unique identifier.

get/v1/providers/{id}

Path parameters

idstring required

The unique identifier of the provider.

Response

Detailed information about a specific provider.

idstring

Unique identifier of the provider.

namestring

Name of the provider.

category'Email' | 'SMS'

Provider category.

type'SendGrid' | 'Twilio'

Provider implementation type.

subTypestring

Provider sub-type, if applicable.

methodstring

Authentication or delivery method.

clientIdstring

Client ID or API key (secret is never returned).

clientId2string

Secondary client ID, if applicable.

hoststring

SMTP or API host address.

portinteger

SMTP port.

disableSslboolean

Indicates whether SSL/TLS is disabled.

titlestring

Default email or SMS title/subject.

contentstring

Default message content template.

receiverstring

Default receiver address for testing.

regionIdstring

Cloud region ID (provider-specific).

signNamestring

SMS signature name (provider-specific).

templateCodestring

SMS template code (provider-specific).

appIdstring

Application ID (provider-specific).

endpointstring

Provider API endpoint URL.

intranetEndpointstring

Intranet endpoint for private network access.

domainstring

Provider domain.

providerUrlstring

Provider-specific URL.

createdAtstring date-time

Timestamp marking when the provider was created.