> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://contentful.com/developers/docs/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://contentful.com/_mcp/server. **Invitations** are the entities used to add new users to your organization. Users will receive an invitation (presently via email), which they must explicitly accept before they can access your organization. Note that a side effect of creating an invitation is that an organization membership object is created in the "pending" state. Once you have invited a user, you may add them to teams and spaces immediately, without waiting for them to accept. **Note**: These endpoints are in "alpha" state, which means that breaking changes might be introduced in the future ### Create an invitation *(alpha)* [Create an invitation](/references/user-management-api/invitations/create-an-invitation) Use this endpoint to invite someone to your organization. Only organization admins and owners can access this endpoint. #### Request Body | Parameter | Type | Usage | | ----------- | ------ | -------------------------------------------------------- | | `email` | string | required | | `firstName` | string | optional | | `lastName` | string | optional | | `role` | string | optional; one of `member`, `developer`, `admin`, `owner` | #### Response ```js { "sys": { "id": "aasfdsgfesagrwg32ggs", "type": "Invitation", "status": "open", "organizationMembership": { "sys": { "type": "Link", "linkType": "OrganizationMembership", "id": "65jhgf45jrt8j945j89gt" } }, "createdAt": "2019-01-15T08:03:16.007Z", "updatedAt": "2019-01-15T08:03:16.007Z", "createdBy": { "sys": { "type": "Link", "linkType": "User", "id": "dsf4tgfd43gf4t3g4" } }, "user": null, "invitationUrl": "https://be.contentful.com/invitations/aasfdsgfesagrwg32ggs?token=xyzpdq" } } ``` ### Get a single invitation *(alpha)* [Get a single invitation](/references/user-management-api/invitations/get-an-invitation) This endpoint returns details about an existing invitation. The `user` attribute will be `null` until the invitation has been accepted by a user. Only organization admins and owners can access this endpoint. #### Response ```js { "sys": { "id": "aasfdsgfesagrwg32ggs", "type": "Invitation", "status": "open", "organizationMembership": { "sys": { "type": "Link", "linkType": "OrganizationMembership", "id": "65jhgf45jrt8j945j89gt" } }, "createdAt": "2019-01-15T08:03:16.007Z", "updatedAt": "2019-01-15T08:03:16.007Z", "createdBy": { "sys": { "type": "Link", "linkType": "User", "id": "dsf4tgfd43gf4t3g4" } }, "user": null, "invitationUrl": "" } } ``` ### Delete an invitation At present, it is not possible to delete an invitation directly via API. To remove an invitation, you can delete the organization membership associated with it. This action will delete all invitations associated with the organization membership. ## API Docs - Invitations [Create an invitation](https://contentful.com/developers/docs/references/user-management-api/invitations/create-an-invitation.md) - Invitations [Get an invitation](https://contentful.com/developers/docs/references/user-management-api/invitations/get-an-invitation.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://contentful.com/developers/docs/openapi.json) - [OpenAPI YAML](https://contentful.com/developers/docs/openapi.yaml)