Retrieve invitaton by ID

GET /api/v1/Teams/invite/:id/get

Description

This endpoint is used to get an invitation by its id.

Tags: Teams
URL: /api/v{version}/Teams/invite/{id}/get
ApiKey: No API key required
Content-Type: text/plain, application/json, text/json
Path Parameters:

• id: string (uuid), required, the id of the invitation

• version: string, required

• Accept-Language: header, optional, change the default response message language from English(en) to French(fr) or English(en)
  Response:
  Success, returns a RegistrationInviteResponse.
  Error Codes:

• 400: Bad Request

• 404: Not Found

Example:
JSON

GET /api/v1/Teams/invite/12345678-1234-1234-1234-1234567890ab/get
{
"Message": "Invite found",
"Invite": {
  "Id": "12345678-1234-1234-1234-1234567890ab",
  "TeamId": "123",
  "Email": "invite@example.com"
}
}

Plain Text

HTTP/1.1 200 OK
{
"Id": "12345678-1234-1234-1234-1234567890ab",
"TeamId": "123",
"Email": "invite@example.com"
}

/api/v1/Teams/invite/:id/get

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Response: 200

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": {
    "id": `<uuid>`,
    "email": `<string>`,
    "role": 4,
    "status": 2,
    "tenantId": `<uuid>`,
    "fullName": `<string>`,
    "userId": `<uuid>`
  }
}