List organization invitations

GET /organizations/{organization_id}/invitations

Fetch open invitations to the selected organization. Currently unavailable in self-hosted ECE.

Path parameters

Responses

  • Organization invitations fetched successfully

    Hide response attribute Show response attribute object
    • invitations array[object] Required

      The list of organization invitations

      Hide invitations attributes Show invitations attributes object
      • token string Required

        The token used to accept the invitation

      • email string Required

        The email address to invite to the organization

      • created_at string(date-time) Required

        The date and time when the invitation was created

      • expires_at string(date-time) Required

        The date and time when the invitation expires

      • expired boolean Required

        True if the invitation is expired

      • accepted_at string(date-time)

        The date and time when the invitation was accepted

      • organization object Required

        An organization

        Additional properties are allowed.

        Hide organization attributes Show organization attributes object
  • Organization not found. (code: organization.not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is organization.not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /organizations/{organization_id}/invitations
curl \
 -X GET https://{{hostname}}/api/v1/organizations/{organization_id}/invitations
Response examples (200)
{
  "invitations": [
    {
      "token": "string",
      "email": "string",
      "created_at": "2024-05-04T09:42:00+00:00",
      "expires_at": "2024-05-04T09:42:00+00:00",
      "expired": true,
      "accepted_at": "2024-05-04T09:42:00+00:00",
      "organization": {
        "id": "string",
        "name": "string",
        "default_disk_usage_alerts_enabled": true,
        "notifications_allowed_email_domains": [
          "string"
        ],
        "billing_contacts": [
          "string"
        ],
        "operational_contacts": [
          "string"
        ]
      }
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: organization.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}