Skip to Content
SendlySendly
API ReferenceProjects

Retrieve the authenticated project

GET
/api/v1/projects

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.

headerAuthorizationBearer <API Key>

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.

Response Body

The authenticated project

application/json
  1. response

The project the presented credential is scoped to.

id*string
Formatuuid
name*string
disabled*boolean

A disabled project sends nothing; every send is refused.

sandbox_address*|

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_region*|

Locked once the first domain is added.

tracking*string
Value in"ENABLED""DISABLED""MARKETING_ONLY"
language*string

ISO 639-1 code for customer-facing content.

created_at*string
Formatdate-time
Example Request
curl -X GET 'https://api.sendly.now/api/v1/projects'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "disabled": true,  "sandbox_address": "string",  "ses_region": "string",  "tracking": "ENABLED",  "language": "string",  "created_at": "2019-08-24T14:15:22Z"}