Get Organization Invitation

GET

/v1/organization_invitations/{id}

The Get Organization Invitation API retrieves detailed information about a specific invitation to join an organization, identified by id. This API provides insights into the recipient’s email and other relevant information, allowing administrators to track and manage invitations within the organization.

Request

Authorization

Add parameter in header

X-Jicoo-Api-Key

Example:

X-Jicoo-Api-Key: ********************

Path Params

number

required

Body Params application/json

object {0}

Example

{}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/v1/organization_invitations/' \
--header 'Content-Type: application/json' \
--header 'X-Jicoo-Api-Key;' \
--data-raw ''

Responses

🟢200OK

application/json

Body

data

object (OrganizationInvitation)

required

integer

required

Unique ID of the invitation

> 0

string <email>

required

Email of the invitee

role

enum<string>

required

Role assigned to the invitee

Allowed values:

owneradminmemberrestricted

createdAt

string <date-time>

required

Creation time of the invitation

updatedAt

string <date-time>

required

Last update time of the invitation

Example

{
  "data": {
    "id": 1,
    "email": "user@example.com",
    "role": "owner",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Modified at 2024-08-28 10:59:13

List Organization Invitations

Delete Organiztion Invitation