Skip to main content

List Organization Invitations

GET https://infrahub-api.nexgencloud.com/v1/auth/invites

Retrieves a list of existing email invitations to join your organization along with their details, including the email addresses to which invitations have been sent, the status of each invitation, and the timestamp of when it was sent.


Parameters​

No parameters.


Attributes​

status boolean​

Indicates the status of the request to retrieve a list of invitations, true indicates success, while false indicates error.

message string​

A message describing the status of the request.

invites array of objects​

An array of objects containing details about invitations that have been sent.

Show child attributes
email string​

The email of the invited user.

id integer​

The ID of the invitation.

status string​

A message describing the status of the invitation.

created_at date-time​

The timestamp when the invite was sent.

Example request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/auth/invites" \
  -H "accept: application/json"\
  -H "api_key: YOUR API KEY"
Response
{
    "status": true,
    "message": "Getting invites successful",
    "invites": [
        {
            "email": "[email protected]",
            "id": 4,
            "status": "CONFIRMATION_PENDING",
            "created_at": "2023-04-26T04:21:58"
        }
    ]
}

Returns​

A status of true indicates that the list of invitations has been successfully retrieved. The array of invites objects contain details about the sent invitations, including the recipient email, invitation ID, status, and the timestamp of invitation creation. In case of an error, refer to our documentation on handling errors here.


Back to top​