Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ghost.org/llms.txt

Use this file to discover all available pages before exploring further.

At minimum, an email is required to create a new, free member. 
// POST /admin/members/
{
    "members": [
        {
            "email": "jamie@ghost.org",
        }
    ]
}

// Response
{
    "members": [
        {
            "id": "624d445026833200a5801bce",
            "uuid": "83525d87-ac70-40f5-b13c-f9b9753dcbe8",
            "email": "jamie@ghost.org",
            "name": null,
            "note": null,
            "geolocation": null,
            "subscribed": true,
            "created_at": "2022-04-06T07:42:08.000Z",
            "updated_at": "2022-04-06T07:42:08.000Z",
            "labels": [],
            "subscriptions": [],
            "avatar_image": "https://gravatar.com/avatar/7d8efd2c2a781111599a8cae293cf704?s=250&d=blank",
            "email_count": 0,
            "email_opened_count": 0,
            "email_open_rate": null,
            "status": "free",
            "last_seen_at": null,
            "comped": false,
            "unsubscribe_url": "https://example.com/unsubscribe/?uuid=83525d87-ac70-40f5-b13c-f9b9753dcbe8&key=...",
            "can_comment": true,
            "commenting": {
                "disabled": false,
                "disabled_reason": null,
                "disabled_until": null
            },
            "email_suppression": {
                "suppressed": false,
                "info": null
            },
            "tiers": [],
            "newsletters": []
        }
    ]
}
Additional writable member fields include:
KeyDescription
namemember name
notenotes on the member
labelsmember labels
newslettersList of newsletters subscribed to by this member
Create a new, free member with name, newsletter, and label: 
// POST /admin/members/
{
    "members": [
        {
            "email": "jamie@ghost.org",
            "name": "Jamie",
            "labels": [
                {
                    "name": "VIP",
                    "slug": "vip"
                }
            ],
            "newsletters": [
                {
                    "id": "624d445026833200a5801bce"
                }
            ]
        }
    ]
}