Get invitation by ID

GET

/api/v1/organizations/{orgId}/invitations/{id}

const url = 'http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/invitations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/invitations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Retrieves a specific invitation by its unique identifier.

Authorizations

api-key
bearer

Parameters

Path Parameters

orgId

required

string format: uuid

Organization UUID

required

string format: uuid

Invitation UUID

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

Invitation retrieved successfully

application/json

object

required

Unique invitation identifier

string format: uuid

email

required

Email address the invitation was sent to

string format: email

roleId

required

Role ID that will be assigned when the invitation is accepted

string format: uuid

organizationId

required

Organization ID the user will be added to

string format: uuid

organizationName

required

Name of the organization

string

invitedById

User ID who sent the invitation (null if inviter was deleted)

string format: uuid

invitedByEmail

Email of the user who sent the invitation (null if inviter was deleted)

string format: email

expiresAt

required

When the invitation expires

string format: date-time

acceptedAt

When the invitation was accepted (null if pending)

string format: date-time

createdAt

required

When the invitation was created

string format: date-time

isPending

required

Whether the invitation is pending (not accepted)

boolean

isExpired

required

Whether the invitation has expired

boolean

Example

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "newuser@example.com",
  "roleId": "550e8400-e29b-41d4-a716-446655440001",
  "organizationId": "550e8400-e29b-41d4-a716-446655440002",
  "organizationName": "Acme Corporation",
  "invitedById": "550e8400-e29b-41d4-a716-446655440003",
  "invitedByEmail": "admin@acme.com",
  "expiresAt": "2024-06-27T10:30:00Z",
  "acceptedAt": "2024-06-21T14:45:00Z",
  "createdAt": "2024-06-20T10:30:00Z",
  "isPending": true,
  "isExpired": false
}

401

Unauthorized

403

Forbidden - Insufficient permissions

404

Invitation not found