ByCloud Docs
GuidesCLIAPISDK
get/v1/iam/invitations/{invitation_id}

Get invitation

Get details of a specific invitation

Path Parameters

invitation_id

string<uuid>required

path

Invitation ID

Example: "550e8400-e29b-41d4-a716-446655440000"

Responses

200

Invitation details

Content-Type: application/json

invitation

objectoptional
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
403

Insufficient permissions

Content-Type: application/json

error

objectrequired
404

Resource not found

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X GET "https://api.spo1.mycloud.com/v1/iam/invitations/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Response

Invitation details

{
  "invitation": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "jane.doe@example.com",
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "string"
      }
    ],
    "invited_by": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "string",
      "email": "user@example.com"
    },
    "status": "pending",
    "expires_at": "2024-01-15T10:30:00Z",
    "created_at": "2024-01-15T10:30:00Z"
  }
}