List Organization Invitations

GET

/v1/organization_invitations

The List Organization Invitations API retrieves a list of all invitations sent to join an organization. This API provides detailed information about each invitation, including the recipient's email and other relevant details, enabling administrators to manage and oversee all pending invitations within the organization.

Request

Authorization

Add parameter in header

X-Jicoo-Api-Key

Example:

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

Query Params

page

number

optional

perPage

number

optional

string

optional

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?page&perPage&email' \
--header 'Content-Type: application/json' \
--header 'X-Jicoo-Api-Key;' \
--data-raw ''

Responses

🟢200OK

application/json

Body

data

array[object (OrganizationInvitation) {5}]

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 11:00:52

Create Organiztion Invitation

Get Organization Invitation