--- title: Invitation Details --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [User](https://developers.cloudflare.com/api/python/resources/user) [Invites](https://developers.cloudflare.com/api/python/resources/user/subresources/invites) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Invitation Details user.invites.get(strinvite\_id) -> [Invite]() GET/user/invites/{invite\_id} Gets the details of an invitation. ##### Security API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**`X-Auth-Email: user@example.com` The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194` ##### Accepted Permissions (at least one required) `Memberships Write``Memberships Read` ##### ParametersExpand Collapse invite\_id: str Invite identifier tag. maxLength32 [Link to this property](<#(resource)%20user.invites%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20invite_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class Invite: … invited\_member\_id: Optional\[str] ID of the user to add to the organization. maxLength32 Link to this property organization\_id: str ID of the organization the user will be added to. maxLength32 Link to this property id: Optional\[str] Invite identifier tag. maxLength32 Link to this property expires\_on: Optional\[datetime] When the invite is no longer active. formatdate-time Link to this property invited\_by: Optional\[str] The email address of the user who created the invite. maxLength90 Link to this property invited\_member\_email: Optional\[str] Email address of the user to add to the organization. maxLength90 Link to this property invited\_on: Optional\[datetime] When the invite was sent. formatdate-time Link to this property organization\_is\_enforcing\_twofactor: Optional\[bool] Link to this property organization\_name: Optional\[str] Organization name. maxLength100 Link to this property roles: Optional\[List\[str]] List of role names the membership has for this account. Link to this property
status: Optional\[Literal\["pending", "accepted", "rejected", "expired"]] Current status of the invitation. One of the following: "pending" Link to this property "accepted" Link to this property "rejected" Link to this property "expired" Link to this property
Link to this property
[Link to this property](<#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)>) ### Invitation Details Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) invite = client.user.invites.get( "4f5f0c14a2a41d5063dd301b2f829f04", ) print(invite.invited_member_id) ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "invited_member_id": "5a7805061c76ada191ed06f989cc3dac", "organization_id": "5a7805061c76ada191ed06f989cc3dac", "id": "4f5f0c14a2a41d5063dd301b2f829f04", "expires_on": "2014-01-01T05:20:00Z", "invited_by": "user@example.com", "invited_member_email": "user@example.com", "invited_on": "2014-01-01T05:20:00Z", "organization_is_enforcing_twofactor": true, "organization_name": "Cloudflare, Inc.", "roles": [ "Account Administrator" ], "status": "accepted" } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "invited_member_id": "5a7805061c76ada191ed06f989cc3dac", "organization_id": "5a7805061c76ada191ed06f989cc3dac", "id": "4f5f0c14a2a41d5063dd301b2f829f04", "expires_on": "2014-01-01T05:20:00Z", "invited_by": "user@example.com", "invited_member_email": "user@example.com", "invited_on": "2014-01-01T05:20:00Z", "organization_is_enforcing_twofactor": true, "organization_name": "Cloudflare, Inc.", "roles": [ "Account Administrator" ], "status": "accepted" } } ```