Sign in

v1

latestOpenAPI 3.0.32026-07-17485661.9 KB

Invite a user to a space

Invites a user to a space by email address. The invitee accepts the invitation with their own Ghost account. Requires user authentication (JWT). API keys cannot manage invites.

post/spaces/{space_id}/invites

Path parameters

space_idstring required

Ghost space ID.

Request body

emailstring required

Email address to invite.

role'owner' | 'admin' | 'developer' | 'viewer'

A member's role within a space. The owner role belongs to the user who created the space; every space has exactly one owner, so owner is never accepted as an input when granting a role. On the Space schema, this is the caller's own role in the space, omitted for API-key authentication (API keys are space-scoped and carry no member identity).

Response

Invite created

emailstring required

Email address the invite was sent to.

role'owner' | 'admin' | 'developer' | 'viewer' required

A member's role within a space. The owner role belongs to the user who created the space; every space has exactly one owner, so owner is never accepted as an input when granting a role. On the Space schema, this is the caller's own role in the space, omitted for API-key authentication (API keys are space-scoped and carry no member identity).

status'pending' | 'declined' required

Status of a sent invite. pending means it's still awaiting a response; declined means the invitee declined it. A declined invite still occupies the email's slot for the space (one pending-or-declined invite per email), so it must be cancelled before that email can be re-invited.

created_atstring date-time required

When the invite was created.