Ghost

App · 10 actions

Publish and manage a Ghost site: write, schedule, email and update posts, and add and update members. Start a workflow when someone becomes a member or a post is published.

Actions

ActionWhat it does
Add memberAdd a free member, or update the member who already has that email.
Change memberChange a member's email, name, note, labels or newsletters.
Change postChange a post's words, tags or settings, or publish, schedule or unpublish it.
Create postWrite a post as a draft, or publish, schedule or email it.
Delete postDelete a post.
Get memberGet a member by email or ID: their status, labels and newsletters.
Get postGet a post with its content, by its ID or slug.
List membersList members, newest first, by name or email, label, status or when they joined.
List postsList posts, newest first, by status, tag or words in the title.
List tagsList the site's tags with how many posts use each.

Add member

Add a free member, or update the member who already has that email.

Inputs

EmailemailtextRequired
Their email address.
Namenametext
Their name.
Notenotetext
A note only staff see, up to 2000 characters.
Labelslabelslist
Labels to group them by; a new name makes a new label.
Newslettersnewsletterslist
The newsletters they get. Leave empty for the site's default newsletters.
If they're already a memberif_existstext
Update them with these details, or stop with an error. Defaults to updating them.One of: update (Update them), fail (Stop with an error). Default: update.

Outputs

createdtrue/false
True when a new member was added
created_attext
When they joined (ISO 8601)
emailtext
Their email address
idtext
The member's ID
labelslist
Their labels
last_seen_attext
When they were last on the site (ISO 8601)
nametext
Their name
newsletterslist
The newsletters they get
notetext
The staff note on them
statustext
free, paid, comped or gift
subscribedtrue/false
True when they get at least one newsletter
Example output
{
  "created": true,
  "created_at": "2026-10-27T10:05:00.000Z",
  "email": "jamie@example.com",
  "id": "6720f4b2c5b9a2000150e1e7",
  "labels": [
    "VIP"
  ],
  "last_seen_at": "",
  "name": "Jamie",
  "newsletters": [
    "Weekly"
  ],
  "note": "",
  "status": "free",
  "subscribed": true
}

Change member

Change a member's email, name, note, labels or newsletters.

Inputs

MembermembertextRequired
The member's email address, or their ID.
New emailemailtext
A new email address. Leave empty to keep it.
Namenametext
Their name. Leave empty to keep it.
Notenotetext
A note only staff see, up to 2000 characters. Leave empty to keep it.
Labelslabelslist
Labels to group them by; a new name makes a new label. Replaces their labels. Leave empty to keep it.
Newslettersnewsletterslist
The newsletters they get, replacing their current ones. Leave empty to keep them.

Outputs

created_attext
When they joined (ISO 8601)
emailtext
Their email address
idtext
The member's ID
labelslist
Their labels
last_seen_attext
When they were last on the site (ISO 8601)
nametext
Their name
newsletterslist
The newsletters they get
notetext
The staff note on them
statustext
free, paid, comped or gift
subscribedtrue/false
True when they get at least one newsletter
Example output
{
  "created_at": "2026-10-27T10:05:00.000Z",
  "email": "jamie@example.com",
  "id": "6720f4b2c5b9a2000150e1e7",
  "labels": [
    "VIP"
  ],
  "last_seen_at": "",
  "name": "Jamie",
  "newsletters": [
    "Weekly"
  ],
  "note": "",
  "status": "free",
  "subscribed": true
}

Change post

Change a post's words, tags or settings, or publish, schedule or unpublish it.

Inputs

PostposttextRequired
The post. Pick one, or give its ID.
Titletitletext
The post's title. Leave empty to keep it.
Content (HTML)contenttext
The post's body as HTML, such as <p>Hello</p>. Leave empty to keep it.
Statusstatustext
Publish, schedule or unpublish it (draft). Leave empty to keep it.One of: draft, published, scheduled (Scheduled (give a publish time)).
Publish timepublish_atdate and time
When a scheduled post publishes, or the date a published post shows.
Tagstagslist
Its tags; a new name makes a new tag. Replaces its tags. Leave empty to keep it.
Authorsauthorslist
The staff who wrote it. Defaults to the site owner. Leave empty to keep it.
Excerptexcerpttext
A short summary shown in lists and previews, up to 300 characters. Leave empty to keep it.
Feature imagefeature_imagetext
The address of an image to show at the top. Leave empty to keep it.
Featuredfeaturedtrue/false
Pin it as a featured post.
Who can read itvisibilitytext
Everyone, members, or paid members. Leave empty to keep it.One of: public (Everyone), members (Members only), paid (Paid members only).
Email it withemail_newslettertext
Also email the post to this newsletter's subscribers when it publishes. Leave empty to not email it.
Email toemail_segmenttext
Which subscribers get the email. Defaults to every subscriber.One of: all (Every subscriber), status:free (Free members), status:-free (Paid members). Default: all.

