List pending invitations

Returns all pending invitations queued for an organization

Path Parameters

orgId string required

unique id of the organization to which user is invited

Query Parameters

userId string

user_id filter is the email id of user who are invited inside the organization.

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

invitations object[]
Array [
id string
The unique invitation identifier.
userId string
The user email of the invited user.
orgId string
The organization id to which the user is invited.
groupIds string[]
The list of group ids to which the user is invited.
metadata object
The metadata of the invitation.
createdAt date-time
The time when the invitation was created.
expiresAt date-time
The time when the invitation expires.
]

{
  "invitations": [
    {
      "id": "k9c4f4e2-9b9a-4c1a-8f1a-2b9b9b9b9b9b",
      "userId": "john.doe@raystack.org",
      "orgId": "b9c4f4e2-9b9a-4c1a-8f1a-2b9b9b9b9b9b",
      "groupIds": "c9c4f4e2-9b9a-4c1a-8f1a-2b9b9b9b9b9b",
      "metadata": {
        "key": "value"
      },
      "createdAt": "2023-06-07T05:39:56.961Z",
      "expiresAt": "2023-06-07T05:39:56.961Z"
    }
  ]
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...