Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/auth0:auth0-emails-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Auth0 Emails API
version: '2.0'
contact:
name: Auth0 Support
url: https://support.auth0.com
termsOfService: https://auth0.com/web-terms/
description: 'Operations tagged emails across 2 of this provider''s published API definitions: auth0-management-api-openapi.yml, auth0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{tenantDomain}/api/v2
variables:
tenantDomain:
default: '{TENANT}.auth0.com'
description: Auth0 Tenant Domain
security:
- bearerAuth: []
tags:
- name: Emails
paths:
/emails/provider:
get:
summary: Get Email Provider
description: Retrieve details of the email provider configuration in your tenant. A list of fields to include or exclude may also be specified.
tags:
- Emails
parameters:
- name: fields
in: query
description: Comma-separated list of fields to include or exclude (dependent upon include_fields) from the result. Leave empty to retrieve `name` and `enabled`. Additional fields available include `credentials`, `default_from_address`, and `settings`.
schema:
type: string
pattern: ^((name)|(enabled)|(credentials)|(settings)|(default_from_address))(,((name)|(enabled)|(credentials)|(settings)|(default_from_address)))*$
- name: include_fields
in: query
description: Whether specified fields are to be included (true) or excluded (false).
schema:
type: boolean
responses:
'200':
description: Email provider successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/GetEmailProviderResponseContent'
'400':
description: Invalid request query string. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Client is not global.
x-description-2: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope; expected any of: read:email_provider.'
'404':
description: Email provider has not been configured.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: get_provider
x-release-lifecycle: GA
x-operation-name: get
x-operation-request-parameters-name: GetEmailProviderRequestParameters
x-operation-group:
- emails
- provider
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- read:email_provider
delete:
summary: Delete Email Provider
description: Delete the email provider.
tags:
- Emails
responses:
'204':
description: The email provider has been deleted.
'400':
description: Invalid request URI. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Client is not global.
x-description-2: Invalid signature received for JSON Web Token validation
'403':
description: 'Insufficient scope, expected any of: delete:email_provider'
'404':
description: Email provider does not exist.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: delete_provider
x-release-lifecycle: GA
x-operation-name: delete
x-operation-group:
- emails
- provider
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- delete:email_provider
patch:
summary: Update Email Provider
description: 'Update an email provider. The credentials object
requires different properties depending on the email provider (which is specified using the name property):
mandrill requires api_key
sendgrid requires api_key
sparkpost requires api_key. Optionally, set region to eu to use
the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
North America. eu or null are the only valid values for region.
mailgun requires api_key and domain. Optionally, set region to
eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
null are the only valid values for region.
ses requires accessKeyId, secretAccessKey, and region
smtp requires smtp_host, smtp_port, smtp_user, and
smtp_pass
Depending on the type of provider it is possible to specify settings object with different configuration
options, which will be used when sending an email:
smtp provider, settings may contain headers object.
When using AWS SES SMTP host, you may provide a name of configuration set in
X-SES-Configuration-Set header. Value must be a string.
When using Sparkpost host, you may provide value for
X-MSYS_API header. Value must be an object.
for ses provider, settings may contain message object, where you can provide
a name of configuration set in configuration_set_name property. Value must be a string.'
tags:
- Emails
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEmailProviderRequestContent'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateEmailProviderRequestContent'
responses:
'200':
description: Email provider successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEmailProviderResponseContent'
'400':
description: Invalid request body. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Client is not global.
x-description-2: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope; expected any of: update:email_provider.'
'404':
description: Email provider has not been configured.
'409':
description: No deployed action was found.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: patch_provider
x-release-lifecycle: GA
x-operation-name: update
x-operation-group:
- emails
- provider
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- update:email_provider
post:
summary: Configure Email Provider
description: 'Create an email provider. The credentials object
requires different properties depending on the email provider (which is specified using the name property):
mandrill requires api_key
sendgrid requires api_key
sparkpost requires api_key. Optionally, set region to eu to use
the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
North America. eu or null are the only valid values for region.
mailgun requires api_key and domain. Optionally, set region to
eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
null are the only valid values for region.
ses requires accessKeyId, secretAccessKey, and region
smtp requires smtp_host, smtp_port, smtp_user, and
smtp_pass
Depending on the type of provider it is possible to specify settings object with different configuration
options, which will be used when sending an email:
smtp provider, settings may contain headers object.
When using AWS SES SMTP host, you may provide a name of configuration set in
X-SES-Configuration-Set header. Value must be a string.
When using Sparkpost host, you may provide value for
X-MSYS_API header. Value must be an object.
for ses provider, settings may contain message object, where you can provide
a name of configuration set in configuration_set_name property. Value must be a string.'
tags:
- Emails
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEmailProviderRequestContent'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateEmailProviderRequestContent'
responses:
'201':
description: Email provider successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEmailProviderResponseContent'
'400':
description: Invalid request body. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Client is not global.
x-description-2: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope; expected any of: create:email_provider.'
'409':
description: Email provider is already configured.
x-description-1: No deployed action was found.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: post_provider
x-release-lifecycle: GA
x-operation-name: create
x-operation-group:
- emails
- provider
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- create:email_provider
servers:
- url: https://{tenantDomain}/api/v2
variables:
tenantDomain:
default: '{TENANT}.auth0.com'
description: Auth0 Tenant Domain
components:
schemas:
EmailProviderCredentials:
type: object
description: Credentials required to use the provider.
additionalProperties: false
properties:
api_user:
type: string
description: API User.
region:
type: string
description: AWS or SparkPost region.
smtp_host:
type: string
description: SMTP host.
smtp_port:
type: integer
description: SMTP port.
smtp_user:
type: string
description: SMTP username.
CreateEmailProviderRequestContent:
type: object
additionalProperties: false
required:
- name
- credentials
properties:
name:
$ref: '#/components/schemas/EmailProviderNameEnum'
enabled:
type: boolean
description: Whether the provider is enabled (true) or disabled (false).
default: true
default_from_address:
type: string
description: Email address to use as "from" when no other address specified.
credentials:
$ref: '#/components/schemas/EmailProviderCredentialsSchema'
settings:
$ref: '#/components/schemas/EmailSpecificProviderSettingsWithAdditionalProperties'
EmailSpecificProviderSettingsWithAdditionalProperties:
type:
- object
- 'null'
description: Specific provider setting
additionalProperties: true
EmailProviderCredentialsSchema:
type: object
description: Credentials required to use the provider.
anyOf:
- type: object
additionalProperties: false
required:
- api_key
properties:
api_key:
type: string
description: API Key
minLength: 1
- type: object
additionalProperties: false
minProperties: 1
properties:
accessKeyId:
type: string
description: AWS Access Key ID.
minLength: 1
secretAccessKey:
type: string
description: AWS Secret Access Key.
minLength: 1
region:
type: string
description: AWS region.
minLength: 1
- type: object
additionalProperties: false
minProperties: 1
properties:
smtp_host:
$ref: '#/components/schemas/EmailSMTPHost'
smtp_port:
type: integer
description: SMTP port.
smtp_user:
type: string
description: SMTP username.
minLength: 1
smtp_pass:
type: string
description: SMTP password.
minLength: 1
- type: object
additionalProperties: false
minProperties: 1
properties:
api_key:
type: string
description: API Key
minLength: 1
region:
$ref: '#/components/schemas/EmailSparkPostRegionEnum'
- type: object
additionalProperties: false
minProperties: 1
properties:
api_key:
type: string
description: API Key
minLength: 1
domain:
type: string
description: Domain
minLength: 4
region:
$ref: '#/components/schemas/EmailMailgunRegionEnum'
- type: object
additionalProperties: false
minProperties: 1
properties:
connectionString:
type: string
description: Azure Communication Services Connection String.
minLength: 1
- type: object
additionalProperties: false
minProperties: 1
properties:
tenantId:
type: string
description: Microsoft 365 Tenant ID.
minLength: 1
clientId:
type: string
description: Microsoft 365 Client ID.
minLength: 1
clientSecret:
type: string
description: Microsoft 365 Client Secret.
minLength: 1
- $ref: '#/components/schemas/ExtensibilityEmailProviderCredentials'
EmailSparkPostRegionEnum:
description: Set to <code>eu</code> to use SparkPost service hosted in Western Europe. To use SparkPost hosted in North America, set it to <code>null</code>.
enum:
- eu
- null
EmailMailgunRegionEnum:
description: Set to <code>eu</code> if your domain is provisioned to use Mailgun's EU region. Otherwise, set to <code>null</code>.
enum:
- eu
- null
ExtensibilityEmailProviderCredentials:
type: object
additionalProperties: false
properties: {}
EmailProviderNameEnum:
type: string
description: Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `resend`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`.
enum:
- mailgun
- mandrill
- sendgrid
- resend
- ses
- sparkpost
- smtp
- azure_cs
- ms365
- custom
UpdateEmailProviderResponseContent:
type: object
additionalProperties: false
properties:
name:
type: string
description: Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `resend`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`.
default: sendgrid
enabled:
type: boolean
description: Whether the provider is enabled (true) or disabled (false).
default: true
default_from_address:
type: string
description: Email address to use as "from" when no other address specified.
credentials:
$ref: '#/components/schemas/EmailProviderCredentials'
settings:
$ref: '#/components/schemas/EmailProviderSettings'
EmailProviderSettings:
type: object
description: Specific provider setting
additionalProperties: true
EmailSMTPHost:
type: string
description: SMTP host.
anyOf:
- type: string
format: hostname-rfc2181
- type: string
format: ipv4
- type: string
format: ipv6
GetEmailProviderResponseContent:
type: object
additionalProperties: false
properties:
name:
type: string
description: Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `resend`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`.
default: sendgrid
enabled:
type: boolean
description: Whether the provider is enabled (true) or disabled (false).
default: true
default_from_address:
type: string
description: Email address to use as "from" when no other address specified.
credentials:
$ref: '#/components/schemas/EmailProviderCredentials'
settings:
$ref: '#/components/schemas/EmailProviderSettings'
UpdateEmailProviderRequestContent:
type: object
additionalProperties: false
minProperties: 1
properties:
name:
$ref: '#/components/schemas/EmailProviderNameEnum'
enabled:
type: boolean
description: Whether the provider is enabled (true) or disabled (false).
default_from_address:
type: string
description: Email address to use as "from" when no other address specified.
credentials:
$ref: '#/components/schemas/EmailProviderCredentialsSchema'
settings:
$ref: '#/components/schemas/EmailSpecificProviderSettingsWithAdditionalProperties'
CreateEmailProviderResponseContent:
type: object
additionalProperties: false
properties:
name:
type: string
description: Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `resend`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`.
default: sendgrid
enabled:
type: boolean
description: Whether the provider is enabled (true) or disabled (false).
default: true
default_from_address:
type: string
description: Email address to use as "from" when no other address specified.
credentials:
$ref: '#/components/schemas/EmailProviderCredentials'
settings:
$ref: '#/components/schemas/EmailProviderSettings'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: jwt
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: /oauth/token/
x-form-parameters:
audience: /api/v2/
scopes:
create:actions: Create Actions
read:actions: Read Actions
update:actions: Update Actions
delete:actions: Delete Actions
read:anomaly_blocks: Read Anomaly Blocks
delete:anomaly_blocks: Delete Anomaly Blocks
read:attack_protection: Read Attack Protection
update:attack_protection: Update Attack Protection
create:authentication_methods: Create Authentication Methods
read:authentication_methods: Read Authentication Methods
update:authentication_methods: Update Authentication Methods
delete:authentication_methods: Delete Authentication Methods
read:branding: Read Branding
update:branding: Update Branding
delete:branding: Delete Branding
create:client_credentials: Create Client Credentials
read:client_credentials: Read Client Credentials
update:client_credentials: Update Client Credentials
delete:client_credentials: Delete Client Credentials
create:client_grants: Create Client Grants
read:client_grants: Read Client Grants
update:client_grants: Update Client Grants
delete:client_grants: Delete Client Grants
read:client_keys: Read Client Keys
update:client_keys: Update Client Keys
read:client_summary: Read Client Summary
update:client_token_vault_privileged_access: Update Client Token Vault Privileged Access
create:clients: Create Clients
read:clients: Read Clients
update:clients: Update Clients
delete:clients: Delete Clients
create:connection_profiles: Create Connection Profiles
read:connection_profiles: Read Connection Profiles
update:connection_profiles: Update Connection Profiles
delete:connection_profiles: Delete Connection Profiles
create:connections: Create Connections
read:connections: Read Connections
update:connections: Update Connections
delete:connections: Delete Connections
create:connections_keys: Create Connections Keys
read:connections_keys: Read Connections Keys
update:connections_keys: Update Connections Keys
read:current_user: Read Current User
delete:current_user: Delete Current User
create:current_user_device_credentials: Create Current User Device Credentials
delete:current_user_device_credentials: Delete Current User Device Credentials
update:current_user_identities: Update Current User Identities
update:current_user_metadata: Update Current User Metadata
create:custom_domains: Create Custom Domains
read:custom_domains: Read Custom Domains
update:custom_domains: Update Custom Domains
delete:custom_domains: Delete Custom Domains
create:custom_signing_keys: Create Custom Signing Keys
read:custom_signing_keys: Read Custom Signing Keys
update:custom_signing_keys: Update Custom Signing Keys
delete:custom_signing_keys: Delete Custom Signing Keys
read:device_credentials: Read Device Credentials
delete:device_credentials: Delete Device Credentials
create:directory_provisionings: Create Directory Provisionings
read:directory_provisionings: Read Directory Provisionings
update:directory_provisionings: Update Directory Provisionings
delete:directory_provisionings: Delete Directory Provisionings
create:email_provider: Create Email Provider
read:email_provider: Read Email Provider
update:email_provider: Update Email Provider
delete:email_provider: Delete Email Provider
create:email_templates: Create Email Templates
read:email_templates: Read Email Templates
update:email_templates: Update Email Templates
create:encryption_keys: Create Encryption Keys
read:encryption_keys: Read Encryption Keys
update:encryption_keys: Update Encryption Keys
delete:encryption_keys: Delete Encryption Keys
read:event_deliveries: Read Event Deliveries
update:event_deliveries: Update Event Deliveries
create:event_streams: Create Event Streams
read:event_streams: Read Event Streams
update:event_streams: Update Event Streams
delete:event_streams: Delete Event Streams
read:events: Read Events
read:federated_connections_tokens: Read Federated Connections Tokens
delete:federated_connections_tokens: Delete Federated Connections Tokens
create:flows: Create Flows
read:flows: Read Flows
update:flows: Update Flows
delete:flows: Delete Flows
read:flows_executions: Read Flows Executions
delete:flows_executions: Delete Flows Executions
create:flows_vault_connections: Create Flows Vault Connections
read:flows_vault_connections: Read Flows Vault Connections
update:flows_vault_connections: Update Flows Vault Connections
delete:flows_vault_connections: Delete Flows Vault Connections
create:forms: Create Forms
read:forms: Read Forms
update:forms: Update Forms
delete:forms: Delete Forms
read:grants: Read Grants
delete:grants: Delete Grants
read:group_members: Read Group Members
read:groups: Read Groups
delete:groups: Delete Groups
create:guardian_enrollment_tickets: Create Guardian Enrollment Tickets
read:guardian_enrollments: Read Guardian Enrollments
delete:guardian_enrollments: Delete Guardian Enrollments
read:guardian_factors: Read Guardian Factors
update:guardian_factors: Update Guardian Factors
create:hooks: Create Hooks
read:hooks: Read Hooks
update:hooks: Update Hooks
delete:hooks: Delete Hooks
create:log_streams: Create Log Streams
read:log_streams: Read Log Streams
update:log_streams: Update Log Streams
delete:log_streams: Delete Log Streams
read:logs: Read Logs
read:logs_users: Read Logs Users
read:mfa_policies: Read Mfa Policies
update:mfa_policies: Update Mfa Policies
create:network_acls: Create Network Acls
read:network_acls: Read Network Acls
update:network_acls: Update Network Acls
delete:network_acls: Delete Network Acls
create:organization_client_grants: Create Organization Client Grants
read:organization_client_grants: Read Organization Client Grants
delete:organization_client_grants: Delete Organization Client Grants
create:organization_connections: Create Organization Connections
read:organization_connections: Read Organization Connections
update:organization_connections: Update Organization Connections
delete:organization_connections: Delete Organization Connections
create:organization_discovery_domains: Create Organization Discovery Domains
read:organization_discovery_domains: Read Organization Discovery Domains
update:organization_discovery_domains: Update Organization Discovery Domains
delete:organization_discovery_domains: Delete Organization Discovery Domains
create:organization_invitations: Create Organization Invitations
read:organization_invitations: Read Organization Invitations
delete:organization_invitations: Delete Organization Invitations
create:organization_member_roles: Create Organization Member Roles
read:organization_member_roles: Read Organization Member Roles
delete:organization_member_roles: Delete Organization Member Roles
create:organization_members: Create Organization Members
read:organization_members: Read Organization Members
delete:organization_members: Delete Organization Members
create:organizations: Create Organizations
read:organizations: Read Organizations
update:organizations: Update Organizations
delete:organizations: Delete Organizations
read:organizations_summary: Read Organizations Summary
create:phone_providers: Create Phone Providers
read:phone_providers: Read Phone Providers
update:phone_providers: Update Phone Providers
delete:phone_providers: Delete Phone Providers
create:phone_templates: Create Phone Templates
read:phone_templates: Read Phone Templates
update:phone_templates: Update Phone Templates
delete:phone_templates: Delete Phone Templates
read:prompts: Read Prompts
update:prompts: Update Prompts
read:refresh_tokens: Read Refresh Tokens
update:refresh_tokens: Update Refresh Tokens
delete:refresh_tokens: Delete Refresh Tokens
create:resource_servers: Create Resource Servers
read:resource_servers: Read Resource Servers
update:resource_servers: Update Resource Servers
delete:resource_servers: Delete Resource Servers
create:role_members: Create Role Members
read:role_members: Read Role Members
delete:role_members: Delete Role Members
create:roles: Create Roles
read:roles: Read Roles
update:roles: Update Roles
delete:roles: Delete Roles
create:rules: Create Rules
read:rules: Read Rules
update:rules: Update Rules
delete:rules: Delete Rules
read:rules_configs: Read Rules Configs
update:rules_configs: Update Rules Configs
delete:rules_configs: Delete Rules Configs
create:scim_config: Create Scim Config
read:scim_config: Read Scim Config
update:scim_config: Update Scim Config
delete:scim_config: Delete Scim Config
create:scim_token: Create Scim Token
read:scim_token: Read Scim Token
delete:scim_token: Delete Scim Token
read:self_service_profile_custom_texts: Read Self Service Profile Custom Texts
update:self_service_profile_custom_texts: Update Self Service Profile Custom Texts
create:self_service_profiles: Create Self Service Profiles
read:self_service_profiles: Read Self Service Profiles
update:self_service_profiles: Update Self Service Profiles
delete:self_service_profiles: Delete Self Service Profiles
read:sessions: Read Sessions
update:sessions: Update Sessions
delete:sessions: Delete Sessions
create:signing_keys: Create Signing Keys
read:signing_keys: Read Signing Keys
update:signing_keys: Update Signing Keys
create:sso_access_tickets: Create Sso Access Tickets
delete:sso_access_tickets: Delete Sso Access Tickets
read:stats: Read Stats
read:tenant_settings: Read Tenant Settings
update:tenant_settings: Update Tenant Settings
create:token_exchange_profiles: Create Token Exchange Profiles
read:token_exchange_profiles: Read Token Exchange Profiles
update:token_exchange_profiles: Update Token Exchange Profiles
delete:token_exchange_profiles: Delete Token Exchange Profiles
create:user_attribute_profiles: Create User Attribute Profiles
read:user_attribute_profiles: Read User Attribute Profiles
update:user_attribute_profiles: Update User Attribute Profiles
delete:user_attribute_profiles: Delete User Attribute Profiles
read:user_idp_tokens: Read User Idp Tokens
create:user_tickets: Create User Tickets
create:users: Create Users
read:users: Read Users
update:users: Update Users
delete:users: Delete Users
update:users_app_metadata: Update Users App Metadata
create:vdcs_templates: Create Vdcs Templates
read:vdcs_templates: Read Vdcs Templates
update:vdcs_templates: Update Vdcs Templates
delete:vdcs_templates: Delete Vdcs Templates
externalDocs:
description: Auth0 Management API Documentation
url: https://auth0.com/docs/api/management/v2/
x-refined-from:
- auth0-management-api-openapi.yml
- auth0-openapi.json