Projects

Retrieve the authenticated project

The project the presented credential is scoped to — resolved from the API key, or from the x-project-id header for a session or delegated token. Singular despite the plural path, like /api/v1/usage: every v1 operation acts on exactly one project.

sandbox_address is this project's quick-start sender. It works with no domain setup, but only to the project owner's own verified address and under a daily cap — it is how you prove sending works end to end before any DNS exists. It is null when no handle can be derived (a project with no owner).

To enumerate every project you belong to — a different question, and not project-scoped — use GET /api/users/me/projects.

Requires the projects:read scope — View your projects and their settings.

get/api/v1/projects

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/projects
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: projects:read)

Response

The authenticated project

created_atstring date-time required
disabledboolean required

A disabled project sends nothing; every send is refused.

idstring uuid required
languagestring required

ISO 639-1 code for customer-facing content.

namestring required
sandbox_addressstring nullable required

This project's quick-start sender, usable with no domain setup — but only to the project owner's own verified address, and under a daily cap. Null when none can be derived.

ses_regionstring nullable required

Locked once the first domain is added.

tracking'ENABLED' | 'DISABLED' | 'MARKETING_ONLY' required

Changes

No recorded changes to this operation across all 1 revision of this API.