Skip to Content
SendlySendly
API ReferenceProjects

Show which onboarding steps this project has finished: a verified domain, a first email, contacts

GET
/api/projects/{id}/setup-state

Show which onboarding steps this project has finished: a verified domain, a first email, contacts.

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.

id*string

Response Body

OK

application/json
  1. response
[key: string]?unknown
Example Request
curl -X GET 'https://api.sendly.now/api/projects/string/setup-state'
Example Response
{  "property1": null,  "property2": null}