Read a project

One project, deleted or not (a deleted one has deleted_at). An admin key reads any project; a project key with scope read reads its own.

Parameters

Name	In	Type	Description
`project_id`required	path	string · uuid	The project’s id

Request body

None.

Responses

200

The project

Project object · all fields required
created_atstring · date-time
deleted_atstring · date-time | null

When the project was deleted; null while it is live. A deleted project can only be read.
idstring · uuid

example 01900000-0000-7000-8000-000000000001
namestring

example Acme News
settingsProjectSettings

A project’s settings, every field present.
11 fields
- ProjectSettings object · all fields required
- auto_footerboolean
  
  Add an unsubscribe footer when a template has none.
- brandingBranding
  
  How the public pages look.
  4 fields
  
  Branding object · all fields required
  
  brand_namestring | null
  
  languageLanguage
  
  The language of the public pages.
  
  en
  ru
  
  support_emailstring · email | null
  
  text_overridesmap of string → string
  
  Texts of the pages by key.
- daily_send_quotainteger · int32 | null
  
  Most messages a day; null: no quota.
  
  ≥ 0
- default_throttle_per_hourinteger · int32 | null
  
  Default campaign speed, messages an hour; null: no limit.
  
  ≥ 0
- dns_credentialsDnsCredentials
  
  Which DNS providers the project set its own credentials for; the credentials are never returned.
  1 fields
  
  DnsCredentials object · all fields required
  
  porkbunboolean
  
  Whether the project set its own Porkbun credentials.
- from_emailstring · email | null
  
  Default sender address of campaigns.
- from_namestring | null
  
  Default sender name of campaigns.
- reply_tostring · email | null
  
  Default Reply-To.
- soft_bounce_suppress_afterinteger · int32 | null
  
  Soft bounces in a row after which an address is suppressed; null: off.
  
  ≥ 0
- trackingTracking
  
  What campaigns track by default.
  2 fields
  
  Tracking object · all fields required
  
  clicksboolean
  
  opensboolean
- transportstring | null
  
  Default transport, direct or relay:<name>; null: the node’s delivery.default_transport.
slugstring

example acme-news
updated_atstring · date-time

The latest change: creation, rename, settings, deletion.

401

No valid key

Problem (application/problem+json)

403

A project key without scope read (forbidden)

Problem (application/problem+json)

404

No such project, or another project’s (not_found)

Problem (application/problem+json)

429

The key is over its rate limit, api.rate_limit_per_minute requests a minute on this node (rate_limited)

Header	Type	Description
`Retry-After`	integer	Seconds until the key’s next request passes; rounded up.

Problem (application/problem+json)

504

Postwind’s storage did not answer within its time limit (storage_timeout). A change the request makes may still take effect: check before repeating it. A repeat with the same Idempotency-Key never runs it twice: it is 409 idempotency_key_in_progress until the key’s 24 h end

Problem (application/problem+json)