Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Notyfi account API

The account API from Notyfi — 3 operation(s) for account.

Notyfi account API is one of 5 APIs that Notyfi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 1.2.0.

Requests are made against a single base URL, https://api.notyfi.com.

6 operations 3 paths 13 schemas 2 DELETE1 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.2.0
Base URL
https://api.notyfi.com/api/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Notyfi account API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as X-Api-Key (apiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — Notyfi API key: Authorization: Bearer notyfimk...
  • apiKeyAuth — Notyfi API key as X-Api-Key.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 2 DELETE, 1 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

account 6
GET
/api/v1/account
Read/bootstrap the signed-in consumer account
account_api_v1_account_get 3 params → 200401403409429503422
PATCH
/api/v1/account
Update the signed-in consumer profile and workspace
patch_account_api_v1_account_patch 3 params body → 200401403409429503422
DELETE
/api/v1/account
Confirm and begin permanent account deletion
delete_account_api_v1_account_delete 2 params body → 202401403409429503422
POST
/api/v1/account/notification-emails
Add or resend verification for a notification email
add_notification_email_api_v1_account_notification_emails_post 3 params body → 202401403409429503422
PATCH
/api/v1/account/notification-emails/{recipient_id}
Enable or disable a verified notification email
update_notification_email_api_v1_account_notification_emails__recipient_id__patch 3 params body → 200401403409429503422
DELETE
/api/v1/account/notification-emails/{recipient_id}
Remove a secondary notification email
delete_notification_email_api_v1_account_notification_emails__recipient_id__delete 3 params → 204401403409429503422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are NotyfiAccountInfo (7 properties), NotyfiNotificationEmailInfo (6 properties), ValidationError (5 properties), NotyfiAccountDeletionInfo (5 properties). Each schema is shown below with its type and property counts.

NotyfiNotificationEmailInfo
object
6 properties 2 required
NotyfiNotificationEmailUpdate
object
1 property 1 required
NotyfiNotificationEmailCreate
object
1 property 1 required
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
NotyfiWorkspaceFolder
object
3 properties 2 required
NotyfiWorkspace
object
2 properties
NotyfiAccountPatch
object
3 properties 1 required
NotyfiAccountInfo
object
The consumer identity bound to the access-token subject. email is populated only from a separately verified, same-sub Cognito ID token. It is never accepted fr…
7 properties 1 required
Error
object
The single error response shape for every 4xx/5xx on the contract.
1 property 1 required
NotyfiAccountDeletionInfo
object
5 properties 3 required
ErrorBody
object
3 properties 2 required
NotyfiAccountDeleteConfirm
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

notyfi-account-api-openapi.yml Raw ↑

Other APIs Notyfi publishes across the network.

Notyfi billing API
Notyfi keys API
Notyfi trackers API
Notyfi webhooks API