> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://contentful-staging.ferndocs.com/developers/docs/_mcp/server. # User Management API ## Docs - [Overview](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/overview.md) - [Organization Memberships](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api.md) - [Invitations](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/invitations.md) - [Teams](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/teams.md) - [Team Memberships](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-memberships.md) - [Space Memberships](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-memberships.md) - [Team Space Memberships](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-space-memberships.md) - [Space Members](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-members.md) - [Space Roles](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-roles.md) - [Users](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/users.md) ## API Docs - User Management API > Organization Memberships [Get all organization memberships](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/organization-memberships/get-all-organization-memberships.md) - User Management API > Organization Memberships [Get an organization membership](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/organization-memberships/get-an-organization-membership.md) - User Management API > Organization Memberships [Update an organization membership](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/organization-memberships/update-an-organization-membership.md) - User Management API > Organization Memberships [Delete an organization membership](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/organization-memberships/delete-an-organization-membership.md) - User Management API > Invitations [Create an invitation](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/invitations/create-an-invitation.md) - User Management API > Invitations [Get an invitation](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/invitations/get-an-invitation.md) - User Management API > Teams [Get all teams for an organization](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/teams/get-all-teams-for-an-organization.md) - User Management API > Teams [Create a team](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/teams/create-a-team.md) - User Management API > Teams [Get all teams for a space](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/teams/get-all-teams-for-a-space.md) - User Management API > Teams [Get a team](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/teams/get-a-team.md) - User Management API > Teams [Update a team](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/teams/update-a-team.md) - User Management API > Teams [Delete a team](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/teams/delete-a-team.md) - User Management API > Team Memberships [Get all team memberships for a team](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-memberships/get-all-team-memberships-for-a-team.md) - User Management API > Team Memberships [Create a team membership](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-memberships/create-a-team-membership.md) - User Management API > Team Memberships [Get all team memberships for an organization](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-memberships/get-all-team-memberships-for-an-organization.md) - User Management API > Team Memberships [Get a team membership](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-memberships/get-a-team-membership.md) - User Management API > Team Memberships [Delete a team membership](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-memberships/delete-a-team-membership.md) - User Management API > Space Memberships [Get all space memberships for a space](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-memberships/get-all-space-memberships-for-a-space.md) - User Management API > Space Memberships [Create a space membership](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-memberships/create-a-space-membership.md) - User Management API > Space Memberships [Get all space memberships for an organization](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-memberships/get-all-space-memberships-for-an-organization.md) - User Management API > Space Memberships [Get a space membership for a space](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-memberships/get-a-space-membership-for-a-space.md) - User Management API > Space Memberships [Update a space membership](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-memberships/update-a-space-membership.md) - User Management API > Space Memberships [Delete a space membership](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-memberships/delete-a-space-membership.md) - User Management API > Space Memberships [Get a space membership for an organization](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-memberships/get-a-space-membership-for-an-organization.md) - User Management API > Team Space Memberships [Get all team space memberships for a space](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-space-memberships/get-all-team-space-memberships-for-a-space.md) - User Management API > Team Space Memberships [Create a team space membership](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-space-memberships/create-a-team-space-membership.md) - User Management API > Team Space Memberships [Get all team space memberships for an organization](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-space-memberships/get-all-team-space-memberships-for-an-organization.md) - User Management API > Team Space Memberships [Get a team space membership for a space](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-space-memberships/get-a-team-space-membership-for-a-space.md) - User Management API > Team Space Memberships [Update a team space membership](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-space-memberships/update-a-team-space-membership.md) - User Management API > Team Space Memberships [Delete a team space membership](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-space-memberships/delete-a-team-space-membership.md) - User Management API > Team Space Memberships [Get a team space membership for an organization](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/team-space-memberships/get-a-team-space-membership-for-an-organization.md) - User Management API > Space Members [Get all space members](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-members/get-all-space-members.md) - User Management API > Space Members [Get a space member](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-members/get-a-space-member.md) - User Management API > Space Roles [Get all space roles](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/space-roles/get-all-space-roles.md) - User Management API > Users [Get all users for an organization](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/users/get-all-users-for-an-organization.md) - User Management API > Users [Get all users for a space](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/users/get-all-users-for-a-space.md) - User Management API > Users [Get a user in an organization](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/users/get-a-user-in-an-organization.md) - User Management API > Users [Get a user in a space](https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/users/get-a-user-in-a-space.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://contentful-staging.ferndocs.com/developers/docs/openapi.json) - [OpenAPI YAML](https://contentful-staging.ferndocs.com/developers/docs/openapi.yaml) > **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://contentful-staging.ferndocs.com/developers/docs/references/user-management-api/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://contentful-staging.ferndocs.com/developers/docs/_mcp/server. **Organization memberships** represent the relationship between a single Contentful user and your organization. In other words, this data object defines explicitly who is a member of your organization. ### Get all organization memberships [Get all organization memberships](/references/user-management-api/organization-memberships/get-all-organization-memberships) This endpoint returns a paginated collection of all organization memberships for this organization. All organization members can access this endpoint and will receive a scoped response. #### Query Parameters | Name | Details | Description | | --------------- | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `skip`, `limit` | - | Specify requested page of result set. See [Pagination](#/introduction/pagination) for more details. | | `order` | Supported values: `role`, `sys.createdAt`, `sys.lastActiveAt`, `sys.user.firstName`, `sys.user.lastName`, `sys.user.email` | Specify sort order of result set. See [Sorting Results](#/introduction/sorting-results) for more details. | | `include` | Supported values: `sys.user`, `sys.createdBy`, `sys.updatedBy` | Specify linked resources to include in response. See [Including Related Resources](#/introduction/including-related-resources) for more details. | | `query` | Fields searched: `sys.user.id`, `sys.user.firstName`, `sys.user.lastName`, `sys.user.email` | Specify a string to search for matching resources against. See [Searching Multiple Attributes](#/introduction/searching-multiple-attributes) for more details. | | Filters | See section below | Specify a value to filter against for the provided attribute. See [Filtering Results](#/introduction/filtering-results) for more information, and below for details about supported attributes for this endpoint. | #### Filter Parameters See [Filtering Results](#/introduction/filtering-results) for details about how to use attributes and operators to construct query filters. | Attribute | Supported Operators | Supported Values | | ---------------------- | ---------------------------------- | ------------------------------------------ | | `role` | `eq`, `ne`, `in`, `nin` | `owner`, `admin`, `developer`, `member` | | `sys.status` | `eq`, `ne`, `in`, `nin` | `pending`, `active` | | `sys.user.sys.id` | `eq`, `ne`, `in`, `nin` | String (id) | | `sys.user.firstName` | `eq`, `ne`, `exists` | String | | `sys.user.lastName` | `eq`, `ne`, `exists` | String | | `sys.lastActiveAt` | `lt`, `lte`, `gt`, `gte`, `exists` | Datetime string (or Boolean with `exists`) | | `sys.sso.lastSignInAt` | `lt`, `lte`, `gt`, `gte`, `exists` | Datetime string (or Boolean with `exists`) | | `sys.createdAt` | `lt`, `lte`, `gt`, `gte` | Datetime string | | `sys.updatedAt` | `lt`, `lte`, `gt`, `gte` | Datetime string | #### Response ```js { "total": 1, "limit": 25, "skip": 0, "sys": { "type": "Array" }, "items": [{ "sys": { "type": "OrganizationMembership", "id": "0xWanD4AZI2AR35wW9q51n", "version": 0, "createdAt": "2015-05-18T11:29:46.809Z", "updatedAt": "2015-05-18T11:29:46.809Z", "lastActiveAt": null, "status": "active", "sso": null, "user": { "sys": { "type": "Link", "linkType": "User", "id": "7BslKh9TdKGOK41VmLDjFZ" } }, "updatedBy": { "sys": { "type": "Link", "linkType": "User", "id": "7BslKh9TdKGOK41VmLDjFZ" } }, "createdBy": { "sys": { "type": "Link", "linkType": "User", "id": "7BslKh9TdKGOK41VmLDjFZ" } } }, "role": "admin" "isExemptFromRestrictedMode":true, }] } ``` ### Get a single organization membership [Get a single organization membership](/references/user-management-api/organization-memberships/get-an-organization-membership) This endpoint returns details about an existing organization membership. All organization members can access this endpoint. #### Response ```js { "sys": { "type": "OrganizationMembership", "id": "0xWanD4AZI2AR35wW9q51n", "version": 0, "status": "active", "createdAt": "2015-05-18T11:29:46.809Z", "updatedAt": "2015-05-18T11:29:46.809Z", "lastActiveAt": "2015-05-18T11:29:46.809Z", "user": { "sys": { "type": "Link", "linkType": "User", "id": "7BslKh9TdKGOK41VmLDjFZ" } }, "updatedBy": { "sys": { "type": "Link", "linkType": "User", "id": "7BslKh9TdKGOK41VmLDjFZ" } }, "createdBy": { "sys": { "type": "Link", "linkType": "User", "id": "7BslKh9TdKGOK41VmLDjFZ" } }, "sso": { "isExemptFromRestrictedMode": false, "lastSignInAt": "2018-09-18T11:29:46.809Z", "exemptionReasons": [] } }, "role": "admin" } ``` ### Create an organization membership It is not possible to create an organization membership directly. To add a user to your organization, you need to invite them to the organization. Inviting a user to your organization has the *indirect* side effect of creating an organization membership, with a status of `pending`. See the [Invitations](/references/user-management-api/invitations) section below for complete details. ### Update a single organization membership [Update a single organization membership](/references/user-management-api/organization-memberships/update-an-organization-membership) This endpoint allows you to change an organization membership. Use this to update the organizational role associated with this organization member. Only organization admins and owners can access this endpoint. #### Request Body | Parameter | Type | Usage | | --------- | ------ | -------------------------------------------------------- | | `role` | string | required; one of `member`, `developer`, `admin`, `owner` | #### Response ```js { "sys": { "type": "OrganizationMembership", "id": "0xWanD4AZI2AR35wW9q51n", "version": 0, "createdAt": "2015-05-18T11:29:46.809Z", "updatedAt": "2015-05-18T11:29:46.809Z", "lastActiveAt": null, "status": "active", "sso": null, "user": { "sys": { "type": "Link", "linkType": "User", "id": "7BslKh9TdKGOK41VmLDjFZ" } }, "updatedBy": { "sys": { "type": "Link", "linkType": "User", "id": "7BslKh9TdKGOK41VmLDjFZ" } }, "createdBy": { "sys": { "type": "Link", "linkType": "User", "id": "7BslKh9TdKGOK41VmLDjFZ" } } }, "role": "admin" } ``` ### Delete a single organization membership [Delete a single organization membership](/references/user-management-api/organization-memberships/delete-an-organization-membership) This endpoint deletes an organization membership. This action only affects whether a user can access an organization; it does not remove the user account itself. Only organization admins and owners can access this endpoint. The user associated with the space membership also has access to this endpoint (so that they have permission to remove themselves from an organization). **Note:** It is not possible to delete an organization membership with an `owner` role if there are no other owner memberships remaining in the organization. #### Response ```headers Status: 204 No Content ```