Outputs

authorslist
Its authors' email addresses
created_attext
When it was made (ISO 8601)
email_statustext
How its email is going, such as submitted or failed
excerpttext
Its excerpt
feature_imagetext
Its feature image's address
featuredtrue/false
True when it is featured
htmltext
Its content as HTML ('Get post' only)
idtext
The post's ID
newslettertext
The newsletter it was emailed with; empty if none
published_attext
When it was or will be published (ISO 8601)
slugtext
Its slug, the end of its address
statustext
draft, published, scheduled or sent
tagslist
Its tags
titletext
Its title
updated_attext
When it last changed (ISO 8601)
urltext
Its address on the site
visibilitytext
public, members or paid
Example output
{
  "authors": [
    "editor@example.com"
  ],
  "created_at": "2026-10-27T09:30:00.000Z",
  "email_status": "",
  "excerpt": "What's new this month.",
  "feature_image": "",
  "featured": false,
  "html": "",
  "id": "6720f3a1c5b9a2000150e1d4",
  "newsletter": "",
  "published_at": "2026-10-27T10:00:00.000Z",
  "slug": "october-update",
  "status": "published",
  "tags": [
    "News"
  ],
  "title": "October update",
  "updated_at": "2026-10-27T10:00:00.000Z",
  "url": "https://example.ghost.io/october-update/",
  "visibility": "public"
}

Create post

Write a post as a draft, or publish, schedule or email it.

Inputs

TitletitletextRequired
The post's title.
Content (HTML)contenttext
The post's body as HTML, such as <p>Hello</p>.
Statusstatustext
Draft, published, or scheduled for the publish time. Defaults to draft.One of: draft, published, scheduled (Scheduled (give a publish time)). Default: draft.
Publish timepublish_atdate and time
When a scheduled post publishes, or the date a published post shows.
Tagstagslist
Its tags; a new name makes a new tag.
Authorsauthorslist
The staff who wrote it. Defaults to the site owner.
Excerptexcerpttext
A short summary shown in lists and previews, up to 300 characters.
Feature imagefeature_imagetext
The address of an image to show at the top.
Featuredfeaturedtrue/false
Pin it as a featured post.
Who can read itvisibilitytext
Everyone, members, or paid members. Defaults to everyone.One of: public (Everyone), members (Members only), paid (Paid members only). Default: public.
Email it withemail_newslettertext
Also email the post to this newsletter's subscribers when it publishes. Leave empty to not email it.
Email toemail_segmenttext
Which subscribers get the email. Defaults to every subscriber.One of: all (Every subscriber), status:free (Free members), status:-free (Paid members). Default: all.

Outputs

authorslist
Its authors' email addresses
created_attext
When it was made (ISO 8601)
email_statustext
How its email is going, such as submitted or failed
excerpttext
Its excerpt
feature_imagetext
Its feature image's address
featuredtrue/false
True when it is featured
htmltext
Its content as HTML ('Get post' only)
idtext
The post's ID
newslettertext
The newsletter it was emailed with; empty if none
published_attext
When it was or will be published (ISO 8601)
slugtext
Its slug, the end of its address
statustext
draft, published, scheduled or sent
tagslist
Its tags
titletext
Its title
updated_attext
When it last changed (ISO 8601)
urltext
Its address on the site
visibilitytext
public, members or paid
Example output
{
  "authors": [
    "editor@example.com"
  ],
  "created_at": "2026-10-27T09:30:00.000Z",
  "email_status": "",
  "excerpt": "What's new this month.",
  "feature_image": "",
  "featured": false,
  "html": "",
  "id": "6720f3a1c5b9a2000150e1d4",
  "newsletter": "",
  "published_at": "2026-10-27T10:00:00.000Z",
  "slug": "october-update",
  "status": "published",
  "tags": [
    "News"
  ],
  "title": "October update",
  "updated_at": "2026-10-27T10:00:00.000Z",
  "url": "https://example.ghost.io/october-update/",
  "visibility": "public"
}

Delete post

Delete a post. It cannot be undone.

Inputs

PostposttextRequired
The post. Pick one, or give its ID.

Outputs

deletedtrue/false
True once deleted
idtext
The deleted post's ID
Example output
{
  "deleted": true,
  "id": "6720f3a1c5b9a2000150e1d4"
}

Get member

Get a member by email or ID: their status, labels and newsletters.

Inputs

MembermembertextRequired
The member's email address, or their ID.

Outputs

