Developer Docs
OverviewGroupsPathways
  • Getting Started
  • Overview
    • API Manager
    • User Privacy
    • Responses
  • Groups
    • Concepts
    • Manage
    • Status
    • Insert
    • Remove
  • Data
    • Overview
    • List
    • Upload
    • Download
    • Delete
    • Insert
    • Remove
  • Pathways
    • Overview
    • Enrolments
      • List
      • Manage
    • Web Tracking
      • Serverless
      • Server-Side Platforms
    • Classroom & Events
      • List
      • Consume
    • Rewards
      • List
      • Consume
    • Webhooks
      • Enrolments
      • Classroom & Events
      • Rewards
    • Logs
      • Activity & Fulfilment Types
      • Activity & User Logs
  • Stories
    • Logs
      • Story Logs
      • User Story Logs
    • Certificates
    • Question Analysis
  • Streams
    • Subscriptions
    • Ratings
  • Analytics
    • Overview
    • Published
    • Realtime
    • Audience
      • Frequency
      • Demographics
      • Locations
      • Retention
    • Reviews
Powered by GitBook
On this page
  • Parameters
  • Status Descriptions
  • Example
  • Success Response

Was this helpful?

  1. Groups

Status

PreviousManageNextInsert

Last updated 3 years ago

Was this helpful?

The 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

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

Expired

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
}

User was (reminder email sent 1 - 2 days before invite expires).

User invite has (28 days after being notified).

status
nudged
expired