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, "test@example.com" is allocated to a group whereas "test2@example.com" is not.
Parameters
Key
Type
Array of strings (valid emails)
Status Descriptions
Example
curl -X POST \
v1/groups/status \
-H 'Authorization: Basic <Your Base64 Encoded Token>' \
-d '{
"email" : ["test@example.com","test2@example.com"]
}'
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": "test@example.com",
"status": "Notified",
"groups": [
"Group One",
"Group Two",
...
]
}
],
"hash": "817f3aad61a810b1e8d7f7fb6303bdb2",
"response_time": 0.08894681930541992
}
Last updated