sendly-now Usage API

Current email usage against the monthly and daily limits the platform enforces.

Operations 3

GET /api/users/me/projects/{id}/api-requests List recent API requests made to this project, with their status codes #
GET /api/users/me/projects/{id}/api-usage Show this project's API request volume over time #
GET /api/v1/usage Retrieve current usage and limits #

Work with this as data

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/sendly-now:sendly-now-usage-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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 Specification

sendly-now-usage-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Sendly Now Usage API
  version: 1.0.0
  contact:
    name: Sendly Support
    url: https://sendly.now
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.txt
  description: 'Operations tagged Usage across 2 of this provider''s published API definitions: openapi.json, sendly-now-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sendly.now
tags:
- description: Current email usage against the monthly and daily limits the platform enforces.
  name: Usage
paths:
  /api/users/me/projects/{id}/api-requests:
    get:
      description: 'List recent API requests made to this project, with their status codes.


        Requires the `usage:read` scope — View your usage totals and billing limits.'
      operationId: listApiRequests
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      properties:
                        apiKeyId:
                          type:
                          - string
                          - 'null'
                        createdAt:
                          description: ISO 8601 datetime string
                          type: string
                        duration:
                          type:
                          - number
                          - 'null'
                        errorCode:
                          type:
                          - string
                          - 'null'
                        errorMessage:
                          type:
                          - string
                          - 'null'
                        id:
                          type: string
                        method:
                          type: string
                        path:
                          type: string
                        requestId:
                          type:
                          - string
                          - 'null'
                        statusCode:
                          type: integer
                      required:
                      - id
                      - requestId
                      - method
                      - path
                      - statusCode
                      - duration
                      - apiKeyId
                      - errorCode
                      - errorMessage
                      - createdAt
                      type: object
                    type: array
                  has_more:
                    type: boolean
                  next_cursor:
                    type:
                    - string
                    - 'null'
                required:
                - data
                - has_more
                - next_cursor
                type: object
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Validation error
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized — missing or invalid auth
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Forbidden — insufficient permissions or project disabled
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Resource not found
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Rate limit or billing limit exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      security:
      - SessionAuth: []
      - OAuth2:
        - usage:read
      summary: List recent API requests made to this project, with their status codes
      tags:
      - Usage
    servers:
    - url: https://api.sendly.now
  /api/users/me/projects/{id}/api-usage:
    get:
      description: 'Show this project''s API request volume over time.


        Requires the `usage:read` scope — View your usage totals and billing limits.'
      operationId: getApiUsage
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  errorRequests:
                    type: integer
                  perKey:
                    items:
                      properties:
                        apiKeyId:
                          description: Null for a call made with a session or an agent token.
                          type:
                          - string
                          - 'null'
                        count:
                          type: integer
                        errorCount:
                          type: integer
                        keyName:
                          type:
                          - string
                          - 'null'
                        lastFour:
                          type:
                          - string
                          - 'null'
                        revoked:
                          type: boolean
                      required:
                      - apiKeyId
                      - keyName
                      - lastFour
                      - revoked
                      - count
                      - errorCount
                      type: object
                    type: array
                  periodStart:
                    description: Start of the billing month the totals cover (UTC).
                    type: string
                  series:
                    items:
                      properties:
                        count:
                          type: integer
                        date:
                          type: string
                        errorCount:
                          type: integer
                      required:
                      - date
                      - count
                      - errorCount
                      type: object
                    type: array
                  totalRequests:
                    type: integer
                required:
                - periodStart
                - totalRequests
                - errorRequests
                - perKey
                - series
                type: object
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Validation error
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized — missing or invalid auth
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Forbidden — insufficient permissions or project disabled
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Resource not found
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Rate limit or billing limit exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      security:
      - SessionAuth: []
      - OAuth2:
        - usage:read
      summary: Show this project's API request volume over time
      tags:
      - Usage
    servers:
    - url: https://api.sendly.now
  /api/v1/usage:
    get:
      description: 'Email usage against the limits that are actually enforced: the current month''s counts per source category, the monthly cap applied to their total, and today''s sends against the trust-tier daily ceiling.


        Every figure is read from an enforcement path, so what this reports and what refuses a send cannot disagree. Correspondingly, nothing else is published — there is no billing period, invoice total or non-email meter here, because the platform meters none of those.


        Two caveats worth reading before you alert on these numbers:


        - The windows differ. The monthly counters roll over on the SERVER''s calendar month; the daily counter buckets on the UTC date. The two therefore reset at different instants.

        - `monthly.limit` is null once a subscription makes sending metered rather than capped, and also when an operator has set per-category limits — in that case the caps live in `monthly.categories[*].limit`.


        Requires the `usage:read` scope — View your usage totals and billing limits.'
      operationId: v1GetUsage
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageV1'
          description: Current usage
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: '`invalid_api_key` or `invalid_session` — missing or invalid credentials.'
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: '`scope_missing`, `project_access_denied`, or `project_disabled`.'
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: '`validation_error` — query, path, or body parameters did not match the schema.'
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: '`rate_limited` — see `Retry-After` and the `RateLimit` headers.'
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: '`internal_error`.'
      security:
      - ApiKeyAuth: []
      - SessionAuth: []
      - OAuth2:
        - usage:read
      summary: Retrieve current usage and limits
      tags:
      - Usage
    servers:
    - url: https://api.sendly.now
