Skip to main content

Members

Manage site members and subscribers. Requires GHOST_ADMIN_API_KEY.

Tools

ToolDescription
admin_browse_membersList members with filtering and pagination
admin_read_memberGet a single member by ID
admin_create_memberCreate a new member
admin_update_memberUpdate an existing member

admin_browse_members

List members with filtering and pagination.

{
"filter": "status:paid",
"include": "labels,newsletters",
"order": "created_at DESC"
}

Common filters

FilterDescription
status:freeFree members
status:paidPaid members
status:compedComplimentary members
subscribed:trueSubscribed to newsletters
label:vipMembers with a specific label

See the NQL Reference for more filter options.

admin_read_member

Get a single member by ID.

{
"id": "6abc1234def5678901234567"
}

admin_create_member

Create a new member.

Basic member

{
"email": "newmember@example.com"
}

Member with full details

{
"email": "vip@example.com",
"name": "John Smith",
"note": "VIP customer - premium support",
"subscribed": true,
"labels": [{ "name": "VIP" }, { "name": "Early Adopter" }],
"comped": true
}

Key parameters

ParameterTypeDescription
emailstringMember email (required)
namestringMember name
notestringInternal note
subscribedbooleanNewsletter subscription status
labelsarrayMember labels
compedbooleanGrant complimentary access

admin_update_member

Update an existing member.

{
"id": "6abc1234def5678901234567",
"name": "Updated Name",
"note": "Updated note",
"labels": [{ "name": "VIP" }]
}