getInvitationInternal (v1)

Retrieve invitation

Overview

Retrieve detailed information about a specified invitation.

GET (/internal/v1/invitations/{invitationId})

Parameters

  • invitationId (path) (required): The unique identifier of the invitation.

Responses

200 OK

Internal representation of an invitation.

400 Bad Request

401 Unauthorized

404 Not Found

500 Internal Server Error

Architecture

5 properties

Internal representation of an invitation.

delivery object

Represents the delivery channel details of an invitation.

organisationPartyId string

The ID of the organisation party.

organisationLegalName string

The legal name of the organisation party.

7 properties
code string
Allowed values: urn:plmr:teams:api:BAD_REQUEST urn:plmr:teams:api:INVALID_PARAM urn:plmr:teams:api:WEB_APPLICATION
message string
requestId string
fieldErrors array [object]
3 properties
code string
Allowed values: urn:plmr:teams:api:UNAUTHORIZED
message string
requestId string
3 properties
code string
Allowed values: urn:plmr:teams:api:RESOURCE_UNKNOWN urn:plmr:teams:api:INVITATION_NOT_FOUND urn:plmr:teams:api:TEAM_NOT_FOUND
message string
requestId string
3 properties
code string
Allowed values: urn:plmr:teams:api:INTERNAL_SERVER_ERROR
message string
requestId string