components:
  schemas:
    Error:
      description: 'Standard error envelope returned by all 4xx/5xx responses. Migrated routes include `success: false`; 422 validation errors add `error.details.errors`.'
      properties:
        error:
          properties:
            code:
              type: string
            details:
              properties:
                errors:
                  items: {}
                  type: array
              required:
              - errors
              type: object
            message:
              type: string
          required:
          - message
          - code
          type: object
        success:
          enum:
          - false
          type: boolean
      required:
      - error
      type: object
    UsageV1:
      description: Current email usage against the limits that are actually enforced.
      properties:
        daily:
          properties:
            emails_sent:
              description: Today's sends. Null when the counter could not be read.
              type:
              - integer
              - 'null'
            limit:
              type: integer
            trust_tier:
              enum:
              - NEW
              - ESTABLISHED
              - TRUSTED
              type: string
          required:
          - emails_sent
          - limit
          - trust_tier
          type: object
        monthly:
          properties:
            categories:
              properties:
                campaign:
                  properties:
                    emails_sent:
                      type: integer
                    limit:
                      type:
                      - integer
                      - 'null'
                  required:
                  - emails_sent
                  - limit
                  type: object
                inbound:
                  properties:
                    emails_sent:
                      type: integer
                    limit:
                      type:
                      - integer
                      - 'null'
                  required:
                  - emails_sent
                  - limit
                  type: object
                transactional:
                  properties:
                    emails_sent:
                      type: integer
                    limit:
                      type:
                      - integer
                      - 'null'
                  required:
                  - emails_sent
                  - limit
                  type: object
                workflow:
                  properties:
                    emails_sent:
                      type: integer
                    limit:
                      type:
                      - integer
                      - 'null'
                  required:
                  - emails_sent
                  - limit
                  type: object
              required:
              - transactional
              - campaign
              - workflow
              - inbound
              type: object
            emails_sent:
              type: integer
            limit:
              description: Monthly cap on the total. Null when per-category limits govern instead.
              type:
              - integer
              - 'null'
          required:
          - emails_sent
          - limit
          - categories
          type: object
        plan:
          description: '`custom` when an operator set per-category limits, `pro` on an active subscription or store entitlement, else `free`.'
          enum:
          - free
          - pro
          - custom
          type: string
      required:
      - plan
      - monthly
      - daily
      type: object
    Problem:
      description: RFC 9457 problem document, served as `application/problem+json`. Returned by every 4xx/5xx response on the `/api/v1` surface.
      properties:
        code:
          description: Machine-readable lowercase error code, e.g. `scope_missing`.
          type: string
        detail:
          description: Explanation specific to this occurrence.
          type: string
        errors:
          description: Field-level failures. Present on 422 `validation_error` responses.
          items:
            properties:
              code:
                type: string
              message:
                type: string
              pointer:
                description: RFC 6901 JSON Pointer to the offending field.
                type: string
            required:
            - pointer
            - code
            - message
            type: object
          type: array
        instance:
          description: Request path the failure occurred on.
          type: string
        next:
          description: The tool an agent calls next to repair this failure — `request_scopes` for a missing permission, `upgrade_plan` for an exhausted plan. Absent when no tool repairs it.
          properties:
            args:
              additionalProperties: {}
              description: Arguments to call it with.
              type: object
            tool:
              description: The MCP tool that repairs this failure, e.g. `upgrade_plan`.
              type: string
          required:
          - tool
          type: object
        request_id:
          description: Correlation id — quote it in support requests.
          type: string
        status:
          description: HTTP status code, repeated in the body.
          type: integer
        title:
          description: Short, stable summary — the same for every occurrence of a `type`.
          type: string
        type:
          description: Dereferenceable URI identifying the error class, anchored on the docs errors page.
          format: uri
          type: string
      required:
      - type
      - title
      - status
      - code
      type: object
  securitySchemes:
    ApiKeyAuth:
      bearerFormat: API Key
      description: 'API key authentication. Use a `sk_*` (FULL) or `pk_*` (SENDING_ONLY) key as the bearer token. Public keys (`pk_*`) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by `/api/v1/*` operations): FULL keys hold every scope; SENDING_ONLY keys hold only `emails:send`.'
      scheme: bearer
      type: http
    MailgunBasicAuth:
      description: 'Mailgun-style authentication for the `/api/compat/mailgun/*` operations only: HTTP Basic with the username `api` and a Sendly API key (`sk_*`, or a `pk_*` send-only key) as the password, exactly as mailgun.js sends it.'
      scheme: basic
      type: http
    OAuth2:
      description: 'OAuth 2.1 with PKCE, for AI agents and other delegated clients (this is what the MCP endpoint at `/api/mcp` uses, and how a third-party application sends on a user''s behalf). Tokens are minted through the consent screen and carry ONLY the scopes the user ticked there, so an operation lists the single scope it requires and a token without it answers `403` with code `SCOPE_MISSING` — before any input is parsed. Unlike an API key, a delegated token reaches an operation only where the route itself declares a scope; every other route refuses it outright.


        **Ask for the right audience.** Pass `resource=https://app.sendly.now/api` on the authorization AND the token request to receive a token for this REST API; `resource=https://app.sendly.now/api/mcp` is the MCP endpoint''s identifier. A request carrying no `resource` receives an OPAQUE token, which every endpoint here rejects. Each identifier publishes RFC 9728 metadata at `/.well-known/oauth-protected-resource/api` and `/.well-known/oauth-protected-resource/api/mcp`.


        **Name the project on every call.** An OAuth grant belongs to a USER, not to a project — the same person may belong to several — so a delegated token carries no tenant and the project is chosen per request with the `x-project-id` header, checked against real membership. Omit it and a project-scoped operation answers `400`; send one the user does not belong to and it answers `403 PROJECT_ACCESS_DENIED`. List the projects a token may name with `GET /api/users/me/projects` (scope `projects:read`), which needs no header. API keys are unaffected: a key already names its project.'
      flows:
        authorizationCode:
          authorizationUrl: https://app.sendly.now/api/auth/oauth2/authorize
          refreshUrl: https://app.sendly.now/api/auth/oauth2/token
          scopes:
            account:read: See your profile and notification preferences
            account:write: Edit your profile and preferences, export your data, delete your account
            analytics:read: View your sending analytics and engagement metrics
            api-keys:read: See which API keys exist, including what each one is allowed to do
            api-keys:write: Create, rotate, and revoke API keys — these keep working even after you disconnect this app
            billing:read: See your plan, usage, invoices and spending limits
            billing:write: Start a checkout, change spending limits, open the billing portal, cancel or refund
            campaigns:read: View your campaigns and their performance
            campaigns:send: Send or schedule your campaigns to their audience
            campaigns:write: Create, edit, and organize your campaigns
            connections:read: See connected services such as Slack and connected AI apps
            connections:write: Connect, re-verify and disconnect services
            contacts:read: View your contacts and their custom fields
            contacts:write: Create, update, and delete your contacts
            deliverability:read: Check why mail from one of your domains is not arriving
            domains:read: View your sending domains and their verification status
            domains:write: Add and remove sending domains, and trigger verification
            emails:read: View the emails you have sent and their delivery status
            emails:send: Send emails from your verified domains
            emails:test: Send test emails to your own address from the Sendly sandbox
            events:read: View the custom events your application has recorded
            events:write: Record custom events for your contacts
            lists:read: View your subscriber lists and who is on them
            lists:write: Create, rename, and delete your subscriber lists
            mailbox-conversations:read: Read the conversations in your hosted mailboxes — every message and attachment people have sent you
            mailbox-conversations:reply: Reply to conversations in your hosted mailboxes, from the mailbox's own address
            mailboxes:read: View the mailboxes on your domains and their settings
            mailboxes:send: Write and send new email from your hosted mailboxes, as that address
            mailboxes:write: Create and delete mailboxes on your verified domains
            members:read: See who belongs to your projects
            members:write: Add and remove project members and change their roles
            projects:read: View your projects and their settings
            projects:write: Create, change, reset and delete projects on your account
            segments:read: View your segments and who belongs to them
            segments:write: Create, edit, and delete your segments
            support:read: See your support tickets
            support:write: Open support tickets and suspension appeals
            suppression:read: View the addresses on your suppression list
            suppression:write: Add and remove addresses on your suppression list
            templates:read: View your email templates
            templates:write: Create, edit, and delete your email templates
            topics:read: View the topics you mail about and who is subscribed to each
            topics:write: Create and edit topics, and change what your contacts are subscribed to — this decides who your campaigns reach
            usage:read: View your usage totals and billing limits
            validation:read: View your email validation runs and their results
            validation:write: Check whether email addresses can receive mail — this is billed per address
            webhooks:read: View your webhook endpoints and their delivery history
            webhooks:write: Create, edit, and delete your webhook endpoints
            workflows:read: View your automation workflows and their runs
            workflows:write: Create, edit, enable, and delete your automation workflows
          tokenUrl: https://app.sendly.now/api/auth/oauth2/token
      type: oauth2
    PostmarkServerToken:
      description: 'Postmark-style authentication for the `/api/compat/postmark/*` operations only: a Sendly API key (`sk_*`, or a `pk_*` send-only key) sent in the `X-Postmark-Server-Token` header, exactly where the postmark SDK puts its server token.'
      in: header
      name: X-Postmark-Server-Token
      type: apiKey
    SessionAuth:
      description: BetterAuth session cookie. Used by the dashboard / browser clients. When present, the active project is taken from the `x-project-id` header.
      in: cookie
      name: better-auth.session_token
      type: apiKey
x-refined-from:
- openapi.json
- sendly-now-openapi.json