--- title: Memberships --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Memberships ##### [List Memberships](https://developers.cloudflare.com/api/typescript/resources/memberships/methods/list) client.memberships.list(MembershipListParams {account, direction, name, 4 more } query?, RequestOptionsoptions?): V4PagePaginationArray< [Membership]() {id, account, api\_access\_enabled, 3 more } > GET/memberships ##### [Membership Details](https://developers.cloudflare.com/api/typescript/resources/memberships/methods/get) client.memberships.get(stringmembershipID, RequestOptionsoptions?): [MembershipGetResponse]() {id, account, api\_access\_enabled, 4 more } GET/memberships/{membership\_id} ##### [Update Membership](https://developers.cloudflare.com/api/typescript/resources/memberships/methods/update) client.memberships.update(stringmembershipID, MembershipUpdateParams {status } body, RequestOptionsoptions?): [MembershipUpdateResponse]() {id, account, api\_access\_enabled, 4 more } PUT/memberships/{membership\_id} ##### [Delete Membership](https://developers.cloudflare.com/api/typescript/resources/memberships/methods/delete) client.memberships.delete(stringmembershipID, RequestOptionsoptions?): [MembershipDeleteResponse]() {id } DELETE/memberships/{membership\_id} ##### ModelsExpand Collapse

Membership {id, account, api\_access\_enabled, 3 more }

id?: string Membership identifier tag. maxLength32 Link to this property account?: Account {id, name, type, 3 more } Link to this property api\_access\_enabled?: boolean| null Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account. Link to this property

permissions?: Permissions {analytics, billing, cache\_purge, 9 more } All access permissions for the user at the account.

Link to this property roles?: Array<string> List of role names the membership has for this account. Link to this property

status?: "accepted"| "pending"| "rejected" Status of this membership.

One of the following: "accepted" Link to this property "pending" Link to this property "rejected" Link to this property

Link to this property

[Link to this property](<#(resource)%20memberships%20%3E%20(model)%20membership%20%3E%20(schema)>)

MembershipGetResponse {id, account, api\_access\_enabled, 4 more }

permissions?: Permissions {analytics, billing, cache\_purge, 9 more } All access permissions for the user at the account.

Link to this property

policies?: Array<Policy> Access policy for the membership

id?: string Policy identifier. Link to this property

access?: "allow"| "deny" Allow or deny operations against the resources.

One of the following: "allow" Link to this property "deny" Link to this property

Link to this property

permission\_groups?: Array<PermissionGroup> A set of permission groups that are specified to the policy.

id: string Identifier of the permission group. Link to this property

meta?: Meta {category, deprecated, description, 5 more } Attributes associated to the permission group.

category?: string A category used to group permission groups. Link to this property deprecated?: string Indicates whether the permission group is deprecated. Link to this property description?: string Additional information about the permission group. Link to this property editable?: string Indicates whether the permission group can be edited. Link to this property eol\_at?: string The planned end-of-life date and time, when provided. formatdate-time Link to this property label?: string A label identifying the permission group. Link to this property scopes?: string The scope associated with the permission group. Link to this property visibility?: string Indicates the permission group’s availability or visibility. Link to this property

Link to this property name?: string Name of the permission group. Link to this property

Link to this property

resource\_groups?: Array<ResourceGroup> A list of resource groups that the policy applies to.

id: string Identifier of the resource group. Link to this property

scope: Scope {key, objects } A scope is a combination of scope objects which provides additional context.

key: string This is a combination of pre-defined resource name and identifier (like Account ID etc.) Link to this property

objects: Array<Object> A list of scope objects for additional context.

key: string This is a combination of pre-defined resource name and identifier (like Zone ID etc.) Link to this property

Link to this property

meta?: Meta {key, value } Attributes associated to the resource group.

key?: string Link to this property value?: string Link to this property

Link to this property name?: string Name of the resource group. Link to this property

Link to this property

Link to this property roles?: Array<string> List of role names the membership has for this account. Link to this property

status?: "accepted"| "pending"| "rejected" Status of this membership.

One of the following: "accepted" Link to this property "pending" Link to this property "rejected" Link to this property

Link to this property

[Link to this property](<#(resource)%20memberships%20%3E%20(model)%20membership_get_response%20%3E%20(schema)>)

MembershipUpdateResponse {id, account, api\_access\_enabled, 4 more }

permissions?: Permissions {analytics, billing, cache\_purge, 9 more } All access permissions for the user at the account.

Link to this property

policies?: Array<Policy> Access policy for the membership

id?: string Policy identifier. Link to this property

access?: "allow"| "deny" Allow or deny operations against the resources.

One of the following: "allow" Link to this property "deny" Link to this property

Link to this property

permission\_groups?: Array<PermissionGroup> A set of permission groups that are specified to the policy.

id: string Identifier of the permission group. Link to this property

meta?: Meta {category, deprecated, description, 5 more } Attributes associated to the permission group.

Link to this property name?: string Name of the permission group. Link to this property

Link to this property

resource\_groups?: Array<ResourceGroup> A list of resource groups that the policy applies to.

id: string Identifier of the resource group. Link to this property

scope: Scope {key, objects } A scope is a combination of scope objects which provides additional context.

key: string This is a combination of pre-defined resource name and identifier (like Account ID etc.) Link to this property

objects: Array<Object> A list of scope objects for additional context.

key: string This is a combination of pre-defined resource name and identifier (like Zone ID etc.) Link to this property

Link to this property

meta?: Meta {key, value } Attributes associated to the resource group.

key?: string Link to this property value?: string Link to this property

Link to this property name?: string Name of the resource group. Link to this property

Link to this property

Link to this property roles?: Array<string> List of role names the membership has for this account. Link to this property

status?: "accepted"| "pending"| "rejected" Status of this membership.

One of the following: "accepted" Link to this property "pending" Link to this property "rejected" Link to this property

Link to this property

[Link to this property](<#(resource)%20memberships%20%3E%20(model)%20membership_update_response%20%3E%20(schema)>)

MembershipDeleteResponse {id }

id?: string Membership identifier tag. maxLength32 Link to this property

[Link to this property](<#(resource)%20memberships%20%3E%20(model)%20membership_delete_response%20%3E%20(schema)>)