Group users API

Search a group for existing users, and add or remove known users. To get a group’s uuid, create a group or find it in the group’s settings in your community. Before you start, read the API overview for how authentication, headers, pagination and errors work.

Find users in a group

Check whether a user is already in a group. Matching users are returned in an array, and the array is empty when nothing matches.

string

required

The UUID of the group.

string

An email address, or part of one, to match against the group’s users.

Find users in a group

curl "https://your-community.zapnito.com/api/v1/groups/GROUP_UUID/users?query=joe" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8"

GET https://your-community.zapnito.com/api/v1/groups/:uuid/users

{
  "users": [
    {
      "name": "Maya Patel",
      "email": "maya.patel@example.com",
      "title": "Head of Compliance"
    },
    {
      "name": "Daniel Reyes",
      "email": "daniel.reyes@example.com",
      "title": "Regulatory Counsel"
    }
  ]
}

Add a user to a group

Add a known user to a group.

string

required

The UUID of the group to add the user to.

string

required

The email address of the user to add.

Add a user to a group

curl -X POST "https://your-community.zapnito.com/api/v1/groups/GROUP_UUID/users" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{"user": {"email": "alex.smith@example.com"}}'

POST https://your-community.zapnito.com/api/v1/groups/:uuid/users

{
  "message": "User alex.smith@example.com added to group Expert Users with UUID GROUP_UUID"
}

200 OK: the user was added, or already belongs to the group. If they already belong, the response carries an errors message instead: User alex.smith@example.com already belongs to group Expert Users with UUID GROUP_UUID.
401 Unauthorized: your API token is invalid, expired or badly formatted. See authentication.
404 Not Found: no group matches the UUID, or no user matches the email address. The messages read Group not found for UUID: '...' and User not found for email: '...'.

Remove a user from a group

Remove a known user from a group.

string

required

The UUID of the group to remove the user from.

string

required

The email address of the user to remove.

Remove a user from a group

curl -X DELETE "https://your-community.zapnito.com/api/v1/groups/GROUP_UUID/users" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{"user": {"email": "jordan.lee@example.com"}}'

DELETE https://your-community.zapnito.com/api/v1/groups/:uuid/users

{
  "message": "User jordan.lee@example.com removed from group Expert Users with UUID GROUP_UUID"
}

200 OK: the user was removed, or wasn’t in the group. If they weren’t in the group, the response carries an errors message instead: User jordan.lee@example.com does not currently belong to group Expert Users with UUID GROUP_UUID.
401 Unauthorized: your API token is incorrect or expired. See authentication.
404 Not Found: no group matches the UUID, or no user matches the email address. The messages read Group not found for UUID: '...' and User not found for email: '...'.

Getting started

Users

Groups and organisations

Content

Channels and rooms

Badges

Find users in a group

Add a user to a group

Remove a user from a group

​Find users in a group

​Add a user to a group

​Remove a user from a group

Find users in a group

Add a user to a group

Remove a user from a group