Status

The status endpoint allows you to search an array of emails that returns each email with the invite status and allocated groups. If the email does not belong to any group(s), then this result is omitted.

In the example below, "[e-mail]" is allocated to a group whereas "[e-mail]" is not.

Parameters

Key	Type
email	Array of strings (valid emails)

Status Descriptions

State	Description
Pending	User invite is pending but has not been sent.
Notified	User invite has been sent.
Active	User has activated their account on the app.
Nudged	User was nudged (reminder email sent 1 - 2 days before invite expires).
Expired	User invite has expired (28 days after being notified).

Example

curl -X POST \
  v1/groups/status \
  -H 'Authorization: Basic <Your Base64 Encoded Token>' \
  -d '{
	"email" : ["[e-mail]","[e-mail]"]
}'

Success Response

The response will contain an array of results, including the email, status, and group. The email is the provided email address, the status is the invite status of the user, and groups is a list of groups this user is in.

{
    "status": "success",
    "data": [
        {
            "email": "[e-mail]",
            "status": "Notified",
            "groups": [
                "Group One",
                "Group Two",
                ...
            ]
        }
    ],
    "hash": "817f3aad61a810b1e8d7f7fb6303bdb2",
    "response_time": 0.08894681930541992
}