created_attext
When they joined (ISO 8601)
emailtext
Their email address
idtext
The member's ID
labelslist
Their labels
last_seen_attext
When they were last on the site (ISO 8601)
nametext
Their name
newsletterslist
The newsletters they get
notetext
The staff note on them
statustext
free, paid, comped or gift
subscribedtrue/false
True when they get at least one newsletter
Example output
{
  "created_at": "2026-10-27T10:05:00.000Z",
  "email": "jamie@example.com",
  "id": "6720f4b2c5b9a2000150e1e7",
  "labels": [
    "VIP"
  ],
  "last_seen_at": "",
  "name": "Jamie",
  "newsletters": [
    "Weekly"
  ],
  "note": "",
  "status": "free",
  "subscribed": true
}

Get post

Get a post with its content, by its ID or slug.

Inputs

PostposttextRequired
The post. Pick one, or give its ID or slug.

Outputs

authorslist
Its authors' email addresses
created_attext
When it was made (ISO 8601)
email_statustext
How its email is going, such as submitted or failed
excerpttext
Its excerpt
feature_imagetext
Its feature image's address
featuredtrue/false
True when it is featured
htmltext
Its content as HTML ('Get post' only)
idtext
The post's ID
newslettertext
The newsletter it was emailed with; empty if none
published_attext
When it was or will be published (ISO 8601)
slugtext
Its slug, the end of its address
statustext
draft, published, scheduled or sent
tagslist
Its tags
titletext
Its title
updated_attext
When it last changed (ISO 8601)
urltext
Its address on the site
visibilitytext
public, members or paid
Example output
{
  "authors": [
    "editor@example.com"
  ],
  "created_at": "2026-10-27T09:30:00.000Z",
  "email_status": "",
  "excerpt": "What's new this month.",
  "feature_image": "",
  "featured": false,
  "html": "<p>What's new this month.</p>",
  "id": "6720f3a1c5b9a2000150e1d4",
  "newsletter": "",
  "published_at": "2026-10-27T10:00:00.000Z",
  "slug": "october-update",
  "status": "published",
  "tags": [
    "News"
  ],
  "title": "October update",
  "updated_at": "2026-10-27T10:00:00.000Z",
  "url": "https://example.ghost.io/october-update/",
  "visibility": "public"
}

List members

List members, newest first, by name or email, label, status or when they joined.

Inputs

Searchsearchtext
Only members whose name or email has these words.
Labellabeltext
Only members with this label.
Statusstatustext
Only free, paid or complimentary members. Defaults to any.One of: any, free, paid, comped (Complimentary). Default: any.
Joined afterjoined_afterdate and time
Only members who joined after this moment.
How manylimitnumber
How many members, newest first. Defaults to 15.From 1 to 100.

Outputs

countnumber
How many were returned
memberslist
The members, newest first
totalnumber
How many match in all
Example output
{
  "count": 1,
  "members": [
    {
      "created_at": "2026-10-27T10:05:00.000Z",
      "email": "jamie@example.com",
      "id": "6720f4b2c5b9a2000150e1e7",
      "labels": [
        "VIP"
      ],
      "last_seen_at": "",
      "name": "Jamie",
      "newsletters": [
        "Weekly"
      ],
      "note": "",
      "status": "free",
      "subscribed": true
    }
  ],
  "total": 1
}

List posts

List posts, newest first, by status, tag or words in the title.

Inputs

Statusstatustext
Only posts with this status. Defaults to any.One of: all (Any status), published, draft, scheduled. Default: all.
Tagtagtext
Only posts with this tag.
Title containstitle_containstext
Only posts whose title has these words.
How manylimitnumber
How many posts, newest first. Defaults to 15.From 1 to 100.

Outputs

countnumber
How many were returned
postslist
The posts, newest first
totalnumber
How many match in all
Example output
{
  "count": 1,
  "posts": [
    {
      "authors": [
        "editor@example.com"
      ],
      "created_at": "2026-10-27T09:30:00.000Z",
      "email_status": "",
      "excerpt": "What's new this month.",
      "feature_image": "",
      "featured": false,
      "html": "",
      "id": "6720f3a1c5b9a2000150e1d4",
      "newsletter": "",
      "published_at": "2026-10-27T10:00:00.000Z",
      "slug": "october-update",
      "status": "published",
      "tags": [
        "News"
      ],
      "title": "October update",
      "updated_at": "2026-10-27T10:00:00.000Z",
      "url": "https://example.ghost.io/october-update/",
      "visibility": "public"
    }
  ],
  "total": 1
}

List tags

List the site's tags with how many posts use each.

Inputs

None.

Outputs

countnumber
How many tags
tagslist
The tags, by name
Example output
{
  "count": 1,
  "tags": [
    {
      "id": "6720f2c0c5b9a2000150e1c1",
      "name": "News",
      "posts": 12,
      "slug": "news"
    }
  ]
}

On this page