SMTPfast API
The SMTPfast API lets you send transactional emails, manage sending domains, create API keys, configure webhooks, and view analytics. All requests require a…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The SMTPfast API lets you send transactional emails, manage sending domains, create API keys, configure webhooks, and view analytics. All requests require a Bearer token obtained from the SMTPfast dashboard.
Endpoints 162
Logs
- GETList email events
/v1/logsThe event log behind the dashboard Logs page: every lifecycle event of every sent email, newest first, with keyset pagination (after walks older, before walks…
Receiving
- GETList received emails
/v1/emails/receivingReceived emails for the team, newest first, with keyset pagination (after walks older, before walks newer, exclusive). List items carry metadata only; fetch… - PATCHMark received emails read or unread
/v1/emails/receivingSet the read state of up to 100 received emails at once. Not in Resend. Ids that are not the team's are skipped. Requires the inbound:read scope. - GETGet a received email
/v1/emails/receiving/:idOne received email with text and HTML bodies, headers, attachment metadata and a 15-minute link to the raw .eml. A quarantined message (virus verdict not… - DELETEDelete a received email
/v1/emails/receiving/:idRemove the team's copy of a received email and its attachments. Requires the inbound:delete scope. - PATCHMark a received email read or unread
/v1/emails/receiving/:idSet the read state of one received email. Not in Resend. Requires the inbound:read scope. - POSTReply to a received email
/v1/emails/receiving/:id/replySend a reply to a received message through the normal send pipeline (credits, suppression, safety checks, webhooks). The reply is threaded with In-Reply-To… - GETList attachments of a received email
/v1/emails/receiving/:id/attachmentsAttachment metadata with a fresh 15-minute download link for each file. Requires the inbound:read scope. - GETGet one attachment of a received email
/v1/emails/receiving/:id/attachments/:attachment_idMetadata and a fresh 15-minute download link for one attachment. Requires the inbound:read scope.
Inboxes
- GETList inboxes
/v1/inboxesThe team's inboxes, newest first, with cursor paging (after walks older, before walks newer). unread counts threads in the inbox folder with at least one… - POSTCreate an inbox
/v1/inboxesOrganise one address on your own domain as an inbox with threads, labels, folders and drafts. The domain must have receiving turned on and be able to send… - GETRetrieve an inbox
/v1/inboxes/:inbox_idOne inbox by id or by its email address. Requires the inbound:read scope. - DELETEDelete an inbox
/v1/inboxes/:inbox_idDelete the inbox with its threads, labels and drafts. Received messages stay in GET /v1/emails/receiving until the 30-day retention removes them, and the… - PATCHUpdate an inbox
/v1/inboxes/:inbox_idChange the internal name or the name recipients see. At least one of name or from_name. from_name: null clears it (not in Resend). Requires the domain:write… - GETList threads
/v1/inboxes/:inbox_id/threadsThreads in one folder, most recently active first. query takes Gmail-style search, with the operators Resend's dashboard search uses: from:, to: (a full… - GETRetrieve a thread
/v1/inboxes/:inbox_id/threads/:thread_idThe thread summary; list its messages with GET .../threads/{thread_id}/emails. Requires the inbound:read scope. - DELETEDelete a thread
/v1/inboxes/:inbox_id/threads/:thread_idMove the thread to trash; it and its received messages are removed 30 days later. Reversible until then by moving it back with PATCH. deleted is false when it… - PATCHUpdate a thread
/v1/inboxes/:inbox_id/threads/:thread_idMark every message read or unread (the same read state the mailbox and GET /v1/emails/receiving show), move the thread to inbox, archive, spam or trash (sent… - GETList thread notes
/v1/inboxes/:inbox_id/threads/:thread_id/notesInternal notes on a thread, oldest first (after walks newer, before walks older). Notes are for the team: they are never emailed, never part of a reply,… - POSTAdd a thread note
/v1/inboxes/:inbox_id/threads/:thread_id/notesAdd an internal note to a thread as the member the key belongs to. Plain text, up to 5000 characters; a thread holds up to 500 notes. The note is never sent… - DELETEDelete a thread note
/v1/inboxes/:inbox_id/threads/:thread_id/notes/:note_idRemove a note. Its author can remove it, and so can a team owner or admin. Not in Resend. Requires the inbound:read scope. - GETList thread emails
/v1/inboxes/:inbox_id/threads/:thread_id/emailsThe messages of a thread, received and sent together, oldest first (after walks newer, before walks older). Not in Resend: latest=true returns the newest page… - GETRetrieve a thread email
/v1/inboxes/:inbox_id/threads/:thread_id/emails/:email_idOne message of a thread. For a received message the id is also the received email id, so its attachments download through GET… - POSTReply to a thread email
/v1/inboxes/:inbox_id/threads/:thread_id/emails/:email_id/replySends real email: a reply from the inbox address, threaded with In-Reply-To and References, through the normal send path (verified domain, suppression, plan… - POSTForward a thread email
/v1/inboxes/:inbox_id/threads/:thread_id/emails/:email_id/forwardSends real email: a forward from the inbox address with the original quoted under a forwarded-message banner, through the normal send path. to is required; 50… - GETList labels
/v1/inboxes/:inbox_id/labelsEvery label on the inbox, oldest first. Requires the inbound:read scope. - POSTCreate a label
/v1/inboxes/:inbox_id/labelsA named, colored tag on one inbox. Names are unique per inbox, ignoring case; an inbox holds up to 100 labels. color defaults to mauve. Organising mail needs… - GETRetrieve a label
/v1/inboxes/:inbox_id/labels/:label_idOne label of the inbox, in the same shape as the list items. 404 when the label belongs to another inbox. Not in Resend. Requires the inbound:read scope. - DELETEDelete a label
/v1/inboxes/:inbox_id/labels/:label_idRemove the label from the inbox and from every thread that carries it. No message is removed. Requires the inbound:read scope. - PATCHUpdate a label
/v1/inboxes/:inbox_id/labels/:label_idRename or recolor a label. At least one of name or color. Requires the inbound:read scope. - GETList drafts
/v1/inboxes/:inbox_id/draftsUnsent drafts, most recently updated first: the queue a person reviews. created_via and created_at are not in Resend. Requires the inbound:read scope. - POSTCreate a draft
/v1/inboxes/:inbox_id/draftsCreate a draft for a person to review and send. Nothing is sent, so it needs only the inbound:read scope: give an agent a key without email:send and every… - GETRetrieve a draft
/v1/inboxes/:inbox_id/drafts/:draft_idOne draft, sent or not. Requires the inbound:read scope. - DELETEDelete a draft
/v1/inboxes/:inbox_id/drafts/:draft_idDiscard a draft and its files. A draft being sent right now returns 409. Requires the inbound:read scope. - PATCHUpdate a draft
/v1/inboxes/:inbox_id/drafts/:draft_idOmitted fields stay as they are; null clears one. attachments replace every file on the draft (null or [] removes them all), as in Resend; not in Resend, an… - GETRetrieve a draft attachment
/v1/inboxes/:inbox_id/drafts/:draft_id/attachments/:attachment_idOne file of a draft with a download link that works for 15 minutes, so the person approving a draft can open what was attached. Not in Resend. A sent draft… - POSTSend a draft
/v1/inboxes/:inbox_id/drafts/:draft_id/sendSends real email: the approval step for a draft. It goes out from the inbox address through the normal send path; a reply draft joins its thread with…
Emails
- GETList sent emails
/v1/emailsList sent emails, newest first. Bodies are not included; fetch one with GET /v1/emails/{id}. Requires the email:read scope. - POSTSend an email
/v1/emailsQueue a single email for delivery. The email is validated, queued, and sent asynchronously via the configured sending provider. Recipients on domains reserved… - POSTSend a batch of emails
/v1/emails/batchQueue up to 100 emails in a single request. The body is a JSON array of email objects, each using the same shape as the single-send endpoint. Validation runs… - GETGet email details
/v1/emails/:idRetrieve the current status and delivery events for a specific email by its ID. - PATCHReschedule a scheduled email
/v1/emails/:idChange the send time of a scheduled email. Only scheduled_at can be changed; to change content, cancel and send again. Requires the email:send scope. - POSTCancel a scheduled email
/v1/emails/:id/cancelCancel an email that has not been sent yet. Valid while the email is scheduled or queued; returns 409 once it has left for the provider. Requires the… - POSTCreate a share link for a sent email
/v1/emails/:id/shareMint a public, expiring link to the rendered view of one sent email (the stored HTML or text body, in a sandboxed frame). Nothing is stored; the link stops… - GETRetrieve email metrics
/v1/emails/metricsResend-compatible counts and rates over a date range, for transactional and broadcast email together. Leave dimensions out for one totals row; add period,… - GETList clicked links
/v1/emails/clicked-linksClicked links across all email over the last N days, ranked by clicks, with unique clicks (distinct emails). Pass url for one link's totals, daily series and…
Contacts
- GETList contact properties
/v1/contact-propertiesThe custom fields this team has declared, with their types and defaults. - POSTDeclare a contact property
/v1/contact-propertiesDeclare a custom field. Declaring is optional: contacts may carry undeclared properties, and those keep working. Declaring gives the field a default used when… - GETGet a contact property
/v1/contact-properties/:idReturn one custom contact property by id. - DELETEDelete a contact property
/v1/contact-properties/:idRemoves the declaration only. Contact values stay where they are, so re-declaring the key finds them again. - PATCHUpdate a contact property default
/v1/contact-properties/:idChanges fallback_value only. Key and type are immutable: renaming would orphan the values already stored under the old key. - GETList contacts
/v1/contactsReturn contacts for the current account. Optional query parameters q, status, and limit support filtering. - POSTCreate a contact
/v1/contactsCreate one contact, or send { contacts: [...] } to create or update up to 500 at once. The single form returns 409 when the email already exists; the bulk… - DELETEDelete contacts in bulk
/v1/contactsDelete up to 500 contacts by id with {"ids": [...]}, or the whole audience with {"confirm": "all"} (optionally with status subscribed or unsubscribed). Not in… - GETExport contacts
/v1/contacts/exportExport up to 10,000 contacts for the current account as CSV or JSON. Optional status and disposable filtering match the list endpoint. - GETList segments
/v1/segmentsReturn manual contact segments for the current account. - POSTCreate a segment
/v1/segmentsCreate a manual segment for organizing contacts and targeting broadcasts. - GETRetrieve a segment
/v1/segments/:idReturn one segment by id, with the number of contacts in it. - DELETEDelete a segment
/v1/segments/:idDelete a segment. Its contacts stay; only their membership in this segment goes. - PATCHUpdate a segment
/v1/segments/:idChange the name, description or color of a segment. Only the fields sent change. - GETList contacts in a segment
/v1/segments/:id/contactsReturn contacts assigned to a manual segment. - GETRetrieve a contact
/v1/contacts/:idRetrieve a contact by ID or URL-encoded email address. - DELETEDelete a contact
/v1/contacts/:idDelete a contact by ID or URL-encoded email address. - PATCHUpdate a contact
/v1/contacts/:idUpdate name fields, subscription status, or custom properties. Email addresses cannot be changed. - GETList a contact's segments
/v1/contacts/:id/segmentsThe segments one contact belongs to. The contact can be named by id or email address, like Resend. Requires the contact:read scope. - POSTAdd a contact to a segment
/v1/contacts/:id/segments/:segment_idResend-compatible. Adding a contact that is already in the segment is not an error. Requires the contact:write scope. - DELETERemove a contact from a segment
/v1/contacts/:id/segments/:segment_idResend-compatible. The contact stays in the audience. Requires the contact:write scope.
Broadcasts
- GETList broadcasts
/v1/broadcastsReturn broadcast campaigns for the current account with recipient rollup metrics. - POSTCreate a broadcast draft
/v1/broadcastsCreate a broadcast campaign draft. Broadcasts can be edited while draft or scheduled, and must include an unsubscribe token before sending. - GETGet broadcast details
/v1/broadcasts/:idRetrieve a broadcast with metrics and the latest recipient rows. - DELETEDelete a draft broadcast
/v1/broadcasts/:idDelete a broadcast that has not been queued or scheduled. - PATCHUpdate a draft or scheduled broadcast
/v1/broadcasts/:idUpdate broadcast content. Updating a scheduled broadcast cancels the previous schedule and returns it to draft. - GETPreview a broadcast audience
/v1/broadcasts/audienceHow many contacts a broadcast to all contacts, or to one segment, would reach after unsubscribes, suppressions and invalid addresses are skipped, plus the… - GETList broadcast recipients
/v1/broadcasts/:id/recipientsResend-compatible: recipients of a broadcast for one event type (sent, delivered, opened, clicked, bounced, complained, unsubscribed, suppressed), newest… - GETList clicked links
/v1/broadcasts/:id/clicked-linksEvery link clicked in this broadcast, with total clicks and the number of distinct recipients who clicked it. Ordered by total clicks. - POSTDuplicate broadcast
/v1/broadcasts/:id/duplicateCopy a broadcast into a new draft. Content and targeting carry over; the schedule, recipients and send history do not. Pass name to set the copy's name,… - POSTSend or schedule a broadcast
/v1/broadcasts/:id/sendSnapshot eligible subscribed contacts, create one queued email per recipient, and send now or schedule within 30 days. With send_over_minutes the recipients… - POSTCancel a scheduled broadcast
/v1/broadcasts/:id/cancelCancel a broadcast. A scheduled broadcast is stopped before anything is sent. A queued or sending broadcast stops where it is: emails already accepted are… - POSTArchive a broadcast
/v1/broadcasts/:id/archiveHide a sent, canceled or failed broadcast from the default list. The broadcast, its recipients and its stats stay available, and the list shows it with… - POSTUnarchive a broadcast
/v1/broadcasts/:id/unarchiveReturn an archived broadcast to the default list. Unarchiving a broadcast that is not archived changes nothing. - POSTSend a test broadcast email
/v1/broadcasts/:id/testQueue a test email to a single recipient using the broadcast content and personalization sample data.
Templates
- GETList templates
/v1/templatesList the team's templates, newest first, in Resend's list shape. Page with limit and an after or before id (not both). Rows carry no content; get one template… - POSTCreate a template
/v1/templatesCreate a template as a draft. Publish it with POST /v1/templates/{id}/publish before sending with it. Same body as Resend's create template; markdown,… - GETGet a template
/v1/templates/:idGet one template by id or alias. The content fields are the current draft; has_unpublished_versions says whether it differs from the published version that… - DELETEDelete a template
/v1/templates/:idDelete a template by id or alias. Emails already sent with it are not affected. Requires the email:send scope. - PATCHUpdate a template
/v1/templates/:idChange the draft. Only the fields you send change. Sends keep using the published version until you publish again. Pass expected_updated_at to refuse the… - POSTPublish a template
/v1/templates/:id/publishPublish the current draft. From then on, sends that name this template render this version; later edits change only the draft until the next publish. Pass the… - POSTDuplicate a template
/v1/templates/:id/duplicateCopy a template's draft into a new draft template named with "(copy)" appended. The alias is not copied and nothing is published. Requires the email:send scope.
Domains
- GETList domains
/v1/domainsReturn all sending domains associated with the current account. - POSTAdd a domain
/v1/domainsRegister a new sending domain. Returns the DNS records that must be configured before the domain can be verified. - GETGet domain details
/v1/domains/:idRetrieve details for a single domain including its current verification status and DNS records. - DELETEDelete a domain
/v1/domains/:idResend-compatible. Removes the domain and its sending identity at the provider. Mail from it stops at once. Requires the domain:write scope and an owner or… - PATCHTurn inbound receiving on or off
/v1/domains/:idEnable or disable inbound email for a verified domain (paid plans). Returns the MX record to publish and the receiving status: disabled, pending, active or… - GETGet the claim record for a domain
/v1/domains/claim?domain=stringThe TXT record a team publishes to prove DNS control before claiming a domain another account added but never verified. 404 when nobody holds the domain, 409… - POSTClaim a domain held by another account
/v1/domains/claimChecks the claim TXT record and moves a never-verified domain from the account that holds it to the caller's team, with its verification reset and any mail… - POSTVerify a domain
/v1/domains/:id/verifyCheck whether the required DNS records have been configured correctly. If verification succeeds, the domain status changes to verified and it can be used for… - POSTSet up sending DNS on Cloudflare in one click
/v1/domains/:id/domain-connect/cloudflareFor a domain whose DNS is on Cloudflare, returns a signed Domain Connect link. The domain owner opens it, approves the change in Cloudflare, and the sending… - POSTSet up receiving DNS on Cloudflare in one click
/v1/domains/:id/domain-connect/cloudflare-inboundLike the sending version, for the MX record that turns on receiving. Not in Resend. Requires the domain:write scope. - GETList link domains
/v1/link-domainsThe team's custom link domains with their status and DNS records. available says whether the feature is on, included_in_plan whether the team's plan has it.… - POSTAdd a link domain
/v1/link-domainsAdd a custom hostname for tracking and unsubscribe links, such as links.example.com. It must be a subdomain of one of your verified sending domains, one per… - GETGet a link domain
/v1/link-domains/:idOne link domain with the DNS records to publish: the CNAME pointing at SMTPfast, and any TXT ownership record Cloudflare offers. Shows the state from the last… - DELETEDelete a link domain
/v1/link-domains/:idMail stops using the link domain at once and the hostname is removed from Cloudflare. Links in mail already sent through it stop working once the hostname is… - GETCheck one-click DNS setup for a link domain
/v1/link-domains/:id/domain-connectWhether the link domain's DNS provider can add its CNAME record through Domain Connect, the open standard behind one-click DNS setup. Not in Resend. Requires… - POSTSet up a link domain's DNS in one click
/v1/link-domains/:id/domain-connectReturns a signed Domain Connect link. The domain owner opens it, approves the CNAME record at the DNS provider, and the link domain turns active once… - POSTRefresh a link domain's status
/v1/link-domains/:id/refreshAsk Cloudflare for the current state now, instead of waiting for the automatic check (every few minutes while pending, daily once active). Also restarts…
API Keys
- GETList API keys
/v1/api-keysReturn all API keys for the current account. The full key value is never included; only the prefix is shown. - POSTCreate API key
/v1/api-keysGenerate a new API key. The full key value is returned only once in the response. Store it securely. Requires the apikey:manage scope when called with an API… - DELETERevoke API key
/v1/api-keys/:idPermanently revoke an API key. Any requests using this key will be rejected immediately. Requires the apikey:manage scope when called with an API key. Called… - PATCHUpdate API key
/v1/api-keys/:idRename a key or change its scopes. The secret is unchanged; scope changes apply on the key's next request. Requires the apikey:manage scope when called with…
Webhooks
- GETList webhooks
/v1/webhooksReturn all webhook endpoints configured for the current account. - POSTCreate webhook
/v1/webhooksRegister a new webhook endpoint. SMTPfast will POST event payloads to this URL when the specified events occur. - GETGet webhook
/v1/webhooks/:idRetrieve a single webhook endpoint by ID. - PUTUpdate webhook
/v1/webhooks/:idUpdate the URL, events, or active status of an existing webhook endpoint. - DELETEDelete webhook
/v1/webhooks/:idRemove a webhook endpoint. Its recorded deliveries are removed with it. - PATCHUpdate webhook
/v1/webhooks/:idSame as PUT: a partial update that leaves out any field you omit. Accepted because Resend uses PATCH for this, so ported code works unchanged. - POSTTest webhook
/v1/webhooks/:id/testSend a test event payload to the webhook URL and return the delivery result. Useful for verifying that your endpoint is reachable and responds correctly. - GETList webhook deliveries
/v1/webhooks/:id/deliveriesDelivery log of one webhook, newest first: every event we POSTed with its attempts, status code, response time, response snippet and error. Failed deliveries… - GETGet a webhook delivery
/v1/webhooks/:id/deliveries/:delivery_idOne delivery with the exact payload that was sent. Requires the webhook:read scope. - POSTRetry a webhook delivery
/v1/webhooks/:id/deliveries/:delivery_id/retrySend the same payload again, once, right now, and return the result of that attempt. A delivery with a scheduled attempt still pending returns 409. Requires… - GETList webhook events
/v1/webhooks/:id/eventsResend-compatible list of the events sent to one webhook, newest first, each with its delivery status: success, failed, attempting (a retry is scheduled) or… - GETRetrieve a webhook event
/v1/webhooks/:id/events/:event_idOne event with the exact payload that was sent and the time of the next retry, if any. Requires the webhook:read scope. - GETList the attempts of a webhook event
/v1/webhooks/:id/events/:event_id/attemptsEvery attempt to deliver one event, newest first, with the HTTP status your endpoint returned. The latest attempt carries the start of the response body;… - POSTReplay a webhook event
/v1/webhooks/:id/events/:event_id/replayOne more delivery attempt for an event, now, with the same body, signed with the current secret. A retry that is already scheduled is brought forward instead… - POSTRotate a webhook signing secret
/v1/webhooks/:id/signing-secret/rotateReplace the signing secret. The new secret is in this response only, and every event sent after this call, retries included, is signed with it, so update your…
Analytics
- GETGet analytics
/v1/analyticsSending and deliverability totals for the account, plus a 30-day daily series. bounceRate counts hard bounces only, over the last 30 days; the bounces object…
Account
- GETWhat this API key can do
/v1/meThe key's scopes, the user who created it, its team, the plan tier, the rate limit, and which send-time safety checks apply to the account. Requires no scope:… - GETUsage against the plan
/v1/usageUsage and plan limits in the same shape as Resend's GET /usage: emails in the last 24 hours and this month (with the reset time), contacts, segments,… - GETWhether the account is active
/v1/account/activationA new account is pending until one of three things happens: an invite code is redeemed, a paid plan is bought, or a free-trial request is approved. This says… - POSTAsk for the free plan
/v1/account/activation/free-trialSends a free-trial request with the use case, as the activation page does. A person reviews it and the account is emailed when it is approved. A second… - POSTActivate with an invite code
/v1/account/activation/inviteActivates the account on the free plan with an invite code. Limited to 10 tries a minute. Works with the key smtpfast signup returns while the account is… - POSTActivate with a paid plan
/v1/account/activation/checkoutReturns a Stripe Checkout link for a paid plan. A person opens it and pays; the account is active as soon as Stripe confirms the payment, so poll GET…
Suppressions
- POSTSuppress addresses in bulk
/v1/suppressions/batch/addResend-compatible: add 1 to 100 addresses as manual suppressions of every send (scope all). An address already suppressed keeps its record, except that a… - POSTRemove suppressions in bulk
/v1/suppressions/batch/removeResend-compatible: remove 1 to 100 suppressions by emails or by ids, not both. Hard bounces and complaints are released from the provider's account list too.… - GETList suppressions
/v1/suppressionsReturn suppressed addresses for the current account. Suppressed recipients are blocked before sending. A suppression with scope marketing blocks marketing… - POSTCreate a manual suppression
/v1/suppressionsManually suppress an address so future sends to it are blocked: every send by default, or marketing email only with scope marketing. - GETRetrieve a suppression
/v1/suppressions/:idRetrieve a suppression by ID or URL-encoded email address. - DELETEDelete a suppression
/v1/suppressions/:idRemove a suppression. The address becomes eligible for future sends unless it is suppressed again.
Forms
- GETList signup forms
/v1/formsReturn all signup forms for the current account. - POSTCreate a signup form
/v1/formsCreate a new signup form, including its confirmation sender and welcome email if you send them. After creation, the embed snippet at /api/forms/{id}/submit… - POSTPreview a form's welcome email
/v1/forms/:id/welcome-previewRender the welcome email of a signup form for a sample contact, without sending it. Pass subject and markdown to preview unsaved changes. Not in Resend.… - GETRetrieve a signup form
/v1/forms/:idRetrieve a signup form by ID. - DELETEDelete a signup form
/v1/forms/:idDelete a signup form. Embedded snippets pointing at this form will stop working. - PATCHUpdate a signup form
/v1/forms/:idUpdate fields, styling, double opt-in behaviour, the confirmation and welcome emails, or active state on an existing form. Only the fields sent change.… - GETList pending signups
/v1/forms/:id/pendingSignups on a double opt-in form that have not clicked their confirmation link and have not expired, newest first. Each one carries the status of its… - POSTApprove all pending signups
/v1/forms/:id/pending/approve-allConfirm pending signups without waiting for the link click, up to 200 per call; call again while remaining is above zero. Each one becomes a contact, fires… - DELETERemove a pending signup
/v1/forms/:id/pending/:pendingIdRemove a pending signup without adding it as a contact. Its confirmation link stops working. Requires the form:write scope. - POSTApprove a pending signup
/v1/forms/:id/pending/:pendingId/approveConfirm one pending signup without waiting for the link click. It becomes a contact, fires contact.subscribed and gets the welcome email if enabled. Approving…
Team
- GETList team members
/v1/team/membersEveryone on the key's team, oldest first, with their role. Any member can list. Requires the team:read scope. - DELETERemove a member
/v1/team/members/:idRemoves the person from the team and revokes their API keys for it. Team resources stay. You cannot remove yourself this way, and the last owner cannot be… - PATCHChange a member's role or billing access
/v1/team/members/:idSend role, can_manage_billing, or both. Owners and admins can change roles under the same rules as the Members page (an admin cannot touch an owner, a team… - GETList pending invitations
/v1/team/invitesInvitations that are not accepted and not expired, newest first. Owner or admin only; requires the team:read scope. - POSTInvite someone to the team
/v1/team/invitesEmails an invitation link that is valid for 7 days. The person signs in with the invited address to accept. Inviting the same address again sends a fresh… - GETRetrieve a pending invitation
/v1/team/invites/:idOne invitation, in the same shape as the list items. 404 once it is accepted, expired or revoked, or when it belongs to another team. Owner or admin only;… - DELETERevoke an invitation
/v1/team/invites/:idThe link stops working at once. Owner or admin only; requires the team:manage scope.
Billing
- GETGet the plan and usage
/v1/billingThe plan the team runs on, its state in Stripe (billing interval, status, renewal or end date, a scheduled move to a smaller plan, a failed payment), usage… - POSTGet a link to start or change a plan
/v1/billing/checkoutNothing is charged and no plan changes here: the response is a link for a person to open. Without a subscription it is a Stripe Checkout page. With one it is… - POSTGet a link to the billing portal
/v1/billing/portalA Stripe billing portal link, for cards, invoices, billing details and cancelling. Plan changes are not offered there. With flow set to cancel it opens on the… - GETList invoices
/v1/billing/invoicesInvoices from Stripe, newest first. Page with after or before, set to an invoice id from the list. Only keys created by the team owner can call it, because…
CLI Login
- POSTStart a CLI login
/v1/cli/deviceStart a device login for a command-line tool. Show the user_code and verification_uri to the person, then poll POST /v1/cli/token every interval seconds with… - POSTCollect the CLI login key
/v1/cli/tokenPoll with the device_code from POST /v1/cli/device. Until the code is approved this answers 400 with an RFC 8628 error. Once approved it returns a new API… - POSTStart a signup from the CLI
/v1/cli/signupEmails an 8-digit code to the address. The answer is the same whether or not the address has an account: an address that has one is emailed to say so, and its… - POSTFinish a CLI signup with the emailed code
/v1/cli/signup/verifyChecks the code and creates the account as the website does: pending until it is activated, on the free plan, with a team, the address confirmed. Returns the…
API details
- Base URL
https://smtpfa.st/api- Authentication
- A bearer token in the Authorization header
- Operations
- 162 operations on 107 pathsGET 65POST 57DELETE 22PATCH 17PUT 1
- Main resources
- Inboxes 28Contacts 21Domains 17Webhooks 15Broadcasts 14Forms 10Emails 9Receiving 9Team 7Templates 7
- Response formats
application/jsontext/csv- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- OpenAPI document · Support
- Listed from
- Smtpfa's published OpenAPI description
How to test the SMTPfast API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the SMTPfast API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List email events” (GET /v1/logs), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the SMTPfast API?
The SMTPfast API lets you send transactional emails, manage sending domains, create API keys, configure webhooks, and view analytics. All requests require a… It is listed under Communication and has 162 endpoints.
Who publishes the SMTPfast API?
It is listed from SMTPfast's public API description (an OpenAPI document), not published by SMTPfast on Swastik Codes. Anyone who controls smtpfa.st can claim the profile by adding a DNS TXT record.
What is the base URL of the SMTPfast API?
Requests go to https://smtpfa.st/api. Endpoint paths are added to this base URL.
How do I authenticate with the SMTPfast API?
With A bearer token in the Authorization header.
How many endpoints does the SMTPfast API have?
162 operations on 107 paths (65 GET, 57 POST, 22 DELETE, 17 PATCH, 1 PUT). The largest groups are Inboxes, Contacts, Domains, Webhooks.
Is forking the SMTPfast API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.