Retrieve an user invite

GET /admin/users/invites/{inviteId}

Python

Default

from portkey_ai import Portkey

# Initialize the Portkey client
portkey = Portkey(
    api_key="PORTKEY_API_KEY",
)

# Get a user invite
user = portkey.admin.users.invites.retrieve(
    invite_id='INVITE_ID'
)

print(user)

200

{
  "object": "invite",
  "id": "419641fb-1458-47d6-94d0-e308159b3ec2",
  "email": "[e-mail]",
  "role": "member",
  "created_at": "2023-12-12 13:56:32",
  "expires_at": "2023-12-12 13:56:32",
  "accepted_at": "2023-12-12 13:56:32",
  "status": "pending",
  "invited_by": "8dcfa174-c5ed-42c7-8a63-be755cc6e3123",
  "workspaces": [
    {
      "workspace_id": "",
      "role": ""
    }
  ]
}

Authorizations

x-portkey-api-key · string · header · required

Path Parameters

inviteId · string · required

string

Response

200 - application/json

OK

object · string

Example:

"invite"

id · string<uuid>

email · string<email>

role · enum<string>

Available options: admin, member

created_at · string<date-time>

expires_at · string<date-time>

accepted_at · string<date-time>

status · enum<string>

Available options: pending, cancelled, accepted, expired

invited_by · string<uuid>